Tomcat サーバー用 Java エージェント

前提条件

  • エージェントのインストールに必要な前提条件の確認については エージェントのインストールに必要な前提条件の確認 を参照してください。
  • SixthSense Java エージェント。エージェントのダウンロード を参照してください。
  • エージェントが SixthSense プラットフォームに接続するために必要な認証用の SSL/TLS 証明書。これらの証明書はカスタマーサポートから提供されます。
  • SixthSense コレクターの URL/IP（カスタマーサポートから提供されるお客様のテナントURL）
  • アクセストークン。トークンへのアクセスについては 「SixthSense ポータルを利用開始する」にある アクセス トークンの取得 を参照してください。

エージェントの設定

Java エージェントは、環境変数を通して引数を渡すことで設定できます。Tomcat サーバーの異なる場所から環境変数を渡すには、次のようにします。

Tomcat 起動スクリプトを編集する必要があります。デフォルトでは、Tomcat 起動スクリプトは $CATALINA_HOME/bin ディレクトリの catalina.sh または catalina.bat です。または、Tomcat の環境変数に引数を設定します。

エージェントのダウンロード

Java アプリケーションを監視するには、SixSense Java エージェントをダウンロードするための有効なライセンスとアクセス権が必要です。

curl --header "PRIVATE-TOKEN:{{TOKEN}}" --output agent.zip "https://artifacts-observability.sixthsense.rakuten.com/api/v4/projects/4/packages/generic/sixthsense/{{AGENT_VERSION}}/agent.zip"
  • ダウンロードしたSixthSense Java エージェントのzipファイルを、アプリケーションを監視する必要があるサーバー上で解凍します。

エージェント構成ファイルにアプリケーション情報を追加する

インストルメント化が必要なアプリケーションサーバーに、エージェントのプライマリ .jar ファイル（SixthSenseAgent.jar）へのパスを含めるように構成します。

  1. アプリケーションサーバーの起動スクリプトを編集して、パスを設定します。
  2. アプリケーションサーバーを再起動します。
  3. アプリケーションサーバーが再起動すると、Java エージェントが JVM およびアプリケーション環境のデフォルトコンポーネントとして検出されたクラスをインストルメント化します。
note

関連する具体的な手順は、アプリケーションサーバーによって異なります。

  1. agent/ca パスに「ca」という名前のフォルダを作成します。
  2. agent/ca フォルダに共有されたca.crtファイルをコピーします。
  3. アプリケーション名とチーム ID を追加します。
  4. ダッシュボードの「agent.service_name」を設定して、アプリケーション名を識別し、アプリケーションがどのチームに属するかを識別するチーム ID を「agent.team_id」に設定します。

例えば、USER_APP がアプリケーション名の場合は、agent folder/SixthSense/Config/agent.config ファイルに移動します。

agent.service_name=${SW_AGENT_NAME:USER_APP}

エージェント SixthSense ポータルへの接続

  1. SixthSense ポータルにログインします
  2. 左側のペインで [設定] をクリックします。
  3. [アクセストークン] をクリックします。
  4. [アクセストークンを表示]をクリックします。
  5. [コピー] をクリックしてアクセス トークンをコピーし、Agent.config ファイルのプロパティセットに追加します。agent.authentication
  6. agent.config ファイルに移動します。Agent フォルダ/SixthSense/Config/agent.config ファイル* Set agent.authentication = ${SW_AGENT_AUTHENTICATION: AccessToken}
  7. コレクターのバックエンドサービスを、オンボーディングチームから提供されたバックエンドコレクターURLに設定します。

例： collector.backend_service=${SW_AGENT_COLLECTOR_BACKEND_SERVICES:d-c.34.93.18.45.sslip.io:443}

OneCloud プラットフォームの場合は、以下の手順に従います。

  1. collector.backend_service をバックエンドコレクター URL に次のように設定します。

イントラパブリックネットワークを使用してバックエンドに接続する場合： collector.backend_service=${SW_AGENT_COLLECTOR_BACKEND_SERVICES:133.237.176.44:80}

OneCloudプライベートネットワークを使用してバックエンドに接続する場合： collector.backend_service=${SW_AGENT_COLLECTOR_BACKEND_SERVICES:100.99.116.221:80}

  1. エージェント構成ファイルで TLS を false に設定します。 agent.force_tls=${SW_AGENT_FORCE_TLS:false}

Unix 環境

setenv.sh

  1. CATALINA_BASE/bin/setenv.sh スクリプトがまだ存在しない場合は作成します。
  2. 以下の CATALINA_OPTS環境変数を使用して SixthSense エージェントを使用するように setenv.sh スクリプトを設定します。CATALINA_OPTS environment variable: export CATALINA_OPTS="$CATALINA_OPTS -javaagent:/full/path/to/SixthSense.jar
  3. エージェントを設定した後、Tomcat を再起動します。

catalina.sh

  1. JAVA_OPTS環境変数を使用してSixthSenseエージェントを使用するようにcatalina.shファイルを設定します。JAVA_OPTS environment variable: export JAVA_OPTS="$JAVA_OPTS -javaagent:/full/path/to/SixthSense.jar".
  2. エージェントを設定した後、Tomcat を再起動して監視を開始します。

Windows環境

setenv.bat

  1. CATALINA_BASE/bin/setenv.bat スクリプトがまだ存在しない場合は、作成します。
  2. 以下の CATALINA_OPTS 環境変数を使用して、SixthSense エージェントを使用するように setenv.bat スクリプトを設定します。SET "CATALINA_OPTS=%CATALINA_OPTS% -javaagent:/full/path/to/SixthSense.jar"　。
  3. エージェントを設定した後、Tomcat を再起動して監視を開始します。

catalina.bat

  1. catalina.bat を使用して Tomcat を起動する場合は、SET Java_OPTS=%Java_OPTS% -Javaagent:/full/path/to/SixthSense.jar ファイルの先頭で Java_OPTS 変数を設定します。
  2. エージェントの設定後、Tomcat を再起動して監視を開始します。

サービスを介した Java エージェントの設定

  1. [スタート] > [Apache Tomcat X.Y.Z.] > [configure Tomcat] > [Java] に移動します。
  2. [Java オプション] テキストボックスに、以下の引数を入力します。 パス区切り文字には、スラッシュ（/）を使用します。 SET 「CATALINA_OPTS=%CATALINA_OPTS% -javaagent:/full/path/to/SixthSense.jar」
  3. Tomcat 6 の場合、-Javaagent 引数の後に改行を追加します。 -Javaagent:/full/path/to/SixthSense.jar
  4. [適用] を選択し、Tomcat を再起動して監視を開始します。