Workstation でのメトリック グループの設定

Workstation でメトリック グループを設定できます。
apmdevops102jp
Workstation でメトリック グループを設定できます。
注:
WebView でのメトリック グループの設定については、「メトリック グループの構成を参照してください。
メトリック グループ用の一致パターンの指定
メトリック グループは以下の情報を保存する管理モジュール オブジェクトです。
  • エージェント一致パターン
    -- エージェント名の一部またはすべてを含むデータを指定することにより、メトリックへの入力をフィルタする Perl 5 の正規表現。
  • メトリック一致パターン
    -- リソース(メトリックに至るまでの一連のフォルダ)およびメトリックを指定する Perl 5 の正規表現。
  • メトリック グループが属する管理モジュール。
サポータビリティ管理モジュールからのこの例を説明します。ディスク使用状況(MB)メトリック グループでは、以下の一致パターンを使用します。
  • メトリック グループ エージェント一致パターン:
    (.*)\|Custom Metric Process \(Virtual\)\|(.*)
  • メトリック一致パターン:
    Enterprise Manager\|Data Store\|(.*)Disk Usage \(mb\)
これらのフィールドに情報を指定するには、Perl 5 の正規表現言語を使用してその情報を入力するか、Investigator のメトリックとエージェントを選択してこれらのフィールドにドラッグします。
エージェント記述子は、管理モジュール単位で定義できます。このようにして定義したエージェント記述子は、管理モジュール内のメトリック グループにも適用されます。
デフォルトでは、どのメトリック グループでも、メトリック グループ別のエージェント一致パターンを使用してエージェントの検索が行われます。または、管理モジュールからエージェント一致パターンを使用する場合は、メトリック グループの設定パネルで、そのためのオプションをクリックします。このオプションを選択した場合、管理モジュールのエージェント一致パターンが変更されたときに、検索されるエージェントが自動的に変わります。
メトリック名の構造
メトリックの完全修飾名の構文は、以下のようになっています。
Domain|Hostname|Process|AgentName|Resource:Metric
たとえば、いずれか 1 つのリソースに含まれているメトリックの完全修飾名は、以下のようになります。
Acme|c1737019-a|AcmeUSA|AcmeWest|GC Heap:Bytes In Use
メトリックの上位にリソースが 2 つ存在する場合は、以下のような名前になります。
Acme|c1737019-a|AcmeUSA|AcmeWest|Servlets|FileServlet:Responses Per Second
リソースの階層がさらに深い場合は、各リソースがパイプ文字(|)で区切られます。
メトリック名の構造の詳細については、「変数の使用」を参照してください。
注:
スーパードメイン以外のドメインのユーザに対しては、以下の構文のように、ドメイン情報のないメトリック名が表示されます。
Hostname|Process|AgentName|Resource:Metric
例:
c1737019|AcmeUSA|AcmeWest|GC Heap:Bytes In Use
メトリック グループの作成
以下を行うことができます。
  • 既存のメトリックからのメトリック グループの作成。
  • [エレメント]メニューからのメトリック グループの作成。
  • メトリック グループへの別のメトリックの追加。
  • メトリック グループのカスタマイズ。
