Hitachi

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

Node exporterのメトリック定義ファイル（metrics_node_exporter.conf）

〈このページの構成〉

形式

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

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

ページの先頭へ

ファイル

metrics_node_exporter.conf

metrics_node_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/

ページの先頭へ

説明

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

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

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

ページの先頭へ

文字コード

UTF-8（BOM無し）

ページの先頭へ

改行コード

Windowsの場合：CR+LF

Linuxの場合：LF

ページの先頭へ

定義の反映時期

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

ページの先頭へ

記述内容

表2‒94　 メトリック定義ファイルの各メンバーに設定する値

メンバー名

省略可否

型

設定する値

name

不可

string

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

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

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

  • 半角英数字

  • -（ハイフン）

  • _（アンダースコア）

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

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

default

可

boolean

デフォルトの選択状態を設定します。

［統合オペレーション・ビューアー］画面の［トレンド］タブで選択するトレンドデータのチェックボックスに，デフォルトでチェックを入れるかどうかを指定します。

  • true：デフォルトでチェックを入れます。

  • false：デフォルトでチェックを入れません。

省略時はデフォルトでチェックを入れません。

promql

不可

string

PromQL文を設定します。

JP1/IMのトレンドデータの参照用APIで使用できるPromQL文を設定できます。

PromQL文に含まれる文字列「$jp1im_TrendData_labels」は，下記の「■$jp1im_TrendData_labelsの置き換え」に記載するPromQL文に置き換えられます。PromQL文に関する注意事項については，「PromQL文に関する注意事項」を参照してください。

1〜1023文字で，制御文字（0x00〜0x1F，0x7F〜0x9F）を除く文字を指定します。

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

resource_en

不可

object

メトリックのリソース情報（英語）を設定します。

category

可

string

メトリックのカテゴリ（英語）を設定します。

1〜255文字で，制御文字（0x00〜0x1F，0x7F〜0x9F）を除く文字を指定します。

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

省略時はメトリックのカテゴリ（英語）を設定しません。

label

可

string

メトリックの表示名（英語）を設定します。

1〜255文字で，制御文字（0x00〜0x1F，0x7F〜0x9F）を除く文字を指定します。

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

省略時は［統合オペレーション・ビューアー］画面の［トレンド］タブのメトリックの表示名にnameメンバーの設定内容を使用します。また，メトリック一覧取得APIでメトリックの表示名を返却しません。

description

可

string

メトリックの説明（英語）を設定します。

1〜1,023文字で，制御文字（0x00〜0x1F，0x7F〜0x9F）を除く文字を指定します。

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

省略時は［統合オペレーション・ビューアー］画面の［トレンド］タブにメトリックの説明を表示しません。また，メトリック一覧取得APIでメトリックの説明を返却しません。

unit

不可

string

メトリックの単位（英語）を設定します。

1〜255文字で，制御文字（0x00〜0x1F，0x7F〜0x9F）を除く文字を指定します。

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

resource_ja

可

object

メトリックのリソース情報（日本語）を設定します。

省略時はresource_enの設定内容を使用します。

category

可

string

メトリックのカテゴリ（日本語）を設定します。

1〜255文字で，制御文字（0x00〜0x1F，0x7F〜0x9F）を除く文字を指定します。

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

省略時はresource_enのcategoryの設定内容を使用します。

label

可

string

メトリックの表示名（日本語）を設定します。

1〜255文字で，制御文字（0x00〜0x1F，0x7F〜0x9F）を除く文字を指定します。

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

省略時はresource_enのlabelの設定内容を使用します。

description

可

string

メトリックの説明（日本語）を設定します。

1〜1,023文字で，制御文字（0x00〜0x1F，0x7F〜0x9F）を除く文字を指定します。

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

省略時はresource_enのdescriptionの設定内容を使用します。

unit

可

string

メトリックの単位（日本語）を設定します。

1〜255文字で，制御文字（0x00〜0x1F，0x7F〜0x9F）を除く文字を指定します。

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

省略時はresource_enのunitの設定内容を使用します。

drop_legend_labels

可

配列（string）

トレンドグラフの凡例から除外するラベルを追加する場合にラベル名を設定します。

マニュアル「JP1/Integrated Management 3 - Manager 導入・設計ガイド」の「3.15.6(4)(b)インスタンス名（グラフの凡例として表示する文字列）」に示す除外対象のラベル以外に，トレンドグラフの凡例から除外するラベル名を記載します。

1〜255文字で，制御文字（0x00〜0x1F，0x7F〜0x9F）を除く文字を指定します。

指定不可の文字を含む場合，トレンドグラフの凡例から除外されません。

ラベルの数は100個まで指定できます。100個を超えた場合，101個目以降のラベルは無視されます。
■$jp1im_TrendData_labelsの置き換え

promqlの値に含まれる文字列「$jp1im_TrendData_labels」は，パフォーマンスデータを取得するときに，取得対象を絞り込むためのPromQL文に置き換えられます。

トレンドのAPIまたは統合オペレーション・ビューアーで指定した，構成情報のSIDの種類ごと（EC2以外のCloudWatchSIDについては，監視対象のAWS名前空間ごと）の，置き換え後のPromQL文を次に示します。太字部分（可変値）は，それぞれに対応するSIDで管理するExporterの設定や，Exporterが出力するサンプルの値に置き換えられます。

表2‒95　 $jp1im_TrendData_labelsの置き換え後のPromQL文

構成情報のSIDの種類

置き換え後のPromQL文

エージェントSID

{jp1_pc_prome_hostname="Prometheusのホスト名",job="スクレイプジョブ名",instance="instanceラベルの値"}

リモートエージェントSID

EC2のCloudWatchSID

{jp1_pc_prome_hostname="Prometheusのホスト名",job="スクレイプジョブ名",instance="instanceラベルの値"},jp1_pc_nodelabel="AWSのリソースのjp1_pc_nodelabelタグに設定した値"}

EC2以外のCloudWatchSID

ページの先頭へ

モデルファイルの設定内容（初期状態）

Node exporterのメトリック定義ファイルのモデルファイルに記述されている各メトリックの設定内容（初期状態）を，次に示します。

ページの先頭へ

Copyright (C) 2023, 2024 Hitachi, Ltd.

Copyright (C) 2023, 2024 Hitachi Solutions, Ltd.