Soracom

監視するデータと、通知が必要になる基準 (評価基準) を設定します。また、通知先を表す Label も設定します。実際には、Label は Contact point と紐づけたり、Silence 対象を特定するための情報です。

ステップ 1: Query および [Firing] にする条件を設定する

Query (監視するデータ) と、Alert の State が Firing に変化する条件を設定します。

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

   

   「Alert rules」画面が表示されます。

2. [＋New alert rule] をクリックします。

   

   「Add rule」画面が表示されます。

   Panel の種類を Time series に設定している場合は、[Alert] → [Create alert rule from this panel] の順にクリックすると、Panel の設定を利用して Alert rule を作成できます。

   

3. [Lagoon managed alert] が選択されていることを確認します。

   

   Query で監視するリソースおよび系列を選択し、Expression でデータの再計算や集計、判定を行います。

   • [＋Add query] をクリックすると、Query を追加できます。
   • [＋Add expression] をクリックすると、Expression を追加できます。

   

   Query:

   監視するリソースおよび系列を設定します。

   項目	説明
   Query の名前	Query の名前を変更できます。この名前は、ほかの Expression で、この Query を参照するときに使用します。
   データソース (1 列目 1 項目)	「Harvest (default)」を選択します。
   Alert 対象の時間範囲 (1 列目 2 項目)	Alert 対象の時間範囲を選択します。[From] と [To] を指定する場合は、どちらも「now」(現在時刻) を含む相対的な時間を指定します。 相対的な時間を指定するときのフォーマット 現在時刻から 30 秒前を指定する場合は、now-30s のように指定します。同様に、d (日)、h (時)、m (分) などの単位を使用できます。ただし、複数の単位を同時に利用することはできません (例: now-5m30s)。たとえば、5 分 30 秒を指定する場合は、now-330s (5 分 30 秒) を指定してください。
   リソースの種類 (2 列目 1 項目) リソース (2 列目 2 項目)	データを評価するリソースの種類およびリソースを選択します。詳しくは、Query を設定する を参照してください。
   データフォーマット (2 列目 3 項目)	「Standard」を選択します。 ここでは「Standard」だけが利用できます。「Table」と「Map」は利用できません。
   系列 (2 列目 4 項目)	系列を選択します。

   

   Query を設定すると、選択した系列のグラフが表示されます。

   系列を選択したときに、想定したグラフが表示されない場合は、もう一度同じ系列を選択してください。

   Expression:

   データの再計算や集計を行い、数値の評価を行います。

   項目	説明
   Expression の名前	Expression の名前を変更できます。この名前は、ほかの Expression で、この Expression を参照するときに使用します。
   計算方法	Expression で使用する計算方法を選択します。計算方法について詳しくは、Query を加工して新しい Query を作成する (Expression) を参照してください。
   [Series]	Expression で計算した結果が表示されます。「Time series data」と表示されたときは、マウスポインターをあわせると、時系列データが表示されます。
   [Make this the alert condition]	クリックすると、この Expression を Alert 条件として利用できます。ただし、時系列データは Alert 条件として利用できません。

   

   不要な Expression は削除できます

   不要な Expression の [] をクリックすると、削除できます。

   

4. [Preview] をクリックします。

   

   データが更新され、Alert 条件が評価されて、Alert の State が更新されます。

   State	説明
   Normal	Alert 条件を満たしません。
   Firing	Alert 条件を満たしました。

ステップ 2: Alert 条件の評価間隔を設定する

次に、Alert 条件の評価間隔を設定します。たとえば、1 分間隔で Alert 条件を評価し、Alert 条件を満たした後も 1 分 30 秒間継続して Alert 条件を満たしている場合に限り、State が Firing に変化するように設定できます。

1. Alert 条件の評価間隔を設定します。

   項目	説明
   [Evaluate every]	Alert rule の評価間隔を入力します。Lagoon は、指定した間隔で Harvest Data のデータを取得して Alert を通知するかどうかを評価します。 10 秒の倍数を入力してください (例: 1m)。 単位の文字として、s (秒)、m (分)、h (時間)、d (日) を利用できます。 Lagoon のプランごとに設定されている「データを取得する時間範囲」よりも長い間隔を指定してください Lagoon のプランごとに、データを取得する時間範囲が設定されています。プランの違いについては、SORACOM Lagoon のプラン を参照してください。
   [for]	Alert rule の継続時間を入力します (例: 1m30s)。たとえば、「1m30s」を指定したときは、Alert 条件を満たしてから、1 分 30 秒の間、継続して Alert 条件を満たした場合に、Alert の State が Firing に変化します。「0」を入力した場合は、1 回でも Alert 条件を満たした場合に、Alert の State が Firing に変化します。

   

