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

形式

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

注※

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

ページの先頭へ

ファイル

metrics_blackbox_exporter.conf

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

ページの先頭へ

説明

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

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

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

ページの先頭へ

文字コード

UTF-8（BOM無し）

ページの先頭へ

改行コード

Windowsの場合：CR+LF

Linuxの場合：LF

ページの先頭へ

定義の反映時期

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

ページの先頭へ

記述内容

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

ページの先頭へ

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

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

• probe_success

  ■設定内容（初期状態）

  メンバー名		設定内容（初期状態）
  name		probe_success
  default		false
  メトリック定義ファイル用promql（$jp1im_TrendData_labelsを含む）		probe_success and $jp1im_TrendData_labels
  resource_en	category	probe
  	label	Probe success or failure
  	description	Displays whether or not the probe was a success
  	unit	-
  resource_ja	category	probe
  	label	プローブ成否
  	description	プローブが成功したかどうかを表示します。 0：失敗 1：成功
  	unit	-
  module		指定しない

• probe_duration_seconds

  ■設定内容（初期状態）

  メンバー名		設定内容（初期状態）
  name		probe_duration_seconds
  default		true
  メトリック定義ファイル用promql（$jp1im_TrendData_labelsを含む）		probe_duration_seconds and $jp1im_TrendData_labels
  resource_en	category	probe
  	label	Probe period
  	description	Returns how long the probe took to complete in seconds
  	unit	second
  resource_ja	category	probe
  	label	プローブ期間
  	description	プローブが完了するまでに要した時間を秒単位で返します。
  	unit	秒
  module		指定しない

• probe_icmp_duration_seconds

  ■設定内容（初期状態）

  メンバー名		設定内容（初期状態）
  name		probe_icmp_duration_seconds
  default		true
  メトリック定義ファイル用promql（$jp1im_TrendData_labelsを含む）		probe_icmp_duration_seconds and $jp1im_TrendData_labels
  resource_en	category	icmp
  	label	ICMP period
  	description	Duration of icmp request
  	unit	second
  resource_ja	category	icmp
  	label	ICMP期間
  	description	フェーズごとのICMP要求の期間
  	unit	秒
  module		icmp

• probe_http_duration_seconds

  ■設定内容（初期状態）

  メンバー名		設定内容（初期状態）
  name		probe_http_duration_seconds
  default		true
  メトリック定義ファイル用promql（$jp1im_TrendData_labelsを含む）		probe_http_duration_seconds and $jp1im_TrendData_labels
  resource_en	category	http
  	label	HTTP request period
  	description	Duration of http request by phase, summed over all redirects
  	unit	second
  resource_ja	category	icmp
  	label	HTTPリクエスト期間
  	description	フェーズごとのHTTPリクエストの期間，すべてのリダイレクトで合計
  	unit	秒
  module		http

• probe_http_status_code

  ■設定内容（初期状態）

  メンバー名		設定内容（初期状態）
  name		probe_http_status_code
  default		false
  メトリック定義ファイル用promql（$jp1im_TrendData_labelsを含む）		probe_http_status_code and $jp1im_TrendData_labels
  resource_en	category	http
  	label	HTTP status
  	description	Response HTTP status code
  	unit	-
  resource_ja	category	http
  	label	HTTPステータス
  	description	HTTPレスポンスステータスコード
  	unit	-
  module		http

ページの先頭へ