3.5. コアプラットフォームモニタリングのアラートおよび通知の設定

手順

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

   $ oc -n openshift-monitoring edit configmap cluster-monitoring-config

2. data/config.yaml の下に、alertmanagerMain コンポーネントの enabled: false を追加します。

   apiVersion: v1
   kind: ConfigMap
   metadata:
     name: cluster-monitoring-config
     namespace: openshift-monitoring
   data:
     config.yaml: |
       alertmanagerMain:
         enabled: false

3. 変更を適用するためにファイルを保存します。Alertmanager インスタンスは、この変更を適用すると自動的に無効にされます。

手順

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

   $ oc -n openshift-monitoring edit configmap cluster-monitoring-config

2. data/config.yaml/alertmanagerMain の下に secrets: セクションを次の設定で追加します。

   apiVersion: v1
   kind: ConfigMap
   metadata:
     name: cluster-monitoring-config
     namespace: openshift-monitoring
   data:
     config.yaml: |
       alertmanagerMain:
         secrets: 1
         - <secret_name_1> 2
         - <secret_name_2>

   1

   このセクションには、Alertmanager にマウントされるシークレットが含まれています。シークレットは、Alertmanager オブジェクトと同じ namespace 内に配置する必要があります。

   2

   受信者の認証認証情報を含む Secret オブジェクトの名前。複数のシークレットを追加する場合は、それぞれを新しい行に配置します。

   次の config map 設定の例では、test-secret-basic-auth および test-secret-api-token という名前の 2 つの Secret オブジェクトを使用するように Alertmanager を設定します。

   apiVersion: v1
   kind: ConfigMap
   metadata:
     name: cluster-monitoring-config
     namespace: openshift-monitoring
   data:
     config.yaml: |
       alertmanagerMain:
         secrets:
         - test-secret-basic-auth
         - test-secret-api-token

3. 変更を適用するためにファイルを保存します。新しい設定は自動的に適用されます。

手順

1. Alertmanager の YAML 設定ファイルを開きます。

   • CLI から Alertmanager 設定を開くには、以下を実行します。

     1. 現在アクティブな Alertmanager 設定を、alertmanager-main シークレットから alertmanager.yaml ファイルに出力します。

        $ oc -n openshift-monitoring get secret alertmanager-main --template='{{ index .data "alertmanager.yaml" }}' | base64 --decode > alertmanager.yaml

     2. alertmanager.yaml ファイルを開きます。

   • OpenShift Container Platform Web コンソールから Alertmanager 設定を開くには、以下を実行します。

     1. Web コンソールの Administration Cluster Settings Configuration Alertmanager YAML ページに移動します。

2. YAML 内のパラメーターを更新して、Alertmanager 設定を編集します。

   global:
     resolve_timeout: 5m
   route:
     group_wait: 30s 1
     group_interval: 5m 2
     repeat_interval: 12h 3
     receiver: default
     routes:
     - matchers:
       - "alertname=Watchdog"
       repeat_interval: 2m
       receiver: watchdog
     - matchers:
       - "service=<your_service>" 4
       routes:
       - matchers:
         - <your_matching_rules> 5
         receiver: <receiver> 6
   receivers:
   - name: default
   - name: watchdog
   - name: <receiver>
     <receiver_configuration> 7

   1

   Alertmanager が通知を送信する前に、アラートグループの初期アラートを収集するまで待機する時間を指定します。

   2

   最初の通知がすでに送信されているアラートグループに追加された新しいアラートに関する通知を Alertmanager が送信するまでの時間を指定します。

   3

   アラート通知を繰り返すまでの最小時間を指定します。各グループの間隔で通知を繰り返す場合は、repeat_interval の値を group_interval の値よりも小さく設定します。ただし、特定の Alertmanager Pod が再起動または再スケジュールされた場合などには、通知の繰り返しが遅れる可能性があります。

   4

   アラートを発生させるサービスの名前を指定します。

   5

   アラートに一致するラベルを指定します。

   6

   アラートに使用するレシーバーの名前を指定します。

   7

   レシーバーの設定を指定します。

   重要
   • matchers キー名を使用して、ノードの照合でアラートが満たす必要のあるマッチャーを指定します。match または match_re キー名は使用しないでください。どちらも非推奨であり、今後のリリースで削除される予定です。

   • 抑制ルールを定義する場合は、次のキー名を使用します。

     • target_matchers: ターゲットマッチャーを示します。
     • source_matchers: ソースマッチャーを示します。

     target_match、target_match_re、source_match、または source_match_re キー名は使用しないでください。これらは非推奨であり、今後のリリースで削除される予定です。

   以下の Alertmanager 設定例は、PagerDuty をアラートレシーバーとして設定します。

   global:
     resolve_timeout: 5m
   route:
     group_wait: 30s
     group_interval: 5m
     repeat_interval: 12h
     receiver: default
     routes:
     - matchers:
       - "alertname=Watchdog"
       repeat_interval: 2m
       receiver: watchdog
     - matchers:
       - "service=example-app"
       routes:
       - matchers:
         - "severity=critical"
         receiver: team-frontend-page
   receivers:
   - name: default
   - name: watchdog
   - name: team-frontend-page
     pagerduty_configs:
     - service_key: "<your_key>"

   この設定では、example-app サービスによって発生した重大度が critical のアラートが、team-frontend-page レシーバーを介して送信されます。通常、この種のアラートは、個人または緊急対応チームに通知します。