エージェントがキャプチャするデータはローカライズされていません。ロケール設定がマルチバイトのマシンでは、メトリックでマルチバイト文字が使用されている場合でも、ブラウザ ツリーのメトリック名はマルチバイト文字では表示されません。この問題を回避するには、英字を使用して、メトリックを作成してください。
注:
新しく作成した管理モジュール エレメントでは、履歴の時間範囲を使用してデータをすぐに表示しようとすると、データが正しく表示されないことがあります。正しい履歴データを表示させるには、数分待つ必要があります。
既存のメトリックからのメトリック グループの作成
既存のメトリックからメトリック グループを作成することができます。
以下の手順に従います。
  1. メトリックを右クリックし、ドロッ
    プダウン リストから[メトリック <メトリック名> からメトリック グループを新規作成]
    を選択します。
  2. デフォルトのメトリック グループ名はそのままにしておきます。
  3. メトリック グループを含める管理モジュールを、以下のいずれかの方法で選択します。
    • ドロップダウン リストから管理モジュールを選択します。または、
    • [選択]
      をクリックして、リストから管理モジュールを選択し、再び
      [選択]
      をクリックします。
  4. [OK]
    をクリックします。
    新しいメトリック グループが、管理モジュール エディタ ツリー内(保存先に指定した管理モジュールの下)で強調表示されます。
    注:
    このメトリック グループは、作成時点ですでにアクティブであり、非アクティブにすることはできません。
    メトリック グループの設定ペインで、メトリック グループの[エージェント一致パターン]フィールドおよび[メトリック一致パターン]フィールドには、すでにメトリック情報が含まれています。
    注:
    エージェント名に基づいたフィルタには、プロパティ introscope.agent.perfmon.agentExpression が使用されます。有効なエージェント一致パターンは、以下のようになります。
    ProcessName|AgentName
    または
    *|MyAgent
  5. [説明]
    タブを選択し、メトリック グループに関する説明テキストと重要な情報を
    [説明テキスト]
    フィールドに入力します。
    このフィールドには最大 64 KB のデータを入れられます。このデータは、適用後、管理モジュールの jar ファイルに保持されます。
  6. 以下のいずれかの操作を行って、使用するエージェント一致パターンを選択します。
    • 管理モジュールに対して定義されたエージェント一致パターンを使用する場合は、
      [管理モジュール エージェント一致パターンを使用]
      を選択します。
    • このメトリック グループに対して定義されたエージェント一致パターンを使用する場合は、
      [メトリック グループ エージェント一致パターンを使用]
      を選択します。
  7. [適用]
    をクリックします。
[エレメント]メニューでのメトリック グループの作成
[エレメント]メニューからメトリック グループを作成することができます。
以下の手順に従います。
  1. Workstation のいずれかのウィンドウで、
    [Workstation]
    -
    [管理モジュール エディタ]
    を選択します。
  2. [管理モジュール エディタ]ウィンドウで、
    [エレメント]
    -
    [メトリック グループを新規作成]
    を選択します。
  3. [名前]
    フィールドに、メトリック グループ名を入力します。
  4. メトリック グループを含める管理モジュールを、以下のいずれかの方法で選択します。
    • ドロップダウン リストから管理モジュールを選択します。または、
    • [選択]
      をクリックして、リストから管理モジュールを選択し、再び
      [選択]
      をクリックします。
  5. [OK]
    をクリックします。
    メトリック グループが Investigator ツリー内で強調表示され、そのメトリック グループの設定内容が設定ペインに表示されます。
    注:
    このメトリック グループは、作成時点ですでにアクティブであり、非アクティブにすることはできません。
  6. [メトリック グループ エージェント一致パターン]
    フィールドと
    [メトリック一致パターン]
    フィールドに、エージェントとメトリックを特定する情報を入力します。
    情報は、以下のいずれかの方法で入力できます。
    • 正規表現を使用した情報の入力
    • 別の Investigator ウィンドウを開いて、メトリックを選択し、[メトリック グループ]ウィンドウに情報をドラッグします。[メトリック グループ エージェント一致パターン]フィールドと[メトリック一致パターン]フィールドの周囲に青色の線が表示されます。
    ドラッグした項目をここでドロップすると、選択したメトリックの情報が、[メトリック グループ エージェント一致パターン]フィールドと[メトリック一致パターン]フィールドに自動的に入力されます。
  7. 以下のいずれかの操作を行って、使用するエージェント一致パターンを選択します。
    • 管理モジュールに対して定義されたエージェント一致パターンを使用する場合は、
      [管理モジュール エージェント一致パターンを使用]
      を選択します。
    • このメトリック グループに対して定義されたエージェント一致パターンを使用する場合は、
      [メトリック グループ エージェント一致パターンを使用]
      を選択します。
  8. [適用]
    をクリックします。
