observability-edot-java-migrate

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

EDOT Java Migration

EDOT Java 迁移

Read the migration guide before making changes:
在进行更改前,请阅读迁移指南:

Guidelines

迁移准则

  1. Remove ALL classic APM references:
    elastic-apm-agent.jar
    ,
    elasticapm.properties
    , all
    ELASTIC_APM_*
    env vars, and any
    co.elastic.apm
    Maven/Gradle dependencies
  2. Use
    elastic-otel-javaagent.jar
    (download from GitHub releases, not a Maven/Gradle dependency)
  3. Attach via
    -javaagent:/path/to/elastic-otel-javaagent.jar
    or
    JAVA_TOOL_OPTIONS="-javaagent:/path/to/elastic-otel-javaagent.jar"
    — without this the agent does nothing
  4. Set exactly three required environment variables:
    • OTEL_SERVICE_NAME
      (replaces
      ELASTIC_APM_SERVICE_NAME
      )
    • OTEL_EXPORTER_OTLP_ENDPOINT
      — must be the managed OTLP endpoint or EDOT Collector URL. Do NOT reuse the old
      ELASTIC_APM_SERVER_URL
      value. Never use an APM Server URL (no
      apm-server
      , no
      :8200
      , no
      /intake/v2/events
      )
    • OTEL_EXPORTER_OTLP_HEADERS
      "Authorization=ApiKey <key>"
      or
      "Authorization=Bearer <token>"
      (replaces
      ELASTIC_APM_SECRET_TOKEN
      /
      API_KEY
      )
  5. Do NOT set
    OTEL_TRACES_EXPORTER
    ,
    OTEL_METRICS_EXPORTER
    , or
    OTEL_LOGS_EXPORTER
    — the defaults are already correct
  6. Never run both classic Elastic APM agent and EDOT agent on the same JVM
  1. 移除所有经典APM相关引用:
    elastic-apm-agent.jar
    elasticapm.properties
    、所有
    ELASTIC_APM_*
    环境变量,以及任何
    co.elastic.apm
    的Maven/Gradle依赖
  2. 使用
    elastic-otel-javaagent.jar
    (从GitHub发布版本下载,而非Maven/Gradle依赖)
  3. 通过
    -javaagent:/path/to/elastic-otel-javaagent.jar
    JAVA_TOOL_OPTIONS="-javaagent:/path/to/elastic-otel-javaagent.jar"
    方式挂载agent——不执行此操作的话,agent将无法正常工作
  4. 必须设置以下三个必填环境变量:
    • OTEL_SERVICE_NAME
      (替代
      ELASTIC_APM_SERVICE_NAME
    • OTEL_EXPORTER_OTLP_ENDPOINT
      —— 必须是托管OTLP端点EDOT Collector的URL。请勿复用旧的
      ELASTIC_APM_SERVER_URL
      值。绝对不能使用APM Server URL(不包含
      apm-server
      :8200
      /intake/v2/events
    • OTEL_EXPORTER_OTLP_HEADERS
      ——
      "Authorization=ApiKey <key>"
      "Authorization=Bearer <token>"
      (替代
      ELASTIC_APM_SECRET_TOKEN
      /
      API_KEY
  5. 请勿设置
    OTEL_TRACES_EXPORTER
    OTEL_METRICS_EXPORTER
    OTEL_LOGS_EXPORTER
    ——默认配置已符合要求
  6. 切勿在同一JVM上同时运行经典Elastic APM agent和EDOT agent

Examples

示例

See the EDOT Java migration guide for complete examples.
完整示例请查看EDOT Java 迁移指南