dbt Cloudでジョブの成功・失敗・中止の通知設定をしてみた~メール編~ #dbt

2022.04.27

さがらです。

dbt Cloudでは、CLI版のdbt Coreと異なりジョブスケジューリング機能があります。

その上で、ジョブの成功・失敗・中止のときに通知してくれる機能もあります。

本ブログでは、ジョブに関する通知設定をEmailで行う方法についてまとめてみます。

通知設定方法

大きく、2つ方法があります。

各ユーザーがそれぞれに指定する

各ユーザーの「Profile」を開き、「Notifications」を押します。

画面右上のEDITボタンを押してNotificationsの編集画面に移ります。

各ジョブで、通知が必要な項目にチェックを入れます。チェックボックスは左から、「SUCCEEDS(成功)」「FAILS(失敗)」「IS CANCELLED(中止)」を意味しています。設定後、右上のSaveを押せば完了です!

ちなみに、通知設定を一括で削除することも可能です。同じNotificationsの画面の一番下に「Unsubscribe from all email notifications」というボタンがありますので、こちらを押せばOKです。

Account Admin権限を持つユーザーが設定する

Enterprise版でのAccount Adminに該当する権限を持つユーザーであれば、対象のdbt CloudのAccount Settingsから、どのジョブの通知をどのユーザーに送るか、という設定を行うことも可能です。 (Team版ではOwner権限があれば出来るかも…?環境がなく未検証です…)

まず、画面左上のメニューバーから「Account Settings」を開きます。

続いて、Notificationsを押します。

画面右上のEDITボタンを押してNotificationsの編集画面に移ります。

まず、設定対象のユーザーを選択します。一番上の「Notifications for user...」を押すと、どのユーザーに対する通知設定を行うか、ユーザーを選択できます。

ユーザー選択後は、上述の各ユーザーが設定する方法と同じです。チェックボックスは左から、「SUCCEEDS(成功)」「FAILS(失敗)」「IS CANCELLED(中止)」を意味しています。設定後、右上のSaveを押せば完了です!

どんな通知が届くのか

ジョブの成功時 ※SUCCEEDSが有効

ジョブの成功時には、completed successfully!と書かれたメールが届きます。

ジョブの失敗時 ※FAILSが有効

ジョブの失敗時には、どのコマンドでエラーが発生したのか書かれた上でメールが届きます。

ジョブのキャンセル時 ※IS CANCELLEDが有効

ジョブのキャンセル時は、シンプルにwas cancelledとだけ書かれたメールが届きます。

最後に

dbt Cloudを導入するメリットの一つとして、ジョブスケジューラが標準で備わっている、ということが挙げられると思います。

ジョブスケジューラとして通知関係はやはり必須ですので、メールに関しては特に違和感なく使えそうで安心しました。 dbt Cloudをご利用の方は通知設定をしていきましょう!