Alauda Distributed Tracing
  • 简体中文

    • 使用 Elasticsearch 安装 Alauda Distributed Tracing

    安装 Alauda Distributed Tracing 平台涉及以下步骤：

    1. 安装 Alauda Build of OpenTelemetry v2 Operator
    2. 部署 Alauda Build of Jaeger v2
    3. 部署 OpenTelemetry Collector 以将 traces 转发到 Jaeger

    目录

    安装 Alauda Build of OpenTelemetry v2 Operator通过 Web 控制台安装通过 CLI 安装部署 Alauda Build of Jaeger v2部署 OpenTelemetry Collector验证（可选）启用 Service Performance Monitoring (SPM)卸载

    安装 Alauda Build of OpenTelemetry v2 Operator

    Alauda Build of OpenTelemetry v2 Operator 负责管理 Jaeger v2 和 OpenTelemetry Collector 实例的生命周期。您必须先安装此 Operator，然后才能部署任何 tracing 组件。

    通过 Web 控制台安装

    请按照 Alauda Build of OpenTelemetry v2 文档中 通过 Web 控制台安装 部分的说明进行操作。

    通过 CLI 安装

    请按照 Alauda Build of OpenTelemetry v2 文档中 通过 CLI 安装 部分的说明进行操作。

    部署 Alauda Build of Jaeger v2

    Jaeger v2 作为由 Alauda Build of OpenTelemetry v2 Operator 管理的 OpenTelemetryCollector 自定义资源进行部署。它使用 backend storage，并通过 OAuth2 Proxy sidecar 与 Alauda Container Platform 身份验证系统集成。

    前提条件

    • 已安装 Alauda Build of OpenTelemetry v2 Operator。
    • 可用的 Elasticsearch 8.x 实例，并且您拥有其 endpoint URL、username 和 password。
    • 由具有 cluster-admin 角色的 cluster administrator 建立的有效 ACP CLI (kubectl) 会话。
    • 已安装 jq 命令行工具。

    操作步骤

    1. 设置用于连接 Elasticsearch 的可配置环境变量：

      export ES_ENDPOINT='<Elasticsearch endpoint URL>'
export ES_USER='<Elasticsearch username>'
export ES_PASS='<Elasticsearch password>'

      请将占位符值替换为您的实际 Elasticsearch 凭证。

    2. 从集群中获取平台配置和与 Jaeger 相关的容器镜像：

      export PLATFORM_URL=$(kubectl -nkube-public get configmap global-info -o jsonpath='{.data.platformURL}')
export CLUSTER_NAME=$(kubectl -nkube-public get configmap global-info -o jsonpath='{.data.clusterName}')
export ALB_CLASS_NAME=$(kubectl -nkube-public get configmap global-info -o jsonpath='{.data.systemAlbIngressClassName}')

export OIDC_ISSUER=$(kubectl -nkube-public get configmap global-info -o jsonpath='{.data.oidcIssuer}')
OIDC_CLIENT_SECRET_REF=$(kubectl -nkube-public get configmap global-info -o jsonpath='{.data.oidcClientSecretRef}')
if [ -n "$OIDC_CLIENT_SECRET_REF" ]; then
  SYSTEM_NAMESPACE=$(kubectl -nkube-public get configmap global-info -o jsonpath='{.data.systemNamespace}')
  export OIDC_CLIENT_ID=$(kubectl -n"$SYSTEM_NAMESPACE" get secret "$OIDC_CLIENT_SECRET_REF" -o go-template='{{index .data "client-id"}}' | base64 -d)
  export OIDC_CLIENT_SECRET=$(kubectl -n"$SYSTEM_NAMESPACE" get secret "$OIDC_CLIENT_SECRET_REF" -o go-template='{{index .data "client-secret"}}' | base64 -d)
else
  export OIDC_CLIENT_ID=$(kubectl -nkube-public get configmap global-info -o jsonpath='{.data.oidcClientID}')
  export OIDC_CLIENT_SECRET=$(kubectl -nkube-public get configmap global-info -o jsonpath='{.data.oidcClientSecret}')
fi

