Back to Details

observability-edot-java-instrument

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

EDOT Java Instrumentation

EDOT Java 埋点指南

Read the setup guide before making changes:
在进行修改前，请先阅读设置指南：

Guidelines

实施准则

  1. Use 
    elastic-otel-javaagent.jar
    (download from GitHub releases, not a Maven/Gradle dependency)
  2. 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
  3. Set exactly three required environment variables: 
    • OTEL_SERVICE_NAME
    • OTEL_EXPORTER_OTLP_ENDPOINT
      — must be the managed OTLP endpoint or EDOT Collector URL. 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>"
  4. Do NOT set 
    OTEL_TRACES_EXPORTER
    , 
    OTEL_METRICS_EXPORTER
    , or 
    OTEL_LOGS_EXPORTER
    — the defaults are already correct
  5. Never run both classic Elastic APM agent and EDOT agent on the same JVM
  1. 使用
    elastic-otel-javaagent.jar
    （从GitHub Releases下载，而非Maven/Gradle依赖）
  2. 通过
    -javaagent:/path/to/elastic-otel-javaagent.jar
    或
    JAVA_TOOL_OPTIONS="-javaagent:/path/to/elastic-otel-javaagent.jar"
    挂载Agent——不配置此参数的话，Agent将无法生效
  3. 必须设置以下三个必填环境变量： 
    • OTEL_SERVICE_NAME
    • OTEL_EXPORTER_OTLP_ENDPOINT
      ——必须为托管式OTLP端点或EDOT Collector的URL。切勿使用APM Server URL（不能包含
      apm-server
      、
      :8200
      或
      /intake/v2/events
      ）
    • OTEL_EXPORTER_OTLP_HEADERS
      ——格式为
      "Authorization=ApiKey <key>"
      或
      "Authorization=Bearer <token>"
  4. 请勿设置
    OTEL_TRACES_EXPORTER
    、
    OTEL_METRICS_EXPORTER
    或
    OTEL_LOGS_EXPORTER
    ——默认配置已满足需求
  5. 切勿在同一JVM中同时运行传统Elastic APM Agent与EDOT Agent

Examples

示例

See the EDOT Java setup guide for complete Dockerfile and docker-compose examples.
完整的Dockerfile与docker-compose示例请参考EDOT Java 设置指南