Skip to content

Commit

Permalink
change file name (#1963)
Browse files Browse the repository at this point in the history
  • Loading branch information
Takuka0311 authored Dec 13, 2024
1 parent 156dd82 commit 8d42203
Show file tree
Hide file tree
Showing 24 changed files with 46 additions and 42 deletions.
36 changes: 18 additions & 18 deletions docs/cn/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@
* [概览](plugins/overview.md)
* [版本管理](plugins/stability-level.md)
* 输入
* [什么是输入插件](plugins/input/README.md)
* [什么是输入插件](plugins/input/inputs.md)
* 原生插件
* [文本日志](plugins/input/native/input-file.md)
* [容器标准输出](plugins/input/native/input-container-stdio.md)
Expand Down Expand Up @@ -69,7 +69,7 @@
* [【Debug】Mock数据-Service](plugins/input/extended/service-mock.md)
* [【Debug】文本日志](plugins/input/extended/metric-debug-file.md)
* 处理
* [什么是处理插件](plugins/processor/README.md)
* [什么是处理插件](plugins/processor/processors.md)
* SPL 处理
* [SPL 处理](plugins/processor/spl/processor-spl-native.md)
* 原生插件
Expand Down Expand Up @@ -102,13 +102,13 @@
* [多行切分](plugins/processor/extended/processor-split-log-regex.md)
* [字符串替换](plugins/processor/extended/processor-string-replace.md)
* 聚合
* [什么是聚合插件](plugins/aggregator/README.md)
* [什么是聚合插件](plugins/aggregator/aggregators.md)
* [基础聚合](plugins/aggregator/aggregator-base.md)
* [按上下文分组](plugins/aggregator/aggregator-context.md)
* [按Key分组](plugins/aggregator/aggregator-content-value-group.md)
* [按GroupMetadata分组](plugins/aggregator/aggregator-metadata-group.md)
* 输出
* [什么是输出插件](plugins/flusher/README.md)
* [什么是输出插件](plugins/flusher/flushers.md)
* 原生插件
* [SLS](plugins/flusher/native/flusher-sls.md)
* [【Debug】Blackhole](plugins/flusher/native/flusher-blackhole.md)
Expand All @@ -117,15 +117,15 @@
* [ClickHouse](plugins/flusher/extended/flusher-clickhouse.md)
* [ElasticSearch](plugins/flusher/extended/flusher-elasticsearch.md)
* [HTTP](plugins/flusher/extended/flusher-http.md)
* [kafkaV2](plugins/flusher/extended/flusher-kafka_v2.md)
* [kafkaV2](plugins/flusher/extended/flusher-kafka-v2.md)
* [Kafka(Deprecated)](plugins/flusher/extended/flusher-kafka.md)
* [OTLP日志](plugins/flusher/extended/flusher-otlp.md)
* [Prometheus](plugins/flusher/extended/flusher-prometheus.md)
* [Pulsar](plugins/flusher/extended/flusher-pulsar.md)
* [标准输出/文件](plugins/flusher/extended/flusher-stdout.md)
* [Loki](plugins/flusher/extended/loki.md)
* 扩展
* [什么是扩展插件](plugins/extension/README.md)
* [什么是扩展插件](plugins/extension/extensions.md)
* [BasicAuth鉴权](plugins/extension/ext-basicauth.md)
* [协议解码/反序列化](plugins/extension/ext-default-decoder.md)
* [协议编码/序列化](plugins/extension/ext-default-encoder.md)
Expand All @@ -142,12 +142,12 @@
* [代码风格](developer-guide/codestyle.md)
* [数据模型](developer-guide/data-model.md)
* 日志协议
* [什么是日志协议](developer-guide/log-protocol/README.md)
* [什么是日志协议](developer-guide/log-protocol/log-protocol.md)
* [协议转换](developer-guide/log-protocol/converter.md)
* [增加新的日志协议](developer-guide/log-protocol/How-to-add-new-protocol.md)
* 协议
* [sls协议](developer-guide/log-protocol/protocol-spec/sls.md)
* [单条协议](developer-guide/log-protocol/protocol-spec/custom_single.md)
* [单条协议](developer-guide/log-protocol/protocol-spec/custom-single.md)
* [raw协议](developer-guide/log-protocol/protocol-spec/raw.md)
* 插件开发
* [开源插件开发引导](developer-guide/plugin-development/plugin-development-guide.md)
Expand Down Expand Up @@ -193,22 +193,22 @@

## 管控工具 <a href="#config-server" id="config-server"></a>

* [使用介绍](config-server/quick-start.md)
* [使用介绍](config-server/usage-instructions.md)
* [通信协议](config-server/communication-protocol.md)
* [开发指南](config-server/developer-guide.md)
* [开发指南](config-server/config-server-developer-guide.md)

## 社区活动 <a href="#events" id="event"></a>

* 开源之夏 2024
* [开源之夏 2024 活动介绍](events/summer-ospp-2024/README.md)
* [开源之夏 2024 活动介绍](events/summer-ospp-2024/summer-ospp-2024.md)
* 项目
* [iLogtail 社区项目介绍](events/summer-ospp-2024/projects/README.md)
* [iLogtail 数据吞吐性能优化](events/summer-ospp-2024/projects/ilogtail-io.md)
* [ConfigServer 能力升级 + 体验优化(全栈)](events/summer-ospp-2024/projects/config-server.md)
* [iLogtail 社区项目介绍](events/summer-ospp-2024/projects/summer-ospp-2024-projects.md)
* [iLogtail 数据吞吐性能优化](events/summer-ospp-2024/projects/summer-ospp-2024-projects-ilogtail-io.md)
* [ConfigServer 能力升级 + 体验优化(全栈)](events/summer-ospp-2024/projects/summer-ospp-2024-projects-config-server.md)

## Awesome iLogtail <a href="#awesome-ilogtail" id="awesome-ilogtail"></a>

* [走近iLogtail社区版](awesome-ilogtail/ilogtail.md)
* [iLogtail社区版使用入门](awesome-ilogtail/getting-started.md)
* [iLogtail社区版开发者指南](awesome-ilogtail/developer-guide.md)
* [iLogtail社区版使用案例](awesome-ilogtail/use-cases.md)
* [走近iLogtail社区版](awesome-ilogtail/awesome-ilogtail.md)
* [iLogtail社区版使用入门](awesome-ilogtail/awesome-ilogtail-getting-started.md)
* [iLogtail社区版开发者指南](awesome-ilogtail/awesome-ilogtail-developer-guide.md)
* [iLogtail社区版使用案例](awesome-ilogtail/awesome-ilogtail-use-cases.md)
File renamed without changes.
File renamed without changes.
File renamed without changes.
Original file line number Diff line number Diff line change
@@ -1,12 +1,15 @@
# 走近iLogtail社区版

## 开源历程

* 2024-08 [iLogtail 开源两周年:感恩遇见,畅想未来](https://mp.weixin.qq.com/s/RoFjoYlPLG1yOzDGc7vqIQ)
* 2023-02 [鲲鹏展翅凌云志:iLogtail社区2022年度开源报告](https://mp.weixin.qq.com/s/6luD7VUFd_0aaeyUBAShkw)
* 2024-02 [你好,iLogtail 2.0!](https://developer.aliyun.com/article/1441630)
* 2022-07 [千万级可观测数据采集器--iLogtail代码完整开源](https://mp.weixin.qq.com/s/Cam_OjPWhcEj77kqC0Q1SA)
* 2022-08 [iLogtail开源之路](https://mp.weixin.qq.com/s/5j5KJe9BmpZ1tdb-KCx_CQ)

## 技术分享

* 2024-08 [软件测试之道 -- 做一个有匠心的程序员!](https://mp.weixin.qq.com/s/ktEMOcXBopFiX9NIN3chHg) 看iLogtail如何做测试设计
* 2024-08 [代码整洁之道--告别码农,做一个有思想的程序员!](https://mp.weixin.qq.com/s/tK0ZyRxKBGpCqIw16SPSxg) 看iLogtail如何追求代码整洁
* 2024-04 [破浪前行:iLogtail十年老架构如何浴火重生](https://developer.aliyun.com/article/1484844)
Expand All @@ -18,8 +21,9 @@
* 2022-12 [阿里十年技术沉淀|深度解析百PB级数据总线技术](https://mp.weixin.qq.com/s/NKoTCM5o-Rs_83Wakk9yCw)

## 最佳实践

* 2022-09 [零信任策略下K8s安全监控最佳实践](https://mp.weixin.qq.com/s/wYUNsGaWEnQZ0BVxsQORbA)

## 其他
* 2021-09 [您有一份来自iLogtail社区的礼物待查收](https://mp.weixin.qq.com/s/fyWwnKR1I4jgNiX30Wu-Vg)

* 2021-09 [您有一份来自iLogtail社区的礼物待查收](https://mp.weixin.qq.com/s/fyWwnKR1I4jgNiX30Wu-Vg)
File renamed without changes.
File renamed without changes.
26 changes: 13 additions & 13 deletions docs/cn/contributing/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
# 贡献指南

欢迎来到 iLogtail 的社区!感谢您为iLogtail贡献代码、文档及案例!
欢迎来到 LoongCollector 的社区!感谢您为 LoongCollector 贡献代码、文档及案例!

iLogtail 自从开源以来,受到了很多社区同学的关注。社区的每一个 Issue、每一个 pull request (PR),都是在为 iLogtail 的发展添砖加瓦。衷心地希望越来越多的社区同学能参与到 iLogtail 项目中来,跟我们一起把 iLogtail 做好。
LoongCollector 自从开源以来,受到了很多社区同学的关注。社区的每一个 Issue、每一个 pull request (PR),都是在为 LoongCollector 的发展添砖加瓦。衷心地希望越来越多的社区同学能参与到 LoongCollector 项目中来,跟我们一起把 LoongCollector 做好。

## 行为准则

参与 iLogtail 社区贡献,请阅读并同意遵守[阿里巴巴开源行为准则](https://github.com/alibaba/community/blob/master/CODE_OF_CONDUCT_zh.md),共同营造一个开放透明且友好的开源社区环境。
参与 LoongCollector 社区贡献,请阅读并同意遵守[阿里巴巴开源行为准则](https://github.com/alibaba/community/blob/master/CODE_OF_CONDUCT_zh.md),共同营造一个开放透明且友好的开源社区环境。

## 贡献流程

Expand Down Expand Up @@ -38,14 +38,14 @@ iLogtail 自从开源以来,受到了很多社区同学的关注。社区的

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

1.[iLogtail](https://github.com/alibaba/loongcollector) 仓库 fork 到个人 GitHub 下。
1.[LoongCollector](https://github.com/alibaba/loongcollector) 仓库 fork 到个人 GitHub 下。
2. 基于个人 fork 分支进行开发、测试工作。详细流程:
1. 保持个人 main 分支跟 iLogtail 主仓库 main 分支及时同步。
1. 保持个人 main 分支跟 LoongCollector 主仓库 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/loongcollector/pulls),在进行较大的变更的时候请确保 PR 有一个对应的 Issue,并进行关联。
3.LoongCollector 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/loongcollector/blob/main/CHANGELOG.md).
Expand Down Expand Up @@ -93,22 +93,22 @@ iLogtail 自从开源以来,受到了很多社区同学的关注。社区的

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

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

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

### 参与社区讨论

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

Discussion 分类:

* Announcements:iLogtail官方公告
* Help:使用 iLogtail 中遇到问题,想在社区寻求帮助。
* Ideas:关于 iLogtail 的一些想法,欢迎随时交流。
* Show and tell:可以在这里展示任何跟 iLogtail 相关的工作,例如一些小工具等。
* Announcements:LoongCollector 官方公告
* Help:使用 LoongCollector 中遇到问题,想在社区寻求帮助。
* Ideas:关于 LoongCollector 的一些想法,欢迎随时交流。
* Show and tell:可以在这里展示任何跟 LoongCollector 相关的工作,例如一些小工具等。

## 联系我们

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -52,4 +52,4 @@
- 在`c.DoWithSelectedFields`方法的`switch`语句中新增一个`case`子句,`case`名为协议名,子句内容为`return c.ConvertToXXXProtocolLogs(logGroup, targetFields)`,其中涉及的函数即为第2步中编写的函数
- 在`c.ToByteStreamWithSelectedFields`方法的`switch`语句中新增一个`case`子句,`case`名为协议名,子句内容为`return c.ConvertToXXXProtocolStream(logGroup, targetFields)`,其中涉及的函数即为第2步中编写的函数
4. 在`./doc/cn/developer-guide/log-protocol/converter.md`的附录、`README.md`中增加协议相关内容,并在`./doc/cn/developer-guide/log-protocol/protocol-spec`文件夹下新增`<protocol>.md`文件描述具体的协议形式。
4. 在`./doc/cn/developer-guide/log-protocol/converter.md`的附录、`log-protocol.md`中增加协议相关内容,并在`./doc/cn/developer-guide/log-protocol/protocol-spec`文件夹下新增`<protocol>.md`文件描述具体的协议形式。
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,6 @@ LoongCollector 的日志数据默认以sls自定义协议的形式与外部进
| 协议类型 | 协议名称 | 支持的编码方式 |
|-------|--------------------------------------------------------------------------------------------------|---------------|
| 标准协议 | [sls协议](protocol-spec/sls.md) | json、protobuf |
| 自定义协议 | [单条协议](protocol-spec/custom_single.md) | json |
| 自定义协议 | [单条协议](protocol-spec/custom-single.md) | json |
| 标准协议 | [Influxdb协议](https://docs.influxdata.com/influxdb/v1.8/write_protocols/line_protocol_reference/) | custom |
| 字节流协议 | [raw协议](protocol-spec/raw.md) | custom |
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,5 @@

iLogtail 为本次开源之夏贡献了两个项目。宣传视频:[iLogtail 社区开源之夏宣讲介绍](https://www.bilibili.com/video/BV1JH4y1V7FS/?vd_source=b01dd5670462ce34eca76313ec727f4d)

* [iLogtail 数据吞吐性能优化](ilogtail-io.md)
* [ConfigServer 能力升级 + 体验优化(全栈)](config-server.md)
* [iLogtail 数据吞吐性能优化](summer-ospp-2024-projects-ilogtail-io.md)
* [ConfigServer 能力升级 + 体验优化(全栈)](summer-ospp-2024-projects-config-server.md)
File renamed without changes.
2 changes: 1 addition & 1 deletion docs/cn/installation/release-notes/release-notes.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ LoongCollector 是一款集卓越性能、超强稳定性和灵活可编程性
3. 更灵活的编程管道

* C++ 全面插件化(已发布):同时提供了充足的组件可供插件自由组合,极大地方便社区新增高性能的输入和输出能力,C++原生插件开发指南详见[如何开发原生Input插件](../../developer-guide/plugin-development/native-plugins/how-to-write-native-input-plugins.md)[如何开发原生Flusher插件](../../developer-guide/plugin-development/native-plugins/how-to-write-native-flusher-plugins.md)
* C++ Input 可使用原生 Processor(已发布):C++ Input插件能够与原生及扩展的Processor插件配合使用,并支持SPL插件。这意味着C++ Input插件不仅可以利用原生Processor提供的高性能来解析日志,还能通过丰富的扩展Processor功能进一步处理日志,具体详情请参阅文档[什么是处理插件](../../plugins/processor/README.md)[什么是输入插件](../../plugins/input/README.md)
* C++ Input 可使用原生 Processor(已发布):C++ Input插件能够与原生及扩展的Processor插件配合使用,并支持SPL插件。这意味着C++ Input插件不仅可以利用原生Processor提供的高性能来解析日志,还能通过丰富的扩展Processor功能进一步处理日志,具体详情请参阅文档[什么是处理插件](../../plugins/processor/processors.md)[什么是输入插件](../../plugins/input/inputs.md)
* Golang Input 可使用原生 Processor (开发中):Go Input 支持多种灵活的数据源输入,而原生处理插件提供了高性能的数据处理。结合两者的优势,可以构建出既高效又能适应多种应用场景的数据处理流水线。详见 [Issue](https://github.com/alibaba/loongcollector/issues/1917)
* SPL 处理模式(已发布):SPL 处理模式支持用户通过 SPL 语句实现对数据的处理。无需编写代码开发插件,极大地拓展了 LoongCollector 可应用的场景。详见文档 [SPL 处理](../../plugins/processor/spl/processor-spl-native.md)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,6 @@

* 使用了除[SLS输出插件](../flusher/native/flusher-sls.md)

* 使用了[SLS输出插件](../flusher/native/flusher-sls.md),且同时使用了[扩展处理插件](../processor/README.md)
* 使用了[SLS输出插件](../flusher/native/flusher-sls.md),且同时使用了[扩展处理插件](../processor/processors.md)

对于上述场景,如果用户的采集配置中未指定聚合插件,则`iLogtail`会使用默认聚合插件,即[上下文聚合插件](aggregator-context.md)
File renamed without changes.
2 changes: 1 addition & 1 deletion docs/cn/plugins/flusher/extended/flusher-pulsar.md
Original file line number Diff line number Diff line change
Expand Up @@ -123,7 +123,7 @@ Topic: test_%{content.application}

- `%{content.fieldname}`。`content`代表从`contents`中取指定字段值
- `%{tag.fieldname}`,`tag`表示从`tags`中取指定字段值,例如:`%{tag.k8s.namespace.name}`
- `${env_name}`, 读取系统变量绑定到动态`topic`上,`ilogtail 1.5.0`开始支持。可以参考`flusher-kafka_v2`中的使用。
- `${env_name}`, 读取系统变量绑定到动态`topic`上,`ilogtail 1.5.0`开始支持。可以参考`flusher-kafka-v2`中的使用。
- 其它方式暂不支持

### TagFieldsRename
Expand Down
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -84,4 +84,4 @@
- 插件组合规则:
- 原生Input插件: 可配合原生/扩展Processor插件使用,支持SPL插件
- 扩展Input插件: 仅支持扩展Processor插件
- 详细说明请参考[处理插件文档](../processor/README.md)
- 详细说明请参考[处理插件文档](../processor/processors.md)
2 changes: 1 addition & 1 deletion docs/cn/plugins/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,7 @@
| 名称 | 提供方 | 简介 |
| --- | --- | --- |
| `flusher_kafka`<br>[Kafka](flusher/extended/flusher-kafka.md) | 社区 | 将采集到的数据输出到Kafka。推荐使用下面的flusher_kafka_v2 |
| `flusher_kafka_v2`<br>[Kafka V2](flusher/extended/flusher-kafka_v2.md) | 社区<br>[shalousun](https://github.com/shalousun) | 将采集到的数据输出到Kafka。 |
| `flusher_kafka_v2`<br>[Kafka V2](flusher/extended/flusher-kafka-v2.md) | 社区<br>[shalousun](https://github.com/shalousun) | 将采集到的数据输出到Kafka。 |
| `flusher_stdout`<br>[标准输出/文件](flusher/extended/flusher-stdout.md) | SLS官方 | 将采集到的数据输出到标准输出或文件。 |
| `flusher_otlp_log`<br>[OTLP日志](flusher/extended/flusher-otlp.md) | 社区<br>[liuhaoyang](https://github.com/liuhaoyang) | 将采集到的数据支持`Opentelemetry log protocol`的后端。 |
| `flusher_http`<br>[HTTP](flusher/extended/flusher-http.md) | 社区<br>[snakorse](https://github.com/snakorse) | 将采集到的数据以http方式输出到指定的后端。 |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@
| [`input_network_security`](../input/native/input-network-security.md) | 网络安全监控插件 |
| [`input_process_security`](../input/native/input-process-security.md) | 进程安全监控插件 |

更多输入插件说明请参考[输入插件文档](../input/README.md)
更多输入插件说明请参考[输入插件文档](../input/inputs.md)

### 插件组合规则

Expand Down

0 comments on commit 8d42203

Please sign in to comment.