JAEGER_RELATED_IMAGES=$(kubectl get csv -n opentelemetry-operator2 \
  -l 'operators.coreos.com/opentelemetry-operator2.opentelemetry-operator2=' \
  -o jsonpath='{.items[0].spec.relatedImages}')
export JAEGER_IMAGE=$(echo "$JAEGER_RELATED_IMAGES" | jq -r '.[] | select(.name=="component.jaeger") | .image')
export JAEGER_ES_ROLLOVER_IMAGE=$(echo "$JAEGER_RELATED_IMAGES" | jq -r '.[] | select(.name=="component.jaeger-es-rollover") | .image')
export JOAUTH2_PROXY_IMAGE=$(echo "$JAEGER_RELATED_IMAGES" | jq -r '.[] | select(.name=="component.oauth2-proxy") | .image')
      NOTE

      请确认命令已执行完毕且没有错误。

    3. 设置默认环境变量。您可以根据部署需求调整这些值：

      # Namespace for the Jaeger instance
export JAEGER_NS="jaeger-system"
# Name of the Jaeger instance
export JAEGER_INSTANCE_NAME="jaeger"
# Elasticsearch index prefix for Jaeger data
export JAEGER_ES_INDEX_PREFIX="acp-${CLUSTER_NAME}"
# Base path for the Jaeger UI
export JAEGER_BASEPATH="/clusters/${CLUSTER_NAME}/jaeger"

    4. 创建 Jaeger namespace 和 Elasticsearch 凭证 Secret：

      kubectl get namespace ${JAEGER_NS} &> /dev/null || kubectl create namespace ${JAEGER_NS}

kubectl create secret generic es-credentials \
  --namespace=${JAEGER_NS} \
  --from-literal=ES_USER=${ES_USER} \
  --from-literal=ES_PASS=${ES_PASS} \
  --dry-run=client -o yaml | kubectl apply -f -

      验证 Secret 是否已创建：

      kubectl get secret es-credentials -n ${JAEGER_NS}

    5. 在 Elasticsearch 中创建 ILM (Index Lifecycle Management) Policy。Jaeger 使用 ILM 来管理索引 rollover 和保留策略：

      curl -k -u "${ES_USER}:${ES_PASS}" -X PUT \
  "${ES_ENDPOINT}/_ilm/policy/jaeger-ilm-policy" \
  -H 'Content-Type: application/json' \
  --data-binary @- << 'EOF'
{
  "policy": {
    "phases": {
      "hot": {
        "min_age": "0ms",
        "actions": {
          "rollover": {
            "max_primary_shard_size": "50gb",
            "max_age": "1d"
          },
          "set_priority": {
            "priority": 100
          }
        }
      },
      "delete": {
        "min_age": "7d",
        "actions": {
          "delete": {}
        }
      }
    }
  }
}
EOF

      关键字段：

      • policy.phases.hot.actions.rollover.max_primary_shard_size：单个 primary shard 的最大大小。当 shard 超过此大小时，将触发 rollover 以创建新索引。默认值：50gb。
      • policy.phases.hot.actions.rollover.max_age：在触发 rollover 前索引允许存在的最长期限。默认值：1d（1 天）。
      • policy.phases.delete.min_age：rollover 之后，在删除旧索引前等待的时间。默认值：7d（7 天）。

      验证 ILM Policy：

      curl -k -u "${ES_USER}:${ES_PASS}" "${ES_ENDPOINT}/_ilm/policy/jaeger-ilm-policy?pretty"

      输出应显示 ILM Policy 详细信息，包括 hot 和 delete 阶段。

    6. 使用 jaeger-es-rollover 工具初始化索引别名和模板。这将为 Jaeger 数据存储准备 Elasticsearch：

      kubectl apply -n ${JAEGER_NS} -f - <<EOF
apiVersion: batch/v1
kind: Job
metadata:
  name: jaeger-es-rollover-init
