OpenTelemetry for Kubernetes 指南

首先，你需要在Kubernetes 安装 OpenTelemetry Operator
OpenTelemetry Operator：OpenTelemetry 为了在Kubernetes更好管理Collector，Agent，一种 Kubernetes Operator的具体实现

Kubernetes Operator

Operator 是 Kubernetes 的扩展软件，它利用 定制资源 管理应用及其组件。

OpenTelemetry Operator 管理的组件:

• OpenTelemetry Collector
• 使用 OpenTelemetry 自动构件库完成自动构建

文档

• API 文档

  开始

  安装Operator前, 先确保安装好Kubernetes[cert-manager](https://cert-manager.io/docs/installation/)，安装运行教程参考 install cert-manager :

  kubectl apply -f https://github.com/open-telemetry/opentelemetry-operator/releases/latest/download/opentelemetry-operator.yaml

  opentelemetry-operator deployment 完成后, 对于的Kubernetes 自定义资源会看到：

官方文档给了一个创建 OpenTelemetry Collector (otelcol) 实例, 像这样:

kubectl apply -f - <<EOF
apiVersion: opentelemetry.io/v1alpha1
kind: OpenTelemetryCollector
metadata:
  name: simplest
spec:
  config: |
    receivers:
      otlp:
        protocols:
          grpc:
          http:
    processors:
    exporters:
      logging:
    service:
      pipelines:
        traces:
          receivers: [otlp]
          processors: []
          exporters: [logging]
EOF

更多细节参考官方文档 ，我们这里重点讲部署实践

部署

Kubernete 自定义资源为 OpenTelemetryCollector 暴露了一个参数 .Spec.Mode, 可以通过它配置我们以何种方式启动Collector，目前支持 DaemonSet, Sidecar, or Deployment (缺省).

Sidecar 注入

一个OpenTelemetry Collector的sidecar 可以通过设置pod的声明sidecar.opentelemetry.io/inject 是为 "true"来注入到pod中。或者如果在同一个命名空间，还可以用OpenTelemetryCollector具体名字来注入，像下面的例子

kubectl apply -f - <<EOF
apiVersion: opentelemetry.io/v1alpha1
kind: OpenTelemetryCollector
metadata:
  name: sidecar-for-my-app
spec:
  mode: sidecar
  config: |
    receivers:
      jaeger:
        protocols:
          grpc:
      otlp:
        protocols:
          grpc:
          http:
    processors:
    exporters:
      logging:
    service:
      pipelines:
        traces:
          receivers: [otlp, jaeger]
          processors: []
          exporters: [logging]
EOF
kubectl apply -f - <<EOF
apiVersion: v1
kind: Pod
metadata:
  name: myapp
  annotations:
    sidecar.opentelemetry.io/inject: "true"
spec:
  containers:
  - name: myapp
    image: jaegertracing/vertx-create-span:operator-e2e-tests
    ports:
      - containerPort: 8080
        protocol: TCP
EOF

在Kubernete部署后，从Kubernete看到Opentelemetry sidecar 注入到应用程序中，采集到数据

当多个 OpenTelemetryCollector资源在同一命名空间设置Sidecar 模式时，最好使用具体命名的方式注入。在同一个命名空间通过声明方式注入，只会有一个Sidecar 实例运行。
声明值可以在pod，namespace配置，越细粒度声明，它的优先级越高：

• pod中声明先生效：pod指定了具体命名Collector，或者设置sidecar.opentelemetry.io/inject 为"false"
• namespace 中声明生效： namespace 设置了一个具体的Collector，而且pod 没有声明或者sidecar.opentelemetry.io/inject 为"true"

当我们管理Pod工作资源，采用Deployment or Statefulset模式时，一定要在PodTemplate
部分添加声明，下面有正确、错误两种示例：

kubectl apply -f - <<EOF
apiVersion: apps/v1
kind: Deployment
metadata:
  name: my-app
  labels:
    app: my-app
  annotations:
    sidecar.opentelemetry.io/inject: "true" # WRONG
spec:
  selector:
    matchLabels:
      app: my-app
  replicas: 1
  template:
    metadata:
      labels:
        app: my-app
      annotations:
        sidecar.opentelemetry.io/inject: "true" # CORRECT
    spec:
      containers:
      - name: myapp
        image: jaegertracing/vertx-create-span:operator-e2e-tests
        ports:
          - containerPort: 8080
            protocol: TCP
EOF

兼容矩阵

目前官方给出Opentelemetry 在Kubernetes兼容版本对照图

OpenTelemetry Operator vs. Kubernetes vs. Cert Manager