Soracom

Users

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

Alert の概要

Alert を設定する操作の流れ

Lagoon 3 では、主に Alert ruleContact pointNotification policy を利用して、Alert を詳細に制御します。

Lagoon 3 でデータを監視して、Slack やメールで通知されるまでの Lagoon 3 の動作は以下のとおりです。

監視するデータが評価基準を満たしてから通知されるまでに数分かかる場合があります

監視するデータが評価基準を満たしてから、実際に通知されるまでの時間は保証されません。通知されるまでに数分かかる場合があります。

  1. Alert rule がデータを評価し、Notification policy が Alert rule の State を評価します。

  2. データが評価基準を満たすと、Alert rule の State が Firing に変化します。

  3. Notification policy は、「State が Firing に変化した Alert rule」を確認すると、Alert rule に設定した Label (severity=warning) に紐づく Contact point に対して、通知を指示します。

    一時的に通知しない設定 (Silence) も利用できます

    発生した問題に対応しているときは、通知を一時的にオフにできます。これを Silence と呼びます。Silence では、Alert rule に設定した Label (severity=warning) に対して、通知しない時間や曜日を設定します。詳しくは、Silence を設定する を参照してください。

項目説明

Alert rule

Alert rule

監視するデータと、通知が必要になる基準 (評価基準) を設定します。また、通知先を表す Label も設定します。実際には、Label は Contact point と紐づけるための情報です。詳しくは、Alert rule を設定する を参照してください。

例:

データと評価基準通知先を表す Label (条件ごとに Label を 2 つずつ設定した例)
室温が 26 ℃を超えたalert_type=temperatureseverity=info
室温が 30 ℃を超えたalert_type=temperatureseverity=warning
バッテリーレベルが 20% 以下になったalert_type=battery_levelseverity=info
バッテリーレベルが 5% 以下になったalert_type=battery_levelseverity=warning

Contact point

Contact point

通知方法、通知先、および通知内容 (本文) を設定します。通知方法にあわせてタイトルや本文を指定できます。詳しくは、Contact point を設定する を参照してください。

例:

Contact point の名前通知先通知内容
Slack-infoSlack の #info チャンネルSlack の mrkdwn フォーマット を利用してデザインできます。
Mail-environment-notification空調システムを管理する部署 (environment@example.com) 宛てのメールテキストで通知内容を指定できます。
Mail-device-notificationデバイスを管理する部署 (device@example.com) 宛てのメールテキストで通知内容を指定できます。

Notification policy

Notification policy

Alert rule に設定した Label と Contact point を紐づけます。

例:

通知対象の Label通知する Contact point の名前説明
severity=info (*1)Slack-info室温が 26 ℃を超えた、または、バッテリーレベルが 20% 以下になったときに、Slack の #info チャンネルに通知されます。
alert_type=temperatureseverity=warningMail-environment-notification室温が 30 ℃を超えたときに、空調システムを管理する部署 (environment@example.com) にメールで通知されます。
alert_type=battery_levelseverity=warningMail-device-notificationバッテリーレベルが 5% 以下になったときに、デバイスを管理する部署 (device@example.com) にメールで通知されます。
  • (*1) severity=info の Label が設定されていれば、室温に関する通知とバッテリーレベルに関する通知の両方が通知対象です。
Alert が作成されてから Contact point に実際に通知されるまでに数十秒かかることがあります

Alert group 画面に Alert が表示されてから、Notification policy が Alert の Label を評価して、Contact point に通知するまでに、1 分以上かかることがあります。

あらかじめ Alert rule および Contact point を設定してください

Notification policy を設定するときには、Label や Contact point の名前が必要です。

Alert を利用するときの「時間」について

以下の「時間」について正しく理解して、Alert を利用してください。

項目説明
データ取得間隔

Lagoon 3 は、Harvest Data からデータを一定の時間間隔で取得します。たとえば、Maker プラン の場合は、最短 30 秒間隔でデータを取得します。そのため、デバイスが Harvest Data に送信したデータを、Lagoon 3 ですぐに利用できないことがあります。詳しくは、デバイスが Harvest Data にデータを保存した時刻と Lagoon 3 でデータを利用できる時刻について を参照してください。

