第9章 PrometheusRule [monitoring.coreos.com/v1]
- 説明
PrometheusRule
カスタムリソース定義 (CRD) では、Prometheus
またはThanosRuler
オブジェクトによって評価される [アラート](https://prometheus.io/docs/prometheus/latest/configuration/alerting_rules/) および [記録](https://prometheus.io/docs/prometheus/latest/configuration/recording_rules/) のルールを定義します。Prometheus
およびThanosRuler
オブジェクトは、ラベルセレクターと namespace セレクターを使用してPrometheusRule
オブジェクトを選択します。- 型
-
object
- 必須
-
spec
-
9.1. 仕様
プロパティー | 型 | 説明 |
---|---|---|
|
| apiVersion はオブジェクトのこの表現のバージョンスキーマを定義します。サーバーは認識されたスキーマを最新の内部値に変換し、認識されない値は拒否することがあります。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources を参照してください。 |
|
| kind はこのオブジェクトが表す REST リソースを表す文字列の値です。サーバーはクライアントが要求を送信するエンドポイントからこれを推測できる場合があります。これは更新できません。CamelCase を使用します。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds を参照してください。 |
| 標準オブジェクトのメタデータ。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata を参照してください。 | |
|
| Prometheus に必要なアラートルール定義の仕様。 |
9.1.1. .spec
- 説明
- Prometheus に必要なアラートルール定義の仕様。
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| Prometheus ルールファイルの内容 |
|
| RuleGroup は、順次評価される記録およびアラートルールのリストです。 |
9.1.2. .spec.groups
- 説明
- Prometheus ルールファイルの内容
- 型
-
array
9.1.3. .spec.groups[]
- 説明
- RuleGroup は、順次評価される記録およびアラートルールのリストです。
- 型
-
object
- 必須
-
name
-
プロパティー | 型 | 説明 |
---|---|---|
|
| interval は、グループ内のルールが評価される頻度を決定します。 |
|
| アラートルールが生成できるアラート数と記録ルールが生成できるシリーズ数を制限します。limit は Prometheus 2.31 以降および Thanos Ruler 0.24 以降でサポートされます。 |
|
| ルールグループの名前。 |
|
| PartialResponseStrategy は ThanosRuler でのみ使用され、Prometheus インスタンスでは無視されます。詳細情報: https://github.com/thanos-io/thanos/blob/main/docs/components/rule.md#partial-response |
|
| この特定のグループのルール評価タイムスタンプを、指定期間だけ過去にオフセットすることを定義します。 Prometheus v2.53.0 以降が必要です。ThanosRuler ではサポートされていません。 |
|
| アラートルールおよび記録ルールのリスト。 |
|
| ルールとは、アラートまたは記録ルールを表します。Prometheus のドキュメントを参照してください: [alerting](https://www.prometheus.io/docs/prometheus/latest/configuration/alerting_rules/) ルール、または [recording](https://www.prometheus.io/docs/prometheus/latest/configuration/recording_rules/#recording-rules) ルール |
9.1.4. .spec.groups[].rules
- 説明
- アラートルールおよび記録ルールのリスト。
- 型
-
array
9.1.5. .spec.groups[].rules[]
- 説明
- ルールとは、アラートまたは記録ルールを表します。Prometheus のドキュメントを参照してください: [alerting](https://www.prometheus.io/docs/prometheus/latest/configuration/alerting_rules/) ルール、または [recording](https://www.prometheus.io/docs/prometheus/latest/configuration/recording_rules/#recording-rules) ルール
- 型
-
object
- 必須
-
expr
-
プロパティー | 型 | 説明 |
---|---|---|
|
|
アラートの名前。有効なラベル値である必要があります。 |
|
| 各アラートに追加するアノテーション。アラートルールに対してのみ有効です。 |
|
| 評価する PromQL 式。 |
|
| ここで指定した時間を経過してアラートが返されると、アラートが発動したとみなされます。 |
|
| KeepFiringFor は、アラートをトリガーした条件がクリアされた後、アラートの発動状態が継続する期間を定義します。 |
|
| 追加または上書きするラベル。 |
|
|
出力する時系列の名前。有効なメトリクス名である必要があります。 |