spec:
  template:
    spec:
      containers:
      - name: es-rollover-init
        image: "${JAEGER_ES_ROLLOVER_IMAGE}"
        args:
          - init
          - "${ES_ENDPOINT}"
        env:
        - name: INDEX_PREFIX
          value: "${JAEGER_ES_INDEX_PREFIX}"
        - name: ES_USE_ILM
          value: "true"
        - name: ES_TLS_ENABLED
          value: "true"
        - name: ES_TLS_SKIP_HOST_VERIFY
          value: "true"
        - name: ES_USERNAME
          valueFrom:
            secretKeyRef:
              name: es-credentials
              key: ES_USER
        - name: ES_PASSWORD
          valueFrom:
            secretKeyRef:
              name: es-credentials
              key: ES_PASS
      restartPolicy: Never
  backoffLimit: 3
EOF

      等待 Job 完成，然后验证索引模板和别名是否已创建：

      kubectl wait --for=condition=complete job/jaeger-es-rollover-init \
  -n ${JAEGER_NS} --timeout=120s

# Verify index templates
curl -k -sS -u "${ES_USER}:${ES_PASS}" "${ES_ENDPOINT}/_index_template?pretty" \
  | grep ${JAEGER_ES_INDEX_PREFIX}-jaeger-

# Verify index aliases
curl -k -sS -u "${ES_USER}:${ES_PASS}" "${ES_ENDPOINT}/_alias?pretty" \
  | grep ${JAEGER_ES_INDEX_PREFIX}-jaeger-

      预期结果如下：

      • Job 状态为 Complete。
      • Elasticsearch 中存在与 ${JAEGER_ES_INDEX_PREFIX}-jaeger-* 匹配的索引模板。
      • Elasticsearch 中存在 ${JAEGER_ES_INDEX_PREFIX}-jaeger-*-read 和 ${JAEGER_ES_INDEX_PREFIX}-jaeger-*-write 的索引别名。

    7. Job 完成后清理初始化 Job：

      kubectl delete job jaeger-es-rollover-init -n ${JAEGER_NS}

    8. 为 OAuth2 Proxy 创建一个 Secret，用于将 Jaeger UI 与 Alauda Container Platform 身份验证集成：

      # Generate a cookie secret for the OAuth2 Proxy:
OAUTH2_PROXY_COOKIE_SECRET=$(dd if=/dev/urandom bs=32 count=1 2>/dev/null | base64 | tr -d -- '\n' | tr -- '+/' '-_')
# Create the Secret:
kubectl create secret generic ${JAEGER_INSTANCE_NAME}-oauth2-proxy \
  --namespace=${JAEGER_NS} \
  --from-literal=OAUTH2_PROXY_CLIENT_SECRET=${OIDC_CLIENT_SECRET} \
  --from-literal=OAUTH2_PROXY_COOKIE_SECRET=${OAUTH2_PROXY_COOKIE_SECRET} \
  --dry-run=client -o yaml | kubectl apply -f -

    9. 创建名为 jaeger.yaml 的文件，内容如下：

      jaeger.yaml
      apiVersion: opentelemetry.io/v1beta1
kind: OpenTelemetryCollector
metadata:
  labels:
    prometheus: kube-prometheus
  name: ${JAEGER_INSTANCE_NAME}
  namespace: ${JAEGER_NS}
