Alauda Distributed Tracing
  • 简体中文

    • 安装带有 OpenSearch 的 Alauda 分布式追踪

    安装 Alauda 分布式追踪平台包括以下步骤：

    1. 安装 Alauda Build of Jaeger v2 集群插件
    2. 安装 Alauda Build of OpenTelemetry v2 Operator
    3. 部署 Alauda Build of Jaeger v2
    4. 部署 OpenTelemetry Collector，将追踪数据转发到 Jaeger
    NOTE

    从 ACP 4.5 开始，以下插件使用了新名称：

    • Alauda Build of Jaeger v2 更名为 Alauda Container Platform Distributed Tracing。
    • Alauda Build of OpenTelemetry v2 更名为 Alauda Container Platform Application Observability。

    从 customer portal 下载插件时，请搜索新名称。在重命名之前发布的插件包上传到平台后，平台中仍会显示旧名称。

    目录

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

    安装 Alauda Build of Jaeger v2 集群插件

    Alauda Build of Jaeger v2 集群插件提供追踪组件所需的容器镜像：Jaeger（jaeger、jaeger-es-rollover、jaeger-es-index-cleaner）和 OAuth2 Proxy。安装插件会将这些镜像同步到平台的内置 registry，并在目标集群的 cpaas-system 命名空间中创建名为 jaeger-cluster-plugin-manifest 的 ConfigMap。后续步骤会从此 ConfigMap 中读取镜像地址。

    通过 Web 控制台安装

    1. 在平台管理视图中，导航至 管理员 > Marketplace > 集群插件。
    2. 选择要部署追踪组件的集群。
    3. 找到 Alauda Container Platform Distributed Tracing（对于重命名之前发布的插件包，则显示为 Alauda Build of Jaeger v2），然后点击 安装。该插件不需要安装参数。
    NOTE

    如果插件未列出，请从 customer portal 下载插件包，并使用 violet 工具将其发布到平台，或联系技术支持。

    通过 CLI 安装

    无论插件的目标集群是哪个，集群插件都通过在 global 集群中创建 ModuleInfo 资源进行安装。

    1. 在 global 集群中运行以下命令，检查已发布的插件版本：

      kubectl get moduleconfigs -l cpaas.io/module-name=jaeger-cluster-plugin \
  -o custom-columns=NAME:.metadata.name,VERSION:.spec.version

    2. 在 global 集群中创建 ModuleInfo 资源以安装插件。将 <target-cluster> 替换为要部署追踪组件的集群名称，并将 <plugin-version> 替换为上一步中的版本：

      kubectl apply -f - <<EOF
apiVersion: cluster.alauda.io/v1alpha1
kind: ModuleInfo
metadata:
  labels:
    cpaas.io/cluster-name: <target-cluster>
    cpaas.io/module-name: jaeger-cluster-plugin
    cpaas.io/module-type: plugin
  name: <target-cluster>-jaeger-cluster-plugin
spec:
  config: {}
  version: <plugin-version>
EOF

      平台在接收该资源时会重写 metadata.name，并将记录存储为 <target-cluster>-<hash>。之后，所应用的名称将不存在，因此再次运行此命令会针对从未写入的名称报告 AlreadyExists，且不会创建任何内容。请按照下一步所示，通过标签识别该记录。

    3. 在 global 集群中验证安装：

      kubectl get moduleinfo -l cpaas.io/module-name=jaeger-cluster-plugin

      当 STATUS 列显示 Running 时，表示插件已成功安装。

    4. 验证目标集群中是否已创建 ConfigMap（针对目标集群运行）：

      kubectl get configmap jaeger-cluster-plugin-manifest -n cpaas-system

    安装 Alauda Build of OpenTelemetry v2 Operator

    Alauda Build of OpenTelemetry v2 Operator 管理 Jaeger v2 和 OpenTelemetry Collector 实例的生命周期。在部署任何 tracing 组件之前，必须先安装此 Operator。

    通过 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 自定义资源进行部署。它使用后端存储，并通过 OAuth2 Proxy sidecar 与 Alauda Container Platform 身份验证系统集成。

    前提条件

    • 已安装 Alauda Container Platform Distributed Tracing（以前称为 Alauda Build of Jaeger v2）集群插件。
    • 已安装 Alauda Container Platform Application Observability（以前称为 Alauda Build of OpenTelemetry v2）Operator。
    • 有一个可用的 OpenSearch 3.x 实例，并且拥有其 endpoint URL、用户名和密码。
    • 由具有 cluster-admin 角色的集群管理员建立的活动 ACP CLI（kubectl）会话。

    操作步骤

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

      export OPENSEARCH_ENDPOINT='<OpenSearch endpoint URL>'
