Script exporter設定ファイル(jpc_script_exporter.yml)
形式
YAML形式で記述します。
scripts: - name: run_scriptA command: ./examples/scriptA.sh timeout: max_timeout: 120 - name: run_scriptB command: ./examples/scriptB.sh args: - arg1 - arg2
ファイル
jpc_script_exporter.yml
jpc_script_exporter.yml.model(モデルファイル)
格納先ディレクトリ
- Windowsの場合
-
- 物理ホストのとき
-
Agentパス\conf\
- 論理ホストのとき
-
共有フォルダ\jp1ima\conf\
- Linuxの場合
-
- 物理ホストのとき
-
/opt/jp1ima/conf/
- 論理ホストのとき
-
共有ディレクトリ/jp1ima/conf/
説明
Script exporterの動作を規定する設定ファイルです。
文字コード
UTF-8(BOM無し)
改行コード
Windowsの場合:CR+LF
Linuxの場合:LF
定義の反映時期
Script exporterを再起動したときです。
記述内容
項目名※ |
説明 |
変更可否 |
JP1/IM - Agentでユーザーが設定する内容 |
JP1/IM - Agentのデフォルト値 |
||
---|---|---|---|---|---|---|
scripts: |
スクリプトに関する情報を設定します。 |
− |
− |
指定なし |
||
- |
name: |
Prometheusで表示するスクリプト名を,1〜255文字以内の文字列で指定します。 Prometheusでラベルの値に使用できる文字列(Unicodeの文字)を指定する必要があります。 |
◎ |
監視対象スクリプト名(任意の名前) |
指定なし |
|
command: |
実行するスクリプトを指定します。 スクリプトの出力形式については,マニュアル「JP1/Integrated Management 3 - Manager 導入・設計ガイド」の「3.15.1 JP1/IM - Agentによる性能監視機能」で,PrometheusのText-based formatを説明している個所を参照してください。 <設定例> "/bin/foo" <出力例> # HELP metric_name description # TYPE metric_name gauge metric_name {label1="labelvalue1"} 12345 metric_name {label1="labelvalue2"} 67890 |
◎ |
監視対象のスクリプト |
指定なし |
||
args: |
スクリプトの引数を指定します。 <設定例> - "--output" - "/dev/null" |
◎ |
スクリプトの引数(引数がない場合は指定不要) |
指定なし |
||
timeout: |
タイムアウトに関する情報を設定します。 |
○ |
− |
指定なし |
||
max_timeout: |
タイムアウトの値を秒数で指定します。 指定を省略した場合,Prometheusで設定したタイムアウトの値が仮定されます。 |
○ |
タイムアウトにする秒数 |
指定なし |
||
enforced: |
タイムアウトになったときにスクリプトを強制終了するかを指定します。 trueまたはfalseを指定できます。 指定を省略した場合,「false」が仮定されます。 |
○ |
タイムアウトになったときにスクリプトを強制終了するか |
指定なし |
- (凡例)
-
◎:設定必須 〇:変更可 −:該当なし
- 注※
-
[]はオプションを意味します。