評価範囲Lagoon 3 がデータを 1 回評価するときの、評価対象の時間範囲 (Alert 対象の時間範囲) です。評価時刻 (now) からの相対時間 (何分前 / 何時間前 / 何日前) で指定します。たとえば、1 回評価するときに評価時刻の 30 秒前から 40 秒前までの 10 秒間のデータを評価する (例: now-40s to now-30s) といった設定を行います。
評価間隔データを評価したあと、次にデータを評価するまでの待機時間 (時間間隔) です。10 秒の倍数を指定できます。

たとえば、デバイスから 10 秒に 1 回データが送信されるシステムを構築し、Lagoon 3 の Maker プランを利用しているときは、以下の図のように時間を設定することを推奨します。また、このように設定したときの Lagoon 3 の動作については、動作例 を参照してください。

Alert rule を評価するタイミングで Harvest Data から最新のデータを取得できない場合があります

Alert rule を評価するタイミングで、Harvest Data から最新のデータが取得されます。ただし、最後にデータを取得してからデータ取得間隔 (Maker プランを利用しているときは 30 秒間) が経過していない場合は、Harvest Data からデータを取得できません。そのため、以下のように動作することに注意してください。

  • Alert rule を評価するタイミングが、前回データを取得してから 30 秒 (Maker プランの場合) 経過していない場合は、Harvest Data からデータを取得できません。そのため、評価範囲を now-10s to now に設定していると、No data になります。

  • Alert rule を評価するタイミングが、前回データを取得してから 30 秒以上 (Maker プランの場合) 経過していれば、この時点で Harvest Data からデータを取得できます。そのため、評価範囲を now-10s to now に設定していても、No data にはなりません。

動作例

Alert rule を保存すると、Alert rule の評価が始まります。ここでは、Maker プランを利用しているときに、Lagoon 3 がデータを取得するタイミングと、Lagoon 3 がデータを評価する方法を説明します。

  1. Dashboard の表示や、そのほかの Alert rule の評価などを契機として、Lagoon 3 が Harvest Data から最新のデータを取得します。

    下図では、now で示された時間に、それまでに Harvest Data に送信された 2 つのデータが Lagoon 3 に取得されたことと、その後 30 秒間は Harvest Data からデータを取得できないことを表しています。

  2. Alert rule を評価するタイミングになり (ここでは手順 1 の約 20 秒後とします)、Lagoon 3 が now-40s to now-30s の設定に従って、30 秒前から 40 秒前 (10 秒間) のデータを評価します。

    下図の評価範囲 (黄色い範囲) に含まれる 1 つのデータだけが評価されます。

  3. 手順 1 の 30 秒後以降、Dashboard の表示や、そのほかの Alert rule の評価などを契機として、Lagoon 3 が Harvest Data から最新のデータを取得します。

    図では、3 つのデータが取得されていることと、その後 30 秒間は Harvest Data からデータを取得できないことに注目してください。

  4. Alert rule を評価するタイミングになり (ここでは手順 2 の 10 秒後、つまり手順 3 の数秒後)、Lagoon 3 が now-40s to now-30s の設定に従って、30 秒前から 40 秒前 (10 秒間) のデータを評価します。

    下図の評価範囲 (黄色い範囲) に含まれる 1 つのデータだけが評価されます。

  5. 同様に、10 秒間隔で 10 秒間のデータを評価します。

  6. 手順 3 の 30 秒後以降、Dashboard の表示や、そのほかの Alert rule の評価などを契機として、Lagoon 3 が Harvest Data から最新のデータを取得します。

    図では、3 つのデータが取得されていることと、その後 30 秒間は Harvest Data からデータを取得できないことに注目してください。

    これ以降、同じ動作を繰り返します。

    ここで紹介した動作例のように、漏れなくすべてのデータが評価されるように設定することを推奨しますが、用途に合わせて柔軟に設定できます。

評価間隔と評価範囲の組み合わせによっては、一部または全部のデータが評価されないことがあります
  • 評価間隔が 20 秒で、評価範囲が now-40s to now-30s (10 秒) の場合、一部のデータは評価されません。

  • 評価範囲を now-40s to now-10s (30 秒間) のように、to の次に設定する時間を now-30s (Maker プランの場合) よりも now に近い時間にすると、Lagoon 3 がデータを取得していない範囲が評価されるため、No data になるなど、意図したとおりに評価できないことがあります。

Pro プランに変更するとデータ取得間隔が短くなります

Pro プランに変更するとデータ取得間隔が短くなるため、評価範囲を now-15s to now-5s に設定しても、データを正しく評価できます。プランについて詳しくは、SORACOM Lagoon 3 のプランとライセンスパック を参照してください。