入门

设置

1. 从 opentelemetry-java-instrumentation 仓库的 Releases 下载 opentelemetry-javaagent.jar，并将其放置在您偏好的目录中。JAR 文件包含代理和仪器库。
2. 在 JVM 启动参数中添加 -javaagent:path/to/opentelemetry-javaagent.jar 和其他配置，然后启动您的应用程序

   • 直接在启动命令上

     java -javaagent:path/to/opentelemetry-javaagent.jar -Dotel.service.name=your-service-name -jar myapp.jar
     

   • 通过 JAVA_TOOL_OPTIONS 和其他环境变量

     export JAVA_TOOL_OPTIONS="-javaagent:path/to/opentelemetry-javaagent.jar"
     export OTEL_SERVICE_NAME="your-service-name"
     java -jar myapp.jar
     

声明式配置

声明式配置使用 YAML 文件代替环境变量或系统属性。当您需要设置许多配置选项，或者您想使用环境变量或系统属性中不可用的配置选项时，这很有用。

有关更多详细信息，请参阅 声明式配置 页面。

配置代理

该代理高度可配置。

一种选择是通过 -D 标志传递配置属性。在此示例中，配置了服务名称和用于跟踪的 Zipkin 导出器。

java -javaagent:path/to/opentelemetry-javaagent.jar \
     -Dotel.service.name=your-service-name \
     -Dotel.traces.exporter=zipkin \
     -jar myapp.jar

您还可以使用环境变量来配置代理。

OTEL_SERVICE_NAME=your-service-name \
OTEL_TRACES_EXPORTER=zipkin \
java -javaagent:path/to/opentelemetry-javaagent.jar \
     -jar myapp.jar

您还可以提供一个 Java 属性文件并从中加载配置值。

java -javaagent:path/to/opentelemetry-javaagent.jar \
     -Dotel.javaagent.configuration-file=path/to/properties/file.properties \
     -jar myapp.jar

或

OTEL_JAVAAGENT_CONFIGURATION_FILE=path/to/properties/file.properties \
java -javaagent:path/to/opentelemetry-javaagent.jar \
     -jar myapp.jar

要查看完整的配置选项，请参阅 代理配置。

支持的库、框架、应用程序服务和 JVM

Java 代理附带了许多流行组件的仪器库。完整列表请参阅 支持的库、框架、应用程序服务和 JVM。

故障排除

下一步

在为您的应用程序或服务配置了自动仪器后，您可能希望 注释 选定的方法或添加 手动仪器 来收集自定义遥测数据。