エージェント設定
WhaTapエージェントは、エージェントごとに必要な設定をwhatap.confファイルに作成します。 エージェントは、環境変数を使用して設定ファイルの位置を把握して読み込みます。
他の設定がない場合、エージェントは(whatap.agent-X.Y.Z.jar)にあるディレクトリからwhatap.conf ファイルを実装します。5秒ごとにwhatap.confファイルの確認してリロードします。
ユーザーの利便性を高めるため、WhaTapモニタリングサービスでもエージェント設定機能を提供しています。
基本設定
whatap.home=.
whatap.config=whatap.conf
-
whatap.home
:既定値は_whatap.agent.jar_ファイルへのパスを入力してください。 -
whatap.config
: ファイル名のみを入力することをお勧めします。相手パスを一緒に入力することができます。
エージェントがデータを収集し、サーバーにデータを送信するには、アクセスキーとサーバーアドレスが設定されている必要があります。
license=x220g160hgd29-x3qpff0garcus7-z4p0kao58un11a
whatap.server.host=10.10.0.1
WhaTapエージェントを初めて実行すると、次のようにどのjarファイルがエージェントとして使用され、どのパスでwhatap.confファイルをロードされたのかを確認できます。
サーバー接続およびデータ送信
WhaTapエージェントは、whatap.confファイルに設定したサーバーアドレスに接続します。
whatap.server.host=10.10.1.1
whatap.server.port=6600 # 既定値
- TCPセッションを接続すると
license
を利用してサーバーから通信キーを受け取ります。誤ったlicense
を設定すると、サーバーはセッションを終了します。 - TCP接続が繰り返し終了する場合は、ファイアウォールの確認または
license
の値が正しいことを確認してください。 - TCPセッションを接続すると、サーバーから受信した秘密鍵に基づいてセキュリティで保護された通信データが送信されます。
複数のアプリケーションサーバーの設定ファイル管理
1つのサーバーの中で複数のアプリケーションを運営する場合、各アプリケーション別の設定ファイルを別途管理するには、whatap.confファイル名を変更し、開始スクリプトにJVMオプションを追加してください。
-Dwhatap.config=whatap_Aservice.conf
-Dwhatap.config=whatap_Bservice.conf
whatap.conf設定ファイルは、${WHATAP_HOME}
パスに配置する必要があります。
サービス画面でエージェントを設定する
ホーム画面 > プロジェクト選択 > 管理 > エージェント設定
モニタリング対象サーバーにあるwhatap.confファイルを修正することなく、WhaTapモニタリングサービスからエージェント設定のオプションを追加または修正、削除することができます。
-
この機能は、修正権限を持つメンバーのみ利用できます。修正権限のないメンバーは、設定内容の表示のみ可能です。
-
オプション値として設定できる形式は次のとおりです。
- Boolean形式の値は、
true
またはfalse
を選択してください。 - 数値の値は数字のみ入力できます。
- テキスト(String) 形式の値を入力または修正する場合は、オプションの説明を詳しく確認してください。
- Boolean形式の値は、
-
修正できないオプションは選択できません。(例、
license
) -
追加または修正、削除したオプションによっては、エージェントの再起動が必要になる場合があります。
-
アプリケーションの種類やエージェントのバージョンによって、適用できるオプションキーが異なる場合があります。
オプションを追加する
-
エージェント一覧からオプションを追加するエージェントを選択します。
-
オプションの作成から追加するオプションを選択します。
- 検索で追加するオプションを見つけることができます。テキストを入力すると、一致するオプションをフィルタリングします。
- 直接入力を選択する場合は、オプションキーと値を入力できます。
-
選択したオプションキーの説明と既定値を確認し、設定値を入力します。
- 選択したオプションをキャンセルするにはボタンを選択します。
- オプションを追加設定するには+ 追加するボタンを選択し、上記2のプロセスを繰り返します。
-
必要なすべてのオプションを追加した場合は、画面右上の適用ボタンを選択します。
選択したオプションと設定値をエージェントに適用します。
- 変更内容を初期化するには、画面右上のボタンを選択します。
- オプション値に何も入力しない状態で適用ボタンを選択した場合は、オプションを削除します。
- すでに追加したオプションは、オプション一覧から選択することはできません。
- アプリケーションの種類やエージェントのバージョンによって、適用できるオプションキーが異なる場合があります。
- 例として提供された画像は、アプリケーションの種類やエージェントによって異なる場合があります。
オプションを修正・削除する
-
画面を上下にスクロールするか、左側のオプション一覧から修正または削除するオプションを選択してください。
-
変更するオプションから目的の値を選択または修正してください。オプションを削除するにはボタンを選択してください。
-
変更した事項を適用するには適用ボタンを選択してください。
-
画面の上部に移動するにはオプションで移動ボタンを選択してください。
-
オプション値に何も入力しない状態で適用ボタンを選択した場合は、オプションを削除します。
複数のエージェントに同時適用する
プロジェクトに所属する複数のエージェントに変更したオプションを同時に適用できます。
-
画面右上の複数エージェント適用 チェックボックスを選択すると、各オプション項目にチェックボックスが生成されます。
-
同時に適用するオプションのチェックボックスを選択してください。複数選択できます。
-
画面右上の適用ボタンを選択してください。
-
エージェント適用ウィンドウが表示すると、変更したオプションを適用するエージェントを選択してください。すべてを選択するには、全体選択チェックボックスを選択してください。
-
適用ボタンを選択します。
エージェントの既定値を設定する
プロジェクトに新しいエージェントを追加する場合、既存の設定値を繰り返し適用する手間を省くには、プロジェクト別、業務別の基本設定値を作成して適用します。
タスクデフォルト:whatap.confファイルから
whatap.okind
エントリとして分類されたエージェントにオプションを適用し、どのオプションが適用されているか確認することができます。プロジェクトデフォルト:プロジェクトに所属するすべてのエージェントに共通のオプションを適用することができ、どのオプションに適用されているか確認できます。
-
ジョブのデフォルトまたはプロジェクトのデフォルトタブを選択してオプションを適用するとエージェントの管理に役立ちます。
-
オプションの優先順位は、ジョブのデフォルト、プロジェクトのデフォルト、エージェント設定の順です。
- プロジェクトのデフォルトで、bオプション値に1000を適用し、ジョブのデフォルトで、bオプション値に2000を適用した場合、ジョブのデフォルトで設定したオプション値の2000を優先します。
- プロジェクトのデフォルトで、bオプション値に入力せずに、ジョブのデフォルトの bオプション値に2000が適用された場合、ジョブのデフォルトで設定したオプション値が優先されます。
エージェント設定を共有する
エージェントの設定内容を json形式のファイルとして保存し、そのファイルを読み込んで他のエージェントに適用することができます。
-
エージェント一覧で設定内容をjsonファイルに書き出しするエージェントを選択してください。
-
画面右上のボタンを選択してください。
-
jsonファイルをダウンロードしてください。
-
エージェント一覧で他のエージェントを選択してください。
-
画面右上のボタンを選択してください。
jsonファイルを通じて読み込んだエージェント設定を確認してください。
エージェント設定オプションの案内
次のリンクは、設定できるオプションについて説明します。