アラート設定ファイル（jpc_alerting_rules.yml）
形式
YAML形式で記述します。
groups:
- name: グループ名
rules:
- alert: アラート名
expr: 条件式
for: 期間
labels:
jp1_pc_product_name: "/HITACHI/JP1/JPCCS2"
jp1_pc_component: "/HITACHI/JP1/JPCCS/CONFINFO"
jp1_pc_severity: JP1イベントの重大度
jp1_pc_eventid: JP1イベントのイベントID
jp1_pc_metricname: メトリック名
annotations:
jp1_pc_firing_description: 異常条件を満たしたときのメッセージ
jp1_pc_resolved_description: 異常条件を満たさなくなったときのメッセージ
ファイル
jpc_alerting_rules.yml
jpc_alerting_rules.yml.model（モデルファイル）
格納先ディレクトリ
■統合エージェントホスト
- Windowsの場合
-
-
物理ホストのとき
Agentパス\conf\
-
論理ホストのとき
共有フォルダ\jp1ima\conf\
-
- Linuxの場合
-
-
物理ホストのとき
/opt/jp1ima/conf/
-
論理ホストのとき
共有ディレクトリ/jp1ima/conf/
-
説明
Prometheus serverが実行するアラート評価のルールを定義するファイルです。
文字コード
UTF-8（BOM無し）
改行コード
Windowsの場合：CR+LF
Linuxの場合：LF
定義の反映時期
Prometheus serverを再起動したとき，およびPrometheus serverにリロードを指示したときに反映されます。
記述内容
下記の表で使用している一般的なプレースホルダーの定義については，「ymlファイルの記述項目で使用している一般的なプレースホルダーの定義について」を参照してください。
|
項目名 |
説明 |
変更可否 |
JP1/IM - Agentでユーザーが設定する内容 |
JP1/IM - Agentのデフォルト値 |
|||
|---|---|---|---|---|---|---|---|
|
groups: |
− |
△ |
− |
"groups:" |
|||
|
name: <string> |
アラートのグループ名を255バイト以内で指定します。グループ名は，監視エージェントホスト内で一意である必要があり，同じグループ名を指定したnameを重複して指定できません。なお，異なる監視エージェントホスト間では，それぞれに同じグループ名を指定したnameを指定できます。 |
○ |
任意のグループ名を指定します。 |
指定なし |
|||
|
rules: |
アラートルールを設定します。100個まで指定できます。 |
△ |
− |
指定なし |
|||
|
alert: <string> |
アラートの名前を指定します。 |
○ |
ユーザーが作成したアラートの名前を指定します。 |
指定なし |
|||
|
expr: <string> |
アラートの条件式を255バイト以内で指定します。 PromQL文を指定します。 |
○ |
評価するPromQL文を指定します。※ PromQL文に関する注意事項については，「PromQL文に関する注意事項」を参照してください。 |
指定なし |
|||
|
for: <duration> |
アラートが異常状態となるまでにかかる時間を0秒から24時間の範囲で指定します。 値は数字と単位で指定します。指定できる単位はs（秒）とm（分）です。 アラートの条件式に該当しても，forに指定した期間内に該当しなくなった場合は異常と扱われません。 |
○ |
アラートが異常状態となるまでにかかる時間を指定します。 |
指定なし |
|||
|
labels: |
アラートごとに追加または上書きするラベルを設定します。 |
△ |
− |
指定なし |
|||
|
jp1_pc_product_name: <string> |
JP1イベントのプロダクト名に設定する値を指定します。 |
○ |
"/HITACHI/JP1/JPCCS2"，または，"/HITACHI/JP1/JPCCS2/xxxx" xxxxは，ユーザーが指定できます。 |
指定なし |
|||
|
jp1_pc_component: <string> |
JP1イベントのコンポーネント名に設定する値を指定します。 |
○ |
JP1イベントを処理する製品プラグインに応じて，次の値を指定します。 jp1pccs_azure.js："/HITACHI/JP1/JPCCS/AZURE/CONFINFO" jp1pccs_kubernetes.js："/HITACHI/JP1/JPCCS/KUBERNETES/CONFINFO" jp1pccs.js："/HITACHI/JP1/JPCCS/CONFINFO" |
指定なし |
|||
|
jp1_pc_severity: <string> |
JP1イベントの重大度に設定する値を指定します。 |
○ |
次のどれかを指定します。
|
指定なし |
|||
|
jp1_pc_eventid: <string> |
JP1イベントのイベントIDに設定する値を指定します。 |
○ |
JP1イベントのイベントIDとして指定できる「0〜1FFF，7FFF8000〜7FFFFFFF」の範囲内の任意の値を指定します。 |
指定を省略した場合，JP1イベントのID属性の値に「00007600」を設定します。 |
|||
|
jp1_pc_metricname: <string> |
JP1イベントのメトリック名に設定する値を指定します。 Yet another cloudwatch exporterの場合，メトリック名（コンマ区切りで複数指定されている場合は先頭のメトリック名）に対応するAWS名前空間のIM管理ノードに対して，JP1イベントの関連付けを行います。 |
○ |
コンマ区切りでメトリック名を指定します。 |
指定なし |
|||
|
annotations: |
各アラートに追加する注釈を設定します。 |
△ |
− |
指定なし |
|||
|
jp1_pc_firing_description: <string> |
アラートの異常条件を満たしたとき，JP1イベントのメッセージに設定する値を指定します。 値の長さが1,024バイト以上の場合，先頭から1,023バイト目までの文字列を設定します。 指定を省略した場合，JP1イベントのメッセージの内容は「The alert is firing.(alert=アラート名)」となります。 |
○ |
任意のメッセージを指定します。 |
指定を省略した場合，JP1イベントのメッセージの内容は「The alert is firing.(alert=アラート名)」となります。 |
|||
|
jp1_pc_resolved_description: <string> |
アラートの異常条件を満たさなくなったとき，JP1イベントのメッセージに設定する値を指定します。 値の長さが1,024バイト以上の場合，先頭から1,023バイト目までの文字列を設定します。 指定を省略した場合，JP1イベントのメッセージの内容は「The alert is resolved.(alert=アラート名)」となります。 |
○ |
任意のメッセージを指定します。 |
指定を省略した場合，JP1イベントのメッセージの内容は「The alert is resolved.(alert=アラート名)」となります。 |
|||
- （凡例）
-
〇：変更可 △：変更不可 −：該当なし
- 注※
-
次に示すラベルはJP1イベントの属性に設定するため，集計演算子などでラベルが取り除かれないようにしてください。
-
instance
-
job
-
jp1_pc_nodelabel
-
jp1_pc_exporter
-
jp1_pc_remote_monitor_instance
-
account
-
region
-
dimension_任意の文字列
なお，accout，region，dimension_任意の文字列のラベルは，Yet another cloudwatch exporterのメトリックを監視する場合にだけ該当します。
-