このページでは、Databricks SQL アラートをエンド ツー エンドで作成する手順について説明します。 アラート エディター、アラートの作成チュートリアル、評価の詳細を確認する方法、構成できる詳細設定と通知テンプレートについて説明します。
アラート エディターを調べる
このセクションの手順では、次の図に示すアラートを作成する方法について説明します。 各コンポーネントを理解するには、ラベルと説明を使用します。
- クエリ エディター: 警告するクエリを作成してテストします。
- コンピューティング: アラート クエリを実行する SQL ウェアハウスを選択します。 状態インジケーターは、選択したウェアハウスが稼働中かどうかを示します。 スケジュールされた実行時の倉庫のサイズ設定に関する推奨事項と動作については、「 アラートの SQL ウェアハウスを選択する」を参照してください。
- スケジュール: アラートを実行するための定期的なスケジュールを設定します。
- 共有: ワークスペース内の他のユーザーがアラートを操作する方法を定義するアクセス許可を設定します。
- 条件: アラート通知をトリガーする値のしきい値を選択します。 クエリを実行して、このセクションの条件をテストできます。
-
通知: しきい値が予期される範囲を超えたときにアラートを送信する必要があるユーザーまたは通知先を示します。 必要に応じて、通知が
OKに戻るまで通知を繰り返すように通知の頻度を設定します。 - 詳細設定: 詳細設定を使用して、特別な値と条件に関するアラートを生成します。
Important
アラートは、 パラメーターを含むクエリをサポートしていません。
アラートを作成する
アラートを作成するには、次の手順に従います。
サイドバー
の [アラート ] をクリックし、[ アラートの作成] をクリックします。次のクエリをコピーしてクエリ エディターに貼り付けます。 すべて実行 (1000) をクリックします。 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コンピューティング セレクターをクリックし、一覧からウェアハウスをクリックして、アラートを実行するコンピューティング リソースを指定します。
[ 条件] フィールドで、アラートをトリガーする条件を設定します。
次のように、次の設定を適用します。
- 確認するデータ値として [合計] を選択します。 クエリ結果の列の最初の値にアラート条件を設定することも、SUM や AVERAGE など、1 つの列のすべての行に集計を設定することもできます。
- チェックする列として 金額 を選択します。
- 適用する論理演算子として > (より大きい) を選択します。
- しきい値を
Static value4000 に設定します。 既定では、静的な値が選択されています。 値フィールドに「4000」と入力します。
[ テスト条件 ] をクリックしてアラートをプレビューし、アラートが現在のデータでトリガーされるかどうかをテストします。 指定された設定によってアラートがトリガーされます。 しきい値を変更して、さらにテストすることができます。
[ 通知 ] セクションで、ユーザー名を検索し、表示されたらクリックします。
[
をクリックします。予定表アイコンをクリックして、[ スケジュールの編集] ダイアログを開きます。 ドロップダウン メニューを使用してアラートを設定し、1 時間の 0 分後から 5分ごとに実行されるようにします。 保存 をクリックします。 必要に応じて、[Cron 構文の表示] チェックボックスをオンにして、[Quartz Cron 構文] でスケジュールを編集します。
[ アラートの表示] をクリックします。
アラートが保存され、指定したスケジュールに従って実行されます。 この例で使用されるデータは静的であるため、 テスト条件 が Triggered として返された場合は、次回の実行時に再度トリガーされます。 アラートとして電子メール通知を受け取ります。 テスト条件が OK を返した場合、通知は送信されません。
アラートの詳細を確認する
アラートの詳細を表示するページが開きます。 このページには、評価の詳細を含むアラート履歴も表示されます。 [ 今すぐ実行 ] ボタンをクリックしてアラート クエリをすぐに実行し、このページの結果を返します。
ページの右上隅にある [編集] をクリックして、アラートの編集を続けます。
詳細設定
[ 詳細設定 ] をクリックして、次の設定を適用します。
-
[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>、 <span>、 <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> |
[プレビュー] トグル ボタンをクリックして、レンダリングされた結果をプレビューします。
Important
プレビューは、テンプレート変数が正しくレンダリングされることを確認するのに役立ちます。 通知の送信先ごとに通知を異なる方法で表示できるため、最終的な通知コンテンツを正確に表現することはできません。
Markdown エディター
Markdown エディターをオンにして、Markdown を使用して本文を書き込みます。 Markdown エディターには、書式設定ツール バーとレンダリングプレビューがあります。
Markdown エディターで、 @VARIABLE_NAMEを使用して変数を参照します。 変数ピッカーを開くには、本文に「 @ 」と入力します。 Markdown エディターでは、 ALERT_NAME、 ALERT_STATUS、 ALERT_CONDITION、 ALERT_THRESHOLD、 ALERT_COLUMN、 ALERT_URL、および QUERY_RESULT_TABLEがサポートされます。