# CnOps 智能运维与可观测社区 - 开源项目文档索引 > 面向 AI/LLM 的开源项目帮助文档索引，每篇文档同时提供网页和 Markdown 入口。 ## LoongCollector - [项目主页](https://cnops.com.cn/projects/loongcollector) - [如何开发扩展Input插件](https://cnops.com.cn/projects/loongcollector/docs/lc--how-to-write-input-plugins) | [Markdown](https://cnops.com.cn/api/md/projects/loongcollector/lc--how-to-write-input-plugins): 开发前请先阅读 pkg/pipeline/input.go 中的接口分层：公共接口（MetricInput / ServiceInput）与 V1 / V2 扩展（采集路径不同）是分开定义的。 目前 Input 分为两类： MetricInput：由插件框架按周期调度，适合定时拉取指标等场景。 ServiceInput：在独立 goroutine 中常驻运行，适合接受外部推送（如 HTTP... - [开源插件开发引导](https://cnops.com.cn/projects/loongcollector/docs/lc--plugin-development-guide) | [Markdown](https://cnops.com.cn/api/md/projects/loongcollector/lc--plugin-development-guide): LoongCollector 插件的实现原理、整体架构、系统设计等介绍，请参考插件系统。 LoongCollector 原生插件的开发主要有以下步骤： 1. 创建Issue，描述开发插件功能，会有社区同学参与讨论插件开发的可行性，如果社区review 通过，请参考步骤2继续进行。 2. 开发对应插件，可以参考以下文档： 如何开发原生Input插件 ... - [自监控告警说明](https://cnops.com.cn/projects/loongcollector/docs/lc--internal-alarms-description) | [Markdown](https://cnops.com.cn/api/md/projects/loongcollector/lc--internal-alarms-description): 【文档施工中，请耐心等待】 - [走近LoongCollector社区版](https://cnops.com.cn/projects/loongcollector/docs/lc--awesome-loongcollector--awesome-loongcollector) | [Markdown](https://cnops.com.cn/api/md/projects/loongcollector/lc--awesome-loongcollector--awesome-loongcollector): 2024-11 iLogtail 开源贡献人物专访：技术之路无坦途，与社区共同成长 2024-09 iLogtail 开源两周年：社区使用调查报告 2024-09 iLogtail进化论：重塑可观测采集的技术边界 2024-08 iLogtail 开源两周年：感恩遇见，畅想未来 2024-02 你好，iLogtail 2.0！ 2023-02... - [贡献指南](https://cnops.com.cn/projects/loongcollector/docs/lc--contributing--contributing) | [Markdown](https://cnops.com.cn/api/md/projects/loongcollector/lc--contributing--contributing): 欢迎来到 LoongCollector 的社区！感谢您为 LoongCollector 贡献代码、文档及案例！ LoongCollector 自从开源以来，受到了很多社区同学的关注。社区的每一个 Issue、每一个 pull request (PR)，都是在为 LoongCollector 的发展添砖加瓦。衷心地希望越来越多的社区同学能参与到 LoongCollector 项目中来，跟我们一起把... - [iLogtail 社区项目介绍](https://cnops.com.cn/projects/loongcollector/docs/lc--summer-ospp-2024-projects) | [Markdown](https://cnops.com.cn/api/md/projects/loongcollector/lc--summer-ospp-2024-projects): iLogtail 为本次开源之夏贡献了两个项目。宣传视频：iLogtail 社区开源之夏宣讲介绍 iLogtail 数据吞吐性能优化 ConfigServer 能力升级 + 体验优化（全栈） - [开源之夏 2024 活动介绍](https://cnops.com.cn/projects/loongcollector/docs/lc--summer-ospp-2024) | [Markdown](https://cnops.com.cn/api/md/projects/loongcollector/lc--summer-ospp-2024): 开源之夏是由中国科学院软件研究所“开源软件供应链点亮计划”发起并长期支持的一项暑期开源活动，旨在鼓励在校学生积极参与开源软件的开发维护，培养和发掘更多优秀的开发者，促进优秀开源软件社区的蓬勃发展，助力开源软件供应链建设。活动联合各大开源社区，针对重要开源软件的开发与维护提供项目开发任务，并向全球高校学生开放报名。 开源之夏活动中的 iLogtail 社区主页。 欢迎 iLogtail... - [SPL 处理](https://cnops.com.cn/projects/loongcollector/docs/lc--processor-spl-native) | [Markdown](https://cnops.com.cn/api/md/projects/loongcollector/lc--processor-spl-native): processorspl插件通过SPL语句处理数据 Stable 推荐版本：LoongCollector v3.0.5 及以上 | 参数 | 类型 | 是否必填 | 默认值 | 说明 | | --- | --- | --- | --- | --- | | Type | string | 是 | / | 插件类型。固定为processorspl。 | | Script | string | 是... - [什么是处理插件](https://cnops.com.cn/projects/loongcollector/docs/lc--processors) | [Markdown](https://cnops.com.cn/api/md/projects/loongcollector/lc--processors): 处理插件用于对采集到的数据进行解析、过滤和加工。LoongCollector 提供了三种处理模式，以满足不同场景的数据处理需求： - 原生插件(C++) - 扩展插件(Golang) - SPL处理 这三种处理模式可以灵活组合使用，通过统一的 Event 数据模型，支持处理包括日志、指标、追踪、事件、性能剖析等多种可观测数据。 - 采用C++实现，性能最优，资源开销极低 -... - [脱敏](https://cnops.com.cn/projects/loongcollector/docs/lc--processor-desensitize-native) | [Markdown](https://cnops.com.cn/api/md/projects/loongcollector/lc--processor-desensitize-native): processordesensitizenative 插件对事件指定字段内容进行脱敏。 Stable 推荐版本：iLogtail v2.0.0 及以上 | 参数 | 类型 | 是否必填 | 默认值 | 说明 | | --- | --- | --- | --- | --- | | Type | string | 是 | / | ... - [使用介绍](https://cnops.com.cn/projects/loongcollector/docs/lc--usage-instructions) | [Markdown](https://cnops.com.cn/api/md/projects/loongcollector/lc--usage-instructions): 目前开源版 LoongCollector 主要提供了本地采集配置管理模式，当涉及实例数较多时，需要逐个实例进行配置变更，管理比较复杂。 此外，多实例场景下 LoongCollector 的版本信息、运行状态等也缺乏统一的监控。因此，需要提供全局管控服务用于对 LoongCollector 的采集配置、版本信息、运行状态等进行统一的管理。 ConfigServer... - [容器场景iLogtail与Filebeat性能对比测试](https://cnops.com.cn/projects/loongcollector/docs/lc--performance-compare-with-filebeat) | [Markdown](https://cnops.com.cn/api/md/projects/loongcollector/lc--performance-compare-with-filebeat): 前段时间, iLogtail（https://github.com/alibaba/loongcollector）阿里千万实例可观测采集器开源，其中介绍了iLogtail采集性能可以达到单核100MB/s，相比开源采集Agent有5-10倍性能优势。很多小伙伴好奇iLogtail具体的性能数据和资源消耗如何，本文将针对目前业界使用度较高且性能相对较优的Agent... - [LoongCollector 发布记录](https://cnops.com.cn/projects/loongcollector/docs/lc--release-notes--release-notes) | [Markdown](https://cnops.com.cn/api/md/projects/loongcollector/lc--release-notes--release-notes): 下载地址、校验和、每条 Release 正文中列出的容器镜像 tag，一律以 GitHub — alibaba/loongcollector Releases 为唯一事实源；更新文档或脚本前请打开 当前 latest release 页面 核对（撰写本节时最新 stable tag 为 v3.3.2，仅作占位，以后以页面为准）。 同一条 Release（例如 v3.3.2）正文中通常会并列给出：... - [脚本执行数据](https://cnops.com.cn/projects/loongcollector/docs/lc--input-command) | [Markdown](https://cnops.com.cn/api/md/projects/loongcollector/lc--input-command): inputcommand插件可以通过配置脚本内容，在agent机器上生成可执行的脚本，并通过指定的cmdpath 执行该脚本，插件会从脚本执行后stdout获得内容进行解析，从而获取脚本内容执行后的信息。 注意：如需使用该插件，LoongCollector 进程需以 root 用户运行。配置的脚本内容请自行评估风险。 Alpha 推荐版本：iLogtail v1.7.1 及以上 | 参数 ... - [【Debug】Blackhole](https://cnops.com.cn/projects/loongcollector/docs/lc--flusher-blackhole) | [Markdown](https://cnops.com.cn/api/md/projects/loongcollector/lc--flusher-blackhole): flusherblackhole flusher插件直接丢弃采集的事件，属于原生输出插件，主要用于测试。 Stable 推荐版本：LoongCollector v3.0.5 及以上 | 参数 | 类型 | 是否必填 | 默认值 | 说明 | | --- | --- | --- | --- | --- | | Type | string | 是 | / | ... - [如何生成插件文档](https://cnops.com.cn/projects/loongcollector/docs/lc--how-to-generate-plugin-docs) | [Markdown](https://cnops.com.cn/api/md/projects/loongcollector/lc--how-to-generate-plugin-docs): 使用comment tag 标记的大写字符开头的字段，这些字段将会被自动提取到文档中。如果字段还有json, yaml 或 mapstructure tag 标记，字段的名称会被上述tag中的名字所替换, 此外init 注册函数设置的默认值同样会被提取到默认值字段。 1. 执行 make docs 生成插件文档. 注意:... - [什么是日志协议](https://cnops.com.cn/projects/loongcollector/docs/lc--log-protocol--log-protocol) | [Markdown](https://cnops.com.cn/api/md/projects/loongcollector/lc--log-protocol--log-protocol): LoongCollector 的日志数据默认以sls自定义协议的形式与外部进行交互，但也支持日志数据在sls协议和其它标准协议或自定义协议之间的转换。除此之外，对于某种协议，LoongCollector 还支持对日志数据进行不同方式的编码。 目前，LoongCollector 日志数据支持的协议及相应的编码方式如下表所示，其中协议类型可分为自定义协议和标准协议： | 协议类型 | 协议名称 ... - [什么是输入插件](https://cnops.com.cn/projects/loongcollector/docs/lc--inputs) | [Markdown](https://cnops.com.cn/api/md/projects/loongcollector/lc--inputs): 输入插件是 LoongCollector 的核心组件之一，负责从各类数据源高效采集数据。LoongCollector 提供两种类型的输入插件，分别针对不同的使用场景: - 原生插件(C++): 高性能、低开销的首选方案 - 扩展插件(Golang): 灵活可扩展的补充方案 原生插件采用 C++实现，具有以下显著优势: - 卓越的性能表现和极低的资源开销 - 专注于常见数据源的高效采集 -... - [快速开始](https://cnops.com.cn/projects/loongcollector/docs/lc--quick-start) | [Markdown](https://cnops.com.cn/api/md/projects/loongcollector/lc--quick-start): 1. 下载预编译的 LoongCollector 包，解压后进入目录，该目录下文均称为部署目录。 版本号请始终以 GitHub Releases — alibaba/loongcollector 为准（含 linux-amd64 / linux-arm64 / windows-amd64 资产及 checksum）。下例中的 VERSION 仅为演示；你也可使用 Release... - [采集配置](https://cnops.com.cn/projects/loongcollector/docs/lc--collection-config) | [Markdown](https://cnops.com.cn/api/md/projects/loongcollector/lc--collection-config): 在 LoongCollector 中，采集配置（英文 collection pipeline；代码与实现中也常简称 pipeline）指一组 inputs / processors / aggregators / flushers（及可选 extensions）组成的采集与投递定义，通常对应一个配置文件。 | 类别 | 说明 | 默认目录（相对 conf/，本地示意） |... - [sls协议](https://cnops.com.cn/projects/loongcollector/docs/lc--sls) | [Markdown](https://cnops.com.cn/api/md/projects/loongcollector/lc--sls): sls协议对应的Protobuf模式定义如下： 传输数据字段以及标签，简单的 key/value 对。 Log 是表示单条日志的数据类型，Time 字段为日志时间，Contents 字段维护了此日志的内容，由一个 key/value 列表组成。 LogGroup（日志组）是对多条日志的包装： - Logs：包含所有日志。 - Category：日志服务Logstore，可以类比Kafka... - [开发环境](https://cnops.com.cn/projects/loongcollector/docs/lc--development-environment) | [Markdown](https://cnops.com.cn/api/md/projects/loongcollector/lc--development-environment): 虽然源代码编译已经提供了方便的 LoongCollector 编译方法，但却不适合开发场景。因为开发过程中需要不断进行编译调试，重复全量编译的速度太慢，因此需要构建支持增量编译开发环境。 LoongCollector 为了支持插件系统，引入了 libGoPluginAdaptor 和 libGoPluginBase（以下简称 adaptor 和 base）这两个动态库，它们与... - [自监控指标说明](https://cnops.com.cn/projects/loongcollector/docs/lc--internal-metrics-description) | [Markdown](https://cnops.com.cn/api/md/projects/loongcollector/lc--internal-metrics-description): 在 LoongCollector 中，有如下几种指标类型： 进程级（agent）：LoongCollector的整体状态，包含一些Cpu、Mem等信息。 Runner级（runner）：LoongCollector内部的独立线程的单例，通常是一整个功能模块，例如fileserver、processorrunner等。runner级指标记录的就是这些单例的状态。 ... - [Logger接口](https://cnops.com.cn/projects/loongcollector/docs/lc--logger-api) | [Markdown](https://cnops.com.cn/api/md/projects/loongcollector/lc--logger-api): Logger提供了DBG、INFO、WARN、ERR 4个级别的日志打印，每个级别分别提供kv和format形式打印接口。 其中WARN和ERR级别的alarmType参数，通常使用全大写XXXALARM。 基本使用示例 对于... - [如何开发原生Input插件](https://cnops.com.cn/projects/loongcollector/docs/lc--how-to-write-native-input-plugins) | [Markdown](https://cnops.com.cn/api/md/projects/loongcollector/lc--how-to-write-native-input-plugins): 同一输入类型的多个插件实例通常由管理类（Runner）在共享线程或任务模型下驱动；实例侧保存配置并参与注册/反注册。 原生 Input 声明见 core/collectionpipeline/plugin/interface/Input.h（派生自 Plugin）： 与早期文档相比，请注意 Init 增加 optionalGoPipeline 参数，且必须实现... - [添加字段](https://cnops.com.cn/projects/loongcollector/docs/lc--processor-add-fields) | [Markdown](https://cnops.com.cn/api/md/projects/loongcollector/lc--processor-add-fields): processoraddfields processor插件可以添加日志字段。 Stable 推荐版本：iLogtail v1.0.27 及以上 | 参数 | 类型 | 是否必选 | 说明 | | ------------- | -------... - [什么是输出插件](https://cnops.com.cn/projects/loongcollector/docs/lc--flushers) | [Markdown](https://cnops.com.cn/api/md/projects/loongcollector/lc--flushers): 输出插件（Flusher）位于采集配置末端，负责将聚合后的 Event / EventGroup 写出到下游：日志服务、消息队列、时序库、搜索与分析引擎、本地文件或标准输出等。每个采集配置必须至少配置 一个 Flusher；也可配置 多个 Flusher，实现一条数据多路投递。 LoongCollector 提供两类输出插件： -... - [插件系统](https://cnops.com.cn/projects/loongcollector/docs/lc--plugin-system) | [Markdown](https://cnops.com.cn/api/md/projects/loongcollector/lc--plugin-system): > 与当前仓库的关系：下文中的 libPluginAdaptor、libPluginBase，以及 Input / Processor / Aggregator / Flusher 分层，与今日 LoongCollector 主线一致；插件系统随主版本演进，是采集 Agent 的核心组成部分。 > 版本与名称：3.x 及之后的开源采集组件与主进程统称... - [ClickHouse](https://cnops.com.cn/projects/loongcollector/docs/lc--flusher-clickhouse) | [Markdown](https://cnops.com.cn/api/md/projects/loongcollector/lc--flusher-clickhouse): flusherclickhouse flusher插件可以实现将采集到的数据，经过处理后，发送到 ClickHouse，需要 ClickHouse 版本至少为 22.3。 Alpha 推荐版本：iLogtail v1.4.0 及以上 | 参数 | 类型 | 是否必选 | 说明 ... - [容器标准输出](https://cnops.com.cn/projects/loongcollector/docs/lc--input-container-stdio) | [Markdown](https://cnops.com.cn/api/md/projects/loongcollector/lc--input-container-stdio): inputcontainerstdio input插件可以实现从容器标准输出/标准错误流中采集日志，采集的日志内容将会保存在content字段中。支持通过容器元信息筛选待采集容器，并支持多行文本切分、添加容器Meta信息等数据处理操作。 Stable 推荐版本：LoongCollector v3.0.5 及以上 | 参数 | 类型 | 是否必填 | 默认值 | 说明 | |... - [什么是扩展插件](https://cnops.com.cn/projects/loongcollector/docs/lc--extensions) | [Markdown](https://cnops.com.cn/api/md/projects/loongcollector/lc--extensions): 扩展插件用于对其它插件能力的补充（e.g. 鉴权、编解码、熔断、限流……） - [概览](https://cnops.com.cn/projects/loongcollector/docs/lc--overview) | [Markdown](https://cnops.com.cn/api/md/projects/loongcollector/lc--overview): 下文各表按插件 Type（反引号内英文名）字典序 升序排列。 | 名称 | 提供方 | 简介 | |... - [什么是LoongCollector](https://cnops.com.cn/projects/loongcollector/docs/lc--readme) | [Markdown](https://cnops.com.cn/api/md/projects/loongcollector/lc--readme): LoongCollector 是一款集卓越性能、超强稳定性和灵活可编程性于一身的数据采集器，专为构建下一代可观测 Pipeline 设计。源自阿里云可观测团队所开源的 iLogtail 项目，在继承了 iLogtail 强大的日志采集与处理能力的基础上，进行了全面的功能升级与扩展。从原来单一日志场景，逐步扩展为可观测数据采集、本地计算、服务发现的统一体。... - [检查代码规范](https://cnops.com.cn/projects/loongcollector/docs/lc--check-codestyle) | [Markdown](https://cnops.com.cn/api/md/projects/loongcollector/lc--check-codestyle): LoongCollector 的 Go 插件（plugins/）使用 golangci-lint 检查代码风格。SCOPE 定义是 可选，默认范围是根目录。 xxx为限定的目录名称。 - [单元测试](https://cnops.com.cn/projects/loongcollector/docs/lc--unit-test) | [Markdown](https://cnops.com.cn/api/md/projects/loongcollector/lc--unit-test): C++部分单测基于 gtest 实现，具体编写方法可以参考已有测试用例。 在开发镜像中，内置了C++单测覆盖率统计工具 gcovr，可以通过以下命令在本地查看覆盖率。 1. 进入开发容器中，参考开发环境。 2. CMake 设置参数 BUILDLOGTAILUT=ON，编译单测 3. 运行脚本 ./scripts/runcoreut.sh，运行单测 4. 生成覆盖率报告... - [什么是聚合插件](https://cnops.com.cn/projects/loongcollector/docs/lc--aggregators) | [Markdown](https://cnops.com.cn/api/md/projects/loongcollector/lc--aggregators): 聚合插件用于将事件进行打包，从而提升发送效率。仅限以下场景使用： 使用了SLS输出插件以外的其他输出插件。 使用了SLS输出插件，且同时使用了扩展处理插件 对于上述场景，如果用户的采集配置中未指定聚合插件，则LoongCollector会使用默认聚合插件，即上下文聚合插件。 - [下载](https://cnops.com.cn/projects/loongcollector/docs/lc--download) | [Markdown](https://cnops.com.cn/api/md/projects/loongcollector/lc--download): 生产环境推荐直接使用 GitHub Releases 上当前最新 stable 发行版附带的预编译包（tag、loongcollector-.-.tar.gz 及 .sha256 均以发布页为准）。 国内用户也可以从阿里云 OSS 下载，满足如下模式（具体是否沿用、路径是否与 Release 正文一致，以每条 Release 的说明为准）：... - [本地文件](https://cnops.com.cn/projects/loongcollector/docs/lc--flusher-file) | [Markdown](https://cnops.com.cn/api/md/projects/loongcollector/lc--flusher-file): flusherfile flusher插件将采集到的数据写入本地文件中。flusher\file插件使用spdlog库实现，所以写入的文件具有部分日志文件的特征，例如存在大小限制、会自动轮转。 Alpha 推荐版本：LoongCollector v3.0.5 及以上 | 参数 | 类型 | 是否必填 | 默认值 | 说明 | | --- | --- | --- | ---... - [基础聚合](https://cnops.com.cn/projects/loongcollector/docs/lc--aggregator-base) | [Markdown](https://cnops.com.cn/api/md/projects/loongcollector/lc--aggregator-base): aggregatorbase aggregator 插件可以实现对单条数据的聚合。 Stable 推荐版本：iLogtail v1.0.27 及以上 | 参数 | 类型 | 是否必选 | 说明 | | --- | --- | --- | --- | | Type | string | 是 | 插件类型，指定为aggregatorbase。 | | MaxLogGroupCount | int... - [Docker使用](https://cnops.com.cn/projects/loongcollector/docs/lc--start-with-container) | [Markdown](https://cnops.com.cn/api/md/projects/loongcollector/lc--start-with-container): 已安装docker 1. 准备 LoongCollector 配置目录 新建配置目录config目录，在目录中创建filesimple.yaml和stdoutsimple.yaml。 在filesimple.yaml中配置采集容器中的simple.log到标准输出。 ... - [iLogtail 发布记录(2.x版本)](https://cnops.com.cn/projects/loongcollector/docs/lc--release-notes-ilogtail-2x) | [Markdown](https://cnops.com.cn/api/md/projects/loongcollector/lc--release-notes-ilogtail-2x): 发版日期：2024 年 1 月 12 日 iLogtail 2.0是一个架构全新升级的版本，与1.x版本的采集配置不是完全兼容的，升级指南请参考变更说明#1294 2.0版本的配置方式完美支持了C++原生插件之间的级联和C++原生插件和Go插件之间的级联，同时引入了更加高效的数据处理语言SLS Processing Language (SPL)，端上数据处理更加游刃有余。 新功能 ... - [版本管理](https://cnops.com.cn/projects/loongcollector/docs/lc--stability-level) | [Markdown](https://cnops.com.cn/api/md/projects/loongcollector/lc--stability-level): 由于不同的 LoongCollector 插件往往处于不同的开发进度，为了更好地区分这些插件的状态及可用性，我们将所有插件的状态分为 4 个阶段：Alpha、Beta、Stable 和 Deprecated，用户可以在各个插件的说明页上看到该插件的状态，从而方便用户更好地进行方案选择。... - [系统参数](https://cnops.com.cn/projects/loongcollector/docs/lc--system-config) | [Markdown](https://cnops.com.cn/api/md/projects/loongcollector/lc--system-config): LoongCollector 启动时会加载实例级系统参数配置文件，用于进程资源、credential、热加载间隔等行为。发行版默认路径为 conf/instanceconfig/local/loongcollectorconfig.json。目录布局参考文档：目录结构说明。 为兼容历史环境，仍可通过环境变量指定该文件路径：LOONGCONFIG 或... - [文本日志](https://cnops.com.cn/projects/loongcollector/docs/lc--input-file) | [Markdown](https://cnops.com.cn/api/md/projects/loongcollector/lc--input-file): inputfile插件可以实现从文本文件中采集日志。采集的日志内容将会保存在事件的content字段中。 Stable 推荐版本：iLogtail v1.0.27 及以上 | 参数 | 类型 | 是否必填 | 默认值 | 说明 | | --- | --- | --- | --- | --- | | Type | string | 是 | / | ... - [LoongCollector社区版开发使用经验](https://cnops.com.cn/projects/loongcollector/docs/lc--awesome-loongcollector-getting-started) | [Markdown](https://cnops.com.cn/api/md/projects/loongcollector/lc--awesome-loongcollector-getting-started): 2022-10 如何将业务日志采集到Kafka 2022-09 iLogtail日志处理实战 2022-09 iLogtail配置文件热加载 2022-08 使用DaemonSet模式采集K8s容器日志 2022-07 主机环境采集业务日志到SLS 2022-07 K8s环境采集业务日志到SLS 2022-08 采集MySQL Binlog 2025-02 200%性能提升:... - [通信协议](https://cnops.com.cn/projects/loongcollector/docs/lc--communication-protocol) | [Markdown](https://cnops.com.cn/api/md/projects/loongcollector/lc--communication-protocol): 由 LoongCollector 社区联合哔哩哔哩共同建设。服从HTTP/HTTPS协议。 ip 和 port 为 ConfigServer 的 ip 和接收端口，默认为127.0.0.1和8899。 数据的发送及接收均为 protocol buffer 格式，参见源代码中的 configserver/protocol 文件夹（v1.0）。 在调用API接口过程中，若返回HTTP状态码为... - [iLogtail 数据吞吐性能优化](https://cnops.com.cn/projects/loongcollector/docs/lc--summer-ospp-2024-projects-ilogtail-io) | [Markdown](https://cnops.com.cn/api/md/projects/loongcollector/lc--summer-ospp-2024-projects-ilogtail-io): iLogtail... - [检查文件许可证](https://cnops.com.cn/projects/loongcollector/docs/lc--check-license) | [Markdown](https://cnops.com.cn/api/md/projects/loongcollector/lc--check-license): LoongCollector 仓库遵循标准的 Apache 2.0 许可，所有文件必须具有许可证声明。贡献者应检查所提交文件是否包含相应许可证头。 如果要检查整个项目文件，请运行以下命令。 没有许可证的文件将被找到并保存为 licensecoverage.txt。 当需要固定范围时，请在命令中附加SCOPE。 xxx为限定的目录名称。... - [开发者](https://cnops.com.cn/projects/loongcollector/docs/lc--developer) | [Markdown](https://cnops.com.cn/api/md/projects/loongcollector/lc--developer): > 名单与角色请以仓库实时状态为准：下列 PMC / Committer 为文档手工列举，可能滞后于 alibaba/loongcollector 上实际治理安排或 RELEASE 说明中的贡献者信息；若有出入，以社区公开规则及仓库内最新文档为准。全体贡献者汇总见 Contributors 图谱。 LoongCollector（延续自 iLogtail 开源社区）包含... - [插件文档规范](https://cnops.com.cn/projects/loongcollector/docs/lc--plugin-doc-templete) | [Markdown](https://cnops.com.cn/api/md/projects/loongcollector/lc--plugin-doc-templete): 这是一份 LoongCollector 插件的中文文档的模版及格式说明。 文档以插件英文名命名文件，改为-，例如metricmock插件的文档名为metric-mock.md，保存在docs/cn/plugins/input/extended/metric-mock.md的相应文件夹下。 标题为插件的中文名。 简介处需要写上插件的英文名并附上介绍。简介的最后需要附上源代码链接。 -... - [【Debug】文本日志](https://cnops.com.cn/projects/loongcollector/docs/lc--metric-debug-file) | [Markdown](https://cnops.com.cn/api/md/projects/loongcollector/lc--metric-debug-file): metricdebugfile 插件是一个用于调试的插件，它可以逐行读取指定文件的内容，并将其与指定的名称绑定在一起成为一个字段，用于模拟文件输入。源代码 Stable 推荐版本：iLogtail v1.0.27 及以上 | 参数 | 类型 | 是否必选 | 说明 ... - [Golang 自监控指标接口](https://cnops.com.cn/projects/loongcollector/docs/lc--plugin-self-monitor-guide) | [Markdown](https://cnops.com.cn/api/md/projects/loongcollector/lc--plugin-self-monitor-guide): LoongCollector 提供了指标接口，可以方便地为插件增加一些自监控指标，目前支持Counter，Gauge，String，Latency等类型。 接口： 实现：... - [E2E测试](https://cnops.com.cn/projects/loongcollector/docs/lc--e2e-test) | [Markdown](https://cnops.com.cn/api/md/projects/loongcollector/lc--e2e-test): LoongCollector 提供了一个完整的E2E测试引擎，方便您快速开展集成测试，从而进一步保证代码质量。在大部分情况下，您只需要编写一个配置文件来定义测试行为，即可轻松完成测试。 E2E测试采用行为驱动开发（Behavior-Driven... - [如何开发原生Flusher插件](https://cnops.com.cn/projects/loongcollector/docs/lc--how-to-write-native-flusher-plugins) | [Markdown](https://cnops.com.cn/api/md/projects/loongcollector/lc--how-to-write-native-flusher-plugins): 基类见 core/collectionpipeline/plugin/interface/Flusher.h： 注意：Send / Flush / FlushAll 的返回值为 bool（与旧文档中的 void 不同）。 基于 HTTP 发送时可派生 HttpFlusher： 作用：将多个较小的 PipelineEventGroup 按 tag 等规则合并，提高发送效率。 ... - [如何收集自监控指标](https://cnops.com.cn/projects/loongcollector/docs/lc--how-to-collect-internal-metrics) | [Markdown](https://cnops.com.cn/api/md/projects/loongcollector/lc--how-to-collect-internal-metrics): LoongCollector 目前提供用于暴露自监控指标的 Input 插件；在一个采集配置（collection pipeline）中加入该插件即可采集自监控数据。 1. 选择输入插件自监控指标数据。这里需要注意一点，就是inputinternalmetrics插件输出的数据格式是 C++ 的多值 MetricEvent... - [编译](https://cnops.com.cn/projects/loongcollector/docs/lc--build) | [Markdown](https://cnops.com.cn/api/md/projects/loongcollector/lc--build): 下载源代码 安装docker Makefile描述了整个项目的所有编译目标，主要的包括： | 目标 | 描述 | | --- | --- | | core | 仅编译C++核心 | | plugin | 仅编译Go插件 | | all | 编译完整 LoongCollector | | dist | 打包发行 | | docker | 制作 LoongCollector 镜像 | |... - [过滤](https://cnops.com.cn/projects/loongcollector/docs/lc--processor-filter-regex-native) | [Markdown](https://cnops.com.cn/api/md/projects/loongcollector/lc--processor-filter-regex-native): processorfilterregexnative插件根据事件字段内容来过滤事件。 Stable 推荐版本：iLogtail v2.0.4 及以上 | 参数 | 类型 | 是否必填 | 默认值 | 说明 | | --- | --- | --- | --- | --- | | Type | string | 是 | / | ... - [单条协议](https://cnops.com.cn/projects/loongcollector/docs/lc--custom-single) | [Markdown](https://cnops.com.cn/api/md/projects/loongcollector/lc--custom-single): 单条协议在内存中对应的数据结构为map[string]interface{}，其中的键及相应值的类型为： - time：uint32类型 - contents：map[string]string类型 - tags：map[string]string类型 - [协议转换](https://cnops.com.cn/projects/loongcollector/docs/lc--converter) | [Markdown](https://cnops.com.cn/api/md/projects/loongcollector/lc--converter): 在开发Flusher插件时，用户往往需要将日志数据从sls协议转换成其他协议。在扩展Metric数据模型后，v2版本的Flusher插件还需要支持从PipelineGroupEvents数据转换成其他协议的场景。为了加快开发插件流程，LoongCollector 提供了通用协议转换模块，用户只需要指定目标协议的名称和编码方式即可获得编码后的字节流。... - [如何开发扩展Processor插件](https://cnops.com.cn/projects/loongcollector/docs/lc--how-to-write-processor-plugins) | [Markdown](https://cnops.com.cn/api/md/projects/loongcollector/lc--how-to-write-processor-plugins): Processor 对采集配置（collection pipeline）内的数据做加工。接口定义见 pkg/pipeline/processor.go：在公共的 Processor 之上，分为 ProcessorV1 与 ProcessorV2，新插件建议优先实现 V2。 输入输出均为 []protocol.Log，多个 Processor 实例在链路上 串行 调用 ProcessLogs。... - [发展历史](https://cnops.com.cn/projects/loongcollector/docs/lc--brief-history) | [Markdown](https://cnops.com.cn/api/md/projects/loongcollector/lc--brief-history): LoongCollector 原名 iLogtail ，从 2013 年开始研发，于 2024 年 iLogtail 开源项目两周年庆典之际，品牌正式升级为 LoongCollector。 秉承着阿里人简单的特点， iLogtail... - [BasicAuth鉴权](https://cnops.com.cn/projects/loongcollector/docs/lc--ext-basicauth) | [Markdown](https://cnops.com.cn/api/md/projects/loongcollector/lc--ext-basicauth): extbasicauth 扩展插件，实现了 extensions.ClientAuthenticator 接口，可以在 httpflusher 插件中引用，提供向请求中添加 basic auth Header 的能力。 Alpha 推荐版本：iLogtail v1.5.0 及以上 | 参数 | 类型 | 是否必选 | 说明 |... - [代码风格](https://cnops.com.cn/projects/loongcollector/docs/lc--codestyle) | [Markdown](https://cnops.com.cn/api/md/projects/loongcollector/lc--codestyle): LoongCollector C++遵循基于Google代码规范的风格，详细格式约束见.clang-format。 Go遵循Effective Go风格。 Markdown遵循基于 markdownlint 的风格，并为了兼容 GitBook 排除 MD033。 使用VSCode的Clang-Format (by xaver)插件。 或使用命令行进行格式化 使用VSCode的Go (by Go... - [追加字段](https://cnops.com.cn/projects/loongcollector/docs/lc--processor-appender) | [Markdown](https://cnops.com.cn/api/md/projects/loongcollector/lc--processor-appender): processorappender插件可为指定字段（可以不存在）追加特定的值，且支持模板参数。 Stable 推荐版本：iLogtail v1.0.27 及以上 插件类型（type）为 processorappender。 | 参数 | 类型 | 是否必选 | 参数说明 ... - [Apache Doris](https://cnops.com.cn/projects/loongcollector/docs/lc--flusher-doris) | [Markdown](https://cnops.com.cn/api/md/projects/loongcollector/lc--flusher-doris): flusherdoris flusher插件可以实现将采集到的数据，经过处理后，通过 Stream Load API 发送到 Apache Doris。该插件支持并发刷新、Group Commit、进度监控等特性，适用于高吞吐量数据写入场景。 源代码：flusherdoris.go Alpha 推荐版本：LoongCollector v3.2.6 及以上 Apache Doris：v2.0... - [如何添加自监控指标](https://cnops.com.cn/projects/loongcollector/docs/lc--how-to-add-internal-metrics) | [Markdown](https://cnops.com.cn/api/md/projects/loongcollector/lc--how-to-add-internal-metrics): 本文说明如何在 C++ Core 或 Golang 插件中新增自监控指标，以及如何与 inputinternalmetrics 等采集路径衔接。 - 写入侧：WriteMetrics（core/monitor/MetricManager.h）维护一条 MetricsRecord 链表；每条记录包含 category、labels、以及若干 Counter / TimeCounter /... - [Kubernetes使用](https://cnops.com.cn/projects/loongcollector/docs/lc--start-with-k8s) | [Markdown](https://cnops.com.cn/api/md/projects/loongcollector/lc--start-with-k8s): 已部署Kubernetes集群或minikube 具备访问Kubernetes集群的kubectl DaemonSet 中的镜像 tag 请与 GitHub — alibaba/loongcollector Releases 当前版本一致（Release 正文会列出 ghcr.io/alibaba/loongcollector: 与 阿里云镜像... - [iLogtail 发布记录(1.x版本)](https://cnops.com.cn/projects/loongcollector/docs/lc--release-notes-ilogtail-1x) | [Markdown](https://cnops.com.cn/api/md/projects/loongcollector/lc--release-notes-ilogtail-1x): 发版日期：2024 年 1 月 2 日 优化 goprofile插件上报数据中使用机器的IP地址 #1281 问题修复 修复正则配置timekey没有默认设置为time的兼容性问题 #1272 修复使用libcurl因没有设置CURLOPTNOSIGNAL导致偶尔崩溃的问题 #1286 修复原生分隔符解析插件解析行首有空格的日志时字段错乱的问题 #1288 ... - [产品优势](https://cnops.com.cn/projects/loongcollector/docs/lc--benefits) | [Markdown](https://cnops.com.cn/api/md/projects/loongcollector/lc--benefits): 在可观测领域，Fluent Bit、OpenTelemetry Collector 及 Vector 都是备受推崇的可观测数据采集器。其中，FluentBit 小巧精悍，以性能著称；OpenTelemetry Collector 背靠 CNCF，借助 Opentelemetry 概念构建了丰富的生态体系；而 Vector 在 Datadog 加持下，则通过 Observability... - [Docker镜像](https://cnops.com.cn/projects/loongcollector/docs/lc--docker-image) | [Markdown](https://cnops.com.cn/api/md/projects/loongcollector/lc--docker-image): 下载源代码 安装docker 制作镜像分为2步： 1. 代码库根目录准备 loongcollector-\.\.tar.gz 若使用已发布版本，可以从LoongCollector 发布记录下载压缩包。 若要使用本地最新代码构建，则执行如下命令make dist。 2. 将 LoongCollector 发行版的tar包安装到base镜像中。 ... - [日志](https://cnops.com.cn/projects/loongcollector/docs/lc--logging) | [Markdown](https://cnops.com.cn/api/md/projects/loongcollector/lc--logging): LoongCollector 由 C++ 主进程与 Go 扩展插件等组成，运行日志分为 C++ 主进程日志（spdlog，配置为 apsaralogconf.json）与 插件 / Go 侧日志（seelog，配置为 pluginlogger.xml）。 路径约定：下文 {conf} 表示配置根目录（为 $LOONGCOLLECTORROOT/conf），{log}... - [eBPF文件安全数据](https://cnops.com.cn/projects/loongcollector/docs/lc--input-file-security) | [Markdown](https://cnops.com.cn/api/md/projects/loongcollector/lc--input-file-security): inputfilesecurity插件可以实现利用ebpf探针采集文件安全相关动作。 Beta 推荐版本：LoongCollector v3.1.6 及以上 | 参数 | 类型 | 是否必填 | 默认值 | 说明 | | --- | --- | --- | --- | --- | | Type | string | 是 | / | ... - [【示例】MetricInput](https://cnops.com.cn/projects/loongcollector/docs/lc--metric-input-example) | [Markdown](https://cnops.com.cn/api/md/projects/loongcollector/lc--metric-input-example): metricinputexample 可作为编写MetricInput类插件的参考示例样例，该插件会定时生成模拟的指标数据。源代码 Stable 推荐版本：iLogtail v1.0.27 及以上 | 参数 | 类型，默认值 | 说明 | | - | - | - | | Type | string，无默认值（必填） | 插件类型，固定为metricinputexample。 | 采集配置 ... - [Apsara 解析](https://cnops.com.cn/projects/loongcollector/docs/lc--processor-parse-apsara-native) | [Markdown](https://cnops.com.cn/api/md/projects/loongcollector/lc--processor-parse-apsara-native): processorparseapsaranative 插件解析飞天格式日志行，提取时间并拆解基础字段（如 level、thread、file、line），并将剩余 key:value 形式字段写入事件。 源代码：ProcessorParseApsaraNative.cpp Stable 推荐版本：LoongCollector v3.1.4 及以上 | 参数 | 类型 | 是否必填 ... - [添加云资产信息](https://cnops.com.cn/projects/loongcollector/docs/lc--processor-cloudmeta) | [Markdown](https://cnops.com.cn/api/md/projects/loongcollector/lc--processor-cloudmeta): processorcloudmeta插件可以添加为日志增加云平台元数据信息。 Alpha 推荐版本：iLogtail v1.4.0 及以上 | 参数 | 类型 | 是否必选 | 说明 ... - [按Key分组](https://cnops.com.cn/projects/loongcollector/docs/lc--aggregator-content-value-group) | [Markdown](https://cnops.com.cn/api/md/projects/loongcollector/lc--aggregator-content-value-group): aggregatorcontentvaluegroup aggregator 插件可以实现对单条数据按指定的 Key 进行聚合。 Alpha 推荐版本：iLogtail v1.4.0 及以上 | 参数 | 类型 | 是否必选 | 说明 ... - [Kafka（C++）](https://cnops.com.cn/projects/loongcollector/docs/lc--flusher-kafka) | [Markdown](https://cnops.com.cn/api/md/projects/loongcollector/lc--flusher-kafka): flusherkafkanative 将事件序列化为 JSON 文本后异步投递到 Kafka，底层基于 librdkafka。 源代码：FlusherKafka.cpp Alpha 推荐版本：LoongCollector v3.2.6 及以上 | 参数 | 类型 | 是否必选 | 默认值 | 说明 | | :--- | :--- | :--- | :--- | :--- | | Type |... - [ElasticSearch](https://cnops.com.cn/projects/loongcollector/docs/lc--flusher-elasticsearch) | [Markdown](https://cnops.com.cn/api/md/projects/loongcollector/lc--flusher-elasticsearch): flusherelasticsearch flusher插件可以实现将采集到的数据，经过处理后，发送到 ElasticSearch，需要 ElasticSearch 版本至少为 8。 Alpha 推荐版本：iLogtail v2.0.0 及以上 | 参数 | 类型 | 是否必选 | 说明 ... - [协议解码/反序列化](https://cnops.com.cn/projects/loongcollector/docs/lc--ext-default-decoder) | [Markdown](https://cnops.com.cn/api/md/projects/loongcollector/lc--ext-default-decoder): extdefaultdecoder 扩展，实现了 Decoder 接口，可以用在 servicehttpserver、udpserver 等插件中用于解析不同的协议数据。 Alpha 推荐版本：iLogtail v1.5.0 及以上 | 参数 | 类型 | 是否必选 | 说明 ... - [数据模型（C++）](https://cnops.com.cn/projects/loongcollector/docs/lc--data-model-cpp) | [Markdown](https://cnops.com.cn/api/md/projects/loongcollector/lc--data-model-cpp): LoongCollector C++ Core 在 collection pipeline（采集配置）执行路径中使用以 PipelineEventGroup 为容器、PipelineEvent 为单条数据抽象的可观测事件模型，涵盖日志、指标、链路 Span 与原始字节等类型。概念上与 数据模型（Golang） 中的 Pipeline Event 体系一致；本节侧重 C++... - [增加新的日志协议](https://cnops.com.cn/projects/loongcollector/docs/lc--how-to-add-new-protocol) | [Markdown](https://cnops.com.cn/api/md/projects/loongcollector/lc--how-to-add-new-protocol): 如果 LoongCollector 暂时不支持您所需的日志协议，您可以为 LoongCollector 增加该协议并添加相应的协议转换函数，具体步骤如下： 1.... - [raw协议](https://cnops.com.cn/projects/loongcollector/docs/lc--raw) | [Markdown](https://cnops.com.cn/api/md/projects/loongcollector/lc--raw): raw协议在内存中对应的数据结构定义如下： 传输数据的原始字节流，是PipelineEvent的一种实现。 传输数据的标签及元数据信息，简单的key/value对。 传输数据整体。 - [如何开发扩展Aggregator插件](https://cnops.com.cn/projects/loongcollector/docs/lc--how-to-write-aggregator-plugins) | [Markdown](https://cnops.com.cn/api/md/projects/loongcollector/lc--how-to-write-aggregator-plugins): Aggregator 将多条事件聚合成 LogGroup / PipelineGroupEvents 再交给 Flusher。定义见 pkg/pipeline/aggregator.go。 Init(Context, LogGroupQueue) (int, error)：第一个返回值为 Flush 调用周期（毫秒）；为 0 时用全局默认。第二个返回值表示初始化错误。LogGroupQueue... - [纯插件模式启动](https://cnops.com.cn/projects/loongcollector/docs/lc--pure-plugin-start) | [Markdown](https://cnops.com.cn/api/md/projects/loongcollector/lc--pure-plugin-start): 纯插件模式为 LoongCollector 插件开发提供轻量级测试能力，以下我们将介绍如以纯插件模式启动 LoongCollector。 在根目录下执行 make pluginmain 命令，会得到 output/loongcollector 可执行文件，使用以下命令可以快速启动 LoongCollector 程序，并将日志使用控制台输出。 LoongCollector... - [E2E测试——如何添加新的测试行为](https://cnops.com.cn/projects/loongcollector/docs/lc--e2e-test-step) | [Markdown](https://cnops.com.cn/api/md/projects/loongcollector/lc--e2e-test-step): LoongCollector 提供了一个完整的E2E测试引擎，方便您快速开展集成测试，从而进一步保证代码质量。在大部分情况下，您只需要编写一个配置文件来定义测试行为，即可轻松完成测试。 可以参考 test/engine/steps.go 中的定义，目前支持的测试行为如下： | 行为类型 | 模板 | 参数 | 说明 | | --- | --- | --- | --- | | Given |... - [检查依赖包许可证](https://cnops.com.cn/projects/loongcollector/docs/lc--check-dependency-license) | [Markdown](https://cnops.com.cn/api/md/projects/loongcollector/lc--check-dependency-license): LoongCollector 基于Apache 2.0 协议进行开源，开发者需要保证依赖包协议与Apache 2.0 协议兼容，所有依赖包或源码引入License 说明位于根目录 licenses 文件夹。 开发者可以使用以下命令进行依赖包License 扫描。 - 当提示 DEPENDENCIES CHECKING IS PASSED 时，说明依赖包检查通过。 - 当提示 FOLLOWING... - [成就](https://cnops.com.cn/projects/loongcollector/docs/lc--achievement) | [Markdown](https://cnops.com.cn/api/md/projects/loongcollector/lc--achievement): 成功提交1次任意 PR，并被社区接受。 --- - Cheng Zhang(@shabicheng) - Goclis Yao(@Goclis) - Qian Sheng(@qiansheng91) - Yonghua Sun(@yonghua-sun) - Weilong Pan(@panawala) - Haorui(@haoruilee) - Chao Lee(@chaolee50) -... - [ConfigServer 能力升级 + 体验优化（全栈）](https://cnops.com.cn/projects/loongcollector/docs/lc--summer-ospp-2024-projects-config-server) | [Markdown](https://cnops.com.cn/api/md/projects/loongcollector/lc--summer-ospp-2024-projects-config-server): iLogtail... - [编译依赖](https://cnops.com.cn/projects/loongcollector/docs/lc--dependencies) | [Markdown](https://cnops.com.cn/api/md/projects/loongcollector/lc--dependencies): | 序号 | 名称 (版本) | 用于…… | | ------ |... - [转发输入插件](https://cnops.com.cn/projects/loongcollector/docs/lc--input-forward) | [Markdown](https://cnops.com.cn/api/md/projects/loongcollector/lc--input-forward): inputforward 插件用于接收来自其他系统的数据转发请求，目前支持LoongSuite协议。该插件可以作为数据转发的接收端，通过配置的匹配规则来处理接收到的数据。源代码 Stable 推荐版本：LoongCollector v2.0.0 及以上 | 参数 | 类型，默认值 | 说明 | | - | - | - | | Type | String，无默认值（必填） |... - [守护进程](https://cnops.com.cn/projects/loongcollector/docs/lc--daemon) | [Markdown](https://cnops.com.cn/api/md/projects/loongcollector/lc--daemon): 当 LoongCollector 因为各种原因异常退出，需要有一个守护来保证 LoongCollector 进程的可用性。 参考快速开始，下载并安装 LoongCollector： 快速开始 1. 执行生成systemd文件 其中ExecStart中路径根据 LoongCollector 安装路径自行修改。 2. 注册服务 3. 启动服务 4. 查看服务状态... - [E2E测试——如何编写Subscriber插件](https://cnops.com.cn/projects/loongcollector/docs/lc--how-to-add-subscriber) | [Markdown](https://cnops.com.cn/api/md/projects/loongcollector/lc--how-to-add-subscriber): 订阅器（Subscribe）插件是测试引擎中用于接收数据的组件，在接收到数据后，订阅器会进一步将数据发送至验证器（Validator）进行校验。如果您为 LoongCollector 开发了新的输出插件，则您必须为该输出插件编写一个对应的订阅器，用于从您输出插件对应的存储单元中拉取 LoongCollector 写入的数据，并在集成测试中使用该订阅器。 - Name()：返回订阅器的名字； -... - [主机Meta数据](https://cnops.com.cn/projects/loongcollector/docs/lc--metric-meta-host) | [Markdown](https://cnops.com.cn/api/md/projects/loongcollector/lc--metric-meta-host): metricmetahost input插件用于采集主机的Meta信息（例如CPU型号、内存大小、进程等）。 Stable 推荐版本：iLogtail v1.1.0 及以上 | 参数 | 类型 | 是否必选 | 说明 ... - [分隔符解析](https://cnops.com.cn/projects/loongcollector/docs/lc--processor-parse-delimiter-native) | [Markdown](https://cnops.com.cn/api/md/projects/loongcollector/lc--processor-parse-delimiter-native): processorparsedelimiternative插件解析事件中分隔符格式字段内容并提取新字段。 Stable 推荐版本：LoongCollector v3.0.5 及以上 | 参数 | 类型 | 是否必填 | 默认值 | 说明 | | --- | --- | --- | --- | --- | | Type | string | 是 | / | ... - [协议编码/序列化](https://cnops.com.cn/projects/loongcollector/docs/lc--ext-default-encoder) | [Markdown](https://cnops.com.cn/api/md/projects/loongcollector/lc--ext-default-encoder): extdefaultencoder 扩展，实现了 Encoder 接口，可以用在 flusherhttp 等插件中用于序列化不同的协议数据。 Alpha 推荐版本：LoongCollector v3.0.5 及以上 | 参数 | 类型 | 是否必选 | 说明 ... - [如何开发扩展Flusher插件](https://cnops.com.cn/projects/loongcollector/docs/lc--how-to-write-flusher-plugins) | [Markdown](https://cnops.com.cn/api/md/projects/loongcollector/lc--how-to-write-flusher-plugins): Flusher 插件与外部系统进行交互，将数据发送到外部，以下将从接口定义与案例2方面指导如何开发 Flusher 插件 - Init: 插件初始化接口，对于Flusher 主要作用是创建外部资源链接 - Description： 插件描述 - IsReady：插件系统在调用 Flush / Export 前会调用该接口检查当前 flusher 是否仍能够处理更多数据；若返回否，会等待后重试。... - [按上下文分组](https://cnops.com.cn/projects/loongcollector/docs/lc--aggregator-context) | [Markdown](https://cnops.com.cn/api/md/projects/loongcollector/lc--aggregator-context): aggregatorcontext aggregator 插件可以根据数据来源对单条数据进行聚合。 Beta 推荐版本：iLogtail v1.2.0 及以上 | 参数 | 类型 | 是否必选 | 说明 | | --- | --- | --- | --- | | Type | string | 是 | 插件类型，指定为aggregatorcontext。 | |... - [SLS](https://cnops.com.cn/projects/loongcollector/docs/lc--flusher-sls) | [Markdown](https://cnops.com.cn/api/md/projects/loongcollector/lc--flusher-sls): flushersls flusher插件将采集到的事件发送至SLS。 使用本插件时，必须在启动参数中配置AK和SK。 Stable 推荐版本：iLogtail v1.0.27 及以上 | 参数 | 类型 | 是否必填 | 默认值 | 说明 | | --- | --- | --- | --- | --- | | Type | string | 是 | / | ... - [HTTP](https://cnops.com.cn/projects/loongcollector/docs/lc--flusher-http) | [Markdown](https://cnops.com.cn/api/md/projects/loongcollector/lc--flusher-http): flusherhttp flusher插件可以实现将采集到的数据，经过处理后，通过http格式发送到指定的地址。 Alpha 推荐版本：iLogtail v1.4.0 及以上 | 参数 | 类型 | 是否必选 | 说明 ... - [数据模型（Golang）](https://cnops.com.cn/projects/loongcollector/docs/lc--data-model-golang) | [Markdown](https://cnops.com.cn/api/md/projects/loongcollector/lc--data-model-golang): LoongCollector Golang 部分目前支持 SLS Log Protocol 和 Pipeline Event 两种数据模型，两种模型的描述和对比如下： | | SLS Log Protocol | Pipeline Event | | ---- | ---- | ---- | | 描述 | SLS 日志的专用处理结构 |... - [原始数据](https://cnops.com.cn/projects/loongcollector/docs/lc--processor-default) | [Markdown](https://cnops.com.cn/api/md/projects/loongcollector/lc--processor-default): processordefault插件不对数据任何操作，只是简单的数据透传。源代码 | LogGroup(v1) | EventTypeLogging | EventTypeMetric | EventTypeSpan | | ------------ | ---------------- | --------------- | ------------- | | ✅ | ... - [开源协议](https://cnops.com.cn/projects/loongcollector/docs/lc--license) | [Markdown](https://cnops.com.cn/api/md/projects/loongcollector/lc--license): LoongCollector，包括内核、插件和工具均遵循Apache License v2.0分发： - [社区版和企业版的对比说明](https://cnops.com.cn/projects/loongcollector/docs/lc--compare-editions) | [Markdown](https://cnops.com.cn/api/md/projects/loongcollector/lc--compare-editions): | 分类 | 比较项 | 社区版 | 商业版 | | ------ | -------------------- | ---------------- |... - [数据筛选](https://cnops.com.cn/projects/loongcollector/docs/lc--ext-groupinfo-filter) | [Markdown](https://cnops.com.cn/api/md/projects/loongcollector/lc--ext-groupinfo-filter): extgroupinfofilter 扩展插件，实现了 extensions.FlushInterceptor 接口，可以在 httpflusher 插件中引用，提供在向远端最终提交前筛选数据的能力。 Alpha 推荐版本：iLogtail v1.5.0 及以上 | 参数 | 类型 | 是否必选 | 说明 ... - [数据脱敏](https://cnops.com.cn/projects/loongcollector/docs/lc--processor-desensitize) | [Markdown](https://cnops.com.cn/api/md/projects/loongcollector/lc--processor-desensitize): processordesensitize插件可以通过正则表达式匹配并实现文本日志中敏感数据的脱敏。源代码 Beta 推荐版本：iLogtail v1.6.0 及以上 | 参数 | 类型，默认值 | 说明 | | - | - | - | | Type | string，无默认值(必填) | 插件类型，固定为processordesensitize | |... - [多Flusher路由](https://cnops.com.cn/projects/loongcollector/docs/lc--router) | [Markdown](https://cnops.com.cn/api/md/projects/loongcollector/lc--router): 您可以选择根据pipeline event group的属性将group发送到不同的flusher。 仅限使用原生处理插件且所有flusher均支持发送路由能力的场景。 推荐版本：LoongCollector v3.0.5 及以上 | 参数 | 类型 | 是否必填 | 默认值 | 说明 | | --- | --- | --- | --- | --- | | Type |... - [【Debug】Mock数据-Metric](https://cnops.com.cn/projects/loongcollector/docs/lc--metric-mock) | [Markdown](https://cnops.com.cn/api/md/projects/loongcollector/lc--metric-mock): metricmock 插件是用于模拟采集Metric类型输入数据的插件，可以通过调整参数获取不同的模拟输入。源代码 Stable 推荐版本：iLogtail v1.0.27 及以上 | 参数 | 类型，默认值 | 说明 | | - | - | - | | Type | string，无默认值（必填） | 插件类型，固定为metricmock。 | | Tags |... - [按GroupMetadata分组](https://cnops.com.cn/projects/loongcollector/docs/lc--aggregator-metadata-group) | [Markdown](https://cnops.com.cn/api/md/projects/loongcollector/lc--aggregator-metadata-group): aggregatormetadatagroup aggregator插件可以实现对PipelineGroupEvents按照指定的 Metadata Key 进行重新聚合。仅支持v2版本。 Alpha 推荐版本：iLogtail v1.4.0 及以上 | 参数 | 类型 | 是否必选 | 说明 ... - [Json解析](https://cnops.com.cn/projects/loongcollector/docs/lc--processor-parse-json-native) | [Markdown](https://cnops.com.cn/api/md/projects/loongcollector/lc--processor-parse-json-native): processorparsejsonnative插件解析事件中Json格式字段内容并提取新字段。 Stable 推荐版本：LoongCollector v3.1.5 及以上, 在 CPU >= westmere 型号的情况下，json解析会使用 SIMD 指令进行计算加速，跟原来相比性能有一倍的提升。 | 参数 | 类型 | 是否必填 | 默认值 | 说明 | | ---... - [Benchmark测试](https://cnops.com.cn/projects/loongcollector/docs/lc--benchmark) | [Markdown](https://cnops.com.cn/api/md/projects/loongcollector/lc--benchmark): 与e2e测试工作原理相同，详情可见： - e2e-test.md 目前仅支持通过docker-compose搭建测试环境，在准备开始进行benchmark测试前，您首先需要准备以下内容： - 测试环境：Docker-Compose环境（需在本地安装docker-compose）... - [目录结构说明](https://cnops.com.cn/projects/loongcollector/docs/lc--loongcollector-dir) | [Markdown](https://cnops.com.cn/api/md/projects/loongcollector/lc--loongcollector-dir): 作为 2024 年产品规划的重要组成部分，iLogtail 产品将正式更名为 LoongCollector。此次更新主要包含以下变更： - 程序二进制文件由 iLogtail 更名为 LoongCollector - 全面优化目录结构和配置文件布局，提供更清晰的组织方式 LoongCollector 采用模块化的分层目录设计，以下展示了安装在 /opt/loongcollector... - [Kafka（Deprecated）](https://cnops.com.cn/projects/loongcollector/docs/lc--extended--flusher-kafka) | [Markdown](https://cnops.com.cn/api/md/projects/loongcollector/lc--extended--flusher-kafka): flusherkafka flusher插件可以实现将采集到的数据，经过处理后，发送到Kafka。 Deprecated，请使用flusherkafkav2 推荐版本：无 | 参数 | 类型 | 是否必选 | 说明 | |... - [主机元数据采集](https://cnops.com.cn/projects/loongcollector/docs/lc--input-host-meta) | [Markdown](https://cnops.com.cn/api/md/projects/loongcollector/lc--input-host-meta): inputhostmeta 定时采集主机元数据，包括主机、进程及其之间的关系。 Beta 推荐版本：LoongCollector v3.2.6 及以上 | 参数 | 类型，默认值 | 说明 | | - | - | - | | Type | string，无默认值（必填） | 插件类型，固定为inputhostmeta。 | | Interval | int, 60 | 采集间隔时间，单位为秒。... - [如何开发Extension插件](https://cnops.com.cn/projects/loongcollector/docs/lc--how-to-write-extension-plugins) | [Markdown](https://cnops.com.cn/api/md/projects/loongcollector/lc--how-to-write-extension-plugins): Extension 插件可以用来注册自定义的能力和接口实现，这些能力和接口实现，可以在其他插件(input、processor、aggregator、flusher)中引用。 Extension 插件用于以统一方式注册可选能力（多为某业务接口的实现）。在采集配置里放在 extensions 段后，同一采集配置内的其他插件（Input / Processor / Aggregator /... - [KafkaV2](https://cnops.com.cn/projects/loongcollector/docs/lc--flusher-kafka-v2) | [Markdown](https://cnops.com.cn/api/md/projects/loongcollector/lc--flusher-kafka-v2): flusherkafkav2 flusher插件可以实现将采集到的数据，经过处理后，发送到Kafka。 Beta 推荐版本：iLogtail v1.6.0 及以上 | 参数 | 类型 | 是否必选 | 说明 ... - [iLogtail 兼容模式使用指南](https://cnops.com.cn/projects/loongcollector/docs/lc--logtail-mode) | [Markdown](https://cnops.com.cn/api/md/projects/loongcollector/lc--logtail-mode): LoongCollector 提供了 Logtail 兼容模式，可以让您在升级到 LoongCollector 后继续使用原有的 Logtail 配置和数据，实现平滑迁移。本文将详细介绍如何配置和使用这个兼容模式。 > 在开始之前，请先了解 LoongCollector 的目录结构说明。 由于 LoongCollector 采用了新的目录结构和配置体系，与原有 Logtail... - [主机监控数据](https://cnops.com.cn/projects/loongcollector/docs/lc--input-host-monitor) | [Markdown](https://cnops.com.cn/api/md/projects/loongcollector/lc--input-host-monitor): inputhostmonitor 插件定期采集宿主机的 CPU、内存、磁盘、网络、系统负载、进程等监控指标。 源代码：InputHostMonitor.cpp Beta 推荐版本：LoongCollector v3.3.2 及以上 | 参数 | 类型 | 必填 | 默认值 | 说明 | | --- | --- | --- | --- | --- | | Type |... - [字段值映射处理](https://cnops.com.cn/projects/loongcollector/docs/lc--processor-dict-map) | [Markdown](https://cnops.com.cn/api/md/projects/loongcollector/lc--processor-dict-map): processordictmap插件可对指定字段的值查表映射 Stable 推荐版本：iLogtail v1.0.27 及以上 | 参数 | 类型 | 是否必选 | 参数说明 ... - [请求熔断](https://cnops.com.cn/projects/loongcollector/docs/lc--ext-request-breaker) | [Markdown](https://cnops.com.cn/api/md/projects/loongcollector/lc--ext-request-breaker): extrequestbreaker 扩展插件，实现了 extensions.RequestInterceptor 接口，课题在 httpflusher 插件中引用，提供请求熔断的能力。 Alpha 推荐版本：iLogtail v1.5.0 及以上 | 参数 | 类型 | 是否必选 | 说明 ... - [正则解析](https://cnops.com.cn/projects/loongcollector/docs/lc--processor-parse-regex-native) | [Markdown](https://cnops.com.cn/api/md/projects/loongcollector/lc--processor-parse-regex-native): processorparseregexnative插件通过正则匹配解析事件指定字段内容并提取新字段 Stable 推荐版本：iLogtail v2.0.0 及以上 | 参数 | 类型 | 是否必填 | 默认值 | 说明 | | --- | --- | --- | --- | --- | | Type | string | 是 | / | ... - [主机监控数据](https://cnops.com.cn/projects/loongcollector/docs/lc--metric-system) | [Markdown](https://cnops.com.cn/api/md/projects/loongcollector/lc--metric-system): metricsystemv2 input插件用于采集主机的监控数据（例如CPU、内存、负载、磁盘、网络等）。 Stable 推荐版本：iLogtail v1.6.0 及以上 | 参数 | 类型 | 是否必选 | 说明 ... - [如何开发外部私有插件](https://cnops.com.cn/projects/loongcollector/docs/lc--how-to-write-external-plugins) | [Markdown](https://cnops.com.cn/api/md/projects/loongcollector/lc--how-to-write-external-plugins): 某些情况下，您可能想要开发自己的非公开插件，但又希望能够及时更新使用到社区 LoongCollector 不断迭代的更新功能（而不是在社区版本上分叉），LoongCollector 的外部插件开发机制可以满足您这样的需求。 假设您将要在仓库中 my-repo.com/myspace/myplugins 中创建一个名为 serviceexampleplugin 的 input 插件。... - [自监控告警数据](https://cnops.com.cn/projects/loongcollector/docs/lc--input-internal-alarms) | [Markdown](https://cnops.com.cn/api/md/projects/loongcollector/lc--input-internal-alarms): inputinternalalarms 插件收集 LoongCollector 自身运行时的告警数据，并以LogEvent的格式暴露出去。 Beta 推荐版本：LoongCollector v3.0.5 及以上 关于具体告警的详情，请参见自监控告警说明。 | 参数 | 类型 | 是否必填 | 默认值 | 说明 | | --- | --- | --- | --- | ---... - [丢弃字段](https://cnops.com.cn/projects/loongcollector/docs/lc--processor-drop) | [Markdown](https://cnops.com.cn/api/md/projects/loongcollector/lc--processor-drop): processordrop processor插件可以丢弃日志字段。 Stable 推荐版本：iLogtail v1.0.27 及以上 | 参数 | 类型 | 是否必选 | 说明 | | -------- | -------- | -------- | -------------------------------- |... - [Loki](https://cnops.com.cn/projects/loongcollector/docs/lc--flusher-loki) | [Markdown](https://cnops.com.cn/api/md/projects/loongcollector/lc--flusher-loki): flusherloki flusher插件可以实现将采集到的数据，经过处理后，发送到 Loki。 Alpha 推荐版本：iLogtail v1.5.0 及以上 | 参数 | 类型 | 是否必选 | 说明 ... - [支持的操作系统](https://cnops.com.cn/projects/loongcollector/docs/lc--os) | [Markdown](https://cnops.com.cn/api/md/projects/loongcollector/lc--os): LoongCollector 支持以下操作系统和架构。 | | | | | -------- | ------------------------------------- | ------- | | 操作系统 | 发行版 |... - [如何自定义构建产物中默认包含的插件](https://cnops.com.cn/projects/loongcollector/docs/lc--how-to-custom-builtin-plugins) | [Markdown](https://cnops.com.cn/api/md/projects/loongcollector/lc--how-to-custom-builtin-plugins): LoongCollector 通过 插件引用配置文件 来定义要包含在构建产物中的插件，该文件中默认包含了LoongCollector 仓库中的所有插件。 同时，LoongCollector 也以同样的机制支持引入外部私有插件，关于如何开发外部插件，请参阅如何开发外部私有插件。LoongCollector 默认会检测仓库根目录下的 externalplugins.yml 文件来查找外部插件定义。... - [MySQL Binlog](https://cnops.com.cn/projects/loongcollector/docs/lc--service-canal) | [Markdown](https://cnops.com.cn/api/md/projects/loongcollector/lc--service-canal): servicecanal input插件可以采集MySQL Binlog。 Beta 推荐版本：LoongCollector v3.0.5 及以上 | 参数 | 类型，默认值 | 说明 | | --- | --- | --- | | Type | string，无默认值（必填） | 插件类型，指定为servicecanal。 | | Host| string，127.0.0.1 |... - [时间解析](https://cnops.com.cn/projects/loongcollector/docs/lc--processor-parse-timestamp-native) | [Markdown](https://cnops.com.cn/api/md/projects/loongcollector/lc--processor-parse-timestamp-native): processorparsetimestampnative插件解析事件中记录时间的字段，并将结果置为事件的time字段。 Stable 推荐版本：iLogtail v2.0.0 及以上 | 参数 | 类型 | 是否必填 | 默认值 | 说明 | | --- | --- | --- | --- | --- | | Type | string | 是 | / |... - [自监控指标数据](https://cnops.com.cn/projects/loongcollector/docs/lc--input-internal-metrics) | [Markdown](https://cnops.com.cn/api/md/projects/loongcollector/lc--input-internal-metrics): inputinternalmetrics 插件收集 LoongCollector 自身运行时的指标数据，并以多值MetricEvent的格式暴露出去。 Beta 推荐版本：LoongCollector v3.0.5 及以上 关于具体指标的详情，请参见自监控指标说明。 | 参数 | 类型 | 是否必填 | 默认值 | 说明 | | --- | --- | --- | ---... - [插件配置项基本原则](https://cnops.com.cn/projects/loongcollector/docs/lc--principles-of-plugin-configuration) | [Markdown](https://cnops.com.cn/api/md/projects/loongcollector/lc--principles-of-plugin-configuration): 1. key 拼写错误：等价于该 key 没有被配置，直接拒绝加载该参数 2. value 格式错误、取值错误：直接拒绝加载该参数 1. key 拼写错误：等价于该 key 没有被配置，使用默认值 2. value 格式错误、取值错误：使用默认值 1. key 不存在或者 key 取值为空：不进行过滤 2. value 有值但全部取值错误：使用默认值，一般不进行过滤 3. value... - [字段加密](https://cnops.com.cn/projects/loongcollector/docs/lc--processor-encrypy) | [Markdown](https://cnops.com.cn/api/md/projects/loongcollector/lc--processor-encrypy): processorencrypt插件可以使用 AES-128、AES-192、AES-256 算法对指定的字段加密，采用 PKCS7 填充算法。由于密文可能包含不可见字符，插件会对其进行十六进制编码。 Stable 推荐版本：iLogtail v1.0.27 及以上 | 参数 | 类型，默认值 | 说明 | | - | - | - | | Type |... - [时间戳过滤](https://cnops.com.cn/projects/loongcollector/docs/lc--processor-timestamp-filter-native) | [Markdown](https://cnops.com.cn/api/md/projects/loongcollector/lc--processor-timestamp-filter-native): processortimestampfilternative插件根据时间戳过滤事件，丢弃不在指定时间范围内的事件。插件支持从事件的时间戳字段或事件自身的time字段获取时间戳，并根据配置的上界和下界进行过滤。 源代码：ProcessorTimestampFilterNative.cpp Stable 推荐版本：LoongCollector v3.2.6 及以上 | 参数 | 类型 | 是否必填... - [容器标准输出](https://cnops.com.cn/projects/loongcollector/docs/lc--service-docker-stdout) | [Markdown](https://cnops.com.cn/api/md/projects/loongcollector/lc--service-docker-stdout): servicedockerstdout input插件可以实现从容器标准输出/标准错误流中采集日志，采集的日志内容将会保存在content字段中。支持通过容器元信息筛选待采集容器，并支持多行文本切分、添加容器Meta信息等数据处理操作，概览如下： 容器筛选，每项筛选条件之间为AND关系 支持通过容器Label白名单指定待采集的容器，多个白名单之间关系为OR。 ... - [OTLP日志](https://cnops.com.cn/projects/loongcollector/docs/lc--flusher-otlp) | [Markdown](https://cnops.com.cn/api/md/projects/loongcollector/lc--flusher-otlp): flusherotlp flusher插件可以实现将采集到的数据，经过处理后，发送到支持Opentelemetry Protocol的后端。 v1采集配置目前只支持Logs数据，v2采集配置支持Logs/Metrics/Traces三种数据。 Alpha 推荐版本：iLogtail v1.5.0 及以上 | 参数 | 类型 | 是否必选 | 说明 ... - [GO Profile](https://cnops.com.cn/projects/loongcollector/docs/lc--service-goprofile) | [Markdown](https://cnops.com.cn/api/md/projects/loongcollector/lc--service-goprofile): servicegoprofile input插件可以采集Golang pprof 性能数据。 推荐版本：iLogtail v1.7.1 及以上 | 参数 | 类型，默认值 | 说明 |... - [Prometheus](https://cnops.com.cn/projects/loongcollector/docs/lc--flusher-prometheus) | [Markdown](https://cnops.com.cn/api/md/projects/loongcollector/lc--flusher-prometheus): flusherprometheus flusher插件可以实现将采集到的数据，经过处理后，通过http格式发送到指定的 Prometheus RemoteWrite 地址。 参数配置大部分继承flusherhttp，详见flusherhttp。 Alpha 推荐版本：LoongCollector v3.0.5 及以上 | 参数 | 类型 ... - [eBPF网络可观测数据](https://cnops.com.cn/projects/loongcollector/docs/lc--input-network-observer) | [Markdown](https://cnops.com.cn/api/md/projects/loongcollector/lc--input-network-observer): inputnetworkobserver插件可以实现利用ebpf探针采集网络可观测数据。 Dev 推荐版本：LoongCollector v3.1.4 及以上 | 参数 | 类型 | 是否必填 | 默认值 | 说明 | | --- | --- | --- | --- | --- | | Type | string | 是 | / | ... - [条件字段处理](https://cnops.com.cn/projects/loongcollector/docs/lc--processor-fields-with-condition) | [Markdown](https://cnops.com.cn/api/md/projects/loongcollector/lc--processor-fields-with-condition): processorfieldswithcondition插件支持根据日志部分字段的取值，动态进行字段扩展或删除。源代码 Stable 支持多字段取值比较。 关系运算符：equals（默认）、regexp、contains、startwith。 逻辑运算符：and（默认）、or。 默认仅做字段动态处理。 可以开启过滤功能，未命中任意条件则丢弃。 ... - [eBPF网络安全数据](https://cnops.com.cn/projects/loongcollector/docs/lc--input-network-security) | [Markdown](https://cnops.com.cn/api/md/projects/loongcollector/lc--input-network-security): inputnetworksecurity插件可以实现利用ebpf探针采集网络安全相关动作。 Dev 推荐版本：LoongCollector v3.1.4 及以上 | 参数 | 类型 | 是否必填 | 默认值 | 说明 | | --- | --- | --- | --- | --- | | Type | string | 是 | / | ... - [日志过滤](https://cnops.com.cn/projects/loongcollector/docs/lc--processor-filter-regex) | [Markdown](https://cnops.com.cn/api/md/projects/loongcollector/lc--processor-filter-regex): processorfilterregex 插件可以实现对日志的过滤。一条数据只有完全匹配 Include 中的正则表达式，且不匹配 Exclude 中的正则表达式时才会被采集，否则直接丢弃。 Stable 推荐版本：iLogtail v1.0.27 及以上 | 参数 | 类型，默认值 | 说明 ... - [GPU数据](https://cnops.com.cn/projects/loongcollector/docs/lc--service-gpu) | [Markdown](https://cnops.com.cn/api/md/projects/loongcollector/lc--service-gpu): servicegpumetric input插件可以采集 英伟达 GPU 相关指标（如未安装英伟达驱动，此插件无法正常工作）。 Stable 推荐版本：iLogtail v1.0.27 及以上 | 参数 | 类型，默认值 | 说明 | | --- |--------| --- | | CollectIntervalMs | int(1000) |... - [Pulsar](https://cnops.com.cn/projects/loongcollector/docs/lc--flusher-pulsar) | [Markdown](https://cnops.com.cn/api/md/projects/loongcollector/lc--flusher-pulsar): flusherpulsar flusher插件可以实现将采集到的数据，经过处理后，发送到Pulsar。 Alpha 推荐版本：iLogtail v1.6.0 及以上 | 参数 | 类型 | 是否必选 | 说明 ... - [eBPF进程安全数据](https://cnops.com.cn/projects/loongcollector/docs/lc--input-process-security) | [Markdown](https://cnops.com.cn/api/md/projects/loongcollector/lc--input-process-security): inputprocesssecurity插件可以实现利用ebpf探针采集进程安全相关动作。 Beta 推荐版本：LoongCollector v3.1.6 及以上 | 参数 | 类型 | 是否必填 | 默认值 | 说明 | | --- | --- | --- | --- | --- | | Type | string | 是 | / | ... - [HTTP数据](https://cnops.com.cn/projects/loongcollector/docs/lc--service-http-server) | [Markdown](https://cnops.com.cn/api/md/projects/loongcollector/lc--service-http-server): servicehttpserver input插件可以接收来自unix socket、http/https、tcp的请求，并支持sls协议、otlp等多种协议。 Stable 推荐版本：iLogtail v1.5.0 及以上 | 参数 | 类型 | 是否必选 | 说明 ... - [标准输出/文件](https://cnops.com.cn/projects/loongcollector/docs/lc--flusher-stdout) | [Markdown](https://cnops.com.cn/api/md/projects/loongcollector/lc--flusher-stdout): flusherstdout flusher插件可以实现将采集到的数据，经过处理后，打印到标准输出或者自定义文件。 | LogGroup(v1) | EventTypeLogging | EventTypeMetric | EventTypeSpan | | ------------ | ---------------- | --------------- | ------------- | | ... - [时间提取（Go 时间格式）](https://cnops.com.cn/projects/loongcollector/docs/lc--processor-gotime) | [Markdown](https://cnops.com.cn/api/md/projects/loongcollector/lc--processor-gotime): Stable 推荐版本：iLogtail v1.7.1 及以上 | 参数 | 类型 | 是否必选 | 说明 | | - | - | - | - | | SourceKey | string | 是 | 原始字段名。 | | SourceFormat | string | 是 | 原始时间的格式。 | | SourceLocation | int | 否 | 原始时间的时区。参数值为空时，表示... - [Grok](https://cnops.com.cn/projects/loongcollector/docs/lc--processor-grok) | [Markdown](https://cnops.com.cn/api/md/projects/loongcollector/lc--processor-grok): processorgrok插件可以通过 Grok 语法匹配的模式，实现文本日志的字段提取。源代码 Beta 推荐版本：iLogtail v1.4.0 及以上 | 参数 | 类型，默认值 | 说明 | | - | - | - | | Type | string，无默认值（必填） | 插件类型，固定为processorgrok | |... - [【示例】ServiceInput](https://cnops.com.cn/projects/loongcollector/docs/lc--service-input-example) | [Markdown](https://cnops.com.cn/api/md/projects/loongcollector/lc--service-input-example): serviceinputexample 可作为编写ServiceInput类插件的参考示例样例，可以在指定端口接收模拟HTTP请求。源代码 Stable 推荐版本：iLogtail v1.0.27 及以上 | 参数 | 类型，默认值 | 说明 | | - | - | - | | Type | string，无默认值（必填） | 插件类型，固定为serviceinputexample。 | |... - [Prometheus 抓取](https://cnops.com.cn/projects/loongcollector/docs/lc--input-prometheus) | [Markdown](https://cnops.com.cn/api/md/projects/loongcollector/lc--input-prometheus): inputprometheus 插件按 ScrapeConfig 配置抓取 Prometheus 指标并输出到 rawevent中。默认使用 ProcessorPromParseMetricNative 和 ProcessorPromRelabelMetricNative 两个 Processor 进行指标解析和处理。 源代码：InputPrometheus.cpp Beta ... - [Journal数据](https://cnops.com.cn/projects/loongcollector/docs/lc--service-journal) | [Markdown](https://cnops.com.cn/api/md/projects/loongcollector/lc--service-journal): servicejournal 插件支持从原始的二进制文件中采集Linux系统的Journal（systemd）日志。systemd是专用于 Linux 操作系统的系统与服务管理器。当作为启动进程(PID=1)运行时，它将作为初始化系统运行，启动并维护各种用户空间的服务。... - [一次性文件采集](https://cnops.com.cn/projects/loongcollector/docs/lc--input-static-file-onetime) | [Markdown](https://cnops.com.cn/api/md/projects/loongcollector/lc--input-static-file-onetime): inputstaticfileonetime插件是LoongCollector的OneTime类型输入插件，专门用于一次性文件采集任务。与常规的inputfile插件不同，该插件执行一次后即完成采集任务，不会持续监控文件变化，适用于历史文件采集、数据迁移、批量数据处理等场景。 Beta 推荐版本：暂无（可使用edge版体验） ... - [Json](https://cnops.com.cn/projects/loongcollector/docs/lc--processor-json) | [Markdown](https://cnops.com.cn/api/md/projects/loongcollector/lc--processor-json): processorjson processor插件可以实现对Json格式日志的解析。 备注：当作为第一个日志解析插件且追求原生性能时，可改用原生插件 JSON 解析。 | LogGroup(v1) | EventTypeLogging | EventTypeMetric | EventTypeSpan | | ------------ | ---------------- |... - [Kafka](https://cnops.com.cn/projects/loongcollector/docs/lc--service-kafka) | [Markdown](https://cnops.com.cn/api/md/projects/loongcollector/lc--service-kafka): servicekafka input插件实现了ServiceInputV1和ServiceInputV2接口，插件用于采集Kafka的消息。 Stable 推荐版本：LoongCollector v3.0.5 及以上 | 参数 | 类型 | 是否必选 | 说明 ... - [日志转SLS Metric](https://cnops.com.cn/projects/loongcollector/docs/lc--processor-log-to-sls-metric) | [Markdown](https://cnops.com.cn/api/md/projects/loongcollector/lc--processor-log-to-sls-metric): processorlogtoslsmetric插件可以根据配置将日志转换为sls metric。 Beta 推荐版本：iLogtail v1.7.1 及以上 | 参数 | 类型 | 必选或可选 | 参数说明 ... - [otel Metric格式转换](https://cnops.com.cn/projects/loongcollector/docs/lc--processor-otel-metric) | [Markdown](https://cnops.com.cn/api/md/projects/loongcollector/lc--processor-otel-metric): Stable 推荐版本：iLogtail v1.8.0 及以上 下面是修复后的表格： | 参数 | 类型 | 是否必选 | 说明 ... - [Kubernetes元信息采集](https://cnops.com.cn/projects/loongcollector/docs/lc--service-kubernetesmeta-v2) | [Markdown](https://cnops.com.cn/api/md/projects/loongcollector/lc--service-kubernetesmeta-v2): servicekubernetesmeta 定时采集Kubernetes元数据，包括Pod、Deployment等资源及其之间的关系。并提供HTTP查询接口，支持通过一些字段索引，如Pod IP、Host IP等信息快速查询元数据。 Beta 推荐版本：LoongCollector v3.0.5 及以上 注意： 本插件需要在Kubernetes集群中运行，且需要有访问Kubernetes... - [【Debug】Mock数据-Service](https://cnops.com.cn/projects/loongcollector/docs/lc--service-mock) | [Markdown](https://cnops.com.cn/api/md/projects/loongcollector/lc--service-mock): servicemock 插件是用于模拟采集Service类型输入数据的插件，可以通过调整参数获取不同的模拟输入。源代码 Stable 推荐版本：iLogtail v1.0.27 及以上 | 参数 | 类型，默认值 | 说明 | | - | - | - | | Type | string，无默认值（必填） | 插件类型，固定为servicemock | | Tags |... - [otel Trace格式转换](https://cnops.com.cn/projects/loongcollector/docs/lc--processor-otel-trace) | [Markdown](https://cnops.com.cn/api/md/projects/loongcollector/lc--processor-otel-trace): Stable 推荐版本：iLogtail v1.7.1 及以上 下面是修复后的表格： | 参数 | 类型 | 是否必选 | 说明 ... - [SqlServer 查询数据](https://cnops.com.cn/projects/loongcollector/docs/lc--service-mssql) | [Markdown](https://cnops.com.cn/api/md/projects/loongcollector/lc--service-mssql): servicemssql input插件可以采集Sql Server查询数据。 Beta 推荐版本：iLogtail v1.2.0 及以上 | 参数 | 类型，默认值 | 说明 | | --- | --- | --- | | Type | string，无默认值（必填） | 插件类型，指定为servicemssql。 | | Host| string，127.0.0.1 | 数据库主机。| |... - [字段打包](https://cnops.com.cn/projects/loongcollector/docs/lc--processor-packjson) | [Markdown](https://cnops.com.cn/api/md/projects/loongcollector/lc--processor-packjson): processorpackjson插件可添加指定的字段（支持多个）以 JSON 格式打包成单个字段。 Stable 推荐版本：iLogtail v1.0.27 及以上 | 参数 | 类型 | 是否必选 | 参数说明 | | ----------------- | ------ |... - [日志限速](https://cnops.com.cn/projects/loongcollector/docs/lc--processor-rate-limit) | [Markdown](https://cnops.com.cn/api/md/projects/loongcollector/lc--processor-rate-limit): processorratelimit插件用于对日志进行限速处理，确保在设定的时间窗口内，具有相同索引值的日志条目的数量不超过预定的速率限制。若某索引值下的日志条目数量超出限定速率，则超额的日志条目将被丢弃不予采集。 以"ip"字段作为索引的情况为例，考虑两条日志：{"ip": "10...", "method": "POST", "browser": "aliyun-sdk-java"}... - [OTLP数据](https://cnops.com.cn/projects/loongcollector/docs/lc--service-otlp) | [Markdown](https://cnops.com.cn/api/md/projects/loongcollector/lc--service-otlp): serviceotlp input插件实现了ServiceInputV1和ServiceInputV2接口，可以接受Opentelemetry log/metric/trace protocol的http/gRPC请求，并且转换输出SLSProto或PipelineGroupEvents。 Beta 推荐版本：iLogtail v1.8.0 及以上 | 参数 |... - [PostgreSQL 查询数据](https://cnops.com.cn/projects/loongcollector/docs/lc--service-pgsql) | [Markdown](https://cnops.com.cn/api/md/projects/loongcollector/lc--service-pgsql): servicepgsql input插件可以采集PostgreSQL 查询数据。 Beta 推荐版本：iLogtail v1.2.0 及以上 | 参数 | 类型，默认值 | 说明 | | --- | --- | --- | | Type | string，无默认值（必填） | 插件类型，指定为servicepgsql。 | | Host| string，127.0.0.1 | 数据库主机。|... - [正则](https://cnops.com.cn/projects/loongcollector/docs/lc--processor-regex) | [Markdown](https://cnops.com.cn/api/md/projects/loongcollector/lc--processor-regex): processorregex processor插件可以通过正则匹配的模式实现文本日志的字段提取。 备注：当作为第一个日志解析插件时，建议使用正则解析原生处理插件替代。 Stable 推荐版本：iLogtail v1.0.27 及以上 | 参数 | 类型 | 是否必选 | 说明 ... - [收集 SNMP 协议机器信息](https://cnops.com.cn/projects/loongcollector/docs/lc--service-snmp) | [Markdown](https://cnops.com.cn/api/md/projects/loongcollector/lc--service-snmp): servicesnmp插件支持 SNMP V1，V2，V3。可以转化用户输入并对指定 ip 的机器执行 SNMP-GET 指令获取机器信息。 运行本插件需要本地已运行 snmp 程序，开放snmpget需要的端口，且可正常执行snmptranslate命令和snmptable命令。 Stable 推荐版本：iLogtail v1.0.27 及以上 | 参数 ... - [重命名字段](https://cnops.com.cn/projects/loongcollector/docs/lc--processor-rename) | [Markdown](https://cnops.com.cn/api/md/projects/loongcollector/lc--processor-rename): processorrename processor插件可以将日志字段重命名。 | LogGroup(v1) | EventTypeLogging | EventTypeMetric | EventTypeSpan | | ------------ | ---------------- | --------------- | ------------- | | ✅ | ... - [分隔符](https://cnops.com.cn/projects/loongcollector/docs/lc--processor-delimiter) | [Markdown](https://cnops.com.cn/api/md/projects/loongcollector/lc--processor-delimiter): processorsplitchar processor插件可以通过单字符的分隔符提取字段，该方式支持使用引用符对分隔符进行包裹。 processorsplitstring processor插件可以通过多字符的分隔符提取字段，该方式不支持使用引用符对分隔符进行包裹。 Stable 推荐版本：iLogtail v1.0.27 及以上 | 参数 | 类型 |... - [Syslog数据](https://cnops.com.cn/projects/loongcollector/docs/lc--service-syslog) | [Markdown](https://cnops.com.cn/api/md/projects/loongcollector/lc--service-syslog): servicesyslog 插件在指定 地址与端口 上监听；LoongCollector 根据采集配置拉起该插件后，即可接收经 rsyslog 转发的系统日志、Nginx 转发的访问/错误日志，以及 syslog 客户端上报的日志。源代码 Beta 推荐版本：iLogtail v1.0.31 及以上 | 参数 | 类型，默认值 | 说明 | | - | - | - | | Type |... - [键值对](https://cnops.com.cn/projects/loongcollector/docs/lc--processor-split-key-value) | [Markdown](https://cnops.com.cn/api/md/projects/loongcollector/lc--processor-split-key-value): processorsplitkeyvalue processor插件可以通过切分键值对的方式提取字段。 Stable 推荐版本：iLogtail v1.5.0 及以上 | 参数 | 类型 | 是否必选 | 说明 ... - [多行切分](https://cnops.com.cn/projects/loongcollector/docs/lc--processor-split-log-regex) | [Markdown](https://cnops.com.cn/api/md/projects/loongcollector/lc--processor-split-log-regex): processorsplitlogregex processor插件实现多行日志（例如Java程序日志）的采集。 备注：推荐在文件类等输入插件（如 inputfile）的 Multiline 配置中完成多行聚合；该能力在读取路径上由主进程内置逻辑（含内部处理器）完成。 若仍需使用本扩展插件在 Processor 阶段做多行切分，与其他 Processor 串联时，须将其置于 processors... - [字符串替换](https://cnops.com.cn/projects/loongcollector/docs/lc--processor-string-replace) | [Markdown](https://cnops.com.cn/api/md/projects/loongcollector/lc--processor-string-replace): processorstringreplace processor插件可以通过全文、正则匹配、去转义的方式实现文本日志的替换。 Stable 推荐版本：iLogtail v1.6.0 及以上 | 参数 | 类型 | 是否必选 | 说明 ... - [时间提取（strptime 格式）](https://cnops.com.cn/projects/loongcollector/docs/lc--processor-strptime) | [Markdown](https://cnops.com.cn/api/md/projects/loongcollector/lc--processor-strptime): processorstrptime插件可从指定字段中提取日志时间，时间格式为 Linux strptime。 Stable 推荐版本：iLogtail v1.7.0 及以上 | 参数 | 类型 | 是否必选 | 参数说明 ... ## OpenTelemetry - [项目主页](https://cnops.com.cn/projects/opentelemetry) - [规范状态概览](https://cnops.com.cn/projects/opentelemetry/docs/otel--status) | [Markdown](https://cnops.com.cn/api/md/projects/opentelemetry/otel--status): OpenTelemetry 是基于各种信号逐一开发的。链路追踪、指标、Baggage 和日志都是一种信号。 每个信号都构建在上下文传播机制之上，这是一种用于在分布式系统中关联数据的共享机制。 每个信号由四个核心组件组成： - API - SDK - OpenTelemetry 协议（OTLP） - Collector 信号还包括 contrib 组件，这是插件和插桩组成的生态体系。... - [应用要求](https://cnops.com.cn/projects/opentelemetry/docs/otel--application) | [Markdown](https://cnops.com.cn/api/md/projects/opentelemetry/otel--application): 在定义应用将产生哪些 OpenTelemetry (OTel) 信号，以及何时应添加对未来 SDK 的支持时，会产生以下要求： 1. 每种支持的语言中，只要其 Traces 或 Metrics SDK 已 GA（正式发布），就必须至少有 1 个服务示例。 - 移动端支持（Swift）不是初始优先事项，不包含在上述要求中。 2. 应用进程必须与语言无关。 - 在可用的情况下优先使用... - [快速入门](https://cnops.com.cn/projects/opentelemetry/docs/otel--kubernetes--getting-started) | [Markdown](https://cnops.com.cn/api/md/projects/opentelemetry/otel--kubernetes--getting-started): 本页面将引导你以最快的方式开始使用 OpenTelemetry 监控你的 Kubernetes 集群。 它将专注于收集 Kubernetes 集群、节点、Pod 和容器的指标和日志，以及使集群支持发送 OTLP 数据的服务。 如果你想在 Kubernetes 中看到 OpenTelemetry 的实际应用，最好的起点是 OpenTelemetry 演示。 该演示旨在说明... - [Kubernetes 的重要组件](https://cnops.com.cn/projects/opentelemetry/docs/otel--collector--components) | [Markdown](https://cnops.com.cn/api/md/projects/opentelemetry/otel--collector--components): OpenTelemetry Collector 支持许多不同的接收器和处理器以助力监控 Kubernetes。 本节介绍采集 Kubernetes 数据并对其进行加工增强的核心组件。 本页面涵盖的组件： - Kubernetes 属性处理器：向传入的应用遥测数据添加 Kubernetes 元数据。 - Kubeletstats 接收器：从 kubelet 上的 API 服务器拉取节点、Pod... - [文档](https://cnops.com.cn/projects/opentelemetry/docs/otel--docs-overview) | [Markdown](https://cnops.com.cn/api/md/projects/opentelemetry/otel--docs-overview): OpenTelemetry 也被称为 OTel，是一个供应商中立的、开源的可观测性框架， 可用于插桩、生成、采集和导出链路、指标和日志等遥测数据。 OpenTelemetry 作为一个行业标准，得到了 40 多个可观测供应商的支持， 被许多代码库、服务和应用集成， 被众多终端用户采用。 - [使用指标和链路诊断内存泄漏](https://cnops.com.cn/projects/opentelemetry/docs/otel--recommendation-cache) | [Markdown](https://cnops.com.cn/api/md/projects/opentelemetry/otel--recommendation-cache): OpenTelemetry 提供的应用遥测数据对于诊断分布式系统中的问题非常有用。 在这个场景中，我们将逐步演示如何从宏观指标与追踪数据入手，定位内存泄漏问题的根源。 要运行此场景，你需要部署演示应用程序并启用 recommendationServiceCacheFailure 功能标志。 启用功能标志后，让应用程序运行约 10 分钟左右，以便填充数据。 诊断问题的第一步是确定问题存在。... - [广告服务](https://cnops.com.cn/projects/opentelemetry/docs/otel--ad) | [Markdown](https://cnops.com.cn/api/md/projects/opentelemetry/otel--ad): 此服务根据上下文关键词为用户提供合适的广告。广告内容为商店中可用的商品。 广告服务源码 此服务依赖 OpenTelemetry Java 代理来自动插桩对 gRPC 等库的观测，并配置 OpenTelemetry SDK。 此代理通过 -javaagent 命令行参数传递到进程中。在 Dockerfile 中通过 JAVATOOLOPTIONS 添加命令行参数，并在自动生成的 Gradle... - [各服务的日志覆盖情况](https://cnops.com.cn/projects/opentelemetry/docs/otel--log-coverage) | [Markdown](https://cnops.com.cn/api/md/projects/opentelemetry/otel--log-coverage): | 服务 | 语言 | OTLP 日志 | | --------------- | ---------- | --------- | | Accounting | .NET | ✅ | | Ad | Java | ✅ | | Cart | .NET ... - [代理](https://cnops.com.cn/projects/opentelemetry/docs/otel--deployment--agent) | [Markdown](https://cnops.com.cn/api/md/projects/opentelemetry/otel--deployment--agent): 代理 Collect 部署模式既包含采用 [OpenTelemetry 协议（OTLP）][otlp]并通过 OpenTelemetry SDK [插桩][instrumentation]的各类应用， 也包含使用 OTLP 导出器将遥测信号发送到与应用一起运行的 [Collector][collector] 实例或与应用（例如边车或 DaemonSet）所在主机上的的其他 Collector。... - [OpenTelemetry Java 介绍](https://cnops.com.cn/projects/opentelemetry/docs/otel--intro) | [Markdown](https://cnops.com.cn/api/md/projects/opentelemetry/otel--intro): OpenTelemetry Java 是为 Java 生态系统打造的一套 OpenTelemetry 可观测性工具集。 从宏观层面来看，它由 API、SDK 和插桩（instrumentation）三部分组成。 本页面将介绍该生态系统，包括概念性的概述、一份文档导航指南 ，以及一份含发版信息和构件等关键详情的仓库清单。 API... - [Lambda Collector 配置](https://cnops.com.cn/projects/opentelemetry/docs/otel--lambda-collector) | [Markdown](https://cnops.com.cn/api/md/projects/opentelemetry/otel--lambda-collector): OpenTelemetry 社区将 Collector 作为独立的 Lambda 层提供，与插桩层分开， 为用户提供了最大的灵活性。这与当前的 AWS OpenTelemetry 发行版（ADOT）不同， 后者将插桩和 Collector 打包在一起。 完成应用的自动插桩后，你应添加 Collector Lambda 层来收集并提交数据至所选后端。 请查找最新的 Collector 层发布版本，... - [快速入门](https://cnops.com.cn/projects/opentelemetry/docs/otel--quick-start) | [Markdown](https://cnops.com.cn/api/md/projects/opentelemetry/otel--quick-start): OpenTelemetry Collector 是一个可执行文件，它能够接收链路、 指标和日志， 处理这些遥测数据，并通过其组件将其导出到多种可观测性后端。要了解 Collector 的概念性概览， 请参见 Collector。 你将学习如何在不到五分钟的时间内完成以下操作：... - [常见漏洞与暴露（CVE）](https://cnops.com.cn/projects/opentelemetry/docs/otel--cve) | [Markdown](https://cnops.com.cn/api/md/projects/opentelemetry/otel--cve): 以下是 OpenTelemetry GitHub 组织中所有代码仓库已报告的 CVE 列表。原始数据存放在 sig-security 仓库中，并在每日更新。 ... - [Node.js](https://cnops.com.cn/projects/opentelemetry/docs/otel--nodejs) | [Markdown](https://cnops.com.cn/api/md/projects/opentelemetry/otel--nodejs): 这个页面将向你展示如何在 Node.js 中开始使用 OpenTelemetry。 你将学习如何为应用程序植入[链路][traces]和[指标][metrics]，并将其记录到控制台。 OpenTelemetry for Node.js 的日志记录库仍在开发中，因此下面没有提供示例。 有关状态详情，请参阅状态和发布。 确保你已安装以下内容： - Node.js -... - [OpenTelemetry Collector Chart](https://cnops.com.cn/projects/opentelemetry/docs/otel--helm--collector) | [Markdown](https://cnops.com.cn/api/md/projects/opentelemetry/otel--helm--collector): OpenTelemetry Collector 是监控 Kubernetes 集群及其内部所有服务的重要工具。 为了方便在 Kubernetes 中安装和管理 Collector 部署， OpenTelemetry 社区创建了 OpenTelemetry Collector Helm Chart。 此 Helm chart 可用于将 Collector 安装为... - [快速开始](https://cnops.com.cn/projects/opentelemetry/docs/otel--agent--getting-started) | [Markdown](https://cnops.com.cn/api/md/projects/opentelemetry/otel--agent--getting-started): 1. 从 opentelemetry-java-instrumentation 仓库的 [Releases][] 下载 [opentelemetry-javaagent.jar][] 并将 JAR 放在您偏好的目录中。 JAR 文件包含代理和插桩库。 2. 添加 -javaagent:path/to/opentelemetry-javaagent.jar 和其他配置到 ... - [PHP 零代码插桩](https://cnops.com.cn/projects/opentelemetry/docs/otel--php) | [Markdown](https://cnops.com.cn/api/md/projects/opentelemetry/otel--php): 使用 PHP 进行自动插桩需要满足以下条件： - PHP 8.0 或更高版本 - OpenTelemetry PHP 扩展 - Composer 自动加载 - OpenTelemetry SDK - 一个或多个插桩库 - 配置方法 仅安装 OpenTelemetry 扩展本身不会生成链路数据。 该扩展可以通过 pecl、pickle、 PIE 或 php-extension-installer... - [构建认证器扩展](https://cnops.com.cn/projects/opentelemetry/docs/otel--authenticator-extension) | [Markdown](https://cnops.com.cn/api/md/projects/opentelemetry/otel--authenticator-extension): OpenTelemetry Collector 允许将接收器和导出器连接到认证器， 从而在接收端对传入连接进行身份验证，并在导出端为传出的请求添加认证数据。 这种机制是通过[扩展][extensions]实现的，本文将指导你实现自己的认证器。 如果你正在寻找如何使用现有认证器的文档，请参考入门指南页面以及你的认证器文档。 你可以在本网站的注册表中找到现有认证器的列表。... - [零代码插桩配置](https://cnops.com.cn/projects/opentelemetry/docs/otel--js--configuration) | [Markdown](https://cnops.com.cn/api/md/projects/opentelemetry/otel--js--configuration): 这个模块通过设置环境变量具有高度的可配置性。 自动插桩行为的许多方面都可以根据你的需要进行配置，例如资源探测器、导出器、链路上下文传播头等等。 SDK 和导出器配置可以使用环境变量设置。 默认情况下，该模块将启用所有 SDK 资源探测器。 你可以使用 OTELNODERESOURCEDETECTORS 环境变量来只启用特定的探测器，或完全禁用它们： - env - host - os -... - [前置条件](https://cnops.com.cn/projects/opentelemetry/docs/otel--prerequisites) | [Markdown](https://cnops.com.cn/api/md/projects/opentelemetry/otel--prerequisites): 要参与本仓库的贡献，你需要熟悉以下技术和工具： - git - GitHub - Markdown（CommonMark） - YAML 有关文档如何在本地构建和测试的技术细节，请参阅开发指南。 所有 OpenTelemetry 贡献者必须签署 Linux 基金会的[贡献者许可协议（CLA）][CLA]。 尚未签署 CLA 的贡献者提交的 PR 会在自动测试中失败。 你提供的姓名和电子邮件必须与... - [从 OpenTracing 迁移](https://cnops.com.cn/projects/opentelemetry/docs/otel--opentracing) | [Markdown](https://cnops.com.cn/api/md/projects/opentelemetry/otel--opentracing): OpenTelemetry 项目自从诞生以来，[OpenTracing][] 的向后兼容性就是优先事项之一。 为了简化迁移过程，OpenTelemetry 支持在同一代码库中同时使用 OpenTelemetry 和 OpenTracing API。这样就可以使用 OpenTelemetry SDK 记录 OpenTracing 的插桩数据。 为实现这一点，每个 OpenTelemetry SDK... - [采样](https://cnops.com.cn/projects/opentelemetry/docs/otel--js--sampling) | [Markdown](https://cnops.com.cn/api/md/projects/opentelemetry/otel--js--sampling): [采样](/project/opentelemetry/doc/otel--sampling)是一个限制系统生成链路数量的过程。JavaScript SDK 提供了几种[头部采样器](/project/opentelemetry/doc/otel--sampling#head-sampling)。 ## 默认行为 {#default-behavior} 默认情况下，所有 Span 都会被采样， - [可观测性入门](https://cnops.com.cn/projects/opentelemetry/docs/otel--observability-primer) | [Markdown](https://cnops.com.cn/api/md/projects/opentelemetry/otel--observability-primer): 可观测性让你能够从外部理解一个系统，它允许你在不了解系统内部运作的情况下，对该系统提出问题。更重要的是， 它能帮你轻松排查和处理新出现的问题，也就是所谓的"未知的未知"。它还能帮你回答"为什么会发生这种情况？"这样的问题。 要对你的系统提出这些问题，你的应用程序必须进行适当的插桩。也就是说，应用程序代码必须能够发出信号， 例如链路、 指标和 日志。当开发人员不需要添加更多插桩就能排查问题时，... - [链路（Trace）](https://cnops.com.cn/projects/opentelemetry/docs/otel--traces) | [Markdown](https://cnops.com.cn/api/md/projects/opentelemetry/otel--traces): 链路为我们提供了向应用发出请求时会发生什么的总览图。 无论你的应用是具有单个数据库的单体应用还是复杂的服务网格，链路对于了解请求在应用中的完整“路径”至关重要。 让我们通过三个用 Span 表示的工作单元来探讨这个问题： 以下 JSON 示例不表示特定格式，尤其是不表示 OTLP/JSON，因为 OTLP/JSON 更详细。 hello span: 这是根... - [HTTP 插桩配置](https://cnops.com.cn/projects/opentelemetry/docs/otel--http) | [Markdown](https://cnops.com.cn/api/md/projects/opentelemetry/otel--http): 你可以配置代理，将预定义的 HTTP 头作为 Span 属性进行采集， 符合语义规范。 使用以下属性来定义要采集的 HTTP 头： 以逗号分隔的 HTTP 头名称列表。 HTTP 客户端插桩将采集所有配置的头名称的 HTTP 请求头值。 以逗号分隔的 HTTP 头名称列表。 HTTP 客户端插桩将采集所有配置的头名称的 HTTP 响应头值。 以逗号分隔的 HTTP 头名称列表。 HTTP... - [零代码](https://cnops.com.cn/projects/opentelemetry/docs/otel--zero-code--zero-code) | [Markdown](https://cnops.com.cn/api/md/projects/opentelemetry/otel--zero-code--zero-code): 作为一名运维人员，你可能希望在不编辑源代码的情况下为一个或多个应用添加可观测性。 OpenTelemetry 允许你快速为某个服务增加一定程度的可观测性，而无需使用 OpenTelemetry API 和 SDK 进行基于代码的插桩。 零代码插桩通常以代理或类似代理的安装方式，将 OpenTelemetry API 和 SDK 的能力添加到你的应用中。... - [快速开始](https://cnops.com.cn/projects/opentelemetry/docs/otel--spring-boot-starter--getting-started) | [Markdown](https://cnops.com.cn/api/md/projects/opentelemetry/otel--spring-boot-starter--getting-started): 你也可以使用 Java 代理为你的 Spring Boot 应用程序配置插桩。 有关优缺点，请参见 Java 零代码插桩. OpenTelemetry Spring Boot 启动器适用于 Spring Boot 2.6+ 和 3.1+ 版本，以及 Spring Boot Native image 应用程序。... - [开发人员入门](https://cnops.com.cn/projects/opentelemetry/docs/otel--dev) | [Markdown](https://cnops.com.cn/api/md/projects/opentelemetry/otel--dev): 如果你符合以下条件，那么这个入门指南就是为你准备的： - 你是一名软件开发者。 - 你的目标是通过编写代码来实现可观测性。 - 你希望你的依赖项能自动生成可观测性数据。 OpenTelemetry 可以帮到你！为了实现你的目标——自动为依赖项添加插桩以及使用我们的 API 手动为你自己的代码添加插桩——我们建议你先学习以下概念： - 什么是 OpenTelemetry？ -... - [开始](https://cnops.com.cn/projects/opentelemetry/docs/otel--go--getting-started) | [Markdown](https://cnops.com.cn/api/md/projects/opentelemetry/otel--go--getting-started): 本页面将向你展示如何在 Go 中开始使用 OpenTelemetry。 你将学习如何手动为一个简单的应用程序进行插桩, 并且使其能将 [traces][]，[metrics][]... - [安装 Collector](https://cnops.com.cn/projects/opentelemetry/docs/otel--installation) | [Markdown](https://cnops.com.cn/api/md/projects/opentelemetry/otel--installation): 你可以在多种操作系统和多种架构上部署 OpenTelemetry Collector。 以下说明展示了如何下载并安装 Collector 的最新稳定版本。 如果你还不熟悉 OpenTelemetry Collector 的部署模型、组件和相关代码库， 请先查阅[数据收集][Data Collection]和[部署方法][Deployment Methods]页面。 以下命令会拉取一个... - [使用 API 扩展插桩功能](https://cnops.com.cn/projects/opentelemetry/docs/otel--spring-boot-starter--api) | [Markdown](https://cnops.com.cn/api/md/projects/opentelemetry/otel--spring-boot-starter--api): 除开箱即用的插桩功能外，你还可借助 OpenTelemetry API，通过自定义手动插桩的方式对 Spring 启动器进行扩展。 这使你能够为自己的代码创建 Span 和指标， 无需进行过多代码修改。 所需的依赖项已包含在 Spring Boot 启动器中。 Spring Boot 启动器是一个特殊的案例，其中 OpenTelemetry 可作为 Spring Bean 使用。 只需将... - [Lambda 手动插桩](https://cnops.com.cn/projects/opentelemetry/docs/otel--lambda-manual-instrument) | [Markdown](https://cnops.com.cn/api/md/projects/opentelemetry/otel--lambda-manual-instrument): 对于在 Lambda 自动插桩文档中未涵盖的语言，社区尚未提供独立的插桩器。 用户需要遵循其选定语言的通用插桩指导，并添加 Collector Lambda 层来提交数据。 参见 Collector Lambda 层指导将层添加到你的应用程序并配置 Collector。我们建议首先添加此层。 查看语言插桩指导，了解如何手动插桩你的应用程序。 发布新的 Lambda 版本以部署新更改和插桩器。 - [配置](https://cnops.com.cn/projects/opentelemetry/docs/otel--agent--configuration) | [Markdown](https://cnops.com.cn/api/md/projects/opentelemetry/otel--agent--configuration): 本页介绍了向 Java 代理提供配置的多种方式。有关配置选项本身的信息，请参阅配置 SDK。 代理可以从以下一个或多个来源（按优先级从高到低排序）获取配置： - 系统属性 - 环境变量 - 配置文件 - AutoConfigurationCustomizer#addPropertiesSupplier() 函数提供的属性；使用 ... - [OpenTelemetry Demo Chart](https://cnops.com.cn/projects/opentelemetry/docs/otel--helm--demo) | [Markdown](https://cnops.com.cn/api/md/projects/opentelemetry/otel--helm--demo): OpenTelemetry Demo 是一个基于微服务的分布式系统， 旨在说明 OpenTelemetry 在接近真实世界环境中的实现。 作为该工作的一部分，OpenTelemetry 社区创建了 OpenTelemetry Demo Helm Chart， 以便可以在 Kubernetes 中轻松安装。 Demo Helm Chart 的默认 values.yaml 已准备好安装。... - [上下文传播](https://cnops.com.cn/projects/opentelemetry/docs/otel--context-propagation) | [Markdown](https://cnops.com.cn/api/md/projects/opentelemetry/otel--context-propagation): 通过上下文传播，无论信号在何处生成，信号彼此之间都可以相互关联。 尽管上下文传播的作用不仅限于链路追踪， 但上下文传播允许链路跨进程和网络边界任意分布的服务来构建相关系统的关联信息。 要理解上下文传播，你需要理解两个独立的概念：上下文和传播。 上下文（Context）这个对象包含了发送和接收服务或执行单元的信息， 用于将一个信号与另一个信号关联起来。 当 Service A 调用 Service... - [运维人员入门](https://cnops.com.cn/projects/opentelemetry/docs/otel--ops) | [Markdown](https://cnops.com.cn/api/md/projects/opentelemetry/otel--ops): 如果你符合以下条件，那么这个入门指南就是为你准备的： - 你在生产环境中运行一组应用程序。 - 你的目标是从这些应用程序中获取可观测性数据（telemetry），而无需修改它们的代码。 - 你想从多个服务中收集链路、指标和日志，并将它们发送到你的可观测性后端。 OpenTelemetry 可以帮到你！为了实现在不修改应用程序代码的情况下获取观测数据的目标，我们建议你学习以下内容： - 什么是... - [Metrics](https://cnops.com.cn/projects/opentelemetry/docs/otel--metrics) | [Markdown](https://cnops.com.cn/api/md/projects/opentelemetry/otel--metrics): 一个 metric 是在运行时捕获的服务的测量值。捕获测量值的时刻称为 metric 事件，它不仅包括测量值本身，还包括捕获它的时间和相关的元数据。 应用和请求的 metrics 是可用性和性能的重要指标。自定义 metric 可以在‘可用性因素是如何影响到用户体验和业务’方面提供见解。收集的数据可以用于异常警告或触发调度决策，以在高要求时自动扩展部署。 要了解 OpenTelemetry 中的... - [基于代码的方式](https://cnops.com.cn/projects/opentelemetry/docs/otel--code-based) | [Markdown](https://cnops.com.cn/api/md/projects/opentelemetry/otel--code-based): 你首先需要在服务代码中导入 OpenTelemetry。如果你正在开发一个库或其他打算被可运行二进制文件使用的组件， 那么你只需要依赖 API。如果你的构件是一个独立的进程或服务，那么你需要同时依赖 API 和 SDK。 有关 OpenTelemetry API 和 SDK 的更多信息，请参阅规范。 为了创建链路或指标，你需要先创建一个 tracer 和/或 meter 提供程序。通常，我们建议... - [手动 Span 属性](https://cnops.com.cn/projects/opentelemetry/docs/otel--manual-span-attributes) | [Markdown](https://cnops.com.cn/api/md/projects/opentelemetry/otel--manual-span-attributes): 本页面列出了在整个 Demo 使用的所有手动 Span 属性： | 名称 | 类型 | 描述 | | --------------------------- | ------ | ---------------------------- | | app.ads.category |... - [架构要求](https://cnops.com.cn/projects/opentelemetry/docs/otel--requirements--architecture) | [Markdown](https://cnops.com.cn/api/md/projects/opentelemetry/otel--requirements--architecture): OpenTelemetry 社区演示应用旨在展示如何将 OpenTelemetry API、SDK 和工具用于轻量生产级别的云原生应用中。 这个演示应用的总体目标不仅是提供一个规范性的 OpenTelemetry 组件“演示”， 还要作为一个框架，供终端用户、厂商和其他利益相关者进一步定制。 - 应用要求 - OpenTelemetry 要求 - 系统要求 -... - [通过示例入门](https://cnops.com.cn/projects/opentelemetry/docs/otel--java--getting-started) | [Markdown](https://cnops.com.cn/api/md/projects/opentelemetry/otel--java--getting-started): 本页面将向你展示如何在 Java 中快速开始使用 OpenTelemetry。 你将学习如何为一个简单的 Java 应用实现自动插桩， 通过这样的方式使[链路][traces]、[指标][metrics]和[日志][logs]输出到控制台。 确保你已在本地安装以下内容： -... - [浏览器](https://cnops.com.cn/projects/opentelemetry/docs/otel--browser) | [Markdown](https://cnops.com.cn/api/md/projects/opentelemetry/otel--browser): 尽管本指南使用下述示例应用，你也可以将这些步骤应用于你自己的应用。 请确保你已在本地安装以下内容： - Node.js - TypeScript，如果你将使用 TypeScript。 这是一个非常简单的指南，如果你想查看更复杂的示例，请访问 examples/opentelemetry-web。 将以下文件复制到空目录中，并将其命名为 index.html。 要在浏览器中创建链路，你需要... - [插桩](https://cnops.com.cn/projects/opentelemetry/docs/otel--js--instrumentation) | [Markdown](https://cnops.com.cn/api/md/projects/opentelemetry/otel--js--instrumentation): 在本页中，你将学习如何手动向代码添加链路、指标和日志。 但是，你并不局限于只使用一种插桩方式： 可以使用自动插桩来入门，然后根据需要使用手动插桩来丰富代码。 本页使用了入门指南中的示例应用程序的修改版本，帮助你学习手动插桩。 你无需使用该示例应用程序：如果你希望为自己的应用程序或库实现插桩，可遵循此处的说明，将该流程调整适配到你自己的代码中。 在一个新目录下创建一个空的 NPM... - [Issue](https://cnops.com.cn/projects/opentelemetry/docs/otel--issues) | [Markdown](https://cnops.com.cn/api/md/projects/opentelemetry/otel--issues):
CVE 编号 问题摘要 严重等级