このページは Cloud Translation API によって翻訳されました。

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

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

ログエクスプローラ ページでは、次の手順でログベースのアラートの作成、編集が可能です。

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

バックアップジョブと復元ジョブのカテゴリ（SCHEDULED_BACKUP、ON_DEMAND_BACKUP、RESTORE）のアラートを構成できます。

バックアッププランとバックアッププランの関連付けジョブカテゴリ（UPDATE）のアラートを構成することもできます。

使用可能なジョブステータスは、SUCCESSFUL、FAILED、SKIPPED、RUNNING です。

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

始める前に

ログベースのアラートポリシーの権限を割り当てる。

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

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

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

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

[ログエクスプローラ] に移動
[クエリ] ペインで、通知を受け取るアラートを定義します。
- 次のクエリは、スケジュール設定されたバックアップジョブが失敗するたびに通知を受け取る例です。
```
logName="projects/PROJECT_ID/logs/backupdr.googleapis.com/LOG_NAME"
jsonPayload.jobCategory="SCHEDULED_BACKUP"
jsonPayload.jobStatus="FAILED"
```
  次のように置き換えます。
  - PROJECT_ID: プロジェクトの名前。
  - LOG_NAME: ログの名前。次のいずれかです。
    - bdr_backup_plan_jobs: バックアッププランに関連するジョブ
    - bdr_backup_plan_association_jobs: クロスプロジェクト保護の場合、管理者プロジェクトのバックアッププランの関連付けに関連するジョブ。
    - bdr_backup_plan_association_source_jobs: ワークロードプロジェクトのバックアッププランの関連付けに関連するジョブ。
[クエリ結果] ペインの上部にある、[アラートを作成] をクリックします。
[アラートの詳細] セクションで、次の操作を行います。
1. [アラートポリシー名] フィールドに、アラートの名前を入力します。この名前は通知ヘッダーに表示されます。
2. [ドキュメント] フィールドに、アラートの説明を入力します。このフィールドの内容のフォーマットと調整の詳細については、ドキュメントテンプレートでマークダウンと変数を使用するをご覧ください。
[次へ] をクリックします。
[アラートに含めるログを選択] セクションで、次の操作を行います。
1. [ログをプレビュー] をクリックして、クエリと結果を確認します。必要に応じて、このペインでクエリを編集することもできます。
2. [ラベルを追加] をクリックして、次の操作を行います。ラベルを使用すると、通知をカスタマイズして、より有益な情報を提供できます。
  1. [表示名] フィールドに、ラベルの名前を入力します。
  2. [ログフィールド名] リストから、ログフィールド名を選択します。これらのフィールドは、選択したクエリ結果に基づいて表示されます。
  3. [正規表現] フィールドに、正規表現グループが 1 つのみ含まれているフィールドから値を抽出する式を入力します。
[次へ] をクリックします。
[通知頻度と自動クローズ期間の設定] セクションで、次の操作を行います。
1. [通知の間隔] リストから、通知間の最小時間を選択します。この値により、同じアラートが複数回トリガーされた場合に受信する通知の数を制御できます。
2. [インシデントの自動クローズ期間] リストから、一致するログエントリがない場合にインシデントが自動的にクローズされるまでの期間を選択します。
[次へ] をクリックします。
[通知チャンネル] リストから、アラートの通知チャンネルを 1 つ以上選択します。通知チャンネルが構成されていない場合は、[通知チャンネルを管理] をクリックして作成します。手順については、通知チャンネルを作成して管理するをご覧ください。
[保存] をクリックします。

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

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

次の手順でログエントリを記述します。

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

logEntries.write に移動

次のログエントリを、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: プロジェクトの名前。

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

ログエントリは、次の方法でアラートに指定されたフィルタと一致します。
- logName 値は、クラウドプロジェクトのバックアップまたは復元ジョブのログを指定します。
- jsonPayload には、失敗したジョブカテゴリ SCHEDULED_BACKUP が含まれています。これは、ログがバックアッププランでスケジュールされたバックアップに関連していることを示します。
- jsonPayload には、ジョブが失敗したことを示す FAILED としてのフィールドジョブステータスが含まれています。
ログエントリを書き込むと、次のシーケンスが発生します。
1. 新しいログエントリがログエクスプローラに表示され、アラートがトリガーされます。
2. インシデントが Cloud Monitoring ページで開かれます。
3. インシデントの通知が届きます。メール通知チャネルを構成した場合、通知が表示されます。
  
  メール内の [インシデントを表示] をクリックすると、Cloud Monitoring ページでインシデントを確認できます。インシデントの詳細（インシデントの確認とクローズの方法など）については、ログベースのアラートのインシデントを管理するをご覧ください。

ボールトに保存されているリソースのログベースのアラートを構成する コレクションでコンテンツを整理 必要に応じて、コンテンツの保存と分類を行います。

始める前に

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

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

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