本文へスキップ

エージェント設定

WhaTapエージェントは、エージェントごとに必要な設定をwhatap.confファイルに作成します。 エージェントは、環境変数を使用して設定ファイルの位置を把握して読み込みます。

他の設定がない場合、エージェントは(whatap.agent-X.Y.Z.jar)にあるディレクトリからwhatap.conf ファイルを実装します。5秒ごとにwhatap.confファイルの確認してリロードします。

ユーザーの利便性を高めるため、WhaTapモニタリングサービスでもエージェント設定機能を提供しています。

基本設定

whatap.conf
whatap.home=.
whatap.config=whatap.conf
  • whatap.home:既定値は_whatap.agent.jar_ファイルへのパスを入力してください。

  • whatap.config: ファイル名のみを入力することをお勧めします。相手パスを一緒に入力することができます。

エージェントがデータを収集し、サーバーにデータを送信するには、アクセスキーとサーバーアドレスが設定されている必要があります。

whatap.conf
license=x220g160hgd29-x3qpff0garcus7-z4p0kao58un11a
whatap.server.host=10.10.0.1

WhaTapエージェントを初めて実行すると、次のようにどのjarファイルがエージェントとして使用され、どのパスでwhatap.confファイルをロードされたのかを確認できます。

Java start screen

サーバー接続およびデータ送信

WhaTapエージェントは、whatap.confファイルに設定したサーバーアドレスに接続します。

whatap.conf
whatap.server.host=10.10.1.1
whatap.server.port=6600 # 既定値
  • TCPセッションを接続するとlicenseを利用してサーバーから通信キーを受け取ります。誤ったlicenseを設定すると、サーバーはセッションを終了します。
  • TCP接続が繰り返し終了する場合は、ファイアウォールの確認またはlicenseの値が正しいことを確認してください。
  • TCPセッションを接続すると、サーバーから受信した秘密鍵に基づいてセキュリティで保護された通信データが送信されます。

複数のアプリケーションサーバーの設定ファイル管理

1つのサーバーの中で複数のアプリケーションを運営する場合、各アプリケーション別の設定ファイルを別途管理するには、whatap.confファイル名を変更し、開始スクリプトにJVMオプションを追加してください。

Service A
-Dwhatap.config=whatap_Aservice.conf
Service B
-Dwhatap.config=whatap_Bservice.conf
注意

whatap.conf設定ファイルは、${WHATAP_HOME}パスに配置する必要があります。

サービス画面でエージェントを設定する

ホーム画面 > プロジェクト選択 > 管理 > エージェント設定

モニタリング対象サーバーにあるwhatap.confファイルを修正することなく、WhaTapモニタリングサービスからエージェント設定のオプションを追加または修正、削除することができます。

