newrelic/nrdot-collector-k8s

NewRelic 优化的 OpenTelemetry Collector 镜像文档

镜像概述和主要用途

本镜像为 https://opentelemetry.io/docs/collector/ 的自定义发行版，专注于提供与 NewRelic 平台的无缝集成能力。通过预配置的 NewRelic 适配组件，简化遥测数据（指标、日志、追踪）从应用到 NewRelic 后端的采集、处理和导出流程，降低用户在配置和维护 OpenTelemetry Collector 时的复杂度。

核心功能和特性

1. 预置 NewRelic 集成组件

• 内置 NewRelic 导出器（otlphttp 或 newrelic 导出器），预配置与 NewRelic 后端的通信协议
• 包含针对 NewRelic 优化的处理器（如批量处理器、采样处理器），提升数据传输效率

2. 简化集成流程

• 减少手动配置步骤，通过环境变量即可快速完成基础配置（如授权、端点设置）
• 兼容 OpenTelemetry 标准配置格式，支持自定义扩展配置

3. 与 NewRelic 生态深度兼容

• 支持 NewRelic 全量遥测数据类型（Metrics、Logs、Traces）
• 自动适配 NewRelic 数据格式要求，避免格式转换问题
• 兼容 NewRelic One、NewRelic APM 等平台功能

使用场景和适用范围

适用场景

• 云原生应用监控：容器化或微服务架构中，统一采集多服务遥测数据并发送至 NewRelic
• 混合环境数据聚合：从物理机、虚拟机、Kubernetes 集群等多环境采集数据，集中导出至 NewRelic
• 遗留系统监控改造：无需修改应用代码，通过 Collector 旁挂方式接入 NewRelic 监控

适用用户

• 需要将应用遥测数据接入 NewRelic 的开发/运维团队
• 使用 OpenTelemetry 进行标准化遥测采集，同时依赖 NewRelic 进行数据分析的企业用户
• 追求低配置成本、高兼容性监控方案的技术团队

使用方法和配置说明

前置条件

• 已获取 NewRelic 账号及 https://docs.newrelic.com/docs/apis/intro-apis/new-relic-api-keys/#license-key%EF%BC%88%E5%BF%85%E5%A1%AB%EF%BC%89
• 容器运行环境需支持 Docker 或 Kubernetes

快速启动（Docker Run）

基础命令

bash
docker run -d \
  --name nrdot-collector \
  -e NEW_RELIC_LICENSE_KEY=<your-newrelic-license-key> \
  -p 4317:4317  # OTLP gRPC 接收端口 \
  -p 4318:4318  # OTLP HTTP 接收端口 \
  newrelic/nrdot-collector

参数说明

• -e NEW_RELIC_LICENSE_KEY：NewRelic 授权密钥，用于鉴权数据上传（必填）
• -p 4317:4317：暴露 OTLP gRPC 协议端口，接收应用发送的遥测数据
• -p 4318:4318：暴露 OTLP HTTP 协议端口，接收应用发送的遥测数据

Docker Compose 配置示例

yaml
version: '3.8'
services:
  nrdot-collector:
    image: docker.xuanyuan.run/newrelic/nrdot-collector
    container_name: nrdot-collector
    environment:
      - NEW_RELIC_LICENSE_KEY=<your-newrelic-license-key>
      - NEW_RELIC_REGION=us  # 可选，指定 NewRelic 区域（us/europe），默认 us
      - OTEL_COLLECTOR_CONFIG=/etc/otelcol/config.yaml  # 自定义配置文件路径（可选）
    ports:
      - "4317:4317"  # OTLP gRPC
      - "4318:4318"  # OTLP HTTP
      - "8888:8888"  # 健康检查端口（可选）
    volumes:
      - ./custom-config.yaml:/etc/otelcol/config.yaml  # 挂载自定义配置文件（可选）
    restart: unless-stopped

核心配置说明

环境变量配置

自定义配置文件（示例）

如需扩展配置（如添加接收器、处理器），可通过挂载自定义 config.yaml 文件实现：

yaml
# 自定义配置示例（挂载至 /etc/otelcol/config.yaml）
receivers:
  otlp:
    protocols:
      grpc:
        endpoint: 0.0.0.0:4317
      http:
        endpoint: 0.0.0.0:4318

processors:
  batch:  # 批量处理提升效率
    timeout: 5s
    send_batch_size: 1024

exporters:
  otlp/newrelic:
    endpoint: ${OTEL_EXPORTER_OTLP_ENDPOINT}
    headers:
      api-key: ${NEW_RELIC_LICENSE_KEY}  # 使用环境变量注入 License Key

service:
  pipelines:
    traces:
      receivers: [otlp]
      processors: [batch]
      exporters: [otlp/newrelic]
    metrics:
      receivers: [otlp]
      processors: [batch]
      exporters: [otlp/newrelic]
    logs:
      receivers: [otlp]
      processors: [batch]
      exporters: [otlp/newrelic]

更多信息

完整配置指南、版本更新日志及故障排查文档，请参考 GitHub 仓库：
https://github.com/newrelic/nrdot-collector-releases/blob/main/README.md