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

〈このページの構成〉

形式
ファイル
格納先ディレクトリ
説明
文字コード
改行コード
定義の反映時期
記述内容
モデルファイルの設定内容（初期状態）とアラート定義例

形式

JP1/IM - Agentの「Node exporterのメトリック定義ファイル」と同じです。

ページの先頭へ

ファイル

metrics_script_exporter.conf

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

ページの先頭へ

説明

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

定義内容は，JP1/IM - Agentの製品プラグインの__metricListGetメソッド，および__timeSeriesDataGetメソッドの返却値に使用します。JP1/IM - Managerが階層構成で，統合マネージャーから下位マネージャーのトレンドデータ管理DBに保存されているトレンドデータを参照する場合，統合マネージャーのメトリック定義ファイルに参照するトレンドデータのメトリックを追加する必要があります。

ページの先頭へ

文字コード

UTF-8（BOM無し）

ページの先頭へ

改行コード

Windowsの場合：CR+LF

Linuxの場合：LF

ページの先頭へ

定義の反映時期

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

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

ページの先頭へ

記述内容

JP1/IM - Agentの「Node exporterのメトリック定義ファイル（metrics_node_exporter.conf）」（2.　定義ファイル）の「記述内容」を参照してください。

ページの先頭へ

モデルファイルの設定内容（初期状態）とアラート定義例

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

azure_virtual_machine_disk_read_bytes_total

■設定内容（初期状態）

メンバー名		設定内容（初期状態）
name		script_success
default		true
メトリック定義ファイル用promql（$jp1im_TrendData_labelsを含む）		script_success and $jp1im_TrendData_labels
resource_en	category	script
	label	Script success
	description	Script exit status (0 = error, 1 = success)
	unit	-
resource_ja	category	script
	label	スクリプト成否
	description	スクリプトの実行成否（失敗:0, 成功:1）
	unit	-

■アラート定義例^※

groups:
  - name: script_exporter
    rules:
    - alert: script_success(Script exporter)
      expr: 0 == script_success
      for: 3m
      labels:
        jp1_pc_product_name: "/HITACHI/JP1/JPCCS2"
        jp1_pc_severity: "Error"
        jp1_pc_eventid: "1401"
        jp1_pc_metricname: "script_success"
      annotations:
        jp1_pc_firing_description: "スクリプトの実行に失敗しました。value={{ $value }}"
        jp1_pc_resolved_description: "スクリプトの実行に成功しました。"

注※: 複数のアラートを同一の統合エージェントホストで定義する場合，「groups:」を重複して指定したり，同じグループ名を指定したnameを重複して指定したりしないように注意してください。

script_duration_seconds

■設定内容（初期状態）

メンバー名		設定内容（初期状態）
name		script_duration_seconds
default		true
メトリック定義ファイル用promql（$jp1im_TrendData_labelsを含む）		script_duration_seconds and $jp1im_TrendData_labels
resource_en	category	script
	label	Duration
	description	Script execution time, in seconds
	unit	seconds
resource_ja	category	script
	label	実行時間
	description	スクリプトの実行時間（秒）
	unit	秒

■アラート定義例^※

groups:
  - name: script_exporter
    rules:
    - alert: script_duration_seconds(Script exporter)
      expr: 60 < script_duration_seconds
      for: 3m
      labels:
        jp1_pc_product_name: "/HITACHI/JP1/JPCCS2"
        jp1_pc_severity: "Error"
        jp1_pc_eventid: "1402"
        jp1_pc_metricname: "script_duration_seconds"
      annotations:
        jp1_pc_firing_description: "スクリプトの実行時間がしきい値(60秒)を上回りました。value={{ $value }}秒"
        jp1_pc_resolved_description: "スクリプトの実行時間がしきい値(60秒)を下回りました。"

注※

しきい値が60の例です。値は監視対象に合わせて変更してください。

複数のアラートを同一の統合エージェントホストで定義する場合，「groups:」を重複して指定したり，同じグループ名を指定したnameを重複して指定したりしないように注意してください。

script_exit_code

■設定内容（初期状態）

メンバー名		設定内容（初期状態）
name		script_exit_code
default		true
メトリック定義ファイル用promql（$jp1im_TrendData_labelsを含む）		script_exit_code and $jp1im_TrendData_labels
resource_en	category	script
	label	Exit code
	description	Script execution time, in seconds
	unit	-
resource_ja	category	script
	label	終了コード
	description	スクリプトの終了コード
	unit	-

■アラート定義例^※

groups:
  - name: script_exporter
    rules:
    - alert: script_exit_code(Script exporter)
      expr: 0 != script_exit_code
      for: 3m
      labels:
        jp1_pc_product_name: "/HITACHI/JP1/JPCCS2"
        jp1_pc_severity: "Error"
        jp1_pc_eventid: "1403"
        jp1_pc_metricname: "script_exit_code"
      annotations:
        jp1_pc_firing_description: "スクリプトの実行に失敗しました。value={{ $value }}"
        jp1_pc_resolved_description: "スクリプトの実行に成功しました。"

注※: 複数のアラートを同一の統合エージェントホストで定義する場合，「groups:」を重複して指定したり，同じグループ名を指定したnameを重複して指定したりしないように注意してください。

ページの先頭へ