10.6. ユーザー定義プロジェクトのアラートルールの作成

手順

1. アラートルールの YAML ファイルを作成します。この例では、example-app-alerting-rule.yaml という名前です。

2. アラートルール設定を YAML ファイルに追加します。以下の例では、example-alert という名前の新規アラートルールを作成します。アラートルールは、サンプルサービスによって公開される version メトリクスが 0 になるとアラートを実行します。

   apiVersion: monitoring.coreos.com/v1
   kind: PrometheusRule
   metadata:
     name: example-alert
     namespace: ns1
   spec:
     groups:
     - name: example
       rules:
       - alert: VersionAlert 1
         for: 1m 2
         expr: version{job="prometheus-example-app"} == 0 3
         labels:
           severity: warning 4
         annotations:
           message: This is an example alert. 5

   1

   作成する必要のあるアラートルールの名前。

   2

   アラートが発せられる前に条件が真である必要がある期間。

   3

   新規ルールを定義する PromQL クエリー式。

   4

   アラートルールがアラートに割り当てる重大度。

   5

   アラートに関連付けられたメッセージ。

3. 設定ファイルをクラスターに適用します。

   $ oc apply -f example-app-alerting-rule.yaml

手順

1. openshift-user-workload-monitoring プロジェクトで user-workload-monitoring-config config map を編集します。

   $ oc -n openshift-user-workload-monitoring edit configmap user-workload-monitoring-config

2. 特定のプロジェクトにバインドされないアラートルールを作成するプロジェクトを設定します。

   apiVersion: v1
   kind: ConfigMap
   metadata:
     name: user-workload-monitoring-config
     namespace: openshift-user-workload-monitoring
   data:
     config.yaml: |
       namespacesWithoutLabelEnforcement: [ <namespace> ] 1
       # ...

   1

   クロスプロジェクトアラートルールを作成するプロジェクトを 1 つ以上指定します。ユーザー定義のモニタリング用の Prometheus および Thanos Ruler は、これらのプロジェクト内に作成された PrometheusRule オブジェクトの namespace ラベルを適用しません。

3. アラートルールの YAML ファイルを作成します。この例では、example-cross-project-alerting-rule.yaml という名前です。

4. アラートルール設定を YAML ファイルに追加します。次の例では、example-security という名前の新しいクロスプロジェクトアラートルールを作成します。ユーザープロジェクトが制限付き Pod セキュリティーポリシーを適用しない場合、このアラートルールが起動します。

   クロスプロジェクトアラートルールの例

   apiVersion: monitoring.coreos.com/v1
   kind: PrometheusRule
   metadata:
     name: example-security
   namespace: ns1 1
   spec:
     groups:
       - name: pod-security-policy
         rules:
           - alert: "ProjectNotEnforcingRestrictedPolicy" 2
             for: 5m 3
             expr: kube_namespace_labels{namespace!~"(openshift|kube).*|default",label_pod_security_kubernetes_io_enforce!="restricted"} 4
             annotations:
               message: "Restricted policy not enforced. Project {{ $labels.namespace }} does not enforce the restricted pod security policy." 5
             labels:
               severity: warning 6

   1

   必ず namespacesWithoutLabelEnforcement フィールドで定義したプロジェクトを指定します。

   2

   作成する必要のあるアラートルールの名前。

   3

   アラートが発せられる前に条件が真である必要がある期間。

   4

   新規ルールを定義する PromQL クエリー式。

   5

   アラートに関連付けられたメッセージ。

   6

   アラートルールがアラートに割り当てる重大度。

   重要

   namespacesWithoutLabelEnforcement フィールドで指定したプロジェクトのうちの 1 つにだけ、特定のクロスプロジェクトアラートルールを作成してください。複数のプロジェクトで同じクロスプロジェクトアラートルールを作成すると、アラートが繰り返し発生します。

5. 設定ファイルをクラスターに適用します。

   $ oc apply -f example-cross-project-alerting-rule.yaml