使用 OpenTelemetry Operator for Kubernetes 的自定义代理

这是两部分系列文章的第二部分。第一部分可在 Kubernetes Java 应用程序的零配置 OpenTelemetry 自动 instrumentation 中找到。在第一部分中，我介绍了如何设置和安装 OpenTelemetry Operator for Kubernetes，以及如何配置它以使用 OpenTelemetry Java 代理 自动 instrumentation Java 应用程序。

在本系列的第二部分中，我将展示如何通过 OpenTelemetry 运算符安装*任何* Java 代理，并使用 Elastic Java 代理作为示例。

安装和配置回顾

本系列的第 1 部分，Kubernetes Java 应用程序的零配置 OpenTelemetry 自动 instrumentation，详细介绍了 OpenTelemetry 运算符和 Instrumentation 资源的安装和配置。以下概述了这些步骤，以便提醒您。

1. 安装 cert-manager，例如
   kubectl apply -f https://github.com/cert-manager/cert-manager/releases/download/v1.14.4/cert-manager.yaml
2. 安装运算符，例如
   kubectl apply -f https://github.com/open-telemetry/opentelemetry-operator/releases/latest/download/opentelemetry-operator.yaml
3. 创建 Instrumentation 资源
4. 在部署或命名空间中添加注释
5. 照常部署应用程序

在第一部分中，步骤 3、4 和 5 是为 OpenTelemetry Java 代理 实现的。在本博文中，我将为其他代理实现它们，并使用 Elastic APM 代理作为示例。我假设上面概述的步骤 1 和 2 已经完成，即运算符现在已安装。我将继续使用

使用 Elastic Distribution for OpenTelemetry Java

从 0.4.0 版本开始，Elastic Distribution for OpenTelemetry Java 在路径中包含代理 jar

apiVersion: opentelemetry.io/v1alpha1
kind: Instrumentation
metadata:
  name: elastic-otel
  namespace: banana
spec:
  exporter:
    endpoint: https://my.apm.server.url
  propagators:
    - tracecontext
    - baggage
    - b3
  sampler:
    type: parentbased_traceidratio
    argument: "1.0"
  java:
    image: docker.elastic.co/observability/elastic-otel-javaagent:1.0.0
    env:
      - name: OTEL_EXPORTER_OTLP_HEADERS
        value: "Authorization=Bearer my-apm-secret-token"
      - name: ELASTIC_OTEL_INFERRED_SPANS_ENABLED
        value: "true"
      - name: ELASTIC_OTEL_SPAN_STACK_TRACE_MIN_DURATION
        value: "50"

我在代理中包含了用于启用多个功能的环境，包括

1. ELASTIC_APM_PROFILING_INFERRED_SPANS_ENABLED 用于启用在 此博文 中描述的推断跨度实现功能
2. 如果跨度持续时间超过 ELASTIC_OTEL_SPAN_STACK_TRACE_MIN_DURATION（默认值为 5 毫秒），则会自动捕获跨度堆栈跟踪。

在注释中添加...

metadata:
  annotations:
    instrumentation.opentelemetry.io/inject-java: "elastic-otel"

...到 pod yaml 会使应用程序被跟踪并在 Elastic APM UI 中显示，包括推断的子跨度和堆栈跟踪。

上面提到的功能的添加部分用红色圈出 - 推断的跨度（对于 methodC 和 methodD）位于左下方，堆栈跟踪位于右上方。（请注意，pod 包含

使用 Elastic APM Java 代理

从 1.50.0 版本开始，Elastic APM Java 代理 在路径 /javaagent.jar 中的 docker 镜像中包含代理 jar - 这基本上是 docker 镜像可由 OpenTelemetry 运算符用于自动 instrumentation 所需的全部内容。这意味着 Instrumentation 资源易于定义。

apiVersion: opentelemetry.io/v1alpha1
kind: Instrumentation
metadata:
  name: elastic-apm
  namespace: banana
spec:
  java:
    image: docker.elastic.co/observability/apm-agent-java:1.52.0
    env:
      - name: ELASTIC_APM_SERVER_URL
        value: "https://my.apm.server.url"
      - name: ELASTIC_APM_SECRET_TOKEN
        value: "my-apm-secret-token"
      - name: ELASTIC_APM_LOG_LEVEL
        value: "INFO"
      - name: ELASTIC_APM_PROFILING_INFERRED_SPANS_ENABLED
        value: "true"
      - name: ELASTIC_APM_LOG_SENDING
        value: "true"

我在代理中包含了用于启用多个功能的环境，包括

• ELASTIC_APM_LOG_LEVEL 设置为默认值（INFO），可以轻松将其切换到 DEBUG
• ELASTIC_APM_PROFILING_INFERRED_SPANS_ENABLED 用于启用等效于在 此博文 中描述的功能的推断跨度实现。
• ELASTIC_APM_LOG_SENDING 用于启用将日志发送到 APM UI，日志会自动与事务相关联（对于所有常见的日志记录框架）。

在注释中添加...

metadata:
  annotations:
     instrumentation.opentelemetry.io/inject-java: "elastic-apm"

...到 pod yaml 会使应用程序被跟踪并在 Elastic APM UI 中显示，包括推断的子跨度。

(请注意，pod 包含

使用 OpenTelemetry Java 代理的扩展

为 OpenTelemetry Java 代理设置 Instrumentation 资源非常简单，并且已在本系列文章的第 1 部分中完成 - 并且您可以从上面的示例中看到，这只是一个决定要使用的 Docker 镜像 URL 的问题。但是，如果您想在部署中包含一个扩展，这会稍微复杂一些，但也受操作符支持。基本上，您想与代理一起包含的扩展需要在 Docker 镜像中 - 或者您必须构建一个包含尚未在镜像中的扩展的镜像。然后，您在 Instrumentation 资源中声明镜像和扩展所在的目录。例如，我将展示一个 Instrumentation，它使用 OpenTelemetry Java 代理的 2.5.0 版本OpenTelemetry Java 代理以及来自Elastic OpenTelemetry Java 发行版的推断跨度扩展。发行版镜像在路径中包含扩展

apiVersion: opentelemetry.io/v1alpha1
kind: Instrumentation
metadata:
  name: otel-plus-extension-instrumentation
  namespace: banana
spec:
  exporter:
    endpoint: https://my.apm.server.url
  propagators:
    - tracecontext
    - baggage
    - b3
  sampler:
    type: parentbased_traceidratio
    argument: "1.0"
  java:
    image: ghcr.io/open-telemetry/opentelemetry-operator/autoinstrumentation-java:2.5.0
    extensions:
      - image: "docker.elastic.co/observability/elastic-otel-javaagent:1.0.0"
        dir: "/extensions"
    env:
      - name: OTEL_EXPORTER_OTLP_HEADERS
        value: "Authorization=Bearer my-apm-secret-token"
      - name: ELASTIC_OTEL_INFERRED_SPANS_ENABLED
        value: "true"

请注意，您可以有多个

后续步骤

在这里，我展示了如何使用任何代理与Kubernetes 的 OpenTelemetry 运算符一起使用，并为您的系统配置它。特别是，这些示例展示了如何使用 Elastic Java 代理来自动检测在 Kubernetes 集群中运行的 Java 应用程序，以及如何使用 Instrumentation 资源启用功能。您可以为部署设置零配置，或者仅设置一个注释，这通常是一种更灵活的机制（您可以有多个 Instrumentation 资源定义，并且部署可以选择适合其应用程序的资源）。

本帖中描述的任何功能或功能的发布和时间安排完全由 Elastic 自行决定。任何当前不可用的功能或功能可能无法按时或根本无法交付。