バージョンに関する注意
- ここでは、Lagoon 2 (旧バージョンの Lagoon) について説明しています。最新バージョンの Lagoon 3 については、Lagoon 3 のドキュメント を参照してください。
- Lagoon 2 は 2024 年 5 月 31 日に終了します。Lagoon 2 が終了するまでに Lagoon 3 へ移行してください。Lagoon 3 への移行方法は、Lagoon 2 から Lagoon 3 に移行する を参照してください。Lagoon 2 終了後は、Dashboard が閲覧できません。また、Alert も停止します。
- 各バージョンに関する情報は、SORACOM Lagoon 2 と SORACOM Lagoon 3 の違い を参照してください。
- Lagoon 2 の新規契約はできません。
- Lagoon Classic の提供は終了しました。
Lagoon を利用したアラートの設定方法を解説します。
操作を始める前に準備が必要です (クリックして確認してください)
(1) メールアドレスを作成する
(2) Lagoon の利用を開始する
Lagoon の利用を開始します。詳しくは、SORACOM Lagoon 2 の利用を開始する を参照してください。
準備完了ステップ 1: Lagoon で Panel を作成する
まずは任意の Dashboard から Panel を作成します。
Panel を作成するとデフォルトで Graph が表示されます。
まずはグラフ横の
タブの からこの Panel のタイトルを設定します。 今回は「Lagoon Alert Test」とします。
次にグラフ下の Query を参照してください。
タブをクリックして、この Panel に表示する統計情報を設定します。今回は Lagoon のサンプルデータソースを利用します。以下の動画のように を選択するとサンプルデータソースを利用できます。 タブの詳細はここまでの設定で Graph にサンプルデータソースの値が表示できていますので、一旦 Dashboard を保存します。画面右上にある
ボタンから設定を保存できます。 今回は「Lagoon Alert Dashboard」という名前で保存します。
以上で「ステップ 1: Lagoon で Panel を作成する」まで完了しました。ここまでの設定について不明点があれば、Dashboard を作成する を参照してください。
ステップ 2: Lagoon で Notification Channel を設定する
アラートの通知方法 (Notification Channel) を設定します。Lagoon は OSS として提供されている Grafana をベースに開発されているのでメールや webhook 等の様々な通知方法があります。詳細は Notification Channel を参照してください。 今回はメールへの通知を設定します。
まずは SORACOM Lagoon ホーム画面のサイドメニュー
→ をクリックします。アラート設定画面が表示されますので
から通知チャンネルの新規追加を行います。
通知チャンネルの設定画面が表示されます。 まずは
を設定しこの通知チャンネルに名前をつけます。今回は「Lagoon Alert Channel」とします。 また、 には通知する手段として を、 に通知先のメールアドレスを設定します。
この状態で画面下の
をクリックして、アラートのテスト送信をします。登録したメールアドレスでテストアラートが受信できることを確認します。テストアラートは [Alerting] Test notification
というタイトルで送信されます。
最後に
ボタンで設定を保存します。ここまでで「ステップ 2: Lagoon で Notification Channel を設定する」が完了です。
ステップ 3: Lagoon で Alert Rule を設定する
Lagoon のデータを監視しアラートする設定を行います。ステップ 1 で作成した Panel を編集します。
上の動画のように Alert Rule を参照してください。
タブから ボタンで新規にアラートを作成し、以下のように設定します。設定項目の詳細は- デフォルトでは「ダッシュボード名 + alert」となります。
でアラートの名前を設定します。- の条件をここで設定する時間間隔で評価します。
- 今回は
1m
(1 分間隔で評価) と設定します。
で評価間隔を設定します。- 今回は条件を満たした場合にすぐ通知したいので
0m
と設定します。
を設定すると、設定した条件を満たした場合でも即アラート状態とならず指定した期間アラート通知を保留できます。- 今回は条件を満たした場合にすぐ通知したいので
- 「WHEN」の 1 つ右の設定項目ではデータの集計関数が選択できます。
- 今回は
max()
(時間範囲での最大値) とします。
- 今回は
- 「OF」の 1 つ右の設定項目では監視するデータと監視対象期間を選択できます。
- 今回は
query(A, 5m, now)
( タブで作成した「A」というデータの現在時刻から 5 分前までのデータを監視対象) とします。
- 今回は
- 閾値を設定します。
- 「IS ABOVE」の 1 つ右の設定項目には
25
とします。
- 「IS ABOVE」の 1 つ右の設定項目には
ではアラート条件を設定します。- 「WHEN」の 1 つ右の設定項目ではデータの集計関数が選択できます。
- 今回は不要なアラートが通知されることを回避するため
Keep Last State
(現在の状態を維持) を設定します。
: データが無いか全ての値が Null の時のアラートの状態を設定します。- 今回は不要なアラートが通知されることを回避するため
Keep Last State
(現在の状態を維持) を設定します。 と同様
: Lagoon のシステムエラーなどの理由で状態をアラートとすべきか判断できない時の状態を設定します。
つまり今回の設定は「評価間隔:1 分」ごとに「データ A
の現在から 5 分前まで」の「最大値」が「25」を超過していた場合にアラートを出すことになります。
次に、設定した Lagoon Alert Channel
を選択し任意のメッセージを設定します。
設定が完了したら、画面右上の
ボタンをクリックして設定を保存します。 ここまでの設定で Graph 上に設定した閾値 (今回の場合は 25) が表示されています。
また、サンプルデータソースの値が設定した条件を満たしている場合 (今回の場合は 25 より大きい値) は
で設定した評価間隔が経過するとアラートが通知されます。アラート条件を満たしていない場合は、以下のように閾値をサンプルデータソースの値より小さい値に変更した後、 ボタンで設定を保存すると評価間隔が経過後にアラートが通知されます。以下のように登録したメールアドレスでアラートが受信できていれば成功です。
グラフ上でもアラート状態となっていることが赤い点線で示されています。
次にアラートを解除してみましょう。以下のように閾値をサンプルデータソースより大きい値に変更した後、
ボタンで設定を保存してください。登録したメールアドレスでアラート解除が受信できていれば成功です。
また、グラフの
タブ末尾の をクリックするとアラートの状態履歴を表示できます。
以上で Lagoon でアラートを設定できました。
この機能を活用することで単にデータを可視化するだけではなく、異常検知や定期報告のような活用が可能となります。 アラート設定の応用として Alert をカスタマイズする も参照いただき、色々な場面での活用を検討してみてください。