Hitachi

JP1 Version 13 JP1/Integrated Management 3 - Manager コマンド・定義ファイル・APIリファレンス


Yet another cloudwatch exporterのメトリック定義ファイル(metrics_ya_cloudwatch_exporter.conf)

〈このページの構成〉

形式

[
  {
    "name":"トレンドデータのメトリック名",
    "default":デフォルト選択状態,
    "promql":"PromQL文",
    "resource_en":{
      "category":"メトリックのカテゴリ(英語)",
      "label":"メトリック表示名(英語)",
      "description":"メトリックの説明(英語)",
      "unit":"メトリックの単位(英語)"
    },
    "resource_ja":{
      "category":"メトリックのカテゴリ(日本語)",
      "label":"メトリック表示名(日本語)",
      "description":"メトリックの説明(日本語)",
      "unit":"メトリックの単位(日本語)"
    },
    "cloud_srv": "AWSサービス名前空間名",
    "drop_legend_labels": ["ラベル名", ・・・]
  }, ・・・
]
注※

[]内に記述できる要素の数は1〜1,000個です。範囲外の個数の要素を記述した場合は,KAJY24609-Eのエラーメッセージを出力します。

ファイル

metrics_ya_cloudwatch_exporter.conf

metrics_ya_cloudwatch_exporter.conf.model(モデルファイル)

格納先ディレクトリ

■統合マネージャーホスト

Windowsの場合
  • 物理ホストのとき

    Managerパス\conf\imdd\plugin\jp1pccs\

  • 論理ホストのとき

    共有フォルダ\jp1imm\conf\imdd\plugin\jp1pccs\

Linuxの場合
  • 物理ホストのとき

    /etc/opt/jp1imm/conf/imdd/plugin/jp1pccs/

  • 論理ホストのとき

    共有ディレクトリ/jp1imm/conf/imdd/plugin/jp1pccs/

説明

[統合オペレーション・ビューアー]画面の[トレンド]タブで表示するYet another cloudwatch exporterのメトリック情報を定義するファイルです。

定義内容は,JP1/IM - Agentの製品プラグインの__metricListGetメソッド,および__timeSeriesDataGetメソッドの返却値に使用します。

Yet another cloudwatch exporterのIM管理ノードは,Yet another cloudwatch exporterのメトリック定義ファイルに定義されているメトリックのリソースだけに作成します。

JP1/IM - Managerが階層構成で,統合マネージャーから,下位マネージャーのトレンドデータ管理DBに保存されているトレンドデータを参照する場合,統合マネージャーのメトリック定義ファイルに,参照するトレンドデータのメトリックを追加する必要があります。

文字コード

UTF-8(BOM無し)

改行コード

Windowsの場合:CR+LF

Linuxの場合:LF

定義の反映時期

[統合オペレーション・ビューアー]画面の[トレンド]タブ,または,REST APIで,メトリックの情報を取得したときに反映されます。

Yet another cloudwatch exporterのIM管理ノードについては,jddcreatetreeコマンドおよびjddupdatetreeコマンドを実行したときに反映されます。

記述内容

nameメンバーとcloud_srvメンバーに設定する値を次に示します。それ以外のメンバーに設定する値については,「Node exporterのメトリック定義ファイル(metrics_node_exporter.conf)」の「記述内容」を参照してください。

表2‒97  メトリック定義ファイルのnameメンバーとcloud_srvメンバーに設定する値

メンバー名

省略可否

設定する値

name

不可

string

トレンドデータのメトリック名を設定します。

トレンドデータ(時系列データ)のメトリック名は,[統合オペレーション・ビューアー]画面の[トレンド]タブで,トレンドデータの種類を示す文字列として表示されます。

Yet another cloudwatch exporterのメトリック定義ファイルの場合,ここで定義されているメトリックのリソースだけを作成します。また,メトリック名は,Yet another cloudwatch exporterのメトリック名と一致させる必要があります。

1〜255文字で,次に示す文字を指定できます。

  • 半角英数字

  • -(ハイフン)

  • _(アンダースコア)

指定不可の文字を含む場合,KAJY24604-EまたはKAJY24605-Eのエラーメッセージが出力されます。

メトリック名は,メトリック定義ファイル内で一意にしてください。一意でない場合,KAJY24608-Eのエラーメッセージが出力されます。

cloud_srv

string

AWSサービス名前空間名を設定します。

このメンバーは,Yet another cloudwatch exporterのメトリック定義ファイルの場合だけ,必須で設定します。

Yet another cloudwatch exporter設定ファイル(jpc_ya_cloudwatch_exporter.yml)で指定した次の名前空間の名称を設定します。

  • <Auto-discovery job>のtypeで指定した名前空間

(例1)AWS/EC2

(例2)AWS/S3

1〜255文字で,次に示す文字を指定できます。

  • 半角英数字

  • .(ピリオド)

  • -(ハイフン)

  • _(アンダースコア)

  • /(スラッシュ)

  • #(ハッシュ)

  • :(コロン)

指定不可の文字を含む場合,KAJY24604-EまたはKAJY24605-Eのエラーメッセージが出力されます。

注※

Auto-discovery jobのtypeに指定できる名前空間(サービス)については,マニュアル「JP1/Integrated Management 3 - Manager 導入・設計ガイド」の「3.15.6(1)(k) Yet another cloudwatch exporterのIM管理ノードの作成」の,JP1/IM - AgentのYet another cloudwatch exporterが監視対象としてサポートするAWSの名前空間について説明している個所を参照してください。

モデルファイルの設定内容(初期状態)

Yet another cloudwatch exporterのメトリック定義ファイルのモデルファイルに記述されている各メトリックの設定内容(初期状態)を,次に示します。