otel/autoinstrumentation-nodejs

NodeJS 自动 Instrumentation 代理镜像

镜像概述和主要用途

该镜像是 OpenTelemetry Operator 使用的 NodeJS 自动 instrumentation 代理，旨在为 NodeJS 应用提供无需手动修改代码的遥测数据自动收集能力。作为 OpenTelemetry 可观测性解决方案的组件，它与 OpenTelemetry Operator 协同工作，实现 NodeJS 应用遥测数据（如分布式追踪、指标等）的自动采集、处理与导出。

核心功能和特性

• 自动 Instrumentation：无需手动修改 NodeJS 应用代码，即可自动注入追踪、指标等遥测逻辑
• 与 OpenTelemetry Operator 集成：专为 OpenTelemetry Operator 设计，可通过 Operator 进行统一管理和配置
• 遥测数据自动收集：支持自动收集分布式追踪、性能指标等多种遥测数据
• 标准化导出：兼容 OpenTelemetry 协议，可将遥测数据导出至各类后端（如 Jaeger、Prometheus 等）

使用场景和适用范围

适用于需要为 NodeJS 应用快速添加可观测性能力的场景，特别是在 Kubernetes 集群环境中：

• 需为 NodeJS 微服务自动启用分布式追踪的场景
• 希望减少手动 instrumentation 代码开发工作的场景
• 使用 OpenTelemetry Operator 管理集群内应用遥测配置的场景

使用方法和配置说明

前置条件

• 已在 Kubernetes 集群中部署 OpenTelemetry Operator（参考 https://github.com/open-telemetry/opentelemetry-operator%EF%BC%89

基本使用流程

该代理通常通过 OpenTelemetry Operator 的 Instrumentation 自定义资源进行配置，由 Operator 自动将代理注入到目标 NodeJS 应用 Pod 中，无需手动运行镜像。具体步骤如下：

1. 创建或配置 Instrumentation 资源，指定 NodeJS 自动 instrumentation 相关参数
2. 在 NodeJS 应用的 Deployment/StatefulSet 等资源中添加标签（如 instrumentation.opentelemetry.io/inject-nodejs: "true"）
3. OpenTelemetry Operator 会自动识别标签，将该代理注入到应用容器中，实现遥测数据自动收集

配置说明

详细配置参数及使用方法请参考 OpenTelemetry Operator 官方文档：https://github.com/open-telemetry/opentelemetry-operator

相关链接

• GitHub 仓库：https://github.com/open-telemetry/opentelemetry-operator
• 贡献指南：https://github.com/open-telemetry/opentelemetry-operator/blob/main/CONTRIBUTING.md
• 更多信息：opentelemetry.io