Soracom

Users

ドキュメント
Home ドキュメント SORACOM Lagoon 3 Alert を管理する

Notification policy を設定する

Lagoon の Alert では、Alert rule で設定した条件を満たしたときに Alert が作成されます。Notification policy は、Alert と Contact point を紐づけるための機能です。作成された Alert に設定された Label に応じて、適切な Contact point に通知するように設定できます。

Notification policy は、編集ユーザー (Editor ロール) のみが設定できます。閲覧ユーザー (Viewer ロール) では設定できません。ユーザーの違いについては、Lagoon ユーザーのロールを設定する を参照してください。

Root policy を設定する

すべての Alert に適用されるデフォルトの Notification policy を設定します。デフォルトの Notification policy は、Specific routing (Policy) で上書きできます。

  1. Lagoon コンソールにログイン し、[ (Alerting)][Notification policies] の順にクリックして、[Root policy][Edit] をクリックします。

  2. 以下の項目を設定します。

    項目説明
    [Default contact point]Contact point を選択します。
    [Group by]

    Alert を Alert Group にまとめる基準になる Label を入力します。Alert Group にまとめられた Alert は、[Timing options] で、さまざまな待機時間を設定できます。

    以下の項目を選択できます。

    • grafana_folder: Alert rule を保存した Folder ごとに、Alert Group にまとめます。
    • alertname: Alert rule に設定した名前で、Alert Group にまとめます。
    • Disable (...): Alert Group にまとめません。
    • 空欄: すべての Alert を 1 つの Alert Group にまとめます。

    デフォルトでは、grafana_folder と alertname が選択されています。

    [Timing options]
    • [Group wait]: [Group by] で指定した Alert Group に対する待機時間を指定します。Alert を通知する前に、同じ Alert Group の Alert をまとめて送信するために待機する時間です。デフォルトは、30 秒です。
    • [Group interval]: [Group by] で指定した Alert Group ごとの通知間隔を指定します。Alert を通知してから、次の 同じ Alert Group の異なる Alert の通知が可能になるまでの時間です。デフォルトは、5 分です。
    • [Repeat interval]: Alert が Firing になってから、同じ Alert が再通知されるまでの時間です。デフォルトは、4 時間です。

  3. [Save] をクリックします。

Specific routing (Policy) を設定する

通知する Contact point を Label ごとに指定できます。

例:

  1. Lagoon コンソールにログイン して、[ (Alerting)][Notification policies][+New policy] の順にクリックします。

    新しい Policy が作成されます。

  2. 以下の項目を設定します。

    項目説明
    [Matching labels]

    [+Add matcher] をクリックして、この Policy の条件を設定します。条件に一致すると、[Contact point] で選択した Contact point に Alert が通知されます。

    • [Label]: Label のキーを入力します。
    • [Operator]: 演算子を選択します。
    • [Value]: Label の Value に対する条件を入力します。

    [Matching labels] を指定しない場合は、すべての Alert に対して利用される Policy になります。

    [Contact point]Alert を通知する Contact point を選択します。
    [Continue matching subsequent sibling nodes]

    この Policy の条件に一致したときに、次の Policy の条件を検証するかどうかを設定します。

    • オン: この Policy の Contact point に Alert を通知して、次の Policy の条件を検証します。
    • オフ: この Policy の Contact point に Alert を通知して、終了します。
    [Override grouping]この Policy の条件に一致したときに、Alert Group にまとめる基準を変更する場合は、オンに設定します。
    [Override grouping][Group by]

    この Policy の条件に一致したときの [Group by] を指定します。詳しくは、Root policy を設定する[Group by] を参照してください。

    [Override grouping] をオンに設定した場合のみ、この項目が表示されます。

    [Override general timing]この Policy の条件に一致したときに、Root policy で設定した [Group wait][Group interval][Repeat interval] を変更する場合は、オンに設定します。
    [Override general timing][Group wait][Group interval][Repeat interval]

    この Policy の条件に一致したときの [Group wait][Group interval][Repeat interval] を指定します。各項目について詳しくは、Root policy を設定する を参照してください。

    [Override general timing] をオンに設定した場合のみ、この項目が表示されます。

    [Mute timings]この Policy の条件に一致したとしても、Alert を通知しない時間帯 (Mute timing) を選択します。
  3. [Save policy] をクリックします。

Nested policy を追加する

Policy には、Nested policy を追加できます。Nested policy は、Policy を親として扱う Policy です。親にあたる Policy に設定した条件 (Label) に一致したときに、さらに詳細に Nested policy に条件 (Label) を設定して、通知する Contact point を柔軟に設定するための機能です。

Policy と Nested policy を設定した場合は、以下のように動作します。

  • Alert の Label が、Policy に設定した条件を見たし、さらに Nested policy に設定した条件を満たすと、Nested policy に設定した Contact point に通知されます。
  • Alert の Label が、Policy に設定した条件を満たし、Nested policy に設定した条件を満たさない場合は、Policy に設定した Contact point に通知されます。

例:

Specific routing (Policy) を削除する

  1. Lagoon コンソールにログイン して、[ (Alerting)][Notification policies] の順にクリックします。

  2. 削除する Policy の [] をクリックします。

  3. [Yes, delete] をクリックします。

Mute timing を作成する

Policy の条件に一致したとしても、Alert を通知しない時間帯を設定できます。作成した Mute timing は、Policy の [Mute timing] で選択してください。[Mute timing] で選択されない Mute timing は使用されません。

  1. Lagoon コンソールにログイン して、[ (Alerting)][Notification policies][+Add mute timing] の順にクリックします。

    新しい Mute timing が作成されます。

  2. 以下の項目を設定します。

    項目説明
    [Name]Mute timing の名前を入力します。
    [Time range]

    時間帯を UTC で設定します。

    • 時間と分は、2 桁で入力します。1 桁の場合は、先頭に 0 を追加してください。
    • [Start time] は、[End time] より早い時間に設定してください。たとえば、UTC で 00:00 をまたぐ時間 (例: 20:00 ~ 翌日 10:00) を設定する場合は、20:0024:0000:0010:00 の 2 つの Time range を設定します。
    [Days of the week]

    曜日を設定します。

    例:

    • monday: 月曜日
    • monday, tuesday: 月曜日、火曜日
    • tuesday:thursday: 火曜日から木曜日
    [Days of the month]

    日にちを設定します。

    例:

    • 1: 1 日
    • 14:16: 14 ~ 16 日
    • -1: 月末
    • -2: 月末の前日
    [Months]

    月を設定します。

    例:

    • 1:3: 1 ~ 3 月
    • may:august: 5 ~ 8 月
    • december: 12 月
    [Years]

    年を設定します。

    例:

    • 2021:2022: 2021 ~ 2022 年
    • 2030: 2030 年
  3. [Submit] をクリックします。