Soracom

Users

ドキュメント

Alert rule を設定する

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

ステップ 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. [Grafana 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」(現在時刻) を含む相対的な時間を指定します。

    リソースの種類 (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 条件として利用できません。

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

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

    State説明
    NormalAlert 条件を満たしません。
    FiringAlert 条件を満たしました。

ステップ 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 のときの Alert の State を設定します。

    • Alerting: Firing に変化します。
    • No Data: No Data に変化します。
    • OK: Alert の State が変化しません。
    [Alert state if execution error or timeout]

    Lagoon 3 のシステムエラーなどの理由で、Alert を通知すべきか判断できない場合の Alert の State を設定します。Lagoon 3 のシステムエラーに影響を受けないようにする場合は、「OK」を選択してください。

    • Alerting: Firing に変化します。
    • OK: Alert の State が変化しません。
    • Error: Error に変化します。

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

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

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

項目説明
[Rule name]Alert rule の名前です。ここで設定した名前は、「Alert rules」画面に表示されます。
[Folder]Alert rule を保存する Folder の名前です。
[Group]Alert rule の Group の名前です。同じ Group に所属する Alert rule の [Evaluate every] は、自動的に同じ値が設定されます。
[Summary and annotations]Key-Value の方式で、Alert rule に任意の情報を登録できます。ここで登録した情報は、通知の本文などで利用できます。

ステップ 4: Contact point と関連付けるための Label を設定する

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

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

Alert の概要については、Alert の概要 を参照してください。

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

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

Alert rule を削除する

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

作成できる Alert rule の数はプラン / ライセンスパックによって異なります。詳しくは、SORACOM Lagoon 3 のプラン / ライセンスパックを変更する を参照してください。

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

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

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

    Alert rule が削除されます。

Alert rule の権限を管理する

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