メトリック グループへのメトリックの追加
メトリック グループにメトリックを追加することができます。
以下の手順に従います。
  1. メトリック グループの設定ペインで、
    [追加]
    をクリックします。
    このアクションでは、2 番目のメトリックの情報をそのまま使用する、別のエージェント/メトリック一致パターン フィールド ペアが追加されます。
  2. 別の Investigator ウィンドウを開きます。
  3. 後から開いた Investigator ウィンドウで、メトリック グループに追加するメトリックを選択します。次に、そのメトリックを元のウィンドウの設定ペインにドラッグします。ここでは
    [メトリック グループ エージェント一致パターン]
    フィールドにドロップしてください。
  4. 2 番目の Investigator ウィンドウで同じメトリックをもう一度選択し、
    [メトリック一致パターン]
    フィールドにドラッグします。
メトリック グループのカスタマイズ
データのドラッグ アンド ドロップで得られる情報よりもカスタム化された情報を設定する必要がある場合は、メトリック グループの正規表現をカスタマイズできます。これを行うには、[メトリック グループ エージェント一致パターン]フィールドと[メトリック一致パターン]フィールドの内容を編集して、検索するメトリックを指定します。
以下のルールに従います。
Investigator ツリーの一連の階層を指定するときは、円記号を前に付けたパイプ記号で階層間を区切ります。円記号はエスケープ文字の役割を果たします。
メトリック グループ エージェント一致パターン「Host\|Process\|AgentName」で、
([^\|:]*)
を使用して、1 つのリソース セグメントを表します。
Servlets\|([^\|:]*):Average Response Time \(ms\)
」では、区切り文字と丸かっこにエスケープ文字(円記号)が必要です。
\|
\(
および
\)
の形で使用します。
Servlets\|Servlet1:Average Response Time \(ms\)
」で、複数の文字列を 1 つの一致パターンと一致させるために、丸かっこで囲まれ、パイプ文字で区切られた文字列のリストを含めることができます。
Servlets\|Servlet(1|14|18):Average Response Time \(ms\)
」で、エージェント名とメトリックの間にリソース フォルダがない場合は、メトリック名のみを入力します。それ以外の場合は、円記号を前に付けたパイプ記号で各リソース フォルダを区切り、さらにメトリック名の前にコロン(:)を挿入します。
例([メトリック一致パターン]フィールドの構文):
resource\|subresource:Metric
例([メトリック一致パターン]フィールドの構文):
resource:Metric
例([メトリック一致パターン]フィールドの構文):
Metric
たとえば、OptionReport というサーブレットの平均 JDBC クエリ時間を[メトリック一致パターン]フィールドに指定する場合は、「
Servlets\|OptionReport\|JDBC:Average Query Time
」と入力します。
すべての文字列を指定するときは、「
(.*)
」を使用します。
たとえば、「
Cherubim\|PhoneHome\|(.*)
」と入力し、さらに「
Sockets:Output Bandwidth
」と入力した場合には、ホスト Cherubim で実行中のプロセス PhoneHome のインスタンスの各ソケットの出力帯域幅を、インスタンスを限定しないで指定したことになります。
[メトリック一致パターン]フィールドに「
File System:(.*)
」と入力した場合、これによって表示対象になるデータは、Investigator の File System にあるファイル入力メトリックとファイル出力メトリックです。一方、「
File System:File Input Rate
」と入力すると、表示対象はファイル入力速度のみになります。
メトリック グループを使用して表示するデータのサーバ、プロセス、およびエージェントを限定しないときは、[エージェント]フィールドに「
(.*)\|(.*)\|(.*)
」と指定します。それ以外の場合は、この文字列の一部またはすべての代わりに特定のホスト名、プロセス名、エージェント名、またはこれらの組み合わせを指定すると、それに一致するエージェントを検索できます。
メトリック ツリーのブランチを除外するには、メトリック グループの正規表現で負のルックアヘッドを使用します。たとえば、
Agents\|(.*)\|(.*)\|(?!ima_q01)([^\-:]*):ConnectionStatus
 の場合は ima_q01 の「ConnectionStatus」は除外されますが、その他のエージェントの「ConnectionStatus」は引き続き表示されます。
以下の手順に従います。
  1. ルールに従って、定義を編集します。
  2. 必要に応じて、
    [追加]
    をクリックして、メトリック グループに追加するメトリックを指定します。
  3. [適用]
    をクリックします。