iLogtail

1752
下载
iLogtail 是阿里云日志服务(Log Service)中的一款高性能、可扩展的日志采集工具。它被设计用于实时收集、解析和传输各类日志数据,支持多种数据源和复杂的日志处理场景,广泛应用于分布式系统、Web 服务器、应用程序等环境中的日志管理。

开源插件开发引导


了解 ilogtail 插件

ilogtail插件的实现原理、整体架构、系统设计等介绍,请参考插件系统

开发流程

ilogtail 插件的开发主要有以下步骤:

  1. 创建Issue,描述开发插件功能,会有社区同学参与讨论插件开发的可行性,如果社区review 通过,请参考步骤2继续进行。
  2. 实现相应接口。
  3. 通过init函数注册插件。
  4. 将插件加入插件引用配置文件common配置节, 如果仅运行于指定系统,请添加到linuxwindows配置节.
  5. 进行单测或者E2E测试,请参考如何使用单测如何使用E2E测试.
  6. 使用 make lint 检查代码规范。
  7. 提交Pull Request。

在开发时,Checkpoint接口Logger接口或许能对您有所帮助。此外,可以使用纯插件模式启动 iLogtail,用于对插件进行轻量级测试。

更详细的开发细节,请参考:

文档撰写流程

开发完成后,可以参考如何生成插件文档生成插件的使用文档,也可以手动编写插件文档。

文档的编写主要有如下步骤:

  1. 遵循插件文档规范,编写插件文档。
  2. 数据流水线概览中添加插件的信息。所有的插件按英文名字典序升序排列,添加的时候请注意插入的位置。
  3. 文档目录中添加插件文档的路径,注意与数据流水线概览中保持顺序一致。

observability.cn Authors 2024 | Documentation Distributed under CC-BY-4.0
Copyright © 2017-2024, Alibaba. All rights reserved. Alibaba has registered trademarks and uses trademarks.
浙ICP备2021005855号-32