3. 新規設定をファイルで適用します。

   • CLI から変更を適用するには、次のコマンドを実行します。

     $ oc -n openshift-monitoring create secret generic alertmanager-main --from-file=alertmanager.yaml --dry-run=client -o=yaml |  oc -n openshift-monitoring replace secret --filename=-

   • OpenShift Container Platform Web コンソールから変更を適用するには、Save をクリックします。

手順

1. Administrator パースペクティブで、Administration Cluster Settings Configuration Alertmanager に移動します。

   注記

   または、通知ドロワーから同じページに移動することもできます。OpenShift Container Platform Web コンソールの右上にあるベルのアイコンを選択し、AlertmanagerReceiverNotConfigured アラートで Configure を選択します。

2. ページの Receivers セクションで、Create Receiver をクリックします。
3. Create Receiver フォームで、Receiver name を追加し、リストから Receiver type を選択します。

4. レシーバー設定を編集します。

   • PagerDuty receiver の場合:

     1. 統合のタイプを選択し、PagerDuty 統合キーを追加します。
     2. PagerDuty インストールの URL を追加します。
     3. クライアントおよびインシデントの詳細または重大度の指定を編集する場合は、Show advanced configuration をクリックします。

   • Webhook receiver の場合:

     1. HTTP POST リクエストを送信するエンドポイントを追加します。
     2. デフォルトオプションを編集して解決したアラートを receiver に送信する場合は、Show advanced configuration をクリックします。

   • メール receiver の場合:

     1. 通知を送信するメールアドレスを追加します。
     2. SMTP 設定の詳細を追加します。これには、通知の送信先のアドレス、メールの送信に使用する smarthost およびポート番号、SMTP サーバーのホスト名、および認証情報を含む詳細情報が含まれます。
     3. TLS が必要かどうかを選択します。
     4. 解決済みのアラートが receiver に送信されないようにデフォルトオプションを編集する、またはメール通知設定のボディーを編集する必要がある場合は、Show advanced configuration をクリックします。

   • Slack receiver の場合:

     1. Slack Webhook の URL を追加します。
     2. 通知を送信する Slack チャネルまたはユーザー名を追加します。
     3. デフォルトオプションを編集して解決済みのアラートが receiver に送信されないようにしたり、アイコンおよびユーザー設定を編集する必要がある場合は、Show advanced configuration を選択します。チャネル名とユーザー名を検索し、これらをリンクするかどうかについて選択することもできます。

5. デフォルトでは、すべてのセレクターに一致するラベルを持つ Firing アラートが receiver に送信されます。receiver に送信する前に、Firing アラートのラベル値を完全に一致させる場合は、次の手順を実行します。

   1. フォームの Routing Labels セクションに、ルーティングラベルの名前と値を追加します。
   2. Add label を選択して、さらにルーティングラベルを追加します。
6. Create をクリックしてレシーバーを作成します。