Tomcat

環境変数の追加

Tomcatアプリケーションサーバー環境でJavaモニタリングエージェントを効果的に使用するために必要なJVMオプションを追加する方法を案内します。使用するOSに合わせて設定してください。

Linux

catalina.shファイルの先頭にJAVA_OPTS環境変数を追加します。

{Tomcat_PATH}/bin/catalina.sh
########## WHATAP START ############
WHATAP_HOME=/whatap
WHATAP_JAR=`ls ${WHATAP_HOME}/whatap.agent-*.jar | sort -V | tail -1`
JAVA_OPTS="${JAVA_OPTS} -javaagent:${WHATAP_JAR} "
########## WHATAP END ############

ノート

ls ${WHATAP_HOME}/whatap.agent-*.jar|sort -V|tail-1項目は、エージェントのアップデートで最新のWhaTapエージェントを適用します。

Windows

setup.batファイルを実行した場合

catalina.batファイルの先頭にJAVA_OPT環境変数を追加します。

{Tomcat_PATH}/bin/catalina.bat
rem ########## WHATAP START ############
set WHATAP_HOME=C:\whatap
for /f %%f in ('dir /b /on "%WHATAP_HOME%\whatap.agent-*.jar"') do set last=%%f
set WHATAP_JAR=%last%
set WHATAP_OPTS=-javaagent:%WHATAP_HOME%\%WHATAP_JAR%

if "x%JAVA_OPTS%"=="x" goto setWhatap

set JAVA_OPTS_TMP=%JAVA_OPTS:"=%
if not "x%JAVA_OPTS_TMP:whatap=%"=="x%JAVA_OPTS_TMP%" goto endWhatap

:setWhatap
set JAVA_OPTS=%JAVA_OPTS% %WHATAP_OPTS%

:endWhatap
rem ########## WHATAP END ############

TomcatをWindowsインストーラーでインストールした場合
1. 開始 > Apache Tomcat X.Y.Z. > Configure Tomcatを選択します。
2. Javaタブを選択します。
3. Java Optionsテキストボックスに-javaagentオプションを追加します。
```
-javaagent:{WhaTapインストールパス}/whatap.agent-X.Y.Z.jar
```

Java 17バージョン以降

Java 17 以降では、reflectionに関する次のオプションを追加します。

--add-opens=java.base/java.lang=ALL-UNNAMED

ヒープヒストグラム照会

WhaTapのJavaモニタリングでは、JVMメモリのヒープ占有オブジェクト現況(ヒープメモリ上のオブジェクト別サイズ)を照会できる機能を標準として提供します。アプリケーション > インスタンスパフォーマンス分析メニューからヒープヒストグラムタブを選択してください。

Java 6~8バージョンでは、JVMオプションなしで標準対応しますが、一部のJavaバージョンによっては次のようにJVMオプションを適用する必要があります。

Java 9 ~ Java 15バージョン

-Djdk.attach.allowAttachSelf=true

example
java -javaagent:{WHATAP_HOME}/whatap.agent-X.Y.Z.jar -Djdk.attach.allowAttachSelf=true -jar {application.jar}

Java 16バージョン以降

-Djdk.attach.allowAttachSelf=true
--add-opens=jdk.attach/sun.tools.attach=ALL-UNNAMED

example
java -javaagent:{WHATAP_HOME}/whatap.agent-X.Y.Z.jar -Djdk.attach.allowAttachSelf=true --add-opens=java.base/java.lang=ALL-UNNAMED --add-opens=jdk.attach/sun.tools.attach=ALL-UNNAMED -jar {application.jar}

ノート

Java 5以前の旧バージョン、IBM Javaには対応していません。

次の段階

オープンソース追跡

アプリケーションで使用するフレームワークやオープンソースライブラリによって、エージェントオプションの追加が必要になる場合があります。たとえば、フレームワークやオープンソースでspring-boot-3.x、feign-client-11、okhttp3-4.4使用の際は、次のようにオプションを設定します。
whatap.conf
```
weaving=spring-boot-3.0,feign-11,okhttp3-4.4
```
ユーザーのアプリケーション環境に合わせたフレームワークやオープンソースライブラリを設定する方法は、次の文書を参照してください。
インストールの点検

プロジェクトの作成とエージェントのインストール、JVMオプションまですべて適用したら、次の文書でチェック事項を確認します。
インストール問題の解決

エージェントをインストールする際に発生する可能性がある問題と、これを解決するための具体的なガイドを提供します。ファイアウォールの設定、SpringBoot及びTomcat JMXの設定、OSGIフレームワーク使用サーバーの設定など、様々な状況に対する解決策を案内します。詳細については、次の文書を参照にしてください。
エージェント設定

エージェント設定(whatap.conf)ファイルにオプションを適用して、モニタリングのための様々な機能を提供します。デフォルト設定から、サーバーの接続とデータ転送の設定、複数のアプリケーションサーバーの設定ファイルの管理方法、トランザクションの追跡などが含まれます。詳細については、次の文書を参照にしてください。
モニタリングの開始

すべての設定を完了してから、アプリケーションサーバーを再起動します。エージェントが情報の収集を開始します。まず、アプリケーションメニューでモニタリングデータが収集されていることを確認します。アプリケーションメニューの詳細については、次の文書を参照にしてください。

環境変数の追加​

Linux​

Windows​

Java 17バージョン以降​

ヒープヒストグラム照会​

次の段階​