6.2. 開発者としてアラートを管理する
OpenShift Container Platform では、アラート UI を使用してアラート、サイレンス、およびアラートルールを管理できます。
アラート UI で利用可能なアラート、サイレンス、およびアラートルールは、アクセス可能なプロジェクトに関連付けられます。
6.2.1. Developer パースペクティブからのアラート UI へのアクセス リンクのコピーリンクがクリップボードにコピーされました!
アラート UI には、OpenShift Container Platform Web コンソールの Developer パースペクティブからアクセスできます。
- Developer パースペクティブから、Observe、Alerts タブの順に移動します。
- Project: リストからアラートを管理するプロジェクトを選択します。
このパースペクティブのアラートでは、サイレンスおよびアラートルールはすべて Alerts タブで管理されます。Alerts タブに表示される結果は、選択したプロジェクトに固有のものです。
Developer パースペクティブでは、コア OpenShift Container Platform と、Project: <project_name> リスト内のアクセス可能なユーザー定義プロジェクトから選択できます。ただし、クラスター管理者としてログインしていない場合、コア OpenShift Container Platform プロジェクトに関連するアラート、サイレンス、およびアラートルールは表示されません。
6.2.2. Developer パースペクティブからアラート、サイレンス、アラートルールに関する情報を取得する リンクのコピーリンクがクリップボードにコピーされました!
アラート UI は、アラートおよびそれらを規定するアラートルールおよびサイレンスの詳細情報を提供します。
前提条件
- アラートを表示しているプロジェクトの表示権限を持つユーザーとしてクラスターにアクセスできる。
手順
アラート、サイレンス、アラートルールに関する情報を取得します。
-
OpenShift Container Platform Web コンソールの Developer パースペクティブから、Observe
<project_name> Alerts ページに移動します。 アラート、サイレンス、またはアラートルールの詳細を表示します。
- Alert details を表示するには、アラート名の横にある大なり記号 (>) をクリックし、リストからアラートを選択します。
Silence details を表示するには、Alert details ページの Silenced by セクションでサイレンスを選択します。Silence details ページには、以下の情報が含まれます。
- アラート仕様
- 開始時間
- 終了時間
- サイレンス状態
- 発生するアラートの数およびリスト
-
Alerting rule details を表示するには、Alerts ページのアラートの横にある
メニューをクリックし、View Alerting Rule をクリックします。
選択したプロジェクトに関連するアラート、サイレンスおよびアラートルールのみが Developer パースペクティブに表示されます。
6.2.3. サイレンスの管理 リンクのコピーリンクがクリップボードにコピーされました!
OpenShift Container Platform Web コンソールの Developer パースペクティブでアラートのサイレンスを作成できます。サイレンスを作成した後、それらを表示、編集、および期限切れにすることができます。また、アラートが発生しても、サイレンスが適用されたアラートに関する通知は届きません。
サイレンスを作成すると、それらは Alertmanager Pod 全体に複製されます。ただし、Alertmanager の永続ストレージを設定しないと、サイレンスが失われる可能性があります。これは、たとえば、すべての Alertmanager Pod が同時に再起動した場合に発生する可能性があります。
6.2.3.1. Developer パースペクティブからアラートをサイレントにする リンクのコピーリンクがクリップボードにコピーされました!
特定のアラート、または定義する仕様に一致するアラートのいずれかをサイレントにすることができます。
前提条件
-
クラスター管理者の場合は、
cluster-admin
ロールを持つユーザーとしてクラスターにアクセスできます。 管理者以外のユーザーの場合は、次のユーザーロールを持つユーザーとしてクラスターにアクセスできる。
-
Alertmanager へのアクセスを許可する
cluster-monitoring-view
クラスターロール。 -
monitoring-alertmanager-edit
ロール。これにより、Web コンソールの Administrator パースペクティブでアラートを作成して無効にできます。 -
monitoring-rules-edit
クラスターロール。これにより、Web コンソールの Developer パースペクティブでアラートを作成して無効にできます。
-
Alertmanager へのアクセスを許可する
手順
特定のアラートをサイレントにするには、以下を実行します。
- OpenShift Container Platform Web コンソールの Developer パースペクティブから、Observe に移動し、Alerts タブに移動します。
- Project: リストからアラートをサイレントにするプロジェクトを選択します。
- 必要に応じて、アラート名の横にある大なり記号 (>) をクリックし、アラートの詳細を展開します。
- 展開されたビューでアラートメッセージをクリックすると、そのアラートの Alert details ページが開きます。
- Silence alert をクリックして、アラートのデフォルト設定を含む Silence alert ページを開きます。
オプション: サイレンスのデフォルト設定の詳細を変更します。
注記サイレンスを保存する前にコメントを追加する必要があります。
- サイレンスを保存するには、Silence をクリックします。
一連のアラートをサイレントにします。
- OpenShift Container Platform Web コンソールの Developer パースペクティブから、Observe に移動し、Silences タブに移動します。
- Project: リストから、アラートをサイレントにするプロジェクトを選択します。
- Create silence をクリックします。
Create silence ページで、アラートの期間とラベルの詳細を設定します。
注記サイレンスを保存する前にコメントを追加する必要があります。
- 入力したラベルと一致するアラートのサイレンスを作成するには、Silence をクリックします。
6.2.3.2. Developer パースペクティブからサイレンス設定を編集する リンクのコピーリンクがクリップボードにコピーされました!
サイレンスを編集すると、既存のサイレンスが期限切れになり、変更された設定で新しいサイレンスが作成されます。
前提条件
-
クラスター管理者の場合は、
cluster-admin
ロールを持つユーザーとしてクラスターにアクセスできます。 管理者以外のユーザーの場合は、次のユーザーロールを持つユーザーとしてクラスターにアクセスできる。
-
Alertmanager へのアクセスを許可する
cluster-monitoring-view
クラスターロール。 -
monitoring-rules-edit
クラスターロール。これにより、Web コンソールの Developer パースペクティブでアラートを作成して無効にできます。
-
Alertmanager へのアクセスを許可する
手順
- OpenShift Container Platform Web コンソールの Developer パースペクティブから、Observe に移動し、Silences タブに移動します。
- Project: リストからサイレンス設定を編集するプロジェクトを選択します。
変更するサイレンスの
をクリックして Edit silence を選択します。
または、Actions をクリックし、サイレンスの Silence details ページで Edit silence を選択することもできます。
- Edit silence ページで変更を加え、Silence をクリックします。これにより、既存のサイレンスが期限切れになり、更新された設定でサイレンスが作成されます。
6.2.3.3. Developer パースペクティブからサイレンスの有効期限を設定する リンクのコピーリンクがクリップボードにコピーされました!
単一のサイレンスまたは複数のサイレンスを期限切れにすることができます。サイレンスを期限切れにすると、そのサイレンスは永久に非アクティブ化されます。
サイレンスが適用された期限切れのアラートは削除できません。120 時間を超えて期限切れになったサイレンスはガベージコレクションされます。
前提条件
-
クラスター管理者の場合は、
cluster-admin
ロールを持つユーザーとしてクラスターにアクセスできます。 管理者以外のユーザーの場合は、次のユーザーロールを持つユーザーとしてクラスターにアクセスできる。
-
Alertmanager へのアクセスを許可する
cluster-monitoring-view
クラスターロール。 -
monitoring-rules-edit
クラスターロール。これにより、Web コンソールの Developer パースペクティブでアラートを作成して無効にできます。
-
Alertmanager へのアクセスを許可する
手順
- OpenShift Container Platform Web コンソールの Developer パースペクティブから、Observe に移動し、Silences タブに移動します。
- Project: リストから、サイレンスを期限切れにするプロジェクトを選択します。
- 期限切れにするサイレンスについては、対応する行のチェックボックスを選択します。
Expire 1 silence をクリックして選択した 1 つのサイレンスを期限切れにするか、Expire <n> silences をクリックして複数の沈黙を期限切れにします (<n> は選択した沈黙の数になります)。
または、単一の沈黙を期限切れにするには、Actions をクリックし、サイレンスの Silence details ページで Expire silence を選択します。
6.2.4. ユーザー定義プロジェクトのアラートルールの管理 リンクのコピーリンクがクリップボードにコピーされました!
OpenShift Container Platform では、ユーザー定義プロジェクトのアラートルールを作成、表示、編集、削除できます。これらのアラートルールは、選択したメトリクスの値に基づいてアラートをトリガーします。
6.2.4.1. ユーザー定義プロジェクトのアラートルールの作成 リンクのコピーリンクがクリップボードにコピーされました!
ユーザー定義のプロジェクトに対してアラートルールを作成できます。これらのアラートルールは、選択したメトリクスの値に基づいてアラートをトリガーします。
ユーザーがアラートの影響と原因を理解できるように、アラートルールにアラートメッセージと重大度値が含まれていることを確認します。
前提条件
- ユーザー定義プロジェクトのモニタリングが有効化されている。
-
アラートルールを作成するプロジェクトのクラスター管理者または
monitoring-rules-edit
クラスターロールを持つユーザーとしてログインする。 -
OpenShift CLI (
oc
) がインストールされている。
手順
-
アラートルールの YAML ファイルを作成します。この例では、
example-app-alerting-rule.yaml
という名前です。 アラートルール設定を YAML ファイルに追加します。以下の例では、
example-alert
という名前の新規アラートルールを作成します。アラートルールは、サンプルサービスによって公開されるversion
メトリクスが0
になるとアラートを実行します。Copy to Clipboard Copied! Toggle word wrap Toggle overflow 設定ファイルをクラスターに適用します。
oc apply -f example-app-alerting-rule.yaml
$ oc apply -f example-app-alerting-rule.yaml
Copy to Clipboard Copied! Toggle word wrap Toggle overflow
6.2.4.2. ユーザー定義プロジェクトのクロスプロジェクトアラートルールの作成 リンクのコピーリンクがクリップボードにコピーされました!
user-workload-monitoring-config
config map でプロジェクトを設定することにより、元のプロジェクトにバインドされないアラートルールを作成できます。このプロジェクトで作成された PrometheusRule
オブジェクトは、すべてのプロジェクトに適用できます。
そのため、各ユーザープロジェクトに個別の PrometheusRule
オブジェクトを用意する代わりに、複数のユーザー定義プロジェクトに適用される汎用のアラートルールを設定できます。PrometheusRule
オブジェクトで PromQL クエリーを使用すると、アラートルールに追加または除外するプロジェクトをフィルタリングできます。
前提条件
-
クラスター管理者の場合は、
cluster-admin
クラスターロールを持つユーザーとしてクラスターにアクセスできる。 管理者以外のユーザーの場合は、次のユーザーロールを持つユーザーとしてクラスターにアクセスできる。
-
user-workload-monitoring-config
config map を編集するための、openshift-user-workload-monitoring
プロジェクトのuser-workload-monitoring-config-edit
ロール。 -
アラートルールを作成するプロジェクトの
monitoring-rules-edit
クラスターロール。
-
- クラスター管理者は、ユーザー定義プロジェクトのモニタリングを有効にしている。
-
OpenShift CLI (
oc
) がインストールされている。
手順
openshift-user-workload-monitoring
プロジェクトでuser-workload-monitoring-config
config map を編集します。oc -n openshift-user-workload-monitoring edit configmap user-workload-monitoring-config
$ oc -n openshift-user-workload-monitoring edit configmap user-workload-monitoring-config
Copy to Clipboard Copied! Toggle word wrap Toggle overflow 特定のプロジェクトにバインドされないアラートルールを作成するプロジェクトを設定します。
Copy to Clipboard Copied! Toggle word wrap Toggle overflow - 1
- クロスプロジェクトアラートルールを作成するプロジェクトを 1 つ以上指定します。ユーザー定義のモニタリング用の Prometheus および Thanos Ruler は、これらのプロジェクトで作成された
PrometheusRule
オブジェクトのnamespace
ラベルを適用しません。そのため、PrometheusRule
オブジェクトはすべてのプロジェクトに適用できます。
-
アラートルールの YAML ファイルを作成します。この例では、
example-cross-project-alerting-rule.yaml
という名前です。 アラートルール設定を YAML ファイルに追加します。次の例では、
example-security
という名前の新しいクロスプロジェクトアラートルールを作成します。ユーザープロジェクトが制限付き Pod セキュリティーポリシーを適用しない場合、このアラートルールが起動します。クロスプロジェクトアラートルールの例
Copy to Clipboard Copied! Toggle word wrap Toggle overflow 重要namespacesWithoutLabelEnforcement
フィールドで指定したプロジェクトのうちの 1 つにだけ、特定のクロスプロジェクトアラートルールを作成してください。複数のプロジェクトで同じクロスプロジェクトアラートルールを作成すると、アラートが繰り返し発生します。設定ファイルをクラスターに適用します。
oc apply -f example-cross-project-alerting-rule.yaml
$ oc apply -f example-cross-project-alerting-rule.yaml
Copy to Clipboard Copied! Toggle word wrap Toggle overflow
6.2.4.3. ユーザー定義プロジェクトのアラートルールへのアクセス リンクのコピーリンクがクリップボードにコピーされました!
ユーザー定義プロジェクトのアラートルールを一覧表示するには、プロジェクトの monitoring-rules-view
クラスターロールが割り当てられている必要があります。
前提条件
- ユーザー定義プロジェクトのモニタリングが有効化されている。
-
プロジェクトの
monitoring-rules-view
クラスターロールを持つユーザーとしてログインしている。 -
OpenShift CLI (
oc
) がインストールされている。
手順
<project>
でアラートルールを一覧表示するには、以下を実行します。oc -n <project> get prometheusrule
$ oc -n <project> get prometheusrule
Copy to Clipboard Copied! Toggle word wrap Toggle overflow アラートルールの設定をリスト表示するには、以下を実行します。
oc -n <project> get prometheusrule <rule> -o yaml
$ oc -n <project> get prometheusrule <rule> -o yaml
Copy to Clipboard Copied! Toggle word wrap Toggle overflow
6.2.4.4. ユーザー定義プロジェクトのアラートルールの削除 リンクのコピーリンクがクリップボードにコピーされました!
ユーザー定義プロジェクトのアラートルールを削除できます。
前提条件
- ユーザー定義プロジェクトのモニタリングが有効化されている。
-
アラートルールを作成するプロジェクトのクラスター管理者または
monitoring-rules-edit
クラスターロールを持つユーザーとしてログインする。 -
OpenShift CLI (
oc
) がインストールされている。
手順
<namespace>
内のルール<alerting_rule>
を削除するには、次のコマンドを実行します。oc -n <namespace> delete prometheusrule <alerting_rule>
$ oc -n <namespace> delete prometheusrule <alerting_rule>
Copy to Clipboard Copied! Toggle word wrap Toggle overflow