Java Agent 数据采集
前置条件
- 安装 light-agent(登录 Lighthouse 平台后点击「数据采集」菜单查看安装步骤,或点此查看)
快速开始
-
在 JVM 启动参数中添加
-javaagent:path/to/opentelemetry-javaagent.jar
和其他配置,然后启动你的应用:
- 启动命令
- 环境变量
java -javaagent:path/to/opentelemetry-javaagent.jar \
-Dotel.service.name=your-service-name \
-Dotel.exporter=otlp \
-Dotel.exporter.otlp.protocol=grpc \
-Dotel.exporter.otlp.endpoint=http://localhost:54317 \
-Dfile.encoding=UTF-8 \
-jar myapp.jar
export JAVA_TOOL_OPTIONS="-javaagent:path/to/opentelemetry-javaagent.jar"
export OTEL_SERVICE_NAME="your-service-name"
export OTEL_EXPORTER=otlp
export OTEL_EXPORTER_OTLP_PROTOCOL=grpc
export OTEL_EXPORTER_OTLP_ENDPOINT=http://localhost:54317
java -jar myapp.jar
提示
- 将
path/to/opentelemetry-javaagent.jar
替换为实际路径 - 将
your-service-name
替换为实际的服务名称 - 将
myapp.jar
替换为实际的应用程序 jar 包
配置 OTel 探针
OTel 探针支持非常灵活的配置方式:
- JVM 参数
- 环境变量
- 配置文件
- 环境变量 + 配置文件
通过 -D
标志传递配置属性,配置服务名称和 otlp 调用链导出器:
java -javaagent:path/to/opentelemetry-javaagent.jar \
-Dotel.service.name=your-service-name \
-Dotel.exporter=otlp \
-Dotel.exporter.otlp.protocol=grpc \
-Dotel.exporter.otlp.endpoint=http://localhost:54317 \
-Dfile.encoding=UTF-8 \
-jar myapp.jar
使用环境变量来配置代理:
OTEL_SERVICE_NAME=your-service-name \
OTEL_TRACES_EXPORTER=otlp \
OTEL_EXPORTER_OTLP_ENDPOINT=http://0.0.0.0:54317 \
OTEL_EXPORTER_OTLP_PROTOCOL=grpc \
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 Agent 内置了许多流行组件的自动插桩库。
完整的支持列表请参见 兼容性列表。
故障排除
将系统属性或者环境变量设置为 true
可查看调试日志。请注意,这些日志会非常详细。
- 系统属性:
otel.javaagent.debug
- 环境变量:
OTEL_JAVAAGENT_DEBUG
下一步
在应用或服务自动注入配置后,你可能想要对指定的方法添加注解或手工插桩以收集自定义 APM 数据。
更多配置方式请参考 Java Agent 配置。