2. [Configure no data and error handling] をクリックして、以下の項目を設定します。

   

   項目	説明
   [Alert state if no data or all values are null]	「データが無いかすべてのデータが null のとき」の動作を設定します。 Alerting: この Alert rule で作成される標準的な Alert と同じ Label が設定された Alert が作成されます。標準的な Alert と同一の Notification policy や Contact point を利用して通知する場合に選択します。 No Data: この Alert rule で作成される標準的な Alert とは異なる Label が設定された Alert が作成されます。標準的な Alert とは異なる Notification policy や Contact point を利用して通知する場合に選択します。 OK: この Alert rule によって作成された標準的な Alert が Resolved になります。 設定ごとに「Alert rule の State」、「Query の State」、「作成される Alert」などが以下のように異なります。 項目 Alert rule の State Query の State 作成される Alert に設定される主な Label (*1) Contact point に通知する際の種別 Alerting Firing Alerting (Nodata) alertname={Alert rule の名前} grafana_folder={Alert rule が保存されている Folder の名前} Firing No Data Normal Nodata alertname=DatasourceNoData grafana_folder={Alert rule が保存されている Folder の名前} rulename={Alert rule の名前} Firing OK Normal Normal (Nodata) - (*2) Resolved (*1) 作成された Alert は、「Alert group」画面 で確認できます。また、Notification policy は、「Alert group」画面での表示に基づいて設定します。 (*2) Alert は作成されません。
   [Alert state if execution error or timeout]	無効な Query を設定していたり、Lagoon 3 のシステムエラーなどが発生したときの Alert の動作を設定します。 Alerting: この Alert rule で作成される標準的な Alert と同じ Alertが作成されます。標準的な Alert と同一の Notification policy や Contact point を利用して通知する場合に選択します。 OK: この Alert rule によって作成された標準的な Alert が Resolved になります。 Error: この Alert rule で作成される標準的な Alert とは異なる Alertが作成されます。標準的な Alert とは異なる Notification policy や Contact point を利用して通知する場合に選択します。 設定ごとに「Alert rule の State」、「Query の State」、「作成される Alert」などが以下のように異なります。 項目 Alert rule の State Query の State 作成される Alert に設定される主な Label (*1) Contact point に通知する際の種別 Alerting Firing Alerting (Error) alertname={Alert rule の名前} grafana_folder={Alert rule が保存されている Folder の名前} Firing OK Normal Normal (Error) - (*2) Resolved Error Normal Error alertname=DatasourceError grafana_folder={Alert rule が保存されている Folder の名前} rulename={Alert rule の名前} Firing (*1) 作成された Alert は、「Alert group」画面 で確認できます。また、Notification policy は、「Alert group」画面での表示に基づいて設定します。 (*2) Alert は作成されません。

   詳しくは、Grafana documentation の No data and error handling (英語) を参照してください。

ステップ 3: Alert rule の詳細を設定する

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

ステップ 4: Label を設定する

Lagoon 3 では、Alert の State が Firing になったときに、Alert rule に設定される Label を利用して、通知する Contact point を特定します。また、Silence を利用する際に、Silence 対象を特定するためにも Label は利用されます。

たとえば、Contact point の場合は、severity=info のときの通知先と、severity=warning のときの通知先を変更できます。実際の通知先は Contact point で設定し、Label と Contact point を関連付けるのは Notification policy で設定します。

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

   項目	説明
   [key]	新しいキーを入力して、Enter キーを押すか、既存のキーを選択します。
   [value]	新しい値を入力して、Enter キーを押すか、既存の値を選択します。

   

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

   

Alert rule を削除する

不要になった Alert rule を削除します。

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

   

2. Group の [>] をクリックして、削除する Alert rule の [] をクリックします。

   

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

   Alert rule が削除されます。

Alert rule に対する権限を管理する

Alert rule に対する権限は、Alert rule が保存されている Folder に対する権限で設定できます。たとえば、Folder に対して Edit 権限を持つユーザーは、Alert rule の編集 / 削除ができます。Folder に対する権限を設定する操作については、Folder に対する権限を管理する を参照してください。