sumologic/opentelemetry-operator

Sumo Logic Kubernetes Collection OpenTelemetry Operator 镜像文档

1. 镜像概述和主要用途

本镜像是 Sumo Logic Kubernetes Collection 项目使用的 OpenTelemetry Operator 容器镜像，基于上游 https://github.com/open-telemetry/opentelemetry-operator 构建。其核心用途是在 Kubernetes 集群中自动化管理 OpenTelemetry 资源（如 Collector、Instrumentation 等），简化遥测数据（日志、指标、追踪）的收集、处理与导出流程，并针对与 Sumo Logic 平台的集成进行了优化。

2. 核心功能和特性

2.1 核心功能

• OpenTelemetry Collector 管理：自动部署、配置和维护 OpenTelemetry Collector 实例，支持多模式（DaemonSet、Deployment、StatefulSet）部署。
• Instrumentation 资源管理：通过 Kubernetes CRD（Instrumentation）统一配置应用的自动 instrumentation（如 Java、Python、Node.js 等运行时的 tracer 注入）。
• 资源生命周期管理：自动处理 OpenTelemetry 资源的创建、更新和删除，确保集群内遥测配置一致性。
• 与 Sumo Logic 集成优化：预配置与 Sumo Logic 后端兼容的遥测数据导出路径，简化数据流向 Sumo Logic 平台的配置流程。

2.2 关键特性

• 声明式配置：通过 Kubernetes CRD 定义遥测策略，支持版本化和 GitOps 工作流。
• 自动注入：支持基于 Instrumentation 资源的 Pod 动态 instrumentation 注入，无需修改应用代码。
• 高可用性：支持 Collector 实例的自动扩缩容和故障恢复。
• 可观测性：内置 Operator 自身的 metrics 和日志，便于监控其运行状态。

3. 使用场景和适用范围

3.1 典型使用场景

• Kubernetes 集群遥测数据收集：在 Kubernetes 环境中统一收集容器、节点及应用的日志、指标和追踪数据，并导出至 Sumo Logic。
• 分布式追踪部署：通过 Instrumentation 资源快速为集群内应用启用分布式追踪，无需手动配置 SDK。
• 大规模 Collector 管理：在多团队、多环境的 Kubernetes 集群中，集中管理不同用途的 OpenTelemetry Collector 实例（如基础设施监控、应用监控）。

3.2 适用范围

• 环境要求：Kubernetes 1.21+ 集群（兼容上游 OpenTelemetry Operator 的最低 K8s 版本）。
• 用户群体：需要向 Sumo Logic 平台导出 Kubernetes 遥测数据的 DevOps 团队、SRE 团队及平台工程师。
• 集成场景：与 Sumo Logic Kubernetes Collection 其他组件（如 Fluent Bit、Metrics Server）协同工作，构建完整的可观测性 pipeline。

4. 使用方法和配置说明

4.1 部署前提

• 已安装 Kubernetes 集群（1.21+），且具备集群管理员权限。
• 已配置 kubectl 工具并连接目标集群。
• （可选）已安装 Helm 3（推荐通过 Sumo Logic Kubernetes Collection Helm Chart 部署）。

4.2 部署方式

4.2.1 通过 Sumo Logic Kubernetes Collection Helm Chart 部署（推荐）

Sumo Logic Kubernetes Collection 项目提供官方 Helm Chart，可一键部署包含本 Operator 在内的完整遥测栈：

bash
# 添加 Sumo Logic Helm 仓库
helm repo add sumologic https://sumologic.github.io/sumologic-kubernetes-collection
helm repo update

# 部署（需提前准备 Sumo Logic 访问密钥，参考官方文档配置 values.yaml）
helm install sumologic sumologic/sumologic \
  --namespace sumologic --create-namespace \
  --set sumologic.accessId=<YOUR_ACCESS_ID> \
  --set sumologic.accessKey=<YOUR_ACCESS_KEY> \
  --set sumologic.endpoint=<YOUR_SUMO_ENDPOINT>

4.2.2 手动部署（基于上游 Operator 资源清单）