export OPENSEARCH_USER='<OpenSearch username>'
export OPENSEARCH_PASS='<OpenSearch password>'

      将占位值替换为实际的 OpenSearch 凭据。

    2. 从集群中获取平台配置，并从 Alauda Build of Jaeger v2 集群插件创建的 ConfigMap 中获取 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

export JAEGER_IMAGE=$(kubectl -ncpaas-system get configmap jaeger-cluster-plugin-manifest -o jsonpath='{.data.jaeger-image}')
export JAEGER_ES_ROLLOVER_IMAGE=$(kubectl -ncpaas-system get configmap jaeger-cluster-plugin-manifest -o jsonpath='{.data.jaeger-es-rollover-image}')
export JOAUTH2_PROXY_IMAGE=$(kubectl -ncpaas-system get configmap jaeger-cluster-plugin-manifest -o jsonpath='{.data.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"
# Index prefix for Jaeger data
export JAEGER_ES_INDEX_PREFIX="acp-${CLUSTER_NAME}"
# Maximum expected duration of a single trace. Controls how far beyond the search window spans are looked up.
export JAEGER_MAX_TRACE_DURATION="1h"
# Base path for the Jaeger UI
export JAEGER_BASEPATH="/clusters/${CLUSTER_NAME}/jaeger"

    4. 创建 Jaeger namespace 和 OpenSearch 凭据 Secret：

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

kubectl create secret generic opensearch-credentials \
  --namespace=${JAEGER_NS} \
  --from-literal=OPENSEARCH_USER=${OPENSEARCH_USER} \
  --from-literal=OPENSEARCH_PASS=${OPENSEARCH_PASS} \
  --dry-run=client -o yaml | kubectl apply -f -

      验证 Secret 是否已创建：

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

    5. 在 OpenSearch 中创建 ISM（Index State Management）策略。Jaeger 使用 ISM 管理索引滚动和保留：

      curl -k -u "${OPENSEARCH_USER}:${OPENSEARCH_PASS}" -X PUT \
  "${OPENSEARCH_ENDPOINT}/_plugins/_ism/policies/jaeger-ism-policy" \
  -H 'Content-Type: application/json' \
  --data-binary @- << EOF
{
  "policy": {
    "description": "Jaeger index rollover and retention",
    "default_state": "hot",
    "states": [
      {
        "name": "hot",
        "actions": [
          {
            "rollover": {
              "min_primary_shard_size": "50gb",
              "min_index_age": "1d"
            }
          }
        ],
        "transitions": [
          {
            "state_name": "delete",
            "conditions": {
              "min_index_age": "7d"
            }
          }
        ]
      },
      {
        "name": "delete",
        "actions": [
          {
            "delete": {}
          }
        ],
        "transitions": []
      }
    ],
    "ism_template": [
      { "index_patterns": ["${JAEGER_ES_INDEX_PREFIX}-jaeger-span-0*"], "priority": 100 },
      { "index_patterns": ["${JAEGER_ES_INDEX_PREFIX}-jaeger-service-0*"], "priority": 100 },
      { "index_patterns": ["${JAEGER_ES_INDEX_PREFIX}-jaeger-dependencies-0*"], "priority": 100 },
      { "index_patterns": ["${JAEGER_ES_INDEX_PREFIX}-jaeger-sampling-0*"], "priority": 100 }
    ]
  }
}
EOF

      关键字段：

      • 在 hot 状态中的 rollover.min_primary_shard_size：单个主分片的最大大小。当分片超过此大小时，会触发滚动以创建新索引。默认值：50gb。
      • 在 hot 状态中的 rollover.min_index_age：触发滚动前索引的最大存续时间。默认值：1d（1 天）。
      • 在 hot 状态中的 transitions[0].conditions.min_index_age：从索引创建时开始计算的存续时间，达到该时间后索引会转入 delete 状态。默认值：7d（7 天）。
      • ism_template：将该策略附加到名称与其中某个模式匹配的每个新创建索引。OpenSearch 没有与 Elasticsearch 的 index.lifecycle.name 模板设置等效的功能，因此这是唯一的绑定机制；所以，该策略必须在下一步创建索引之前存在。
      WARNING

      请在 ism_template 模式中保留 -0* 后缀。它仅匹配带编号的滚动索引，例如 -000001 和 -000002。更宽泛的模式（例如 -*）也会匹配之后创建的带日期后缀索引，而 ISM 无法滚动这些索引。

      验证 ISM 策略：

      curl -k -sS -u "${OPENSEARCH_USER}:${OPENSEARCH_PASS}" \
  "${OPENSEARCH_ENDPOINT}/_plugins/_ism/policies/jaeger-ism-policy?pretty"

      输出应显示策略详细信息，包括 hot 和 delete 状态。

      NOTE

      OpenSearch 会拒绝对已经存在且带有 version_conflict_engine_exception 的策略执行 PUT。有关如何更改运行中部署的保留期限，请参阅更新 ISM 策略。

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

      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
          - "${OPENSEARCH_ENDPOINT}"
        env:
        - name: INDEX_PREFIX
          value: "${JAEGER_ES_INDEX_PREFIX}"
        - name: ES_USE_ILM
          value: "true"
        - name: ES_ILM_POLICY_NAME
          value: "jaeger-ism-policy"
        - name: ADAPTIVE_SAMPLING
          value: "true"
        - name: ES_TLS_ENABLED
          value: "true"
        - name: ES_TLS_SKIP_HOST_VERIFY
          value: "true"
        - name: ES_USERNAME
          valueFrom:
            secretKeyRef:
              name: opensearch-credentials
              key: OPENSEARCH_USER
        - name: ES_PASSWORD
          valueFrom:
            secretKeyRef:
              name: opensearch-credentials
              key: OPENSEARCH_PASS
      restartPolicy: Never
  backoffLimit: 3
EOF
      NOTE

      该工具在 OpenSearch 上保留以 ES_ 开头的变量名。ES_USE_ILM=true 选择由生命周期管理的滚动，该工具会将其解析为 OpenSearch ISM API；ES_ILM_POLICY_NAME 指定要验证其是否存在的 ISM 策略。ADAPTIVE_SAMPLING=true 还会创建 sampling 别名，下面的 Jaeger 配置需要这些别名。

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

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

# Verify index templates
curl -k -sS -u "${OPENSEARCH_USER}:${OPENSEARCH_PASS}" \
  "${OPENSEARCH_ENDPOINT}/_cat/templates/${JAEGER_ES_INDEX_PREFIX}-jaeger-*?v"

# Verify index aliases
curl -k -sS -u "${OPENSEARCH_USER}:${OPENSEARCH_PASS}" \
  "${OPENSEARCH_ENDPOINT}/_cat/aliases/${JAEGER_ES_INDEX_PREFIX}-jaeger-*?v"

      预期结果如下：

      • Job 状态为 Complete。
      • OpenSearch 中存在名为 ${JAEGER_ES_INDEX_PREFIX}-jaeger-(span|service|dependencies|sampling) 的索引模板。
      • ${JAEGER_ES_INDEX_PREFIX}-jaeger-*-read 和 ${JAEGER_ES_INDEX_PREFIX}-jaeger-*-write 别名指向初始的 -000001 索引，并且每个写入别名上的 is_write_index 都是 true。

      确认 ISM 已接管新索引：

      curl -k -sS -u "${OPENSEARCH_USER}:${OPENSEARCH_PASS}" \
  "${OPENSEARCH_ENDPOINT}/_plugins/_ism/explain/${JAEGER_ES_INDEX_PREFIX}-jaeger-span-000001?pretty"

      index.plugins.index_state_management.policy_id 字段应显示为 jaeger-ism-policy。

      NOTE

      ISM 通过后台扫描发现新索引，因此 policy_id 可能会在数分钟内保持为 null。如果之后仍为 null，则表示策略的 ism_template 模式与创建的索引名称不匹配。请修正策略，并使用 POST _plugins/_ism/add/<index> 手动附加该策略。

    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: opensearch-credentials
      secret:
        secretName: opensearch-credentials
        items:
          - key: OPENSEARCH_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: opensearch-credentials
      mountPath: /etc/jaeger/opensearch-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: opensearch_storage

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

      jaeger_storage:
        backends:
          opensearch_storage:
            opensearch:
              server_urls:
                - "${OPENSEARCH_ENDPOINT}"
              auth:
                basic:
                  username: "${OPENSEARCH_USER}"
                  password_file: /etc/jaeger/opensearch-credentials/pass
              tls:
                insecure_skip_verify: true
              service_cache_ttl: 12h
              max_trace_duration: "${JAEGER_MAX_TRACE_DURATION}"
              create_mappings: false
              indices:
                index_prefix: "${JAEGER_ES_INDEX_PREFIX}"
                spans:
                  shards: 5
                  replicas: 1
                  rotation:
                    auto_rollover: {}
                services:
                  shards: 5
                  replicas: 1
                  rotation:
                    auto_rollover: {}
                dependencies:
                  shards: 5
                  replicas: 1
                  rotation:
                    auto_rollover: {}
                sampling:
                  shards: 5
                  replicas: 1
                  rotation:
                    auto_rollover: {}

      jaeger_query:
        storage:
          traces: opensearch_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:
        metrics:
          level: detailed
          readers:
            - pull:
                exporter:
                  prometheus:
                    host: "0.0.0.0"
                    port: 8888
        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 binary。
      3. Jaeger 容器的资源请求和限制。请根据预期的 trace 数量进行调整；吞吐量较高的环境可能需要更多 CPU 和内存。
      4. 为 Jaeger 实例启用 Prometheus 指标 endpoint。
      5. jaeger_storage 扩展配置用于存储 trace 数据的 OpenSearch 后端。
      6. opensearch driver 选择 OpenSearch 存储实现。Jaeger 对 OpenSearch 使用与 Elasticsearch 相同的实现。
      7. service_cache_ttl 控制服务名称缓存的保留时间。默认值为 12h。如果 ISM 滚动到删除的间隔较短，请减小此值，以确保 Jaeger UI 能够及时发现服务。
      8. max_trace_duration 是单个 trace 的最大预期持续时间，此处设置为 JAEGER_MAX_TRACE_DURATION。查询服务会在两侧按此值扩大时间范围过滤器，从而仍能找到超出搜索窗口的 span。默认值为 24h；如果 trace 生命周期较短，请将其调小。请参阅查询时间范围。
      9. 使用 auto_rollover 轮换策略时，必须将 create_mappings 设置为 false，因为索引模板和映射由第 6 步中的滚动初始化进行管理。保留默认值会从模板中静默移除读别名和 ISM 滚动别名。
      10. index_prefix 必须与第 6 步 jaeger-es-rollover 初始化期间使用的 INDEX_PREFIX 匹配。有关分片和副本调优的更多详细信息，请参阅分片和副本。
      11. rotation.auto_rollover 策略使用读/写别名，并依赖第 5 步创建的 ISM 策略自动触发索引滚动和删除。默认别名名称与滚动初始化创建的别名匹配。由于读别名始终解析为附加到该别名的所有索引，因此 max_span_age 在此策略中不起作用，且被有意留空；保留期限完全由 ISM 策略控制。
      12. jaeger_query 扩展用于提供 Jaeger Query API 和 Jaeger UI。
      13. additionalContainers 部分定义 OAuth2 Proxy sidecar，该 sidecar 通过与 Alauda Container Platform Dex identity provider 集成来处理 Jaeger UI 的身份验证。
      14. OAuth2 Proxy sidecar 的资源请求和限制。由于该容器仅代理身份验证请求，因此资源需求较低。

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

      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> 是集群名称。

    运行以下命令打印 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_grpc/traces:
        endpoint: "${JAEGER_INSTANCE_NAME}-collector.${JAEGER_NS}.svc.cluster.local:4317"
        tls:
          insecure: true
      prometheus:
        translation_strategy: UnderscoreEscapingWithoutSuffixes # keep OTel metric names without _total suffixes (add_metric_suffixes is deprecated and ignored since collector-contrib v0.154.0)
        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_grpc/traces] 
        metrics:
          receivers: [otlp]
          processors: [memory_limiter, batch]
          exporters: [debug, prometheus]
      telemetry:
        metrics:
          readers:
          - pull:
              exporter:
                prometheus:
                  host: 0.0.0.0
                  port: 8888
      1. prometheus: kube-prometheus 标签使 ACP Prometheus 能够通过自动创建的 ServiceMonitor 抓取 Collector 指标。
      2. Collector 容器的资源请求和限制。请根据预期的 trace 吞吐量进行调整。
      3. 使 operator 能够为 Collector 的指标端点自动创建 ServiceMonitor 资源。
      4. OTLP receiver 通过 gRPC（端口 4317）和 HTTP（端口 4318）接收来自已插桩应用的 trace 数据。
      5. otlp_grpc/traces exporter 将接收到的 trace 转发到 Jaeger collector service。该端点根据 Jaeger 实例名称和命名空间派生。
      6. trace pipeline 通过 OTLP 和 Zipkin 接收数据，经由 memory_limiter 和 batch 处理后，同时导出到 debug exporter（用于日志记录）和 otlp_grpc/traces（用于转发到 Jaeger）。
      OTLP gRPC exporter 名为

      otlp_grpc exporter 类型名称是 otlp_grpc，而不是 otlp。前一个名称仍可作为已弃用的别名使用，但 Collector 随后会在启动时为每个受影响的组件实例记录弃用警告，并且上游计划在未来版本中移除该别名。

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

      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 作为测试客户端，以生成示例 trace：

      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，验证是否可以查看生成的 trace。

      运行以下命令以打印 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 指标，并通过 load_balancing exporter 将前端 OpenTelemetry Collector 中的 span 路由到 Jaeger，从而确保即使两个组件都运行多个副本，指标仍保持准确。Jaeger 会在 Prometheus endpoint 上公开这些指标，并通过兼容 PromQL 的后端将其提供给 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，使其通过 load_balancing exporter 将 span 转发到 Jaeger，并替换直接使用的 otlp_grpc/traces exporter。借助 routing_key: service，给定 service 的所有 span 都会一致地发送到同一个 Jaeger 副本，因此在 Jaeger 内运行的 SpanMetrics Connector（下一步）可以对每个 service 恰好聚合一次。这可以确保当 Collector 或 Jaeger 运行多个副本时，指标仍然正确：

      kubectl patch opentelemetrycollector otel -n ${JAEGER_NS} --type=merge -p "
