ボールトに保存されているリソースのログベースのアラートを構成する

このページでは、 Google Cloud コンソールの [ログ エクスプローラ] ページで、Vault に保存されているリソースのログベースのアラートを構成する方法について説明します。

ログ エクスプローラ ページでは、ログベースのアラートの作成と編集を行う手順について説明します。

  • アラートの名前と説明を入力します。
  • 通知を受け取るログを選択します。
  • 通知の間隔を設定します。
  • インシデントの自動クローズまでの時間を設定します。
  • 通知先のユーザーを指定します。

ジョブカテゴリ SCHEDULED_BACKUPON_DEMAND_BACKUPRESTORE のアラートを構成できます。ジョブのステータス(SUCCESSFULFAILEDSKIPPEDRUNNING)のアラートを設定することもできます。

アラートがトリガーされたときに通知を受け取るように、Google Chat、メール、SMS、チャット プログラム チャネルなど、1 つ以上の通知チャネルを構成できます。手順については、通知チャンネルの作成と管理をご覧ください。

始める前に

ログベースのアラートの作成

アラートを通知するには、通知チャンネルが必要です。通知チャンネルは、アラートの作成前または作成中に作成できます。

ログベースのアラートを作成する手順は次のとおりです。

  1. Google Cloud コンソールで、[ログ エクスプローラ] ページに移動します。

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

  2. [クエリ] ペインで、通知を受け取るアラートを定義します。

    次のクエリは、スケジュール設定されたバックアップ ジョブが失敗するたびに通知を受け取る例です。

      logName="projects/PROJECT_ID/logs/backupdr.googleapis.com%2Fbdr_backup_restore_jobs"
      jsonPayload.jobCategory="SCHEDULED_BACKUP"
      jsonPayload.jobStatus="FAILED"
    

    次のように置き換えます。

    • PROJECT_ID: プロジェクトの名前。
  3. [クエリ結果] ペインの上部にある [アラートを作成] をクリックします。

  4. [アラートの詳細] セクションで、次の操作を行います。

    1. [アラート ポリシー名] フィールドにアラートの名前を入力します。この名前は通知ヘッダーに表示されます。
    2. [ドキュメント] フィールドに、アラートの説明を入力します。このフィールドの内容のフォーマットと調整の詳細については、ドキュメント テンプレートでマークダウンと変数を使用するをご覧ください。
  5. [次へ] をクリックします。

  6. [アラートに含めるログを選択] セクションで、次の操作を行います。

    1. [ログをプレビュー] をクリックして、クエリと結果を確認します。必要に応じて、このペインでクエリを編集することもできます。
    2. [ラベルを追加] をクリックして、次の操作を行います。ラベルを使用すると、通知をカスタマイズしてより有益なものにすることができます。

      1. [表示名] フィールドにラベルの名前を入力します。
      2. [ログフィールド名] リストからログフィールド名を選択します。これらのフィールドは、選択したクエリ結果に基づいて表示されます。
      3. [正規表現] フィールドに、正規表現グループが 1 つのみ含まれているフィールドから値を抽出する式を入力します。
  7. [次へ] をクリックします。

  8. [通知頻度と自動クローズ期間の設定] セクションで、次のようにします。

    1. [通知の間隔] リストから、通知間の最小時間を選択します。この値により、このアラートが複数回トリガーされた場合に受信する通知の数を制御できます。
    2. [インシデントの自動クローズ期間] リストから、一致するログエントリがない場合にインシデントが自動的にクローズされるまでの時間を選択します。
  9. [次へ] をクリックします。

  10. [通知チャンネル] リストから、アラートの通知チャンネルを 1 つ以上選択します。通知チャンネルを構成していない場合は、[通知チャンネルを管理] をクリックして作成します。手順については、通知チャンネルの作成と管理をご覧ください。

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

ログベースのアラートをテストする

作成したログベースのアラートをテストするには、クエリに一致するログエントリを手動で記述します。

ログエントリを記述する手順は次のとおりです。

  1. logEntries.write リファレンス ページに移動します。

    logEntries.write に移動

  2. 次のログエントリを、PROJECT_ID 変数はプロジェクト ID に変更して構成します。

          {
            "entries": [
              {
                "jsonPayload": {
                  "jobCategory": "SCHEDULED_BACKUP",
                  "jobStatus": "FAILED"
                }
              }
            ],
            "resource": {
              "type": "backupdr.googleapis.com/BackupDRProject"
            },
            "logName": "projects/PROJECT_ID/logs/backupdr.googleapis.com%2Fbdr_backup_restore_jobs"
          }
    

    次のように置き換えます。

    • PROJECT_ID: プロジェクトの名前。
  3. 構成したログエントリをコピーします。

  4. [この API を試す] ペインで、次の手順を行います。

    1. [リクエスト本文] フィールドの内容を、前の手順でコピーしたログエントリに置き換えます。
    2. [実行] をクリックします。入力を求めるメッセージが表示されたら、認証フローに従います。
  5. logEntries.write の呼び出しが成功すると、HTTP 200 レスポンス コードと空のレスポンスの本文 {} が返されます。API Explorer の詳細については、API Explorer の使用をご覧ください。

    ログエントリは、次の方法でアラートに指定されたフィルタと一致します。

    • logName 値は、クラウド プロジェクトのバックアップ ジョブまたは復元ジョブのログを指定します。
    • jsonPayload には、失敗したジョブのカテゴリ SCHEDULED_BACKUP が含まれています。これは、ログがバックアップ プランによってスケジュールされたバックアップに関連していることを示します。
    • jsonPayload には、ジョブのステータスが FAILED として含まれています。これは、ジョブが失敗したことを示します。
  6. ログエントリを書き込むと、次のシーケンスが発生します。

    1. 新しいログエントリがログ エクスプローラに表示され、アラートがトリガーされます。
    2. インシデントが Cloud Monitoring ページで開きます。
    3. インシデントの通知が届きます。メール通知チャンネルを構成した場合、通知が表示されます。

      メール内の [インシデントを表示] をクリックすると、[Cloud Monitoring] ページでインシデントを確認できます。インシデントの詳細(確認とクローズの方法など)については、ログベースのアラートのインシデントを管理するをご覧ください。