应用程序服务器配置

了解如何为 Java 应用程序服务器定义代理路径

在为运行在 Java 应用程序服务器上的应用程序使用 Java 代理进行检测时,您必须将 javaagent 路径添加到 JVM 参数中。添加方式因服务器而异。

JBoss EAP / WildFly

您可以在独立配置文件末尾添加 javaagent 参数

# Add to standalone.conf
JAVA_OPTS="$JAVA_OPTS -javaagent:/path/to/opentelemetry-javaagent.jar"
rem Add to standalone.conf.bat
set "JAVA_OPTS=%JAVA_OPTS% -javaagent:<Drive>:\path\to\opentelemetry-javaagent.jar"

Jetty

要定义 Java 代理的路径,请使用 -javaagent 参数

java -javaagent:/path/to/opentelemetry-javaagent.jar -jar start.jar

如果您使用 jetty.sh 文件启动 Jetty,请将以下行添加到 <jetty_home>/bin/jetty.sh 文件中

JAVA_OPTIONS="${JAVA_OPTIONS} -javaagent:/path/to/opentelemetry-javaagent.jar"

如果您使用 start.ini 文件定义 JVM 参数,请在 --exec 选项后添加 javaagent 参数

#===========================================================
# Sample Jetty start.ini file
#-----------------------------------------------------------
--exec
-javaagent:/path/to/opentelemetry-javaagent.jar

Glassfish / Payara

使用 asadmin 工具添加 Java 代理的路径

<server_install_dir>/bin/asadmin create-jvm-options "-javaagent\:/path/to/opentelemetry-javaagent.jar"
<server_install_dir>\bin\asadmin.bat create-jvm-options '-javaagent\:<Drive>\:\\path\\to\\opentelemetry-javaagent.jar'

您也可以从管理控制台添加 -javaagent 参数。例如

  1. https://:4848 打开 GlassFish 管理控制台。
  2. 转到 **配置 > server-config > JVM 设置**。
  3. 选择 **JVM 选项 > 添加 JVM 选项**。
  4. 输入代理的路径:-javaagent:/path/to/opentelemetry-javaagent.jar
  5. **保存**并重新启动服务器。

确保您的域目录中的 domain.xml 文件包含代理的 <jmv-options> 条目。

Tomcat / TomEE

将 Java 代理的路径添加到您的启动脚本。配置方法取决于您的安装

**对于包管理安装** (apt-get/yum),添加到 /etc/tomcat*/tomcat*.conf

JAVA_OPTS="$JAVA_OPTS -javaagent:/path/to/opentelemetry-javaagent.jar"

**对于下载安装**,创建或修改 <tomcat>/bin/setenv.sh (Linux) 或 <tomcat>/bin/setenv.bat (Windows)

# Add to <tomcat_home>/bin/setenv.sh
CATALINA_OPTS="$CATALINA_OPTS -javaagent:/path/to/opentelemetry-javaagent.jar"
rem Add to <tomcat_home>\bin\setenv.bat
set CATALINA_OPTS=%CATALINA_OPTS% -javaagent:"<Drive>:\path\to\opentelemetry-javaagent.jar"

**对于 Windows 服务安装**,使用 <tomcat>/bin/tomcat*w.exe 在 Java 选项下的 Java 选项卡中添加 -javaagent:<Drive>:\path\to\opentelemetry-javaagent.jar

WebLogic

将 Java 代理的路径添加到您的域启动脚本

# Add to <domain_home>/bin/startWebLogic.sh
export JAVA_OPTIONS="$JAVA_OPTIONS -javaagent:/path/to/opentelemetry-javaagent.jar"
rem Add to <domain_home>\bin\startWebLogic.cmd
set JAVA_OPTIONS=%JAVA_OPTIONS% -javaagent:"<Drive>:\path\to\opentelemetry-javaagent.jar"

对于托管服务器实例,使用管理控制台添加 -javaagent 参数。

WebSphere Liberty Profile

将 Java 代理的路径添加到 jvm.options 文件。对于单个服务器,编辑 ${server.config.dir}/jvm.options;对于所有服务器,编辑 ${wlp.install.dir}/etc/jvm.options

-javaagent:/path/to/opentelemetry-javaagent.jar

保存文件后重新启动服务器。

WebSphere Traditional

打开 WebSphere 管理控制台并按照以下步骤操作

  1. 导航到 **服务器 > 服务器类型 > WebSphere 应用程序服务器**。
  2. 选择服务器。
  3. 转到 **Java 和进程管理 > 进程定义**。
  4. 选择 **Java 虚拟机**。
  5. 在 **通用 JVM 参数** 中,输入代理的路径:-javaagent:/path/to/opentelemetry-javaagent.jar
  6. 保存配置并重新启动服务器。

启用预定义的 JMX 指标

Java 代理包含适用于几个流行应用程序服务器的预定义 JMX 指标配置,但默认情况下不启用它们。要启用预定义指标的收集,请为 otel.jmx.target.system 系统属性指定目标列表。例如

$ java -javaagent:path/to/opentelemetry-javaagent.jar \
     -Dotel.jmx.target.system=jetty,tomcat \
     ... \
     -jar myapp.jar

以下是 otel.jmx.target.system 已知的应用程序服务器值

有关从每个应用程序服务器提取的指标列表,请选择前面的名称,或参考 其他详细信息和自定义功能