spec:
  image: "${JAEGER_IMAGE}"
  mode: deployment
  replicas: 1

  resources:
    requests:
      cpu: 100m
      memory: 256Mi
    limits:
      cpu: "2"
      memory: 2Gi

  ports:
    - name: oauth2-proxy
      port: 4180
    - name: jaeger-grpc
      port: 16685

  observability:
    metrics:
      enableMetrics: true

  volumes:
    - name: es-credentials
      secret:
        secretName: es-credentials
        items:
          - key: ES_PASS
            path: pass
    - name: oauth2-proxy-secrets
      secret:
        secretName: ${JAEGER_INSTANCE_NAME}-oauth2-proxy
        items:
          - key: OAUTH2_PROXY_CLIENT_SECRET
            path: client-secret
          - key: OAUTH2_PROXY_COOKIE_SECRET
            path: cookie-secret
  volumeMounts:
    - name: es-credentials
      mountPath: /etc/jaeger/es-credentials
      readOnly: true

  config:
    receivers:
      otlp:
        protocols:
          grpc:
            endpoint: "0.0.0.0:4317"
          http:
            endpoint: "0.0.0.0:4318"

    processors:
      batch: {}
      memory_limiter:
        check_interval: 1s
        limit_percentage: 80
        spike_limit_percentage: 20

    exporters:
      debug: {}
      jaeger_storage_exporter:
        trace_storage: es_storage

    extensions:
      healthcheckv2:
        use_v2: true
        http:
          endpoint: "0.0.0.0:13133"

      jaeger_storage:
        backends:
          es_storage:
            elasticsearch:
              server_urls:
                - "${ES_ENDPOINT}"
              auth:
                basic:
                  username: "${ES_USER}"
                  password_file: /etc/jaeger/es-credentials/pass
              tls:
                insecure_skip_verify: true
              use_aliases: true
              use_ilm: true
              service_cache_ttl: 12h
              create_mappings: false
              indices:
                index_prefix: "${JAEGER_ES_INDEX_PREFIX}"
                spans:
                  shards: 5
                  replicas: 1
                services:
                  shards: 5
                  replicas: 1
                dependencies:
                  shards: 5
                  replicas: 1
                sampling:
                  shards: 5
                  replicas: 1

      jaeger_query:
        storage:
          traces: es_storage
        ui:
          config_file: ""
        base_path: "${JAEGER_BASEPATH}"
        http:
          endpoint: 0.0.0.0:16686

    service:
      extensions: [healthcheckv2, jaeger_storage, jaeger_query]
      pipelines:
        traces:
          receivers: [otlp]
          processors: [memory_limiter, batch]
          exporters: [debug, jaeger_storage_exporter]
      telemetry:
        resource:
          service.name: jaeger
        metrics:
          level: detailed
          readers:
            - pull:
                exporter:
                  prometheus:
                    host: "0.0.0.0"
                    port: 8888
                    without_scope_info: true
                    without_type_suffix: true
                    without_units: true
        logs:
          level: info

  additionalContainers:
    - name: oauth2-proxy
      image: ${JOAUTH2_PROXY_IMAGE}
      args:
        - --http-address=0.0.0.0:4180
        - --upstream=http://127.0.0.1:16686
        - --proxy-prefix=${JAEGER_BASEPATH}/oauth2
        - --redirect-url=${PLATFORM_URL}${JAEGER_BASEPATH}/oauth2/callback
        - --provider=oidc
        - --oidc-issuer-url=${OIDC_ISSUER}
        - --scope=openid profile email groups ext
        - --email-domain=*
        - --code-challenge-method=S256
        - --insecure-oidc-allow-unverified-email=true
        - --cookie-secure=false
        - --skip-provider-button=true
        - --ssl-insecure-skip-verify=true
        - --skip-jwt-bearer-tokens=true
        - --client-id=${OIDC_CLIENT_ID}
        - --client-secret-file=/etc/oauth2-proxy/client-secret
        - --cookie-secret-file=/etc/oauth2-proxy/cookie-secret
      resources:
        requests:
          cpu: 50m
          memory: 64Mi
        limits:
          cpu: 500m
          memory: 256Mi
      volumeMounts:
        - name: oauth2-proxy-secrets
          mountPath: /etc/oauth2-proxy
          readOnly: true
      ports:
        - containerPort: 4180
          name: oauth2-proxy
          protocol: TCP
      1. prometheus: kube-prometheus 标签会被自动创建的 ServiceMonitor 资源继承，使 ACP Prometheus 能够抓取 Jaeger 指标。
      2. Jaeger v2 容器镜像。这不是默认的 OpenTelemetry Collector 镜像；它是基于 OpenTelemetry Collector 框架构建的自定义 Jaeger 二进制文件。
      3. 为 Jaeger 实例启用 Prometheus metrics endpoint。
      4. Jaeger 容器的资源 requests 和 limits。请根据预期的 trace 量进行调整；吞吐量更高的环境可能需要更多 CPU 和 memory。
      5. jaeger_storage 扩展配置用于存储 trace 数据的 Elasticsearch backend。
      6. service_cache_ttl 控制 service name cache 的保留时间。默认值为 12h。如果 ILM 的 hot-to-delete 间隔较短，请减小此值，以确保 Jaeger UI 能够及时发现 services。
      7. 使用 ILM 模式时，create_mappings 必须设置为 false，因为 index mappings 由 rollover 初始化过程管理。
      8. index_prefix 必须与第 6 步中 jaeger-es-rollover 初始化时使用的前缀一致。有关 shards 和 replicas 调优的更多详情，请参见 Shards and Replicas。
      9. jaeger_query 扩展提供 Jaeger Query API 和 Jaeger UI。
      10. additionalContainers 部分定义了 OAuth2 Proxy sidecar，它通过与 Alauda Container Platform Dex identity provider 集成来处理 Jaeger UI 的身份验证。
      11. OAuth2 Proxy sidecar 的资源 requests 和 limits。由于该容器只负责代理身份验证请求，因此其资源需求较低。

    10. 使用 envsubst 渲染清单并应用配置：

      envsubst < jaeger.yaml | kubectl apply -f -

    11. 等待 Jaeger Pod 就绪：

      kubectl rollout status deployment/${JAEGER_INSTANCE_NAME}-collector \
  -n ${JAEGER_NS} --timeout=180s

    12. 为 namespace 添加标签并创建 Ingress 以暴露 Jaeger UI：

      kubectl label namespace ${JAEGER_NS} cpaas.io/project=cpaas-system --overwrite
      kubectl apply -n ${JAEGER_NS} -f - <<EOF
