アプリケーションサーバーの設定

Java エージェントを使用して Java アプリケーションサーバー上で動作するアプリを計装する場合、JVM 引数に javaagent パスを追加する必要があります。 追加方法はサーバーによって異なります。

JBoss EAP / WildFly

スタンドアロン設定ファイルの末尾に javaagent 引数を追加できます。

• Linux
• Windows

# standalone.conf に追加
JAVA_OPTS="$JAVA_OPTS -javaagent:/path/to/opentelemetry-javaagent.jar"

rem 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 引数を追加します。

#===========================================================
# Jetty start.ini ファイルのサンプル
#-----------------------------------------------------------
--exec
-javaagent:/path/to/opentelemetry-javaagent.jar

Glassfish / Payara

asadmin ツールを使って Java エージェントのパスを追加します。

• Linux
• Windows

<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. http://localhost:4848 で GlassFish 管理コンソールを開きます。
2. Configurations > server-config > JVM Settings に移動します。
3. JVM Options > Add JVM Option を選択します。
4. エージェントのパスを入力します。 -javaagent:/path/to/opentelemetry-javaagent.jar
5. Save をクリックしてサーバーを再起動します。

ドメインディレクトリ内の 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）を作成または編集します。

• Linux
• Windows

# <tomcat_home>/bin/setenv.sh に追加
CATALINA_OPTS="$CATALINA_OPTS -javaagent:/path/to/opentelemetry-javaagent.jar"

rem <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 Options に -javaagent:<Drive>:\path\to\opentelemetry-javaagent.jar を追加します。

WebLogic

ドメインの起動スクリプトに Java エージェントのパスを追加します。

• Linux
• Windows

# <domain_home>/bin/startWebLogic.sh に追加
export JAVA_OPTIONS="$JAVA_OPTIONS -javaagent:/path/to/opentelemetry-javaagent.jar"

rem <domain_home>\bin\startWebLogic.cmd に追加
set JAVA_OPTIONS=%JAVA_OPTIONS% -javaagent:"<Drive>:\path\to\opentelemetry-javaagent.jar"

マネージドサーバーインスタンスの場合は、管理コンソールから -javaagent 引数を追加します。

WebSphere Liberty Profile

jvm.options ファイルに Java エージェントのパスを追加します。 単一サーバーの場合は ${server.config.dir}/jvm.options を、すべてのサーバーの場合は ${wlp.install.dir}/etc/jvm.options を編集します。

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

ファイルを保存した後、サーバーを再起動します。

WebSphere Traditional

WebSphere 管理コンソールを開き、以下の手順に従います。

1. Servers > Server type > WebSphere application servers に移動します。
2. サーバーを選択します。
3. Java and Process Management > Process Definition に移動します。
4. Java Virtual Machine を選択します。
5. Generic JVM arguments にエージェントのパスを入力します。 -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 に指定できるアプリケーションサーバーの値は以下のとおりです。

• jetty
• tomcat
• wildfly

各アプリケーションサーバーから抽出されるメトリクスのリストについては、上記のリンクを選択するか、Additional details and customization capabilities を参照してください。