通知先の管理
このページでは、ワークスペースの通知先を作成および構成する方法について説明します。
システム通知は、ワークフローでラン イベント (起動、成功、失敗) が発生したときに通知するメッセージです。defaultでは、通知はユーザーのEメールアドレスに送信されますが、管理者はWebhookまたは Slack および Microsoft Teams 用 Databricks Genie アプリ (パブリックプレビュー) を使用して別の通知先を設定できます。これにより、Databricks を使用してイベント駆動型の統合を構築できます。
管理者は、Unity Catalog オブジェクトに対する特権要求など、ワークスペース ユーザーからのアクセス要求を受信するように通知先を構成することもできます。
通知先を管理するには、Databricks ワークスペース管理者である必要があります。 宛先を設定すると、すべてのユーザーがその宛先を使用できるようになります。
予算アラートなどのアカウントレベルのイベントでは、アカウントコンソールでアカウント管理者が構成するアカウントレベルの通知先が使用されます。「アカウントレベルの通知先を管理する」を参照してください。
ネットワーク要件
Webhookベースの送信先の場合、受信側のEndpointは以下の要件を満たしている必要があります。
- Databricks では、セキュリティのために HTTPS の使用を強制しています。 通知の送信先は、信頼できる認証局によって署名された Secure Sockets Layer (SSL) 証明書を使用する必要があります。
- 通知先は、ワークスペースの制御プレーンとデータプレーンの両方の送信IPアドレスを許可リストに追加する必要があります。
-
コントロールプレーンのウェブアプリのIPアドレスについては、 「 DatabricksサービスとアセットのIPアドレスとドメイン」を参照してください。
-
データプレーンのアウトバウンドIPアドレスについては、Databricksが公開している
ip-ranges.jsonファイルを参照してください。ファイルで、お使いのワークスペースのデータプレーンリージョンを検索し、ネットワークスタックで、対応するアウトバウンドIPアドレスを許可リストに登録してください。Databricksは、発信IPアドレスを30日に1回程度更新する場合があります。更新されたIPアドレスは公開後60日で有効になるため、定期的にファイルを確認し、有効化期間が終了する前に許可リストを更新してください。
リリース間の変更を追跡するには、JSON ファイルの連続するバージョンを保存し、
timestampSeconds値を比較します。エントリをフィルタリングする条件:serviceフィールドはDatabricksplatformフィールドはgcptypeフィールドはoutbound
-
新しい通知先を作成する
新しい通知先を設定するには
-
ワークスペースの上部バーでユーザー名をクリックし、ドロップダウンから [ 設定 ] を選択します。
-
ワークスペース管理 セクションで、「 通知 」タブをクリックします。
-
管理 ボタンをクリックします。
-
[+ 宛先を追加] をクリックします。
-
宛先タイプを選択します。 現在、次の宛先がサポートされています。
- Eメール
- Slack
- Webhook(オプションでOAuth認証(ベータ)を使用)
- Microsoft Teams
- PagerDuty
- AWS EventBridge (ベータ)
-
タイプに基づいて宛先を設定します。
-
作成 をクリックします。
Webhookペイロード
通知を送信するサービスがWebhookペイロードを定義します。ジョブが送信するペイロードについては、HTTP webhookペイロードを参照してください。ステータス変更後にDatabricks SQLアラートが送信するペイロードについては、SQLアラートwebhookペイロードを参照してください。
宛先ごとに異なる資格情報を使用します
宛先の構成は、Databricks ワークスペースに安全に暗号化されて保存されます。URL または資格情報の提供が必要な宛先については、構成された宛先ごとに異なる資格情報を使用することを Databricks ではお勧めします。これにより、サードパーティのEndpointが侵害された場合の影響を抑えることができます。これらには以下が含まれます。
- Slack(Webhook使用):通知の送信先となるURL。
- Microsoft Teams (Webhookの使用): 通知の送信先となる URL。
- PagerDuty: 通知を PagerDuty サービスに一意にルーティングするために使用される統合キー。
- Webhook:HTTP Basic認証のユーザー名とパスワード、またはOAuth認証 (ベータ)のクライアントIDとクライアントシークレット。
設定された宛先ごとに異なるシークレットを使用すると、Databricks ワークスペース内の他のすべての宛先の操作に影響を与えることなく、個々の通知宛先へのアクセスを個別に取り消すことができます。
Webhook送信先のOAuth認証
ベータ版
This feature is in Beta.To use it, a workspace admin must turn on Destination Type Generic Webhook Oauth from the Previews page.See Manage ワークスペース-level previews.
OAuth 2.0クライアント資格情報を使用して、アクセストークンを必要とするEndpointに通知を送信します。DatabricksはIDプロバイダーからトークンを取得し、それを使用して通知リクエストを認証します。
ID プロバイダーがクライアントクレデンシャル付与をサポートしている必要があります。受信側の Endpoint とトークンの Endpoint の両方で HTTPS を使用する必要があります。
OAuth Webhook宛先を作成するには:
-
[設定] > [通知] で [管理] をクリックし、 [+ 宛先の追加] をクリックします。
-
名前を入力し、 [タイプ] で [Webhook] を選択します。
-
[認証モード] で [OAuth] を選択します。
-
次の値を入力します。
- URL : 通知を受信するEndpoint。
- クライアントID と クライアントシークレット :IDプロバイダーによって発行された認証情報。
- Token endpoint URL :Databricks がアクセストークンを取得するエンドポイント。
- Scopes および Audience : IDプロバイダーで必要とされる場合は、これらのオプションの値を入力します。複数のスコープは、カンマで区切ってください。
-
作成 をクリックします。
クライアント ID、クライアント シークレット、およびトークン Endpoint URL をすべて指定する必要があります。OAuth を HTTP Basic 認証と組み合わせて使用することはできません。
構成を確認するには、送信先の 3 ドットメニューを開き、[ テスト ]をクリックします。Databricks がアクセストークンを取得し、サンプルの通知を送信します。テストが失敗した場合は、両方の Endpoint に対する資格情報、スコープ、オーディエンス、受信者の権限、およびネットワークアクセスを確認してください。
AWS EventBridgeの送信先
ベータ版
この機能はベータ版です。使用するには、ワークスペース管理者は プレビュー ページから Destination Type Aws Eventbridge を有効にする必要があります。ワークスペースレベルのプレビューを管理するを参照してください。
サポートされている任意のクラウドでホストされているワークスペースは、AWSアカウントのAmazon EventBridgeイベントバスに通知を送信できます。EventBridgeルールは、一致する通知をAWS Lambda関数などのターゲットにルーティングします。通知をEventBridgeに送信すると、通知データはDatabricksから送信されます。
EventBridgeの要件
EventBridgeをセットアップするには、ワークスペース管理者アクセス権と、AWSアカウントで以下のリソースを作成または構成する権限が必要です。
- 通知を受信するリージョンのEventBridgeイベントバス。
- イベントバスと同じAWSアカウントにあるAWS Identity and Access Management(IAM)ロール。
- EventBridgeルールと通知を消費するターゲット。
また、そのAWSアカウントでiam:GetRole権限を持つ資格情報でAWS CLIを設定する必要があります。
IAMロールを作成するCloudFormation Templateを入手するには、Databricksアカウントチームにお問い合わせください。
イベントバスとロールは、商用AWSパーティション(arn:aws:)を使用する必要があります。イベントバスのAmazonリソースネーム(ARN)のリージョンによって、Databricksがイベントを送信する場所が決まります。
EventBridge 送信先を作成する
-
イベントバスを作成するか、既存のバスを選択して、そのARNをコピーします。
-
Databricks で、 「設定」 > 「通知」 に移動し、 「管理」 をクリックして、 「+宛先を追加」 をクリックします。
-
名前を入力し、 Type に AWS EventBridge を選択します。
-
フォームに表示されている DatabricksプリンシパルARN と 外部ID をコピーします。
-
イベントバスを所有するAWSアカウントで、AWS CloudFormationを開き、アカウントチームが提供したTemplateからスタックを作成します。次のTemplateパラメーターを入力します。
DatabricksPrincipalArn: 送信先フォームからコピーしたプリンシパルARNです。ExternalId:宛先フォームからコピーされた外部ID。EventBusArn:正確なイベントバスARN。ワイルドカードは使用しないでください。
Templateの信頼ポリシーと権限ポリシーは変更しないでください。スタックがIAMリソースを作成することを承認してから、スタックを作成してください。そのロールは、指定したバスに対して
events:PutEventsのみを付与します。 -
スタック出力から
RoleArnをコピーします。次のコマンドをランして、<role-name>をそのARNの最後のコンポーネントに置き換え、出力をアカウントチームに送信して、信頼ポリシーと外部IDを確認します。Bashaws iam get-role --role-name <role-name> --output json -
アカウントチームが設定を確認した後、宛先フォームに戻り、 イベントバスARN と ロールARN を入力します。 作成 をクリックします。
送信先が通知送信先リストに表示されます。
送信先の名前をクリックして設定を編集するか、3点メニューから [削除] を選択して削除します。Databricksで送信先を削除しても、AWSアカウントのCloudFormationスタック、IAMロール、イベントバスは削除されません。不要になったリソースは、AWSで個別に削除してください。
外部IDはDatabricksアカウントIDであり、そのアカウント内のワークスペースで共有されます。秘密ではありません。ロールARNとバスARNを知っている同じDatabricksアカウント内のワークスペース管理者は、このバスに送信する宛先を作成できます。EventBridgeルールのフィルターは、どのイベントがターゲットに到達するかを制御します。バスに送信できるワークスペースを制限するものではありません。
Databricksは、AWS Security トークンサービス (STS)を使用して、このロールの一時的な資格情報を取得します。DatabricksにAWSアクセスキーを提供することはありません。
EventBridge通知をターゲットにルーティングする
各EventBridgeイベントには、databricks.notificationsに設定されたsource、通知タイプを識別するdetail-type、通知ペイロードを含むdetailがあります。detail.workspace.idフィールドは、サポートされているすべての通知タイプで送信ワークスペースを識別します。
-
設定したイベントバスでEventBridgeルールを作成します。
-
イベントパターンを設定して、受信する通知と一致させます。たとえば、このパターンは1つのワークスペースからの
JOB_RUN_ERROR_V2通知と一致します。<workspace-id>をワークスペース ID に置き換えます。JSON{"source": ["databricks.notifications"],"detail-type": ["JOB_RUN_ERROR_V2"],"detail": {"workspace": {"id": ["<workspace-id>"]}}}そのワークスペースのすべての通知タイプをルーティングするには、パターンから
detail-typeを省略します。 -
ルールのターゲットを選択し、必要な権限を構成して、ルールを有効にします。
EventBridgeはルールを使用して、一致するイベントをターゲットにルーティングします。配信によって重複した通知が生成される場合があります。ペイロードは通知タイプによって異なり、送信先は共有の重複排除キーを提供しません。JOB_RUN_ERROR_V2の場合、ターゲットはdetail.workspace.id、detail.run.run_id、detail.run.attempt、およびdetail-typeを組み合わせて、繰り返される通知を識別できます。
Slackの送信先
To set up a webhook-based Slack destination, follow the instructions in Incoming webhooks for Slack.Paste the generated URL into your Databricks notification destination.To use the Databricks Genie app instead, see Slack and Microsoft Teams Genie app destinations.
SlackおよびMicrosoft Teams Genieアプリの送信先
プレビュー
この機能は パブリック プレビュー段階にあります。使用するには、ワークスペース管理者は プレビュー ページから 宛先タイプDatabricksアプリSlack または 宛先タイプDatabricksアプリTeams を有効にする必要があります。ワークスペースレベルのプレビューの管理を参照してください。
Databricks Genieアプリを使用して、SlackワークスペースまたはMicrosoft TeamsテナントをDatabricksワークスペースに接続します。次に、通知先として利用可能なチャンネルを選択します。
Genie アプリの宛先は、次の機能で使用できます:
- SQLアラート:Slack および Microsoft Teams。
- Unity Catalog のアクセス要求: Slack および Microsoft Teams
- Model Serving endpoint notifications: Slack.
Genie アプリの送信先を作成する
Genie アプリの送信先を作成する前に、Slack または Microsoft Teams 用の Databricks Genie アプリをインストールし、Databricks ワークスペースに接続して、通知を受信するチャンネルに追加する必要があります。アプリのインストールと接続のステップの詳細については、Slack または Microsoft Teams をご覧ください。
Genieアプリの送信先を作成するには:
-
[設定] > [通知] で [管理] をクリックし、 [+ 宛先の追加] をクリックします。
-
[Type] で [Slack] または [Microsoft Teams] を選択し、 [Using Databricks App] を選択します。
-
送信先の名目を入力します。
-
ワークスペースまたはテナントとチャンネルを選択します。
- Slack の場合は、 Slack ワークスペース と チャンネル を選択します。
- Microsoft Teams の場合は、 テナント と チャンネル を選択します。テナントセレクターは、テナントIDの最後の6文字によって各テナントを識別します。
SlackワークスペースまたはMicrosoft Teamsテナントが接続されていない場合は、それぞれ [Slackワークスペースを接続] または [Teamsテナントを接続] をクリックし、Genieアプリのセットアップを完了します。送信先フォームに戻り、 [更新] をクリックします。チャンネルにGenieアプリを追加したばかりの場合は、 [チャンネルを再読み込み] をクリックしてチャンネルリストを更新します。
-
作成 をクリックします。
PagerDuty の送信先
PagerDuty宛先を設定するには:
- PagerDutyで、サービスに統合を追加し、 Events API V2 統合タイプを選択します。
- 統合用にPagerDutyによって生成された統合キーをコピーします。
- Databricksで、統合キーをPagerDutyの通知先に貼り付けます。
ジョブに Webhook を追加する
宛先を設定した後、ジョブの ジョブ通知 設定で宛先にアクセスできます。 詳細については、「 ジョブに通知を追加する」を参照してください。
各ジョブは、イベント・タイプごとに最大 3 つのシステム宛先をサポートします。ジョブ通知を設定するときは、Eメール アドレスを手動で入力する必要があります。
制限
現在、通知先には次の制限があります。
- Eメール通知の送信先では、受信者のアドレスの長さに1,300文字の制限があります。
- カスタム通知本文の場合、Slack や Microsoft Teams などの E メール以外の送信先では、HTML 書式設定がサポートされません。一部の通知先はマークダウンをサポートしています。
- ジョブの場合、Eメールの送信先はジョブの設定で手動で設定する必要があります。