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

groups

array

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

groups[]

object

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

interval

string

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

name

string

name はグループの名前です。

rules

array

rules は、順番に評価されるアラートルールのリストです。Prometheus はルールグループを並列に処理することもありますが、単一グループ内のルールは常に順番に処理され、すべてのルールが処理されます。

rules[]

object

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

alert

string

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

annotations

object (string)

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

expr

integer-or-string

expr は評価する PromQL 式です。評価サイクルごとに、これが現在の時刻で評価され、結果として生じるすべての時系列は保留中になるか、アラートが発生します。ほとんどの場合、これは PromQL 式を表す文字列です (例: mapi_current_pending_csr > mapi_max_pending_csr)。まれに、常に発生しているアラートを作成することが目的の場合は、単純な整数 (たとえば "1") になることがあります。これは、アラートパイプラインが機能していることを確認するために、常に発生する "Watchdog" アラートの作成に使用されることがあります。

for

string

for は、最初に結果が返された後にアラートが発動したと見なされるまでの時間間隔です。発動してからの時間が不十分なアラートは保留中とみなされます。

labels

object (string)

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

observedGeneration

integer

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

prometheusRule

object

prometheusRule は、この AlertingRule に対して生成された PrometheusRule です。各 AlertingRule インスタンスにより、同じ namespace (常に openshift-monitoring namespace) に PrometheusRule オブジェクトが生成されます。

name

string

参照される PrometheusRule の名前。