Skip to content

Commit

Permalink
update url
Browse files Browse the repository at this point in the history
  • Loading branch information
Takuka0311 committed Dec 5, 2024
1 parent ca37116 commit 8203efe
Show file tree
Hide file tree
Showing 46 changed files with 145 additions and 147 deletions.
12 changes: 6 additions & 6 deletions .github/ISSUE_TEMPLATE/ask-a-question.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,18 +9,18 @@ assignees: ''

Before asking a question, please first consider:

- Searching [existing discussions](https://github.com/alibaba/ilogtail/discussions/)
- Searching [existing issues](https://github.com/alibaba/ilogtail/issues/)
- Searching [English Doc](https://github.com/alibaba/ilogtail/tree/main/docs/en)
- Searching [existing discussions](https://github.com/alibaba/loongcollector/discussions/)
- Searching [existing issues](https://github.com/alibaba/loongcollector/issues/)
- Searching [English Doc](https://github.com/alibaba/loongcollector/tree/main/docs/en)
- Searching Google

-------

提问之前,建议先在 iLogtail 社区寻找答案。

- 查看 [存在的 discussions](https://github.com/alibaba/ilogtail/discussions/)
- 查看 [存在的 issues](https://github.com/alibaba/ilogtail/issues/)
- 查看 [存在的 discussions](https://github.com/alibaba/loongcollector/discussions/)
- 查看 [存在的 issues](https://github.com/alibaba/loongcollector/issues/)
- 查看 [中文文档](https://ilogtail.gitbook.io/ilogtail-docs/about/readme)
- 查看 Google

如果仍然无法找到答案,我们建议您在[discussions](https://github.com/alibaba/ilogtail/discussions/)进行提问。
如果仍然无法找到答案,我们建议您在[discussions](https://github.com/alibaba/loongcollector/discussions/)进行提问。
26 changes: 13 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
# Alibaba LoongCollector - Fast and Lightweight Observability Data Collector | 中文用户手册([GitBook](https://ilogtail.gitbook.io/ilogtail-docs/) | [可观测中文社区](https://open.observability.cn/project/ilogtail/about/)
# Alibaba LoongCollector - Fast and Lightweight Observability Data Collector | 中文用户手册([GitBook](https://ilogtail.gitbook.io/ilogtail-docs/) | [可观测中文社区](https://open.observability.cn/project/loongcollector/about/)

<img src="https://ilogtail-community-edition.oss-cn-shanghai.aliyuncs.com/images/logo/jpg/black-blue.jpg" alt="loongcollector logo" height="100px" align="center" />

LoongCollector was born for observable scenarios and has many production-level features such as lightweight, high performance, and automated configuration, which are widely used internally by Alibaba Group and tens of thousands of external Alibaba Cloud customers. You can deploy it in physical machines, Kubernetes and other environments to collect telemetry data, such as logs, traces and metrics.

[![GitHub contributors](https://img.shields.io/github/contributors/alibaba/ilogtail)](https://github.com/alibaba/ilogtail/contributors)
[![GitHub stars](https://img.shields.io/github/stars/alibaba/ilogtail)](https://github.com/alibaba/ilogtail/stargazers)
[![GitHub issues](https://img.shields.io/github/issues/alibaba/ilogtail)](https://github.com/alibaba/ilogtail/issues)
[![GitHub license](https://img.shields.io/github/license/alibaba/ilogtail)](https://github.com/alibaba/ilogtail/blob/main/LICENSE)
[![GitHub contributors](https://img.shields.io/github/contributors/alibaba/ilogtail)](https://github.com/alibaba/loongcollector/contributors)
[![GitHub stars](https://img.shields.io/github/stars/alibaba/ilogtail)](https://github.com/alibaba/loongcollector/stargazers)
[![GitHub issues](https://img.shields.io/github/issues/alibaba/ilogtail)](https://github.com/alibaba/loongcollector/issues)
[![GitHub license](https://img.shields.io/github/license/alibaba/ilogtail)](https://github.com/alibaba/loongcollector/blob/main/LICENSE)
[![Coverity Scan Build Status](https://img.shields.io/coverity/scan/28764.svg)](https://scan.coverity.com/projects/alibaba-ilogtail)
[![Coverage Status](https://codecov.io/gh/alibaba/ilogtail/branch/main/graph/badge.svg)](https://codecov.io/gh/alibaba/ilogtail)
[![Go Report Card](https://goreportcard.com/badge/github.com/alibaba/ilogtail)](https://goreportcard.com/report/github.com/alibaba/ilogtail)
[![Go Report Card](https://goreportcard.com/badge/github.com/alibaba/loongcollector)](https://goreportcard.com/report/github.com/alibaba/loongcollector)

## Abstract

Expand Down Expand Up @@ -83,20 +83,20 @@ Our official **User Manual** is located here:

There are many ways to contribute:

* [Fix and report bugs](https://github.com/alibaba/ilogtail/issues)
* [Improve Documentation](https://github.com/alibaba/ilogtail/labels/documentation)
* [Review code and feature proposals](https://github.com/alibaba/ilogtail/pulls)
* [Fix and report bugs](https://github.com/alibaba/loongcollector/issues)
* [Improve Documentation](https://github.com/alibaba/loongcollector/labels/documentation)
* [Review code and feature proposals](https://github.com/alibaba/loongcollector/pulls)
* [Contribute plugins](./docs/en/guides/README.md)

## Contact Us

You can report bugs, make suggestions or participate in discussions through [Github Issues](https://github.com/alibaba/ilogtail/issues) and [Github Discussions](https://github.com/alibaba/ilogtail/discussions), or contact us with the following ways:
You can report bugs, make suggestions or participate in discussions through [Github Issues](https://github.com/alibaba/loongcollector/issues) and [Github Discussions](https://github.com/alibaba/loongcollector/discussions), or contact us with the following ways:

* Bilibili:[阿里云SLS](https://space.bilibili.com/630680534?from=search&seid=2845737427240690794&spm_id_from=333.337.0.0)
* Bilibili:[阿里云SLS](https://space.bilibili.com/630680534)
* Zhihu:[LoongCollector社区](https://www.zhihu.com/column/c_1533139823409270785)
* DingTalk:LoongCollector社区
* DingTalk/WeChat:LoongCollector社区

<img src="https://ilogtail-community-edition.oss-cn-shanghai.aliyuncs.com/images/chatgroup/chatgroup_20240408.png" style="width: 50%; height: 50%" />
<img src="docs/cn/.gitbook/assets/chatgroup.png" style="width: 60%; height: 60%" />

## Our Users

Expand Down
2 changes: 1 addition & 1 deletion docs/cn/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

LoongCollector 是一款集卓越性能、超强稳定性和灵活可编程性于一身的数据采集器,专为构建下一代可观测 Pipeline 设计。源自阿里云可观测性团队所开源的 iLogtail 项目,在继承了 iLogtail 强大的日志采集与处理能力的基础上,进行了全面的功能升级与扩展。从原来单一日志场景,逐步扩展为可观测数据采集、本地计算、服务发现的统一体。

[![GitHub stars](https://camo.githubusercontent.com/674a26318ece2d770231086a733bebdbb174c15721f03714f5b79930574a800a/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f73746172732f616c69626162612f696c6f677461696c)](https://github.com/alibaba/ilogtail/stargazers) [![GitHub issues](https://camo.githubusercontent.com/4266ec67b48f666bc0d440f9d1399e4b56ffc4eca3af3764e062731be83b2873/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f6973737565732f616c69626162612f696c6f677461696c)](https://github.com/alibaba/ilogtail/issues) [![GitHub license](https://camo.githubusercontent.com/608afe55a7ca2ed062304f89208d3b929fddcbde8923cd09ef40edb2d2c3bf76/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f6c6963656e73652f616c69626162612f696c6f677461696c)](https://github.com/alibaba/ilogtail/blob/main/LICENSE)
[![GitHub stars](https://camo.githubusercontent.com/674a26318ece2d770231086a733bebdbb174c15721f03714f5b79930574a800a/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f73746172732f616c69626162612f696c6f677461696c)](https://github.com/alibaba/loongcollector/stargazers) [![GitHub issues](https://camo.githubusercontent.com/4266ec67b48f666bc0d440f9d1399e4b56ffc4eca3af3764e062731be83b2873/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f6973737565732f616c69626162612f696c6f677461696c)](https://github.com/alibaba/loongcollector/issues) [![GitHub license](https://camo.githubusercontent.com/608afe55a7ca2ed062304f89208d3b929fddcbde8923cd09ef40edb2d2c3bf76/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f6c6963656e73652f616c69626162612f696c6f677461696c)](https://github.com/alibaba/loongcollector/blob/main/LICENSE)

## 品牌寓意

Expand Down
2 changes: 1 addition & 1 deletion docs/cn/awesome-ilogtail/use-cases.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# iLogtail社区版使用案例

* [OpenKruise x iLogtail:管理可观测数据采集Sidecar容器最佳实践](https://mp.weixin.qq.com/s/kfUNL3M1bB6_9hkzBLmCSw)
* [File2Kafka性能测试](https://github.com/alibaba/ilogtail/discussions/809)
* [File2Kafka性能测试](https://github.com/alibaba/loongcollector/discussions/809)
* [基于Logtail的阿里云EMR日志分析链路演进](https://zhuanlan.zhihu.com/p/570377914?)
* [一文搞懂 SAE 日志采集架构](https://mp.weixin.qq.com/s/8eOxYXZTU8Py1UzSS8MpLg)
* [树莓派上玩转iLogtail:构建/采集/分析NAS日志](https://mp.weixin.qq.com/s/aT1DikZchRJoCdRCd5CYVw)
2 changes: 1 addition & 1 deletion docs/cn/config-server/communication-protocol.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ ip 和 port 为 ConfigServer 的 ip 和接收端口,默认为127.0.0.1和8899

## API 响应规范

数据的发送及接收均为 protocol buffer 格式,参见源代码中的 [config_server/protocol](https://github.com/alibaba/ilogtail/tree/main/config_server/protocol) 文件夹(v1.0)。
数据的发送及接收均为 protocol buffer 格式,参见源代码中的 [config_server/protocol](https://github.com/alibaba/loongcollector/tree/main/config_server/protocol) 文件夹(v1.0)。

在调用API接口过程中,若返回HTTP状态码为 200,则表示请求成功,若返回HTTP状态码为其他,例如404等,则表示调用API接口失败。服务端会返回请求响应信息如下。code为响应码,表示请求成功/失败的类型;message 是响应信息,包含详细的请求成功信息/失败说明。

Expand Down
10 changes: 5 additions & 5 deletions docs/cn/config-server/developer-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,11 @@

## 更改管控协议

1.[管控协议讨论版](https://github.com/alibaba/ilogtail/discussions/404)提出修改意见
2. 意见通过后,修改[管控协议文件](https://github.com/alibaba/ilogtail/tree/main/config_server/protocol)
1.[管控协议讨论版](https://github.com/alibaba/loongcollector/discussions/404)提出修改意见
2. 意见通过后,修改[管控协议文件](https://github.com/alibaba/loongcollector/tree/main/config_server/protocol)
3. 管控协议生成对应语言的版本,并进行代码适配
* ilogtail C++ 部分:[agent.proto](https://github.com/alibaba/ilogtail/tree/main/core/protobuf/config_server)
* ConfigServer Golang 部分:[agent.proto & user.proto](https://github.com/alibaba/ilogtail/tree/main/config_server/service/proto/v1)
* ilogtail C++ 部分:[agent.proto](https://github.com/alibaba/loongcollector/tree/main/core/protobuf/config_server)
* ConfigServer Golang 部分:[agent.proto & user.proto](https://github.com/alibaba/loongcollector/tree/main/config_server/service/proto/v1)

## 开发

Expand All @@ -33,7 +33,7 @@ go build -o ConfigServer
可以通过如下方式查看测试覆盖率:

```bash
go test -cover github.com/alibaba/ilogtail/config_server/service/test -coverpkg github.com/alibaba/ilogtail/config_server/service/... -coverprofile coverage.out -v
go test -cover github.com/alibaba/loongcollector/config_server/service/test -coverpkg github.com/alibaba/loongcollector/config_server/service/... -coverprofile coverage.out -v
go tool cover -func=coverage.out -o coverage.txt
# Visualization results: go tool cover -html=coverage.out -o coverage.html
cat coverage.txt
Expand Down
24 changes: 12 additions & 12 deletions docs/cn/contributing/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,41 +14,41 @@ iLogtail 自从开源以来,受到了很多社区同学的关注。社区的

### 如何入手?

如果您是初次贡献,可以先从 [good first issue](https://github.com/alibaba/ilogtail/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) 列表中认领一个相对小的任务来快速参与社区贡献。
如果您是初次贡献,可以先从 [good first issue](https://github.com/alibaba/loongcollector/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) 列表中认领一个相对小的任务来快速参与社区贡献。

认领方式: 您可以直接在相应 Issue 中回复参与意愿,然后参照下面的 GitHub 工作流指引解决 issue 并按照规范提交 PR,通过 review 后即可合入到 main 分支。

### GitHub 完整工作流

我们使用 main 分支作为我们的开发分支,这代表它是不稳定的分支。稳定版本归档在 [Release](https://github.com/alibaba/ilogtail/releases) 中,每发布一个 Release 版本,都会打上对应版本 [Tag](https://github.com/alibaba/ilogtail/tags)
我们使用 main 分支作为我们的开发分支,这代表它是不稳定的分支。稳定版本归档在 [Release](https://github.com/alibaba/loongcollector/releases) 中,每发布一个 Release 版本,都会打上对应版本 [Tag](https://github.com/alibaba/loongcollector/tags)

#### 创建/认领 Issue

我们使用 GitHub [Issues](https://github.com/alibaba/ilogtail/issues) 以及 [Pull Requests](https://github.com/alibaba/ilogtail/pulls) 来管理/追踪需求或者问题。如果您希望开发新的特性、功能完善,或者发现了代码的 BUG,或者文档的增加、完善,或者希望提建议等,都可以创建一个 Issue;也可以认领我们发布出来的一些 Issue。
我们使用 GitHub [Issues](https://github.com/alibaba/loongcollector/issues) 以及 [Pull Requests](https://github.com/alibaba/loongcollector/pulls) 来管理/追踪需求或者问题。如果您希望开发新的特性、功能完善,或者发现了代码的 BUG,或者文档的增加、完善,或者希望提建议等,都可以创建一个 Issue;也可以认领我们发布出来的一些 Issue。

新建的 Issue 请按照模板规范填写内容,以便我们更好地理解您需求。另外,也需要您打上对应[标签](#标签),方便我们进行分类管理。

#### 设计交流

如果您的 PR 包含非常大的变更(比如模块的重构或者添加新的组件),**请务必发起详细讨论,编写详细的文档来阐述其设计、解决的问题和用途,达成一致后再进行变更**。您可以在 Issue 或 [Discussions ideas](https://github.com/alibaba/ilogtail/discussions/categories/ideas) 中给出详细的设计。如果需要我们的支持可以扫描加入钉钉群,我们可以提供一对一的交流。
如果您的 PR 包含非常大的变更(比如模块的重构或者添加新的组件),**请务必发起详细讨论,编写详细的文档来阐述其设计、解决的问题和用途,达成一致后再进行变更**。您可以在 Issue 或 [Discussions ideas](https://github.com/alibaba/loongcollector/discussions/categories/ideas) 中给出详细的设计。如果需要我们的支持可以扫描加入钉钉群,我们可以提供一对一的交流。

对于一些小的变更,也请在 Issue 中简单描述您的设计。

#### 开发测试

设计定稿后,即可进行开发流程。下面是开源贡献者常用的工作流(workflow):

1.[iLogtail](https://github.com/alibaba/ilogtail) 仓库 fork 到个人 GitHub 下。
1.[iLogtail](https://github.com/alibaba/loongcollector) 仓库 fork 到个人 GitHub 下。
2. 基于个人 fork 分支进行开发、测试工作。详细流程:
1. 保持个人 main 分支跟 iLogtail 主仓库 main 分支及时同步。
2. 将 fork 后的个人仓库 clone 到本地。
3. 创建新的开发分支,并进行开发。**请确保对应的变更都有 UnitTest 或 E2E 测试**
4. 在本地提交变更。**注意 commit log 保持简练、规范,提交的 email 需要和 GitHub 的 email 保持一致。**
5. 将变更 push 到远程个人分支。
3. 向 iLogtail main 分支创建一个 [pull request (PR)](https://github.com/alibaba/ilogtail/pulls),在进行较大的变更的时候请确保 PR 有一个对应的 Issue,并进行关联。
3. 向 iLogtail main 分支创建一个 [pull request (PR)](https://github.com/alibaba/loongcollector/pulls),在进行较大的变更的时候请确保 PR 有一个对应的 Issue,并进行关联。

1. 发起 PR 前请进行如下规范性检查:[代码/文档风格](../developer-guide/codestyle.md)[编码规范](../developer-guide/code-check/check-codestyle.md)[依赖包许可证](../developer-guide/code-check/check-dependency-license.md)[文件许可证](../developer-guide/code-check/check-license.md)
2. 为了更好的进行版本管理,对于一些独立的特性或者关键BUG修复,请提交[Changelog](https://github.com/alibaba/ilogtail/blob/main/CHANGELOG.md).
2. 为了更好的进行版本管理,对于一些独立的特性或者关键BUG修复,请提交[Changelog](https://github.com/alibaba/loongcollector/blob/main/CHANGELOG.md).

注意一个 PR 尽量不要过于大,如果的确需要有大的变更,可以将其按功能拆分成多个单独的 PR。

Expand All @@ -68,7 +68,7 @@ iLogtail 自从开源以来,受到了很多社区同学的关注。社区的
* [配置样例或K8s部署案例](#config),对应 label: example config。
* 文档(document),对应 label: documentation。
* [案例类](#case),对应 label: awesome ilogtail。
* 回答、解决问题,对应 label: question。我们建议优先提到 [Discussions](https://github.com/alibaba/ilogtail/discussions) 中讨论。
* 回答、解决问题,对应 label: question。我们建议优先提到 [Discussions](https://github.com/alibaba/loongcollector/discussions) 中讨论。

以下为附加标签:

Expand All @@ -87,21 +87,21 @@ iLogtail 自从开源以来,受到了很多社区同学的关注。社区的

除了共享代码,您也可以为我们的配置样板库做出贡献。

`example_config/data_pipelines`目录包含场景化的采集配置模版,重点突出processor / aggregator插件功能。如您对某些常见日志(如Apache、Spring Boot)的处理有一定心得,可以参考已有样例和[README](https://github.com/alibaba/ilogtail/tree/main/example_config#readme)进行提交。
`example_config/data_pipelines`目录包含场景化的采集配置模版,重点突出processor / aggregator插件功能。如您对某些常见日志(如Apache、Spring Boot)的处理有一定心得,可以参考已有样例和[README](https://github.com/alibaba/loongcollector/tree/main/example_config#readme)进行提交。

`k8s_templates`目录包含完整的K8s部署案例,从源到典型处理到输出,以input / flusher插件进行划分。如您对某些常见的日志处理场景(如将数据采集到Elastic Search、Clickhouse)的部署有一定心得,可以参考已有样例和[README](https://github.com/alibaba/ilogtail/tree/main/k8s_templates#readme)进行提交。
`k8s_templates`目录包含完整的K8s部署案例,从源到典型处理到输出,以input / flusher插件进行划分。如您对某些常见的日志处理场景(如将数据采集到Elastic Search、Clickhouse)的部署有一定心得,可以参考已有样例和[README](https://github.com/alibaba/loongcollector/tree/main/k8s_templates#readme)进行提交。

### 案例分享 <a href="#case" id="case"></a>

我们也欢迎您分享任何关于 iLogtail 的使用案例。我们在知乎建立了专栏 [iLogtail社区](https://www.zhihu.com/column/c_1533139823409270785),欢迎大家投稿,分享 iLogtail 的使用案例。

1. 在知乎写文章,例如[一文搞懂 SAE 日志采集架构](https://zhuanlan.zhihu.com/p/557591446)
2. 推荐自己的文章到“iLogtail社区”专栏。
3. GitHub上修改[use-cases.md](https://github.com/alibaba/ilogtail/blob/main/docs/cn/awesome-ilogtail/use-cases.md)并发起PR,Label选awesome ilogtail。
3. GitHub上修改[use-cases.md](https://github.com/alibaba/loongcollector/blob/main/docs/cn/awesome-ilogtail/use-cases.md)并发起PR,Label选awesome ilogtail。

### 参与社区讨论

如果您在使用 iLogtail 中遇到任何问题,欢迎到 [Discussions](https://github.com/alibaba/ilogtail/discussions) 进行交流互动。也欢迎在这里帮助其他使用者解答一些使用中的问题。
如果您在使用 iLogtail 中遇到任何问题,欢迎到 [Discussions](https://github.com/alibaba/loongcollector/discussions) 进行交流互动。也欢迎在这里帮助其他使用者解答一些使用中的问题。

Discussion 分类:

Expand Down
Loading

0 comments on commit 8203efe

Please sign in to comment.