メインコンテンツまでスキップ

アラートを作成する

このページではDatabricks SQLアラートをエンドツーエンドで作成する手順を説明します。 このドキュメントでは、アラートエディタ、アラート作成チュートリアル、評価の詳細を確認する方法、および設定可能な高度な設定と通知テンプレートについて説明します。

アラートエディターを探索する

このセクションのステップでは、次の画像に示すアラートの作成方法を説明します。 各構成要素を理解するには、ラベルと説明を参照してください。

アラート作成UIには、各部分を識別するための番号付きラベルが表示されます。

  1. クエリエディタ :アラートを設定したいクエリを作成してテストします。
  2. コンピュート : アラート クエリを実行するSQLウェアハウスを選択します。 ステータス インジケーターは、選択したウェアハウスが実行中かどうかを示します。 ウェアハウスのサイジングに関する推奨事項と、スケジュールされた実行時間での動作については、 「アラート用のSQLウェアハウスの選択」を参照してください。
  3. スケジュール: アラートを実行する定期的なスケジュールを設定します。
  4. 共有 :ワークスペース内の他のユーザーがアラートをどのように操作できるかを定義する権限を設定します。
  5. 条件 :アラート通知をトリガーする値のしきい値を選択してください。このセクションからクエリを実行して条件をテストできます。
  6. 通知 :しきい値が想定範囲外になった場合に、どのユーザーまたは通知先にアラートを送信するかを指定します。必要に応じて、アラートがOKに戻るまで通知を繰り返すように通知頻度を設定します。
  7. Advanced: 詳細設定を使用して、特別な値と条件でアラートを発します。
重要

アラートは問題のあるクエリをサポートしていません。

アラートを作成する

アラートを作成するには、次のステップを使用します。

  1. クリックアラートアイコンサイドバーで 「アラート」を 選択し、 「アラートの作成」を クリックします。

  2. 以下のクエリをコピーしてクエリエディタに貼り付けてください。 「すべて実行(1000)」 をクリックします。SQL エディターの操作方法について詳しくは、 「新しい SQL エディターでクエリを作成し、データを探索する」を参照してください。

    SQL
    SELECT
    to_date(tpep_pickup_datetime) as date,
    SUM(fare_amount) as amount
    FROM
    `samples`.`nyctaxi`.`trips`
    GROUP BY
    ALL
    ORDER BY
    1 DESC

  3. コンピュート セレクターをクリックし、リストからウェアハウスをクリックして、アラートを実行するコンピュート リソースを指定します。

    コンピュートセレクター

  4. 「条件」 欄に、アラートをトリガーする条件を設定します。

    以下のテキストに示すような設定が適用された条件フィールド。

    以下の設定を図示のとおり適用してください。

    • チェックするデータ値として 「合計」 を選択してください。クエリ結果の列の最初の値に対してアラート条件を設定したり、SUMやAVERAGEなど、単一列のすべての行に対して集計を設定したりすることができます。
    • チェックする列として amount を選択します。
    • 適用する論理演算子として 「>」 (より大きい)を選択してください。
    • しきい値を Static value の4000 に設定します。デフォルトでは、 静的な値 が選択されています。値フィールドに 4000 を入力します。
  5. 「条件をテスト」を クリックすると、アラートをプレビューし、現在のデータでアラートがトリガーされるかどうかをテストできます。指定された設定により、アラートがトリガーされるはずです。しきい値を変更することで、さらにテストを進めることができます。

  6. 通知 セクションで、自分のユーザー名を検索し、表示されたらクリックしてください。

  7. クリックカレンダーアイコン。カレンダーアイコンをクリックすると、 スケジュール編集 ダイアログが開きます。ドロップダウンメニューを使用して、アラートが毎時 0 分から 5 ごとに実行されるように設定します。 「保存」 をクリックしてください。必要に応じて、 [cron構文を表示] チェックボックスを選択すると、 Quartz Cron構文でスケジュールを編集できます。

  8. 「アラートを表示」 をクリックしてください。

アラートは保存され、ご指定のスケジュールに従って実行されます。この例で使用されているデータは静的なため、 テスト条件「トリガー済み」 と返された場合、次回実行時にも再びトリガーされます。アラートとして電子メール通知を受け取ります。 テスト条件OK を返した場合、通知は送信されません。

アラートの詳細を確認する

アラートの詳細を表示するページが開きます。このページには、評価の詳細を含むアラート履歴も表示されます。 「今すぐ実行」 ボタンをクリックすると、アラート クエリがすぐに実行され、このページに結果が返されます。

アラートの編集を続けるには、ページ右上の 「編集」 をクリックしてください。

詳細設定

Advanced をクリックして、次の設定を適用します。

  • 「OK」時に通知: アラートが OKとして返されたときに通知を送信します。
  • 結果が空の状態 : クエリが結果を返さなかった場合に返す特別なステータスを設定します。
  • テンプレート :通知テンプレートを設定します。通知テンプレートを参照してください。

ワークスペース管理者は、新しい通知先を設定できます。「通知先を管理する」を参照してください。

通知テンプレート

通知は、カスタマイズしない限りデフォルトのテンプレートを使用します。件名と本文をカスタマイズするには、 「テンプレートをカスタマイズ」 を選択してください。標準エディタとMarkdownエディタの2種類のエディタが利用可能です。下のタブをクリックして比較してください。

標準エディタでは、主題と本文中の変数を参照するには{{VARIABLE_NAME}}を使用します。以下の変数がサポートされています。

  • ALERT_STATUS評価されたアラートステータス(文字列)。
  • ALERT_CONDITION: アラート条件演算子(文字列)。
  • ALERT_THRESHOLDアラートのしきい値(文字列または数値)。
  • ALERT_COLUMNアラート列名(文字列)。
  • ALERT_NAMEアラート名(文字列)。
  • ALERT_URLアラートページのURL(文字列)。
  • QUERY_RESULT_TABLEクエリ結果のHTMLテーブル(文字列)。結果は最初の100行に限定されます。電子メール通知の宛先のみが HTML をレンダリングできます。
  • QUERY_RESULT_VALUEクエリ結果の値(文字列または数値)。
  • QUERY_RESULT_ROWSクエリ結果の行(値の配列)。
  • QUERY_RESULT_COLSクエリ結果の列(文字列配列)。

例えば、Alert "{{ALERT_NAME}}" changed status to {{ALERT_STATUS}}です。

標準エディタは、書式設定のためにHTMLもサポートしています。電子メール通知の宛先のみが HTML をレンダリングできます。 以下の HTML タグが許可されています: <a><b><blockquote><br><code><del><div><em><h1><h2><h3><h4><h5><h6><hr><i><img><li><ol><p><pre> 、 `` 、 <table><thead><tbody><td><th><tr><u><ul>

以下の属性は、記載されているタグで使用できます。

属性

サポートされているタグ

href

<a>

title

<img>

target

<a>

alt

<img>

src

<img>

start

<b><blockquote><code><del><em><hr><i><pre><u>

プレビュー 切り替えボタンをクリックして、レンダリングされた結果をプレビューします。

重要

プレビュー機能は、テンプレート変数が正しくレンダリングされているかどうかを確認するのに役立ちます。これは最終的な通知内容を正確に表しているわけではありません。なぜなら、通知先によって通知の表示方法が異なる場合があるからです。