ノート
  • この機能は、修正権限を持つメンバーのみ利用できます。修正権限のないメンバーは、設定内容の表示のみ可能です。

  • オプション値として設定できる形式は次のとおりです。

    • Boolean形式の値は、trueまたはfalseを選択してください。
    • 数値の値は数字のみ入力できます。
    • テキスト(String) 形式の値を入力または修正する場合は、オプションの説明を詳しく確認してください。
  • 修正できないオプションは選択できません。(例、license

  • 追加または修正、削除したオプションによっては、エージェントの再起動が必要になる場合があります。

  • アプリケーションの種類やエージェントのバージョンによって、適用できるオプションキーが異なる場合があります。

オプションを追加する

エージェント設定

  1. エージェント一覧からオプションを追加する数字1エージェントを選択します。

  2. 数字2 オプションの作成から追加するオプションを選択します。

    • 検索で追加するオプションを見つけることができます。テキストを入力すると、一致するオプションをフィルタリングします。
    • 直接入力を選択する場合は、オプションキーと値を入力できます。
  3. 選択したオプションキーの説明と既定値を確認し、設定値を入力します。

    • 選択したオプションをキャンセルするには削除アイコンボタンを選択します。
    • オプションを追加設定するには+ 追加するボタンを選択し、上記2のプロセスを繰り返します。
  4. 必要なすべてのオプションを追加した場合は、画面右上の適用ボタンを選択します。

選択したオプションと設定値をエージェントに適用します。

ノート
  • 変更内容を初期化するには、画面右上の初期化アイコンボタンを選択します。
  • オプション値に何も入力しない状態で適用ボタンを選択した場合は、オプションを削除します。
  • すでに追加したオプションは、オプション一覧から選択することはできません。
  • アプリケーションの種類やエージェントのバージョンによって、適用できるオプションキーが異なる場合があります。
  • 例として提供された画像は、アプリケーションの種類やエージェントによって異なる場合があります。

オプションを修正・削除する

オプションを修正

  1. 画面を上下にスクロールするか、左側のオプション一覧から修正または削除するオプションを選択してください。

  2. 変更するオプションから目的の値を選択または修正してください。オプションを削除するには削除アイコンボタンを選択してください。

  3. 変更した事項を適用するには適用ボタンを選択してください。

ノート
  • 画面の上部に移動するには数字3オプションで移動ボタンを選択してください。

  • オプション値に何も入力しない状態で適用ボタンを選択した場合は、オプションを削除します。

複数のエージェントに同時適用する

プロジェクトに所属する複数のエージェントに変更したオプションを同時に適用できます。

  1. 画面右上の複数エージェント適用 チェックボックスを選択すると、各オプション項目にチェックボックスが生成されます。

  2. 同時に適用するオプションのチェックボックスを選択してください。複数選択できます。

  3. 画面右上の適用ボタンを選択してください。

  4. エージェント適用ウィンドウが表示されると、変更したオプションを適用するエージェントを選択してください。すべてを選択するには、全体選択チェックボックスを選択します。

  5. 適用ボタンを選択します。

エージェントの既定値を設定する

プロジェクトに新しいエージェントを追加する場合、既存の設定値を繰り返し適用する手間を省くには、プロジェクト別、業務別の基本設定値を作成して適用します。

  • タスクデフォルトwhatap.confファイルから whatap.okindエントリとして分類されたエージェントにオプションを適用し、どのオプションが適用されているか確認することができます。

  • プロジェクトデフォルト:プロジェクトに所属するすべてのエージェントに共通のオプションを適用することができ、どのオプションに適用されているか確認できます。

ノート
  • ジョブのデフォルトまたはプロジェクトのデフォルトタブを選択してオプションを適用するとエージェントの管理に役立ちます。

  • オプションの優先順位は、ジョブのデフォルトプロジェクトのデフォルトエージェント設定の順です。

    • プロジェクトのデフォルトで、bオプション値に1000を適用し、ジョブのデフォルトで、bオプション値に2000を適用した場合、ジョブのデフォルトで設定したオプション値の2000を優先します。
    • プロジェクトのデフォルトで、bオプション値に入力せずに、ジョブのデフォルトの bオプション値に2000が適用された場合、ジョブのデフォルトで設定したオプション値が優先されます。

エージェント設定を共有する

エージェントの設定内容を json形式のファイルとして保存し、そのファイルを読み込んで他のエージェントに適用することができます。

  1. エージェント一覧で設定内容をjsonファイルに書き出しするエージェントを選択してください。

  2. 画面右上の書き出しアイコンボタンを選択してください。

  3. jsonファイルをダウンロードしてください。

  4. エージェント一覧で他のエージェントを選択してください。

  5. 画面右上の読み込みアイコンボタンを選択してください。

jsonファイルを通じて読み込んだエージェント設定を確認してください。

エージェント設定オプションの案内

次のリンクは、設定できるオプションについて説明します。

エージェント名の識別

モニタリング対象を区別するためのアプリケーションサーバーの固有の識別子設定について案内します。モニタリング対象システムの中からアプリケーションサーバーを正確に区別するために必須な設定です。サーバーのタイプ、IPなどの情報から自動的に名前を指定する方式と、ユーザーが直接whatap.confファイルやJVMオプションでエージェント名を設定する方法があります。

エージェントの通信設定

Javaエージェントがアプリケーションサーバーから収集したデータをサーバーに転送するためのネットワーク設定方法を案内します。主な設定オプションとしては、収集サーバーホスト、ポート、タイムアウト値、ネットワーク転送サイズ、データ転送キューサイズなどがあり、エージェントの効率的なデータ管理と安定したサーバー通信を保証するために重要です。

HTTPC, API Call

HTTP外部呼び出しとAPI呼び出し関連データの収集、分析するためのJavaエージェントのオプション設定方法を案内します。TOO SLOWエラー処理及びCPUとメモリ使用量の追跡、呼び出し時点のスタックトレース記録、URL正規化など、細かいモニタリングのための様々なオプションを提供します。これにより開発者は、アプリケーションの外部依存性を効率的に管理し、性能問題を識別できます。

スクリプトプラグイン

Javaエージェントが提供するプラグインオプションを通じて、ユーザーが希望するコードをトレースデータに注入するか、メソッド実行前後に付加情報を追加する方法を提供します。メソッドの開始/終了時点で特定のコードを実行する場所を設定するオプションと、ユーザー定義型poolをモニタリングするためのクラス設定方法が含まれます。実際のプラグインの適用事例を通じて具体的な活用方法を提示し、モニタリングの柔軟性と細さを高める様々な設定例とAPIの使い方を案内します。

負荷制御

Javaアプリケーションサーバーのトラフィックスロットリングオプションを設定するエージェントオプションを案内します。アプリケーションの最大同時リクエスト数を制限し、特定のユーザーまたはURLに基づいてサービスへのアクセスを制御する機能を含めます。ユーザー定義型メッセージの送信、URLリダイレクト設定、イベント通知の活性化など、様々なオプションを提供し、過負荷状況でのアプリケーションの安定性を保障できます。

エージェント通知

Javaエージェントを通じてアプリケーションサーバーで発生する様々なイベントに対する通知の設定方法を提供します。トランザクションの再帰呼び出し、サービス拒否、HTTPC接続エラー、ヒップおよびディスク使用量超過、CPU使用量しきい値到達、DBコネクション重複割り当て、例外発生時にイベント通知を設定するオプションが含まれます。各イベントごとに発行間隔、発行可否、しきい値の設定など、細かい調整ができます。

統計

Javaアプリケーションモニタリングのための様々な統計収集機能関連エージェントオプションをご案内します。性能カウンタの拡張、ドメイン別トランザクションの収集、マルチサーバートランザクションの依存性分析、ログインタイプ別及びRefererer別の統計収集などが含まれます。また、SQL、HTTP Call、エラー統計とユーザエージェント情報収集の最大レコード数制限設定も確認できます。

トランザクションエラースタック

Javaアプリケーションでトランザクション中に発生するエラーを感知し、これに対するスタックトレースを表示するエージェント設定オプションを案内します。 トランザクション、メソッド、SQL、HTTP呼び出し、SOCKET呼び出しなど様々な領域からエラー情報を収集し、エラースタックの長さ、タイトルの長さなどを設定する方法が含まれます。 エージェント設定によりエラー管理を改善し、アプリケーションのエラー診断をより効率的に行えるようにサポートします。

付加機能

Javaアプリケーションのモニタリングレベルをユーザーのニーズに合わせて調整できる追加のエージェント設定オプションを案内します。SQLパラメータの収集、HTTPパラメータとヘッダ情報の収集、ユーザーIP情報の抽出、ユーザ数の追跡方法の選択、SAP Functionの追跡などを含みます。これらのオプションにより、より詳細なデータ収集と分析が可能になり、特にセキュリティが重要な環境で必要に応じてオプションを調整できます。