若需单独部署本镜像，可基于上游 Operator 部署清单修改镜像地址：

bash
# 下载上游 Operator 部署清单（以 v0.94.0 为例，版本需与 Sumo Logic 兼容）
curl -O https://raw.githubusercontent.com/open-telemetry/opentelemetry-operator/v0.94.0/manifests/opentelemetry-operator.yaml

# 替换镜像为 Sumo Logic 使用的版本（需从 Sumo Logic 文档获取具体镜像 tag）
sed -i 's|image: ghcr.io/open-telemetry/opentelemetry-operator/opentelemetry-operator:.*|image: sumologic/opentelemetry-operator:latest|g' opentelemetry-operator.yaml

# 部署至集群
kubectl apply -f opentelemetry-operator.yaml -n opentelemetry-operator-system

4.3 配置参数

4.3.1 Operator 自身配置（环境变量）

4.3.2 OpenTelemetry Collector 配置（通过 CRD）

通过 OpenTelemetryCollector CRD 定义 Collector 实例，示例（导出至 Sumo Logic）：

yaml
apiVersion: opentelemetry.io/v1beta1
kind: OpenTelemetryCollector
metadata:
  name: sumologic-collector
  namespace: sumologic
spec:
  mode: daemonset
  config: |
    receivers:
      otlp:
        protocols:
          grpc:
          http:
    processors:
      batch:
    exporters:
      sumologic:
        endpoint: "https://<YOUR_SUMO_ENDPOINT>/receiver/v1/http/<YOUR_HTTP_SOURCE_URL>"
    service:
      pipelines:
        traces:
          receivers: [otlp]
          processors: [batch]
          exporters: [sumologic]
        metrics:
          receivers: [otlp]
          processors: [batch]
          exporters: [sumologic]

4.3.3 Instrumentation 配置（应用自动注入）

通过 Instrumentation CRD 配置应用的自动 instrumentation：

yaml
apiVersion: opentelemetry.io/v1alpha1
kind: Instrumentation
metadata:
  name: sumologic-instrumentation
  namespace: sumologic
spec:
  exporter:
    endpoint: http://sumologic-collector-collector:4317  # 指向 Collector 的 gRPC 端点
  propagators:
    - tracecontext
    - baggage
  sampler:
    type: parentbased_always_on
  java:
    image: ghcr.io/open-telemetry/opentelemetry-operator/autoinstrumentation-java:latest
  python:
    image: ghcr.io/open-telemetry/opentelemetry-operator/autoinstrumentation-python:latest

5. 部署示例

5.1 Kubernetes Deployment 示例（Operator 部署）

yaml
apiVersion: apps/v1
kind: Deployment
metadata:
  name: opentelemetry-operator
  namespace: opentelemetry-operator-system
spec:
  replicas: 1
  selector:
    matchLabels:
      name: opentelemetry-operator
  template:
    metadata:
      labels:
        name: opentelemetry-operator
    spec:
      containers:
      - name: opentelemetry-operator
        image: sumologic/opentelemetry-operator:latest  # Sumo Logic 镜像
        ports:
        - containerPort: 8080  # metrics 端口
        - containerPort: 8081  # 健康检查端口
        env:
        - name: OPERATOR_LOG_LEVEL
          value: "info"
        - name: WATCH_NAMESPACE
          value: "sumologic"  # 仅监控 sumologic 命名空间
        resources:
          limits:
            cpu: 500m
            memory: 256Mi
          requests:
            cpu: 100m
            memory: 64Mi

5.2 Helm 部署参数示例（Sumo Logic Collection）

通过 Helm values 自定义 Operator 配置：

yaml
opentelemetry-operator:
  enabled: true
  image:
    repository: sumologic/opentelemetry-operator
    tag: latest
  env:
    - name: OPERATOR_LOG_LEVEL
      value: "debug"
  resources:
    limits:
      cpu: 1000m
      memory: 512Mi

部署命令：

bash
helm upgrade --install sumologic sumologic/sumologic \
  --namespace sumologic --create-namespace \
  -f custom-values.yaml  # 包含上述自定义参数