spec:
  config:
    exporters:
      otlp_grpc/traces: null # remove the direct exporter, replaced by load_balancing
      load_balancing:
        routing_key: service
        protocol:
          otlp: # a configuration field of the load_balancing exporter, not a component type name
            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, load_balancing]
"

      dns resolver 会通过 OpenTelemetry Operator 自动配置的无头 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，通过 Prometheus endpoint 公开生成的 RED 指标，并添加 PromQL metrics backend，使 Jaeger 能够将这些指标提供给 Monitor 选项卡：

      jaeger-spm-patch.yaml
      spec:
  volumes:
    - name: opensearch-credentials
      secret:
        secretName: opensearch-credentials
        items:
          - key: OPENSEARCH_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: opensearch-credentials
      mountPath: /etc/jaeger/opensearch-credentials
      readOnly: true
    - name: monitoring-credentials
      mountPath: /etc/jaeger/monitoring-credentials
      readOnly: true
  config:
    connectors:
      span_metrics: {} 
    exporters:
      prometheus:
        translation_strategy: UnderscoreEscapingWithoutSuffixes # keep OTel metric names without _total suffixes (add_metric_suffixes is deprecated and ignored since Jaeger v2.20.0 / collector-contrib v0.154.0)
        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, span_metrics]
        metrics/spanmetrics:
          receivers: [span_metrics]
          exporters: [prometheus]
      1. monitoring-credentials volume 会将 monitoring basic-auth 凭据挂载到 Jaeger 容器中。
      2. monitoring-credentials volumeMount 会使凭据在 /etc/jaeger/monitoring-credentials/ 处可用。
      3. span_metrics connector 会根据 Jaeger 接收的 span 生成 RED 指标。由于 Collector 会将每个 service 路由到单个 Jaeger 副本，因此每个副本都会正确聚合一组互不重叠的 service。
      4. prometheus exporter 会通过端口 8889 公开生成的指标。Jaeger 实例已包含 prometheus: kube-prometheus 标签和 observability.metrics.enableMetrics: true（在 jaeger.yaml 中设置），因此 Operator 会自动创建 ServiceMonitor，使 ACP Prometheus 能够抓取此 endpoint。
      5. basicauth/monitoring extension 为 monitoring metrics endpoint 提供 basic authentication。
      6. metric_backends 部分配置 Jaeger 查询 SPM 数据时使用的兼容 PromQL 的 metrics storage。
      7. 在 jaeger_query extension 中引用 metrics store。
      8. 必须将 basicauth/monitoring extension 添加到 service.extensions 列表中，才能使其生效。
      9. traces pipeline 现在还会导出到 span_metrics（存储并生成指标），而专用的 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
    扩展到多个副本

    要以高可用模式运行 SPM，请增加 otel 和 ${JAEGER_INSTANCE_NAME} 上 spec.replicas 的值；无需进行其他更改。无状态 Collector 层可以自由扩展，并且由于 span 由 service 进行负载均衡，每个 Jaeger 副本都会负责一组互不重叠的 service，并在不发生冲突的情况下进行聚合。请注意以下事项：

    验证

    启用 SPM 后，您可以按照上方 验证 部分中的说明部署 telemetrygen 测试客户端来进行验证。

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

    卸载

    要从集群中移除 Alauda Distributed Tracing 组件，请按照卸载 Alauda Distributed Tracing中的说明操作。