Soracom

Users

ドキュメント

Alert を設定する

このドキュメントでは SORACOM Lagoon (以降、Lagoon と表示) を利用したアラートの設定方法を解説します。当ガイドの前提は以下のとおりです。

  • SORACOM のアカウントを作成済みであること
  • メールアカウントを作成済であること

Lagoon の利用開始までの手順については サンプルのデータソースを使用して Dashboard を作成する の「ステップ 1: Lagoon の利用を開始する」をご確認ください。

ステップ 1: Lagoon で Panel を作成する 

まずは任意の Dashboard から Panel を作成します。

lagoon-alert_addpanel

Panel を作成するとデフォルトで Graph が表示されます。

まずはグラフ横の [Panel] タブの [Panel title] からこの Panel のタイトルを設定します。 今回は「Lagoon Alert Test」とします。

lagoon-alert_editpanel_general

次にグラフ下の [Query] タブからこの Panel に表示する統計情報を設定します。今回は Lagoon のサンプルデータソースを利用します。以下の動画のように [Demo] を選択するとサンプルデータソースをご利用いただけます。 [Query] タブの詳細は Query を参照ください。

ここまでの設定で Graph にサンプルデータソースの値が表示できていますので、一旦 Dashboard の設定を保存します。画面右上にある [Save] ボタンから設定を保存できます。 今回は「Lagoon Alert Dashboard」という名前で保存します。

lagoon-alert_save_dashboard

以上で「ステップ 1: Lagoon で Panel を作成する」まで完了しました。 ここまでの設定について不明点があれば、サンプルのデータソースを使用して Dashboard を作成する をご確認ください。

ステップ 2: Lagoon で Notification Channel を設定する 

アラートの通知方法 (Notification Channel) を設定します。 Lagoon は OSS として提供されている Grafana をベースに開発されているのでメールや webhook 等の様々な通知方法があります。詳細は Notification Channel を参照してください。 今回はメールへの通知を設定します。

まずは SORACOM Lagoon ホーム画面のサイドメニュー [Alerting][Notification Channel] をクリックします。

lagoon-alert_add_alertchannel

アラート設定画面が表示されますので [New Channel] から通知チャンネルの新規追加を行います。

lagoon-alert_add_alertchannel02

通知チャンネルの設定画面が表示されます。 まずは [Name] を設定しこの通知チャンネルに名前をつけます。今回は「Lagoon Alert Channel」とします。 また、 [Type] には通知する手段として [Email] を、[Addresses] に通知先のメールアドレスを設定します。

lagoon-alert_add_alertchannel03

この状態で画面下の [Test] をクリックして、アラートのテスト送信をします

lagoon-alert_add_alertchannel04

登録したメールアドレスでテストアラートが受信できることを確認します。テストアラートは [Alerting] Test notification というタイトルで送信されます。

lagoon-alert_add_alertchannel05

最後に [Save] ボタンで設定を保存します。

lagoon-alert_add_alertchannel06

ここまでで「ステップ 2: Lagoon で Notification Channel を設定する」が完了です。

ステップ 3: Lagoon で Alert Rule を設定する 

Lagoon のデータを監視しアラートする設定を行います。ステップ 1 で作成した Panel を編集します。

上の動画のように [Alert]タブから [Create Alert] ボタンで新規にアラートを作成し、以下のように設定します。設定項目の詳細は Alert Rule を参照してください。

  • [Name] でアラートの名前を設定します。
    • デフォルトでは「ダッシュボード名 + alert」となります。
  • [Evaluate every] で評価間隔を設定します。
    • [Conditions] の条件をここで設定する時間間隔で評価します。
    • 今回は 1m (1 分間隔で評価) と設定します。
  • [For] を設定すると、設定した条件を満たした場合でも即アラート状態とならず指定した期間アラート通知を保留できます。
    • 今回は条件を満たした場合にすぐ通知したいので 0m と設定します。
  • [Conditions] ではアラート条件を設定します。
    • 「WHEN」の1つ右の設定項目ではデータの集計関数が選択できます。
      • 今回は max() (時間範囲での最大値) とします。
    • 「OF」の1つ右の設定項目では監視するデータと監視対象期間を選択できます。
      • 今回は query(A, 5m, now) ([Metric] タブで作成した「A」というデータの現在時刻から 5 分前までのデータを監視対象) とします。
    • 閾値を設定します。
      • 「IS ABOVE」の1つ右の設定項目には 25 とします。
  • [If no data or all values are null] : データが無いか全ての値が Null の時のアラートの状態を設定します。
    • 今回は不要なアラートが通知されることを回避するため Keep Last State (現在の状態を維持) を設定します。
  • [If execution error or timeout] : Lagoon のシステムエラーなどの理由で状態をアラートとすべきか判断できない時の状態を設定します。
    • [If no data or all values are null] と同様 Keep Last State (現在の状態を維持) を設定します。

つまり今回の設定は「評価間隔:1 分」ごとに「データ A の現在から 5 分前まで」の「最大値」が「25」を超過していた場合にアラートを出すことになります。

次に、設定した [Alert Rule] をステップ 2 で設定した [Notification Channel] と紐付けます。 [Alert] タブの [Notifications] にある [Send to] タブから送り先を設定します。[+] ボタンから先ほど作成した Lagoon Alert Channel を選択し任意のメッセージを設定します。

lagoon-alert_add_alert03

設定が完了したら、画面右上の [Save] ボタンをクリックして設定を保存します。 ここまでの設定で Graph 上に設定した閾値 (今回の場合は 25) が表示されています。

lagoon-alert_add_alert03

また、サンプルデータソースの値が設定した条件を満たしている場合 (今回の場合は 25 より大きい値) は [Evaluate every] で設定した評価間隔が経過するとアラートが通知されます。アラート条件を満たしていない場合は、以下のように閾値をサンプルデータソースの値より小さい値に変更した後、[Save] ボタンで設定を保存すると評価間隔が経過後にアラートが通知されます。

以下のように登録したメールアドレスでアラートが受信できていれば成功です。

lagoon-alert_add_alert05

グラフ上でもアラート状態となっていることが赤い点線で示されています。

lagoon-alert_add_alert06

次にアラートを解除してみましょう。 以下のように閾値をサンプルデータソースより大きい値に変更した後、[Save] ボタンで設定を保存してください。

登録したメールアドレスでアラート解除が受信できていれば成功です。

また、グラフの [Alert] タブ末尾の [State history] をクリックするとアラートの状態履歴を表示できます。

lagoon-alert_add_alert08

lagoon-alert_add_alert08

以上で Lagoon でアラートを設定できました。

この機能を活用することで単にデータを可視化するだけではなく、異常検知や定期報告のような活用が可能となります。 アラート設定の応用として Alert をカスタマイズする も参照いただき、色々な場面での活用を検討してみてください。