第5章 AlertingRule [monitoring.openshift.io/v1]

groups

array

グループは、グループ化されたアラートルールのリストです。ルールグループは、Prometheus がルール処理を並列化するユニットです。1 つのグループ内のすべてのルールは、設定された評価間隔を共有します。グループ内のすべてのルールは、この間隔、順次、およびすべてのルールが処理されます。関連するアラートルールを単一の AlertingRule リソースや、そのリソース内で、密接に関連するアラート、または単に同じ間隔でのアラートを個別のグループにグループ化することが一般的です。また、単一のルールグループでのみ AlertingRule リソースを作成することもできますが、グループが非常に大きい場合や、評価するクエリー式が非常に複雑な場合には、Prometheus にパフォーマンスが低下する可能性があることに注意してください。並行して処理できるように、非常に複雑なルールを複数のグループ全体に分散することは、一般的なユースケースです。

groups[]

object

RuleGroup は、順次評価されるアラートルールのリストです。

interval

string

間隔は、グループ内のルールが評価される頻度です。指定しない場合、デフォルトで Prometheus で設定された global.evaluation_interval に設定されます。デフォルトは 30 秒です。プラットフォーム Prometheus 設定を検査すると、この値がクラスターのデフォルトから変更されているかどうかを確認できます。そのリソースの関連フィールドは spec.evaluationInterval です。

name

string

name はグループ名です。

rules

array

ルールは、順次評価されるアラートルールのリストです。Prometheus はルールグループを並行して処理できますが、1 つのグループ内のルールは常に順番に処理され、すべてのルールが処理されます。

rules[]

object

ルールはアラートルールを記述します。Prometheus のドキュメント： https://www.prometheus.io/docs/prometheus/latest/configuration/alerting_rulesを参照してください。

alert

string

alert はアラートの名前です。有効なラベル値である必要があります。つまり、Unicode 文字を含めることができます。

annotations

object (string)

各アラートに追加するアノテーション。これらは、アラートの説明や runbook リンクなど、クエリーを実行しない追加情報を保存するために使用できる値です。

expr

integer-or-string

expr は評価する PromQL 式です。これはすべての評価サイクルが現時点で評価され、結果として生じるすべての時系列が保留または実行されるアラートになります。これはほとんどの場合、PromQL 式を表す文字列です（例：mapi_current_pending_csr > mapi_max_pending_csr）。まれに、これは単純な整数である可能性があります。たとえば、常に実行されるアラートを作成することが意図された場合は、単純な整数になることがあります。これは、アラートパイプラインが機能することを確認するために、常時的なWatchdog アラートを作成するために使用されることがあります。

for

string

For は、最初に返された結果の後にアラートが実行されるとみなされる期間です。十分に起動されていないアラートは保留中と見なされます。

labels

object (string)

各アラートについて追加または上書きするラベル。アラートの PromQL 式の結果は、式を評価した後、セットのラベルと同じ名前のラベルに対して、アラートの既存のラベルセットの結果、ここでラベルが優先され、以前の値を上書きします。通常、これらはクエリーに役立つ可能性のある短い識別値である必要があります。一般的な例は、アラート重大度 です。1 つは、labels キーで severity: warning を設定します。

observedGeneration

integer

observedGeneration は、処理した最後の世代変更です。

prometheusRule

object

PrometheusRule は、この AlertingRule の生成された PrometheusRule です。それぞれの AlertingRule インスタンスにより、生成された PrometheusRule オブジェクトが同じ namespace に作成されます。これは常に openshift-monitoring namespace になります。

name

string

参照される PrometheusRule の名前。