失敗したワークフローの呼び出しのアラートを構成する

このドキュメントでは、ログ エクスプローラを使用して、失敗した Dataform ワークフローの呼び出しに対するログベースのアラートを構成する方法について説明します。

Cloud Monitoring を使用して Dataform ワークフロー呼び出しの Cloud Logging ログの傾向を確認し、記述した条件の発生時に通知できます。

各 Dataform ワークフローの呼び出しは、Cloud Logging を使用して記録されます。Dataform ワークフローの呼び出しでは、ロギングが自動的に有効になります。このため、Cloud Logging の料金が発生する場合があります。詳しくは、Dataform の料金をご覧ください。

Dataform ワークフローの呼び出しが失敗した場合にアラートを受け取るには、ログベースのアラートを作成します。

ログベースのアラートは、Google Cloud コンソールの [ログ エクスプローラ] ページで作成するか、Monitoring API を使用して作成できます。このガイドでは、ログ エクスプローラを使用して Dataform ワークフロー呼び出しの失敗に対するログベースのアラートを作成する方法について説明します。

始める前に

ログベースのアラートを作成して管理するには、Identity and Access Management ロールに、ログベースのアラートの権限で説明されている権限が含まれていることを確認します。

Dataform ワークフロー呼び出しに失敗に対するログベースのアラートを構成する

Dataform ワークフロー呼び出しの失敗に対してログベースのアラートを構成するには、次の手順に従います。

  1. Google Cloud コンソールで [Logging] を選択してから、[ログ エクスプローラ] を選択します。

    ログ エクスプローラに移動

  2. [クエリ] ペインで [クエリを表示] を選択し、次のクエリを入力します。

        resource.type="dataform.googleapis.com/Repository"
    jsonPayload.@type="type.googleapis.com/google.cloud.dataform.logging.v1.WorkflowInvocationCompletionLogEntry"
    jsonPayload.terminalState="FAILED"

    このクエリは、すべての失敗した Dataform ワークフローの呼び出しをアラートで通知します。

    1. 省略可: 失敗したワークフローの呼び出しをリリース構成でフィルタするには、クエリに次の行を追加します。

      jsonPayload.releaseConfigId="RELEASE_CONFIGURATION_ID"

    2. 省略可: 失敗したワークフローの呼び出しをワークフロー構成でフィルタするには、クエリに次の行を追加します。

      jsonPayload.workflowConfigId="WORKFLOW_CONFIGURATION_ID"

    次のクエリは、daily リリース構成と production ワークフロー構成の両方に関連する Dataform ワークフロー呼び出しが失敗した場合にアラートを送信します。

     resource.type="dataform.googleapis.com/Repository"
 jsonPayload.@type="type.googleapis.com/google.cloud.dataform.logging.v1.WorkflowInvocationCompletionLogEntry"
 jsonPayload.terminalState="FAILED"
 jsonPayload.releaseConfigId="daily"
 jsonPayload.workflowConfigId="production"

  3. 省略可:　[クエリ結果] ペインで [クエリを実行] を使用してクエリを検証します。

  4. [クエリ結果] ペインの上部にある、[アラートを作成] をクリックします。ウィンドウの幅が狭い場合、[アラートを作成] オプションは [Actions] メニューに表示される場合があります。

  5. [アラートの詳細] ペインで、アラートの名前と説明を入力します。

    1. [アラート名] フィールドにアラートの名前を入力します。たとえば、「Dataform: workflow error」です。

    2. このアラートの説明を入力します。通知の受信者が問題を診断する際に有用な情報を表示することもできます。 次の文字列では、アラートの理由を要約しています。

      Log-based alert in project ${project} detected a failed Dataform workflow.

      このフィールドの内容のフォーマットと調整の詳細については、ドキュメント テンプレートでマークダウンと変数を使用するをご覧ください。

  6. 次のステップに進むには、[次へ] をクリックします。

  7. [アラートに含めるログを選択] ペインで、[ログをプレビュー] をクリックしてクエリと結果を確認します。

    ログ エクスプローラの [クエリ] ペインでクエリを作成することをおすすめします。[クエリ] ペインで作成したクエリもこのペインに表示されます。

    必要に応じて、このペインでクエリを編集できます。クエリを編集する場合は、[ログをプレビュー] をクリックして結果を確認します。

  8. [次へ] をクリックします。

  9. 通知間の最小時間を選択します。この値により、このアラートが複数回トリガーされた場合に受信する通知の数を制御できます。この例では、オプションから [5 minute] を選択します。

  10. （省略可）インシデントの自動クローズ期間を選択します。インシデントの自動クローズ期間は、デフォルトで 7 日間に設定されています。

  11. [Next（次へ）] をクリックします。

  12. アラートの通知チャネルを 1 つ以上選択します。この例では、メール通知チャネルを選択します。

    すでにメール通知チャンネルを構成している場合は、リストからそれを選択できます。そうでない場合は、[通知チャンネルを管理] をクリックしてメールチャンネルを追加します。通知チャンネルの作成方法については、通知チャンネルの管理をご覧ください。

  13. [保存] をクリックします。

これで、ログベースのアラートをテストできるようになりました。 アラートをテストする手順については、ログベースのサンプル アラートのテストをご覧ください。

次のステップ