apiVersion: networking.k8s.io/v1
kind: Ingress
metadata:
  name: ${JAEGER_INSTANCE_NAME}
  annotations:
    nginx.ingress.kubernetes.io/enable-cors: "true"
spec:
  ingressClassName: ${ALB_CLASS_NAME}
  rules:
    - http:
        paths:
          - path: ${JAEGER_BASEPATH}
            pathType: ImplementationSpecific
            backend:
              service:
                name: ${JAEGER_INSTANCE_NAME}-collector
                port:
                  number: 4180
EOF

      等待 Ingress 就绪：

      kubectl wait --for=jsonpath='{.status.loadBalancer.ingress}' ingress/${JAEGER_INSTANCE_NAME} \
  -n ${JAEGER_NS} --timeout=180s

    验证

    访问 <platform-url>/clusters/<cluster-name>/jaeger 上的 Jaeger UI，其中 <platform-url> 是 Alauda Container Platform 的 URL，<cluster-name> 是您的 cluster 名称。

    运行以下命令以输出 Jaeger UI URL：

    echo "Jaeger UI: ${PLATFORM_URL}${JAEGER_BASEPATH}"

    部署 OpenTelemetry Collector

    在 Jaeger v2 运行后，部署一个 OpenTelemetry Collector 实例，用于接收已埋点应用发送的 trace 数据并将其转发到 Jaeger。

    1. 创建名为 otel-collector.yaml 的文件，内容如下：

      otel-collector.yaml
      apiVersion: opentelemetry.io/v1beta1
kind: OpenTelemetryCollector
metadata:
  labels:
    prometheus: kube-prometheus
  name: otel
  namespace: ${JAEGER_NS}
