本文へスキップ

エージェント名の識別

WhaTapはモニタリングは、情報収集の対象であるアプリケーションサーバーを識別するための情報で、基本的にアプリケーションサーバーから収集した情報を使用します。基本的な使用状況の情報は、アプリケーションサーバーの種類、IPアドレスなどを組み合わせであり、アプリケーションサーバーを固有識別子として使用します。必要に応じて、ユーザーが設定した名前を使用するか、パターンを変更して固有の値に変更して使用します。エージェントの名前は固有の値である必要があります。

アプリケーションサーバーから抽出した情報を使用する理由は、アプリケーションサーバーの停止またはネットワークの切断、エージェント問題による収集サーバーとエージェントの通信状態が復旧した場合に、再接続されたエージェントから送信される情報が既存エージェントから送信された情報との継続性を維持するためです。

注意
  • エージェント名は、プロジェクトごとに一意である必要があります。
  • エージェントID／名前を変更しても、古いデータには関連付けられません。
ノート
  • WhaTapモニタリンサービスでは、モニタリング対象をオブジェクトまたはエージェントとして混在して使用できます。

デフォルト名の決定方法​

JVMオプションでwhatap.oname設定がない場合、エージェント名に次の優先順位で自動的に割り当てられます。

  1. whatap.typeを特定します。
  2. whatap.typeがサーブレットコンテナの場合、アプリケーションが使用するポートを識別します。
  3. ポートを特定できない場合は、process ID(PID)を検索します。
  4. 識別された情報にIPv4アドレスの3番目と4 番目を追加して、最終的に名前を決定します。

例えば、IPアドレスが10.11.12.13のサーバーでTomcatが8080番ポートで起動した場合、TC-12-13-8080名でエージェント名が自動的に割り振られます。

エージェント名の変数​

使用可能な名前の変数を次のように指定します。

変数説明
文字列入力した文字列を使用します。
{type}コンテナタイプを自動的に識別して割り当てます。
自動識別の対象：JAVA、 TOMCAT、 JBOSS、 RESIN、 SPRINGBOOT、 JETTY、 JEUS、 WEBLOGIC、 WEBSPHERE、 UNDERTOW、 PLAY
{ip0}IPv4アドレスのうち、1番目の単位を使用します。(例：10.11.12.13のうち10)
{ip1}IPv4アドレスのうち、2番目の単位を使用します。(例：10.11.12.13のうち11)
{ip2}IPv4アドレスのうち、3番目の単位を使用します。(例：10.11.12.13のうち12)
{ip3}IPv4アドレスのうち、4番目の単位を使用します。(例：10.11.12.13のうち13)
{pid}JavaのProcess ID(PID)を使用します。
{port}アプリケーションがListenするポートを使用します。

エージェント名の設定​

起動スクリプトにJVMオプションを追加して、自動的に指定する名前の代わりに独自の名前を設定することができます。

オプション設定位置説明
-Dwhatap.nameJVM Optionsエージェント名をパターンに設定します。
既定値{type}-{ip2}-{ip3}-{port}
-Dwhatap.onameJVM Optionsエージェント名を固定値に設定します。
-Dwhatap.oname=java-sales-01
オプションを設定しないと-Dwhatap.nameオプションに設定されたパターンで適用されます。
Tips

IPアドレスが10.11.12.13で、ポート番号が8000の環境で

  • -Dwhatap.onameオプションを適用していない場合：whatap.onameは、-Dwhatap.nameに設定されたパターンによってJAVA-12-13-8000にデフォルト設定されます。

  • -Dwhatap.onameオプションを適用した場合: -Dwhatap.nameオプションを無視して-Dwhatap.onameオプションに設定した値でエージェント名が適用されます。

ノート
  • クラウドのScale Out環境では、VMをコピーして使用できます。したがって、オブジェクト名が自動的に付与されることが重要です。
  • 2つのVPC環境を作成し、同じprivate IPを使用するようにネットワークを構成した場合、2つのVPCが重複しないようにする必要があります。それらを別々のプロジェクトに分割したり、-Dwhatap.nameオプションと名前変数を異なる方法で設定することができます。

次は、whatap.confファイルにエージェント名で適用できるオプションです。

  • whatap.name String

    既定値{type}-{ip2}-{ip3}-{port}

    エージェント名をパターンとして設定します。

  • whatap.okind String

    エージェントが所属するグループ単位を設定します。複数のエージェントをまとめて設定し、そのグループ名でトポロジを確認できます。

  • whatap.onode String

    エージェントが属するNode単位を設定します。

  • auto_oname_enabled Boolean

    既定値false

    サーバーからエージェント名(whatap.oname)を自動的に受信してサーバーに登録する機能をアクティブにします。 このオプションを適用する場合、JVMオプションとして設定した-Dwhatap.name 、-Dwhatap.onameの値は無視します。 収集サーバーとの通信により、whatap.oname値が与えられ、エージェントの通常の動作を開始します。

  • auto_oname_prefix String

    既定値agent

    エージェント名をサーバーから自動的に割り当てる場合は、エージェント名のprefixや業務名を使用します。prefixにシリアル番号「1~)」を付与します。

    ノート

    エージェント名を自動的に割り当てる「auto_oname_enabled」オプションは、使用する前に有効(「true」) にする必要があります。

  • auto_oname_reset Int

    既定値0

    サーバーから新しいエージェント名を付与するために修正します。エージェント名を自動付与すると、whatap.onameというシステム環境変数に設定されます。一度定められたシステムの環境変数は、JAVAインスタンスが再起動するまで維持します。リセットしたいときは、auto_oname_reset値を修正してください。現在の設定値と異なる値に変更すると適用されます。