spec:
  mode: deployment
  replicas: 1
  resources:
    requests:
      cpu: 100m
      memory: 256Mi
    limits:
      cpu: "2"
      memory: 2Gi
  observability:
    metrics:
      enableMetrics: true
  config:
    receivers:
      otlp:
        protocols:
          grpc:
            endpoint: 0.0.0.0:4317
          http:
            endpoint: 0.0.0.0:4318
      zipkin: {}
    processors:
      batch: {}
      memory_limiter:
        check_interval: 1s
        limit_percentage: 80
        spike_limit_percentage: 20
    exporters:
      debug: {}
      otlp/traces:
        endpoint: "${JAEGER_INSTANCE_NAME}-collector.${JAEGER_NS}.svc.cluster.local:4317"
        tls:
          insecure: true
      prometheus:
        add_metric_suffixes: false
        endpoint: "0.0.0.0:8889"
        resource_to_telemetry_conversion:
          enabled: true # by default resource attributes are dropped
    service:
      pipelines:
        traces:
          receivers: [otlp, zipkin]
          processors: [memory_limiter, batch]
          exporters: [debug, otlp/traces] 
        metrics:
          receivers: [otlp]
          processors: [memory_limiter, batch]
          exporters: [debug, prometheus]
      telemetry:
        metrics:
          readers:
          - pull:
              exporter:
                prometheus:
                  host: 0.0.0.0
                  port: 8888
                  without_scope_info: true
                  without_type_suffix: true
                  without_units: true
      1. prometheus: kube-prometheus 标签使 ACP Prometheus 能够通过自动创建的 ServiceMonitor 抓取 Collector 指标。
      2. Collector 容器的资源 requests 和 limits。请根据预期的 trace 吞吐量进行调整。
      3. 使 Operator 能够自动为 Collector 的 metrics endpoint 创建 ServiceMonitor 资源。
      4. OTLP receiver 通过 gRPC（端口 4317）和 HTTP（端口 4318）接收来自已埋点应用的 trace 数据。
      5. otlp/traces exporter 将收到的 traces 转发到 Jaeger collector service。该 endpoint 由 Jaeger 实例名称和 namespace 派生而来。
      6. trace pipeline 通过 OTLP 和 Zipkin 接收数据，经过 memory_limiter 和 batch 处理后，同时导出到 debug exporter（用于日志记录）和 otlp/traces（用于转发到 Jaeger）。

    2. 使用 envsubst 渲染清单并应用配置：

      envsubst < otel-collector.yaml | kubectl apply -f -

    3. 等待 Collector pod 就绪：

      kubectl rollout status deployment/otel-collector \
  -n ${JAEGER_NS} --timeout=180s

    验证

    在安装所有组件后，通过生成示例 trace 数据来验证端到端 tracing pipeline。

    1. 将 telemetrygen 作为测试客户端部署，以生成示例 traces：

      kubectl apply -f - <<EOF
apiVersion: v1
kind: Pod
metadata:
  name: telemetrygen
  namespace: ${JAEGER_NS}
spec:
  restartPolicy: Never
  containers:
    - name: telemetrygen
      image: ghcr.io/open-telemetry/opentelemetry-collector-contrib/telemetrygen:latest
      args:
        - traces
        - --otlp-endpoint=otel-collector.${JAEGER_NS}.svc.cluster.local:4317
        - --otlp-insecure
        - --duration=150s
        - --interval=5s
        - --child-spans=3
        - --rate=2
        - --service=telemetrygen
        - --workers=1
EOF
# Wait for telemetrygen to complete, then clean up the test Pod
kubectl wait -n ${JAEGER_NS} --for=jsonpath='{.status.phase}'=Succeeded pod/telemetrygen --timeout=10m
kubectl delete pod -n ${JAEGER_NS} telemetrygen
      NOTE

      --otlp-endpoint 必须指向上一步部署的 OpenTelemetry Collector service。

    2. 打开 <platform-url>/clusters/<cluster-name>/jaeger 上的 Jaeger UI。

      从 Service 下拉框中选择 telemetrygen service，然后点击 Find Traces，以验证生成的 traces 是否可见。

      运行以下命令以输出 Jaeger UI URL：

      echo "Jaeger UI: ${PLATFORM_URL}${JAEGER_BASEPATH}"

    （可选）启用 Service Performance Monitoring (SPM)

    Service Performance Monitoring (SPM) 会在 Jaeger UI 中以 Monitor 选项卡的形式显示，通过聚合 span 数据生成 RED（Request, Error, Duration）指标。这使您无需预先了解 service 或 operation 名称即可识别性能问题。更多详情请参见 Service Performance Monitoring (SPM)。

    启用 SPM 需要在 Jaeger 内部 运行 SpanMetrics Connector 来生成 RED 指标，并通过 loadbalancing exporter 将来自前端 OpenTelemetry Collector 的 spans 路由到 Jaeger，这样即使两个组件都运行多个 replicas，指标也能保持准确。Jaeger 会在 Prometheus endpoint 上公开这些指标，并通过兼容 PromQL 的 backend 将它们提供给 Monitor 选项卡。

    前提条件

    • 已部署 Jaeger v2 和 OpenTelemetry Collector（已完成前面的所有步骤）。
    • 集群中可用 ACP monitoring。

    操作步骤

    1. 从集群中获取 monitoring endpoint 和凭证：

      export MONITORING_URL=$(kubectl get feature monitoring -o jsonpath='{.spec.accessInfo.database.address}')
MONITORING_SECRET_NAME=$(kubectl get feature monitoring -o jsonpath='{.spec.accessInfo.database.basicAuth.secretName}')

export MONITORING_USERNAME=$(kubectl -ncpaas-system get secret "$MONITORING_SECRET_NAME" -o jsonpath="{.data.username}" | base64 -d)
export MONITORING_PASSWORD=$(kubectl -ncpaas-system get secret "$MONITORING_SECRET_NAME" -o jsonpath="{.data.password}" | base64 -d)

    2. 为 monitoring 凭证创建 Secret：

      kubectl create secret generic monitoring-credentials \
  --namespace=${JAEGER_NS} \
  --from-literal=username=${MONITORING_USERNAME} \
  --from-literal=password=${MONITORING_PASSWORD} \
  --dry-run=client -o yaml | kubectl apply -f -

    3. 修补 OpenTelemetry Collector，使其通过 loadbalancing exporter 而不是直接使用 otlp/traces exporter 将 spans 转发到 Jaeger。使用 routing_key: service 后，某个 service 的所有 spans 会始终发送到同一个 Jaeger replica，因此下一步在 Jaeger 内部运行的 SpanMetrics Connector 会对每个 service 仅聚合一次。这就是在 Collector 或 Jaeger 运行多个 replicas 时仍能保持指标正确的原因：

      kubectl patch opentelemetrycollector otel -n ${JAEGER_NS} --type=merge -p "
spec:
  config:
    exporters:
      loadbalancing:
        routing_key: service
        protocol:
          otlp:
            tls:
              insecure: true
        resolver:
          dns:
            hostname: ${JAEGER_INSTANCE_NAME}-collector-headless.${JAEGER_NS}.svc.cluster.local
            port: '4317' # the dns resolver requires the port as a string
    service:
      pipelines:
        traces:
          exporters: [debug, loadbalancing]
"

      dns resolver 会通过 OpenTelemetry Operator 自动配置的 headless Service（${JAEGER_INSTANCE_NAME}-collector-headless）发现每个 Jaeger collector Pod，因此无需额外的 Service 或 RBAC。

      等待 Collector 重启：

      kubectl rollout status deployment/otel-collector \
  -n ${JAEGER_NS} --timeout=180s

    4. 创建名为 jaeger-spm-patch.yaml 的文件，内容如下。此 patch 会在 Jaeger 内部运行 SpanMetrics Connector，将生成的 RED 指标暴露在 Prometheus endpoint 上，并添加一个 PromQL metrics backend，以便 Jaeger 能将这些指标提供给 Monitor 选项卡：

      jaeger-spm-patch.yaml
      spec:
  volumes:
    - name: es-credentials
      secret:
        secretName: es-credentials
        items:
          - key: ES_PASS
            path: pass
    - name: oauth2-proxy-secrets
      secret:
        secretName: ${JAEGER_INSTANCE_NAME}-oauth2-proxy
        items:
          - key: OAUTH2_PROXY_CLIENT_SECRET
            path: client-secret
          - key: OAUTH2_PROXY_COOKIE_SECRET
            path: cookie-secret
    - name: monitoring-credentials
      secret:
        secretName: monitoring-credentials
        items:
          - key: username
            path: user
          - key: password
            path: pass
  volumeMounts:
    - name: es-credentials
      mountPath: /etc/jaeger/es-credentials
      readOnly: true
    - name: monitoring-credentials
      mountPath: /etc/jaeger/monitoring-credentials
      readOnly: true
  config:
    connectors:
      spanmetrics: {} 
    exporters:
      prometheus:
        add_metric_suffixes: false # Jaeger expects standard OTel metric names without _total suffixes
        endpoint: "0.0.0.0:8889"
        resource_to_telemetry_conversion:
          enabled: true
    extensions:
      basicauth/monitoring:
        client_auth:
          username_file: /etc/jaeger/monitoring-credentials/user
          password_file: /etc/jaeger/monitoring-credentials/pass
      jaeger_storage:
        metric_backends:
          monitoring_metrics_storage:
            prometheus:
              endpoint: ${MONITORING_URL}
              tls:
                insecure_skip_verify: true
              auth:
                authenticator: basicauth/monitoring
      jaeger_query:
        storage:
          metrics: monitoring_metrics_storage
    service:
      extensions: [basicauth/monitoring, healthcheckv2, jaeger_storage, jaeger_query] 
      pipelines:
        traces:
          exporters: [debug, jaeger_storage_exporter, spanmetrics]
        metrics/spanmetrics:
          receivers: [spanmetrics]
          exporters: [prometheus]
      1. monitoring-credentials volume 会将 monitoring basic-auth 凭证挂载到 Jaeger 容器中。
      2. monitoring-credentials volumeMount 会使凭证可在 /etc/jaeger/monitoring-credentials/ 下访问。
      3. spanmetrics connector 会根据 Jaeger 接收到的 spans 生成 RED 指标。由于 Collector 会将每个 service 路由到单个 Jaeger replica，因此每个 replica 都能正确聚合一组互不重叠的 services。
      4. prometheus exporter 会在端口 8889 上暴露生成的指标。Jaeger 实例已经带有 prometheus: kube-prometheus 标签以及 observability.metrics.enableMetrics: true（在 jaeger.yaml 中设置），因此 Operator 会自动创建 ServiceMonitor，让 ACP Prometheus 可以抓取此 endpoint。
      5. basicauth/monitoring 扩展为 monitoring metrics endpoint 提供 basic authentication。
      6. metric_backends 部分配置了 Jaeger 用于查询 SPM 数据的、兼容 PromQL 的 metrics 存储。
      7. 在 jaeger_query 扩展中引用 metrics store。
      8. 必须将 basicauth/monitoring 扩展添加到 service.extensions 列表中才能生效。
      9. traces pipeline 现在也会导出到 spanmetrics（存储加指标生成），并且专门的 metrics/spanmetrics pipeline 会将生成的指标转发到 prometheus exporter。
      WARNING

      volumes、volumeMounts、service.extensions 和 pipeline 的 exporters 字段都是数组。merge patch 会整体替换数组，而不是向其追加内容。上面的 patch 文件包含了所有现有条目以及新增条目，以防止数据丢失。

    5. 应用 patch：

      kubectl patch opentelemetrycollector ${JAEGER_INSTANCE_NAME} -n ${JAEGER_NS} \
  --type=merge -p "$(envsubst < jaeger-spm-patch.yaml)"

      等待 Jaeger 重启：

      kubectl rollout status deployment/${JAEGER_INSTANCE_NAME}-collector \
  -n ${JAEGER_NS} --timeout=180s
    扩展到多个 replicas

    若要以高可用方式运行 SPM，请增加 otel 和 ${JAEGER_INSTANCE_NAME} collectors 上的 spec.replicas；无需进行其他更改。无状态的 Collector 层可以自由扩展，并且由于 spans 按 service 进行负载均衡，每个 Jaeger replica 都拥有一组互不重叠的 services，并且能够无冲突地进行聚合。

    验证

    启用 SPM 后，您可以按照上面的 Verification 部分所述，部署 telemetrygen 测试客户端进行验证。

    生成 traces 后，转到 Jaeger UI 中的 Monitor 选项卡，即可查看 telemetrygen service 的聚合 RED 指标。

    卸载

    要从集群中移除 Alauda Distributed Tracing 组件，请参阅卸载 Alauda Distributed Tracing。