通知チャンネルを作成して管理する

このドキュメントでは、 Google Cloud コンソールを使用して通知チャンネルを構成する方法について説明します。Cloud Monitoring は、アラートポリシーが呼び出されると、これらのチャンネルを使用して通知またはオンコールチームに通知します。アラートポリシーを作成する場合は、構成済みの通知チャンネルのリストから通知先を選択します。たとえば、Compute Engine インスタンスをモニタリングして Pub/Sub トピックをパブリッシュし、オンコールチームに Slack チャンネルを通知するアラートポリシーを構成できます。

詳細については、通知のレイテンシとインシデントあたりの通知をご覧ください。

このドキュメントでは、 Google Cloud コンソールの使用方法について説明します。Cloud Monitoring API を使用する場合は、API による通知チャンネルの作成と管理をご覧ください。

この機能は Google Cloud プロジェクトでのみサポートされています。App Hub 構成の場合は、App Hub ホストプロジェクトまたはアプリ対応フォルダの管理プロジェクトを選択します。

始める前に

Google Cloud コンソールを使用して通知チャンネルを表示および構成するために必要な権限を取得するには、プロジェクトに対する Monitoring 編集者（roles/monitoring.editor）の IAM ロールを付与するよう管理者に依頼してください。ロールの付与については、プロジェクト、フォルダ、組織へのアクセス権の管理をご覧ください。

必要な権限は、カスタムロールや他の事前定義ロールから取得することもできます。

Cloud Monitoring のロールの詳細については、Identity and Access Management を使用してアクセスを制御するをご覧ください。

作成する通知チャンネルを決定する

冗長性を確保するため、次の理由から複数のタイプの通知チャンネルを作成することをおすすめします。

多くの場合、Google Cloud では、通知を渡した後の配信システムを管理していません。
1 つの Google Cloud サービスで Cloud モバイルアプリ、PagerDuty、Webhooks、Slack に対応しています。これらの通知チャンネルのいずれかを使用する場合は、冗長チャンネルとしてメールまたは Pub/Sub を使用してください。
通知を SMS チャンネルにのみ依存することはおすすめしません。

自動化ツールを使用して通知の読み取り、再ルーティング、変換、その他の操作を行う場合は、Webhook または Pub/Sub チャンネルを使用してください。通知形式が変更される可能性があるため、自動化ツールで他のチャンネルタイプを使用することはおすすめしません。

通知チャンネルを作成する

アラートポリシーを作成するときに、構成済みの通知チャンネルを選択してポリシーに追加できます。通知チャンネルを事前に構成することも、アラートポリシーの作成プロセスの中で構成することもできます。詳細については、オンデマンドでチャンネルを作成するをご覧ください。

Google Cloud コンソールを使用して通知チャンネルを作成するには、次の表に示すチャンネル固有の手順に沿って操作してください。

メール

メール通知チャンネルを追加する手順は次のとおりです。

Google Cloud コンソールで、[ アラート] ページに移動します。
[アラート] に移動

このページを検索バーで検索する場合は、小見出しが「Monitoring」の結果を選択します。
Google Cloud コンソールのツールバーで、 Google Cloud プロジェクトを選択します。App Hub 構成の場合は、App Hub ホストプロジェクトまたはアプリ対応フォルダの管理プロジェクトを選択します。
[Edit notification channels] をクリックします。
[メール] セクションで [新しく追加] をクリックします。
1 つのメールアドレスと説明を入力します。
[保存] をクリックします。

アラートポリシーの通知チャンネルとしてグループのメールアドレスを使用する場合は、alerting-noreply@google.com からのメールを受け入れるようにグループを構成します。

アラートポリシーの作成中にメールチャンネルを作成できます。詳しくは、オンデマンドでチャンネルを作成するをご覧ください。

モバイルアプリ

Google Cloud コンソールモバイルアプリを使用すると、 Google Cloud コンソールリソースとモニタリング情報をどこからでもモニタリングできます。 Google Cloud コンソールモバイルアプリの通知は、特定のデバイスまたは特定のユーザーに送信されます。

Google Cloud コンソールモバイルアプリの通知チャンネルのリスト。

デバイスは、通知チャンネルを作成した特定のデバイスにのみ通知を送信することを示します。デバイススコープの通知チャンネルの場合、[表示名] フィールドにはデバイス情報が含まれます。
ユーザーは、 Google Cloud コンソールモバイルアプリがインストールされているすべてのデバイスに通知を送信することを示します。

チャンネルが作成されると、Cloud Monitoring によって通知スコープが決定されます。スコープの選択または変更はできません。

特定の Google Cloud プロジェクトに Google Cloud コンソールモバイルアプリ通知チャンネルを構成する手順は次のとおりです。

モバイルデバイスのアプリストアから Google Cloud コンソールモバイルアプリをインストールします。
Google Cloud コンソールモバイルアプリに表示するプロジェクトを選択します。

プロジェクトを選択すると、選択した Google Cloud プロジェクトとアプリの間でデータ交換が行われます。通知チャンネルが存在しない場合は自動的に作成され、数分後に [通知チャンネル] ページの [モバイルデバイス] セクションに表示されます。

アラートポリシーの通知チャンネルとしてモバイルデバイスを追加するには、アラートの [通知] セクションで [Google Cloud console （モバイル）] を選択し、リストからモバイルデバイスを選択します。

PagerDuty

PagerDuty は、Monitoring との双方向同期をサポートしています。その結果、次のようになります。

Monitoring でインシデントが作成された場合、そのインシデントは PagerDuty で開かれます。
PagerDuty を使用して Monitoring のインシデントをクローズすることはできません。
PagerDuty でインシデントを解決し、Monitoring がインシデントを開いている場合、そのインシデントは PagerDuty で再度開かれます。

PagerDuty の通知を設定するには、次の操作を行います。

PagerDuty アカウントで、新しいサービスで統合を構成するか、既存のサービスに統合を追加します。
1. アカウントを作成するか、既存のアカウントにログインします。
2. [サービス] ページに移動します。
3. サービスの [統合] パネルで新しい統合のリストを見つけ、そのメニューを開いて統合キーをコピーします。
4. 省略可: Monitoring のインシデントの重大度値を正確にマッピングするように PagerDuty を構成します。
Cloud Monitoring で、PagerDuty 通知チャンネルを追加します。
1. Google Cloud コンソールで、[ アラート] ページに移動します。
  [アラート] に移動
  
  このページを検索バーで検索する場合は、小見出しが「Monitoring」の結果を選択します。
2. Google Cloud コンソールのツールバーで、 Google Cloud プロジェクトを選択します。App Hub 構成の場合は、App Hub ホストプロジェクトまたはアプリ対応フォルダの管理プロジェクトを選択します。
3. [Edit notification channels] をクリックします。
4. [PagerDuty] セクションで、[新しく追加] をクリックします。
5. 表示名を入力します。この名前は、手順 1 で新しい統合を構成した PagerDuty サービスの名前と一致する必要があります。
6. 手順 1 でコピーした統合キーを [サービスキー] フィールドに貼り付けます。
7. [保存] をクリックします。

アラートポリシーを作成するときは、[通知] セクションで [PagerDuty] を選択し、PagerDuty の構成を選択します。

PagerDuty の JSON パケットの形式は次のとおりです。

 {
     "description": A string of various fields in the incident,
     "details": JSON payload with schema version 1.2.
 }

details フィールドの例とスキーマを表示するには、次のセクションを開きます。

JSON の例

デフォルトでは、アラートバックエンドはバージョン 1.2 形式の JSON パケットを生成しようとします。この形式の詳細については、次のセクションをご覧ください。

以下に、このようなパケットの例を示します。


{
  "incident": {
    "incident_id": "0.opqiw61fsv7p",
    "scoping_project_id": "internal-project",
    "scoping_project_number": 12345,
    "url": "https://console.cloud.google.com/monitoring/alerting/incidents/0.lxfiw61fsv7p?project=internal-project",
    "severity": "no severity",
    "started_at": 1577840461,
    "ended_at": 1577877071,
    "state": "closed",
    "resource_id": "11223344",
    "resource_name": "internal-project gke-cluster-1-default-pool-e2df4cbd-dgp3",
    "resource_display_name": "gke-cluster-1-default-pool-e2df4cbd-dgp3",
    "resource_type_display_name": "VM Instance",
    "resource": {
      "type": "gce_instance",
      "labels": {
        "instance_id": "11223344",
        "project_id": "internal-project",
        "zone": "us-central1-c"
      }
    },
    "metric": {
      "type": "compute.googleapis.com/instance/cpu/utilization",
      "displayName": "CPU utilization",
      "labels": {
        "instance_name": "the name of the VM instance"
      }
    },
    "metadata": {
      "system_labels": { "labelkey": "labelvalue" },
      "user_labels": { "labelkey": "labelvalue" }
    },
    "policy_name": "Monitor-Project-Cluster",
    "policy_user_labels" : {
        "user-label-1" : "important label",
        "user-label-2" : "another label"
    },
    "condition_name": "VM Instance - CPU utilization [MAX]",
    "threshold_value": "0.9",
    "observed_value": "0.835",
    "condition": {
      "name": "projects/internal-project/alertPolicies/1234567890123456789/conditions/1234567890123456789",
      "displayName": "VM Instance - CPU utilization [MAX]",
      "conditionThreshold": {
        "filter": "metric.type=\"compute.googleapis.com/instance/cpu/utilization\" resource.type=\"gce_instance\" metadata.system_labels.\"state\"=\"ACTIVE\"",
        "aggregations": [
          {
            "alignmentPeriod": "120s",
            "perSeriesAligner": "ALIGN_MEAN"
          }
        ],
        "comparison": "COMPARISON_GT",
        "thresholdValue": 0.9,
        "duration": "0s",
        "trigger": {
          "count": 1
        }
      }
    },
    "documentation": {
      "content": "TEST ALERT\n\npolicy.name=projects/internal-project/alertPolicies/1234567890123456789\n\npolicy.display_name=Monitored-Project-NO-GROUPBY\n\ncondition.name=projects/nternal-project/alertPolicies/1234567890123456789/conditions/1234567890123456789\n\ncondition.display_name=VM Instance - CPU utilization [MAX]\n\nproject=internal-project\n\nresrouce.project=internal-project \n\nDONE\n",
      "mime_type": "text/markdown",
      "subject": "ALERT - No severity",
      "links": [
        {
          "displayName": "Playbook",
          "url": "https://myownpersonaldomain.com/playbook?name=${resource.name}"
        }
      ]
    },
    "summary": "CPU utilization for internal-project gke-cluster-1-16-default-pool-e2df4cbd-dgp3 with metric labels {instance_name=gke-cluster-1-default-pool-e2df4cbd-dgp3} and system labels {state=ACTIVE} returned to normal with a value of 0.835."
  },
  "version": "1.2"
}

スキーマの構造、バージョン 1.2

このセクションでは、ペイロードスキーマのバージョン 1.2 について説明します。アラートポリシーの構成、インシデントの状態、モニタリング対象リソースによっては、返されたパケットでフィールドが不足していたり、フィールドの値が空になっている場合があります。一部のフィールドでは、値として埋め込み構造が使用されます。値の内容が状況に応じて変わるので、埋め込み構造が参照を通じて記述されます。

返されたパケットでは、フィールドの順序は任意です。以下の説明では、関連するグループに整理されます。

{
  "version": "1.2",
  "incident": {

    インシデントに関する情報。

    "incident_id": 文字列。このインシデント用に生成された ID。
    "scoping_project_id": 文字列。指標スコープをホストするプロジェクト ID。
    "scoping_project_number": 数字。スコーピングプロジェクトのプロジェクト番号。
    "url": 文字列。このインシデントのコンソールの URL。 Google Cloud
    "started_at": 数字。インシデントが開かれた時刻（Unix エポック秒数）。
    "ended_at": 数字。インシデントがクローズされた時刻（Unix エポック秒数）。state が closed の場合にのみ入力されます。
    "state": 文字列。インシデントの状態が open または closed。open の場合、ended_at は null です。
    "summary": 文字列。インシデント用に生成された概要テキスト。
    "apigee_url": 文字列。このインシデントの Apigee URL（Apigee リソースタイプ Environment と Proxy* のみ）。
    "observed_value": 文字列。アラートをトリガー / 解決した観測値（条件が期限切れの場合は空欄の可能性あり）。

    インシデントが開かれたモニタリング対象リソースに関する情報。

    "resource": {
      "type": 文字列。アラート対象であるモニタリング対象リソースタイプの識別子。例: gce_instance。モニタリング対象リソースのリストをご覧ください。
      "labels": オブジェクト。モニタリング対象リソースに関連付けられたラベルの Key-Value ペア。
    },
    "resource_type_display_name": 文字列。モニタリング対象リソースタイプの表示名。
    "resource_id": 文字列。モニタリング対象リソースのインスタンス ID。resource.labels.instance_id と同じ値。
    "resource_display_name": 文字列。モニタリング対象リソースの表示名。
    "resource_name": 文字列。このモニタリング対象リソース用に生成された名前。他のフィールドの値が含まれます。

    時系列データの指標タイプに関する情報。

    "metric": {
      "type": 文字列。アラート対象の指標タイプの識別子。例: compute.googleapis.com/instance/cpu/utilization。指標の一覧をご覧ください。
      "displayName": 文字列。指標タイプの表示名。
      "labels": オブジェクト。指標に関連付けられたラベルの Key-Value ペア。
    },
    "metadata": {
      "system_labels": オブジェクト。システムメタデータラベルの Key-Value ペア。
      "user_labels": オブジェクト。ユーザーメタデータラベルの Key-Value ペア。
    },

    インシデントを開いた / 解決したアラートポリシーと条件に関する情報。
    値は、関連する AlertPolicy オブジェクトから取得されます。

    "policy_name": 文字列。アラートポリシーの表示名。
    "policy_user_labels": オブジェクト。ポリシーに適用された任意のユーザーラベルの Key-Value ペア。
    "documentation": オブジェクト。Documentation 形式の埋め込み構造。
    "condition": オブジェクト。Condition 形式の埋め込み構造。
    "condition_name": 文字列。条件の表示名。condition.displayName と同じ値。
    "severity": 文字列。インシデントの重大度レベル。アラートポリシーの作成中にこのフィールドが定義されていない場合、Cloud Monitoring はアラートポリシーの重大度を no severity に設定します。
    "threshold_value": 文字列。この条件のしきい値（条件にしきい値が該当しない場合は空欄の可能性あり）。
  },
}

非推奨ポリシー

ペイロードスキーマには、Google Cloud Platform 利用規約のセクション 1.4（d）に記載されている Google Cloud 非推奨ポリシーが適用されます。なお、生成されたフィールド値の形式は、スキーマによって管理されず、予告なく変更される場合があります。たとえば、incident.summary、incident.documentation.content、incident.url は、フィールドに関連するデータを含むように作られていますが、スキーマがこうしたフィールドを正確に解析することを保証する制約はありません。値全体はまとめて使用でき、非推奨ポリシーを遵守していることを期待できますが、生成されたフィールドの解析に頼りすぎないようにしてください。

重大度レベルをマッピングするように PagerDuty を構成する

デフォルトでは、PagerDuty の通知ではすべてのインシデントの重大度レベルが「重大」と示されます。PagerDuty のアラート重大度が Monitoring のインシデントの重大度と一致するように、PagerDuty でイベントオーケストレーションルールを構成できます。

PagerDuty アカウントで、[サービス] ページに移動します。
Google Cloud通知を受け取る PagerDuty サービスを選択します。
[設定] をクリックします。
[Event Management] セクションに移動し、[View Orchestration Rules] をクリックします。
[+ 新しいルール] をクリックします。
変換する Monitoring の重大度値ごとに、重大度値を同等の PagerDuty 値にマッピングする条件ルールを作成します。
1. メニューの [Step 1: When should this rule be applied?] で、[If events match certain conditions] を選択します。
2. コードエディタを選択します。
3. [If] セクションに「event.custom_details.incident.severity matches part 'VALUE'」と入力します。ここで、VALUE は Monitoring の重大度値の名前です。[次へ] をクリックします。
4. [Step 2: What action(s) should be applied] で [Alert Data] を選択します。
5. アラートの重大度を、ステップ C で入力した Monitoring の値と一致する値に設定し、変更を保存します。
省略可: ルールを追加するには、[Else rule] をクリックします。

SMS

SMS 通知を構成するには、次の操作を行います。

Google Cloud コンソールで、[ アラート] ページに移動します。
[アラート] に移動

このページを検索バーで検索する場合は、小見出しが「Monitoring」の結果を選択します。
Google Cloud コンソールのツールバーで、 Google Cloud プロジェクトを選択します。App Hub 構成の場合は、App Hub ホストプロジェクトまたはアプリ対応フォルダの管理プロジェクトを選択します。
[Edit notification channels] をクリックします。
[SMS] セクションで、[新しく追加] をクリックします。
ダイアログの項目を入力して、[保存] をクリックします。

アラートポリシーを設定したら、通知タイプに [SMS] を選択し、リストから確認済みの電話番号を選択します。

Slack

Monitoring と Slack を統合すると、新しいインシデントが発生したときに、アラートポリシーで Slack チャンネルに投稿できるようになります。Slack 通知を設定する方法は次のとおりです。

Slack: Slack サイトで Slack ワークスペースとチャンネルを作成します。チャンネルの URL をメモしておきます。
Google Cloud コンソールで、[ アラート] ページに移動します。
[アラート] に移動

このページを検索バーで検索する場合は、小見出しが「Monitoring」の結果を選択します。
Google Cloud コンソールのツールバーで、 Google Cloud プロジェクトを選択します。App Hub 構成の場合は、App Hub ホストプロジェクトまたはアプリ対応フォルダの管理プロジェクトを選択します。
[Edit notification channels] をクリックします。
[Slack] セクションで、[新しく追加] をクリックして Slack のログインページを開きます。
1. Slack ワークスペースを選択します。
2. [許可] をクリックして Cloud Monitoring の Slack ワークスペースへのアクセスを有効にします。この操作を行うと、通知チャンネルの Monitoring 構成ページに戻ります。
3. [Slack Channel Name] フィールドに、通知に使用する Slack チャンネルの名前を入力します。
4. [Cloud Alerting Display Name] フィールドに、短い説明文を入力します。このフィールドの値は、[通知チャンネル] ページに表示されます。
5. （省略可）Cloud Monitoring と Slack ワークスペースの間の接続をテストするには、[テスト通知を送信] をクリックします。接続に成功すると、指定した Slack 通知チャンネルにメッセージ This is a test alert notification... が表示されます。通知チャンネルで通知の受信を確認してください。
通知に使用する Slack チャンネルがプライベートチャンネルの場合は、Monitoring アプリをそのチャンネルに手動で招待する必要があります。
1. Slack を開きます。
2. Monitoring の通知として指定したチャンネルに移動します。
3. チャンネルで次のメッセージを入力して送信することで、Monitoring アプリをチャンネルに招待します。
```
/invite @Google Cloud Monitoring
```
  Monitoring で通知チャンネルの作成時に指定したチャンネルに、Monitoring アプリを招待するようにしてください。パブリックチャンネルへの Monitoring アプリの招待は任意です。
アラートポリシーを作成するときは、[通知] セクションの [Slack] を選択し、Slack の構成を選択します。

Webhook

Webhook 通知チャンネルを構成する前に、次の点を考慮してください。

Webhook は公開エンドポイントのみをサポートします。パブリックエンドポイントは、HTTP（port:80）や HTTPS（port:443）など、公共のインターネットから完全にアクセスできます。通知サービスには、エンドポイントとの接続を確立できる機能が必要です。HTTPS の場合は、サーバーのセキュリティ証明書を検証できる必要があります。プライベートエンドポイントに通知を送信する必要がある場合は、Pub/Sub 通知チャンネルを作成し、Pub/Sub トピックへのサブスクリプションを構成します。詳細については、プライベートエンドポイント用に構成した場合に Webhook 通知が失敗するをご覧ください。
Cloud Run Functions の関数が通知チャンネルの Webhook エンドポイントとして構成されている場合は、関数を呼び出すユーザーに必要な認証権限があることを確認してください。詳細については、呼び出しを認証すると関数へのアクセスを有効にするをご覧ください。
Webhook 通知チャンネルは Microsoft Teams に対応していません。Monitoring から Microsoft Teams に通知データを送信するには、統合レイヤを作成して Monitoring Webhook を受信し、Microsoft Teams に転送します。

Webhook 通知チャンネルを構成する

Webhooks 通知を構成するには、次の操作を行います。

Webhook ハンドラ: Monitoring から Webhook データを受信するパブリックエンドポイント URL を指定します。
Google Cloud コンソールで、[ アラート] ページに移動します。
[アラート] に移動

このページを検索バーで検索する場合は、小見出しが「Monitoring」の結果を選択します。
Google Cloud コンソールのツールバーで、 Google Cloud プロジェクトを選択します。App Hub 構成の場合は、App Hub ホストプロジェクトまたはアプリ対応フォルダの管理プロジェクトを選択します。
[Edit notification channels] をクリックします。
[Webhook] セクションで [新しく追加] をクリックします。
ダイアログの項目をすべて入力します。
[接続をテスト] をクリックして、テストペイロードを Webhook エンドポイントに送信します。受信側エンドポイントに移動して配信を確認します。
[保存] をクリックします。

アラートポリシーを作成する場合は、[通知] セクションで [Webhook] を選択し、webhook 構成を選択します。Error Reporting によって送信される通知は 1.0 スキーマに準拠しますが、Monitoring によって送信される通知は 1.2 スキーマに準拠します。

JSON の例

以下に、このようなパケットの例を示します。


{
  "incident": {
    "incident_id": "0.opqiw61fsv7p",
    "scoping_project_id": "internal-project",
    "scoping_project_number": 12345,
    "url": "https://console.cloud.google.com/monitoring/alerting/incidents/0.lxfiw61fsv7p?project=internal-project",
    "severity": "no severity",
    "started_at": 1577840461,
    "ended_at": 1577877071,
    "state": "closed",
    "resource_id": "11223344",
    "resource_name": "internal-project gke-cluster-1-default-pool-e2df4cbd-dgp3",
    "resource_display_name": "gke-cluster-1-default-pool-e2df4cbd-dgp3",
    "resource_type_display_name": "VM Instance",
    "resource": {
      "type": "gce_instance",
      "labels": {
        "instance_id": "11223344",
        "project_id": "internal-project",
        "zone": "us-central1-c"
      }
    },
    "metric": {
      "type": "compute.googleapis.com/instance/cpu/utilization",
      "displayName": "CPU utilization",
      "labels": {
        "instance_name": "the name of the VM instance"
      }
    },
    "metadata": {
      "system_labels": { "labelkey": "labelvalue" },
      "user_labels": { "labelkey": "labelvalue" }
    },
    "policy_name": "Monitor-Project-Cluster",
    "policy_user_labels" : {
        "user-label-1" : "important label",
        "user-label-2" : "another label"
    },
    "condition_name": "VM Instance - CPU utilization [MAX]",
    "threshold_value": "0.9",
    "observed_value": "0.835",
    "condition": {
      "name": "projects/internal-project/alertPolicies/1234567890123456789/conditions/1234567890123456789",
      "displayName": "VM Instance - CPU utilization [MAX]",
      "conditionThreshold": {
        "filter": "metric.type=\"compute.googleapis.com/instance/cpu/utilization\" resource.type=\"gce_instance\" metadata.system_labels.\"state\"=\"ACTIVE\"",
        "aggregations": [
          {
            "alignmentPeriod": "120s",
            "perSeriesAligner": "ALIGN_MEAN"
          }
        ],
        "comparison": "COMPARISON_GT",
        "thresholdValue": 0.9,
        "duration": "0s",
        "trigger": {
          "count": 1
        }
      }
    },
    "documentation": {
      "content": "TEST ALERT\n\npolicy.name=projects/internal-project/alertPolicies/1234567890123456789\n\npolicy.display_name=Monitored-Project-NO-GROUPBY\n\ncondition.name=projects/nternal-project/alertPolicies/1234567890123456789/conditions/1234567890123456789\n\ncondition.display_name=VM Instance - CPU utilization [MAX]\n\nproject=internal-project\n\nresrouce.project=internal-project \n\nDONE\n",
      "mime_type": "text/markdown",
      "subject": "ALERT - No severity",
      "links": [
        {
          "displayName": "Playbook",
          "url": "https://myownpersonaldomain.com/playbook?name=${resource.name}"
        }
      ]
    },
    "summary": "CPU utilization for internal-project gke-cluster-1-16-default-pool-e2df4cbd-dgp3 with metric labels {instance_name=gke-cluster-1-default-pool-e2df4cbd-dgp3} and system labels {state=ACTIVE} returned to normal with a value of 0.835."
  },
  "version": "1.2"
}

スキーマの構造、バージョン 1.2

返されたパケットでは、フィールドの順序は任意です。以下の説明では、関連するグループに整理されます。

基本認証

Cloud Monitoring から送信された Webhook リクエストに加えて、基本的な認証では、ユーザー名とパスワードに HTTP 仕様が使用されます。Cloud Monitoring では、サーバーが適切な WWW-Authenticate ヘッダーで 401 レスポンスを返す必要があります。基本認証の詳細については、次を参照してください。

トークン認証

トークン認証では、エンドポイント URL のクエリ文字列パラメータと、サーバーがそれ自体と Monitoring の間で秘密であると期待するキーが必要です。トークンを含む URL の例を次に示します。

https://www.myserver.com/stackdriver-hook?auth_token=1234-abcd

Monitoring がインシデントをエンドポイント URL に送信した場合、サーバーは添付されたトークンを検証できます。この認証方法は、SSL / TLS を使用して HTTP リクエストを暗号化し、トークンが傍受されないようにする場合に最も効果的です。

Python でのサーバー例については、このサンプルサーバーをご覧ください。

非推奨ポリシー

Pub/Sub

このセクションでは、Pub/Sub 通知チャンネルを構成する方法について説明します。冗長性を確保するために、複数の通知チャンネルを作成することをおすすめします。Pub/Sub は別の配信メカニズムを使用するため、 Google Cloud コンソールのモバイルアプリ、PagerDuty、Webhooks、Slack とペアリングすることをおすすめします。

Pub/Sub 通知チャンネルを構成するには:

必要な API を有効にしてトピックを作成する
トピックの通知チャンネルを構成する
サービスアカウントを認可する
アラートポリシーで通知チャンネルを設定する

データスキーマについて詳しくは、スキーマの例をご覧ください。

アラート通知を受信するには、pull、push、BigQuery のいずれかのサブスクリプションも作成する必要があります。

サブスクリプションがトピックとは異なるプロジェクトにある場合は、サブスクライバープロジェクトでサービスアカウントを作成し、roles/pubsub.subscriber のロールを付与します。

始める前に

Google Cloud プロジェクトに最初の Pub/Sub 通知チャンネルを追加すると、Cloud Monitoring はそのプロジェクトにサービスアカウントを作成します。また、サービスアカウントに Identity and Access Management ロールのモニタリング通知サービスエージェントが付与されます。このサービスアカウントを使用すると、Monitoring がこのプロジェクトの Pub/Sub ベースの通知チャンネルに通知を送信できます。

サービスアカウントの形式は次のとおりです。

service-PROJECT_NUMBER@gcp-sa-monitoring-notification.iam.gserviceaccount.com

通知サービスアカウントの名前には、一意の Google Cloud プロジェクト番号が含まれます。プロジェクトの名前、ID、番号は、 Google Cloud コンソールのプロジェクトのダッシュボードで確認できます。また、次のコマンドでも取得できます。

gcloud projects describe PROJECT_ID --format="value(project_number)"

サービスアカウントを表示して編集するには、 Google Cloud コンソールまたは Google Cloud CLI を使用します。

必要な API を有効にしてトピックを作成する

通知チャンネルと Pub/Sub トピックを作成する予定の Google Cloud プロジェクトで、次の操作を行います。

Sign in to your Google Cloud account. If you're new to Google Cloud, create an account to evaluate how our products perform in real-world scenarios. New customers also get $300 in free credits to run, test, and deploy workloads.

In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

Go to project selector

Make sure that billing is enabled for your Google Cloud project.

Enable the Pub/Sub and Cloud Monitoring APIs.

Enable the APIs

In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

Go to project selector

Make sure that billing is enabled for your Google Cloud project.

Enable the Pub/Sub and Cloud Monitoring APIs.

Enable the APIs

Pub/Sub トピックを作成します。トピックの作成方法については、トピックを作成するをご覧ください。たとえば、Google Cloud CLI を使用して notificationTopic というトピックを作成するには、次のコマンドを実行します。
```
gcloud pubsub topics create notificationTopic
```

次に、Pub/Sub 通知チャンネルを構成します。

トピックの通知を構成する

Pub/Sub 通知チャンネルを作成するには、Monitoring API、Google Cloud CLI または Google Cloud コンソールを使用します。通知チャンネルを作成したら、通知チャンネルとして使用する各トピックを公開するように通知サービスアカウントを認可します。

Monitoring API または Google Cloud CLI を使用した通知チャネルの作成については、チャンネルの作成をご覧ください。

Google Cloud コンソールで通知チャンネルを作成する手順は次のとおりです。

Google Cloud コンソールで、[ アラート] ページに移動します。
[アラート] に移動

このページを検索バーで検索する場合は、小見出しが「Monitoring」の結果を選択します。
Google Cloud コンソールのツールバーで、 Google Cloud プロジェクトを選択します。App Hub 構成の場合は、App Hub ホストプロジェクトまたはアプリ対応フォルダの管理プロジェクトを選択します。
作成した Pub/Sub トピックを含む Google Cloud プロジェクトを選択します。
[Edit notification channels] をクリックします。
[Pub/Sub] セクションで、[新しく追加] をクリックします。

[Created Pub/Sub Channel] ダイアログに、Monitoring によって作成されたサービスアカウントの名前が表示されます。
サービスアカウントを認可します。サービスアカウントは、すべてのトピックまたは特定のトピックを公開できます。
- すべてのトピックを公開するには、[ロールを管理] を選択して、Pub/Sub パブリッシャーのロールを追加します。
  
  通知チャンネルの構成手順が完了したら、次のサービスアカウントを認可するをスキップして、アラートポリシーで通知チャンネルを設定するに進みます。
- 特定のトピックをパブリッシュするには、通知チャンネルの構成が完了した後、次のステップに進んで、特定のトピックをパブリッシュするサービスアカウントを認可します。サービスアカウントを認可する手順については、サービスアカウントを認可するをご覧ください。
チャンネルの表示名と Pub/Sub トピック名を入力します。
（省略可）チャンネルが正しく構成されていることを確認するには、[テスト通知を送信] をクリックします。
[チャンネルを追加] を選択します。

次に、サービスアカウントを認可します。

サービスアカウントを認可する

認可を使用すると、通知チャンネルとして使用する各 Pub/Sub トピックをパブリッシュするように通知サービスアカウントを設定できます。このセクションでは、次の方法について説明します。

特定のトピックのサービスアカウントを認可する。
すべてのトピックのサービスアカウントを認可する。

特定のトピックのサービスアカウントを認可する

Google Cloud コンソールと Google Cloud CLI を使用すると、サービスアカウントに特定のトピックの公開を許可できます。このセクションでは、両方の方法について説明します。

Google Cloud コンソールで特定のトピックのサービスアカウントを認可する手順は次のとおりです。

Google Cloud コンソールで [トピック] ページに移動します。
[トピック] に移動

このページを検索バーで検索する場合は、小見出しが「Pub/Sub」の結果を選択します。
Google Cloud コンソールのツールバーで、 Google Cloud プロジェクトを選択します。App Hub 構成の場合は、App Hub ホストプロジェクトまたはアプリ対応フォルダの管理プロジェクトを選択します。
トピックを選択します。
[権限] タブで、[プリンシパルを追加] を選択します。
[新しいプリンシパル] フィールドに、通知サービスアカウントの名前を入力します。サービスアカウントの命名規則は次のとおりです。
```
service-PROJECT_NUMBER@gcp-sa-monitoring-notification.iam.gserviceaccount.com
```
Pub/Sub パブリッシャー ロールを選択して、[保存] を選択します。

Google Cloud CLI を使用して、特定のトピックのサービスアカウントを認可するには、トピックの pubsub.publisher IAM ロールをサービスアカウントに付与します。たとえば、次のコマンドは、notificationTopic トピックの IAM ロールを構成します。

gcloud pubsub topics add-iam-policy-binding \
projects/PROJECT_NUMBER/topics/notificationTopic --role=roles/pubsub.publisher \
--member=serviceAccount:service-PROJECT_NUMBER@gcp-sa-monitoring-notification.iam.gserviceaccount.com

add-iam-policy-binding コマンドが正常に実行されると、レスポンスは次のようになります。

 Updated IAM policy for topic [notificationTopic].
 bindings:
 ‐ members:
    ‐ serviceAccount:service-PROJECT_NUMBER@gcp-sa-monitoring-notification.iam.gserviceaccount.com
    role: roles/pubsub.publisher
 etag: BwWcDOIw1Pc=
 version: 1

詳細については、pubsub topics add-iam-policy-binding リファレンスページをご覧ください。

すべてのトピックでサービスアカウントを認可する

すべてのトピックでサービスアカウントを認可する方法は次のとおりです。

Google Cloud コンソールで [IAM] ページに移動します。
[IAM] に移動

このページを検索バーで検索する場合は、小見出しが「IAM と管理」の結果を選択します。
Google Cloud コンソールのツールバーで、 Google Cloud プロジェクトを選択します。App Hub 構成の場合は、App Hub ホストプロジェクトまたはアプリ対応フォルダの管理プロジェクトを選択します。
次のスクリーンショットに示すように、[Google 提供のロール付与を含む] を選択します。
次の形式のサービスアカウントを検索します。
```
service-PROJECT_NUMBER@gcp-sa-monitoring-notification.iam.gserviceaccount.com
```
サービスアカウントが一覧にない場合は、ページを再読み込みします。
通知サービスアカウントの（編集）を選択し、[別のロールを追加] を選択してから、Pub/Sub パブリッシャー ロールを追加します。

次に、アラートポリシーで通知チャンネルを設定します。

アラートポリシーで通知チャンネルを設定する

アラートポリシーで Pub/Sub 通知チャンネルを使用するには、チャンネルタイプとして [Pub/Sub] を選択し、トピックを選択します。

スキーマの例

JSON パケットとスキーマの例を表示するには、以下のセクションを開いてください。

JSON の例

以下に、このようなパケットの例を示します。


{
  "incident": {
    "incident_id": "0.opqiw61fsv7p",
    "scoping_project_id": "internal-project",
    "scoping_project_number": 12345,
    "url": "https://console.cloud.google.com/monitoring/alerting/incidents/0.lxfiw61fsv7p?project=internal-project",
    "severity": "no severity",
    "started_at": 1577840461,
    "ended_at": 1577877071,
    "state": "closed",
    "resource_id": "11223344",
    "resource_name": "internal-project gke-cluster-1-default-pool-e2df4cbd-dgp3",
    "resource_display_name": "gke-cluster-1-default-pool-e2df4cbd-dgp3",
    "resource_type_display_name": "VM Instance",
    "resource": {
      "type": "gce_instance",
      "labels": {
        "instance_id": "11223344",
        "project_id": "internal-project",
        "zone": "us-central1-c"
      }
    },
    "metric": {
      "type": "compute.googleapis.com/instance/cpu/utilization",
      "displayName": "CPU utilization",
      "labels": {
        "instance_name": "the name of the VM instance"
      }
    },
    "metadata": {
      "system_labels": { "labelkey": "labelvalue" },
      "user_labels": { "labelkey": "labelvalue" }
    },
    "policy_name": "Monitor-Project-Cluster",
    "policy_user_labels" : {
        "user-label-1" : "important label",
        "user-label-2" : "another label"
    },
    "condition_name": "VM Instance - CPU utilization [MAX]",
    "threshold_value": "0.9",
    "observed_value": "0.835",
    "condition": {
      "name": "projects/internal-project/alertPolicies/1234567890123456789/conditions/1234567890123456789",
      "displayName": "VM Instance - CPU utilization [MAX]",
      "conditionThreshold": {
        "filter": "metric.type=\"compute.googleapis.com/instance/cpu/utilization\" resource.type=\"gce_instance\" metadata.system_labels.\"state\"=\"ACTIVE\"",
        "aggregations": [
          {
            "alignmentPeriod": "120s",
            "perSeriesAligner": "ALIGN_MEAN"
          }
        ],
        "comparison": "COMPARISON_GT",
        "thresholdValue": 0.9,
        "duration": "0s",
        "trigger": {
          "count": 1
        }
      }
    },
    "documentation": {
      "content": "TEST ALERT\n\npolicy.name=projects/internal-project/alertPolicies/1234567890123456789\n\npolicy.display_name=Monitored-Project-NO-GROUPBY\n\ncondition.name=projects/nternal-project/alertPolicies/1234567890123456789/conditions/1234567890123456789\n\ncondition.display_name=VM Instance - CPU utilization [MAX]\n\nproject=internal-project\n\nresrouce.project=internal-project \n\nDONE\n",
      "mime_type": "text/markdown",
      "subject": "ALERT - No severity",
      "links": [
        {
          "displayName": "Playbook",
          "url": "https://myownpersonaldomain.com/playbook?name=${resource.name}"
        }
      ]
    },
    "summary": "CPU utilization for internal-project gke-cluster-1-16-default-pool-e2df4cbd-dgp3 with metric labels {instance_name=gke-cluster-1-default-pool-e2df4cbd-dgp3} and system labels {state=ACTIVE} returned to normal with a value of 0.835."
  },
  "version": "1.2"
}

スキーマの構造、バージョン 1.2

返されたパケットでは、フィールドの順序は任意です。以下の説明では、関連するグループに整理されます。

非推奨ポリシー

Google Cloud Platform 利用規約

incident.summary

incident.documentation.content

incident.url

Google Chat

Google Cloud Monitoring アプリによって、Google Chat スペースで通知を受け取ることができます。

始める前に

組織に所属していて、Google Cloud Monitoring アプリをインストールする場合は、Google Cloud Monitoring アプリにアクセスできる必要があります。アクセス権がない場合は、Google Workspace 管理者に次のことを依頼してください。

Google Cloud Monitoring アプリをインストールする

Google Cloud Monitoring アプリをインストールするには、次の操作を行ってください。Google Workspace Marketplace リスティングからのインストールはサポートされていません。

アプリをインストールし、通知チャンネルとしてスペースを構成するには、次のようにします。

Google Chat で、通知を受け取るスペースを開くか、作成します。
Google Cloud Monitoring アプリをインストールします。
1. スペース名を選択し、[Apps and Integrations] を選択します。
2. Google Cloud Monitoring アプリがアプリリストに表示されない場合は、スペースに戻って「@Google Cloud Monitoring」と入力し、Enter キーを押します。
3. [Add to space] をクリックします。
Chat スペース ID をクリップボードにコピーします。

Google Cloud Monitoring アプリをインストールした場合は、インストールの確認に Chat スペース ID が含まれています。それ以外の場合は、Chat スペース URL の末尾にある space/ の後に、一連の数字と文字として Chat スペース ID が含まれています。
新しいブラウザタブを開き、通知チャンネルを構成します。
1. Google Cloud コンソールで、[ アラート] ページに移動します。
  [アラート] に移動
  
  このページを検索バーで検索する場合は、小見出しが「Monitoring」の結果を選択します。
2. Google Cloud コンソールのツールバーで、 Google Cloud プロジェクトを選択します。App Hub 構成の場合は、App Hub ホストプロジェクトまたはアプリ対応フォルダの管理プロジェクトを選択します。
3. [Edit notification channels] をクリックします。
4. [Google Chat] セクションに移動して、[新しく追加] をクリックします。
5. [Chat Space ID] フィールドに Chat スペース ID を入力し、[保存] をクリックします。

オンデマンドでチャンネルを作成する

アラートポリシーに通知チャンネルを追加する際は、リストからチャンネルを選択する必要があります。アラートポリシーの作成中にオプションのリストを更新するには、次のプロセスを使用します。

通知ダイアログで、[通知チャンネルを管理] をクリックします。新しいブラウザタブの [通知チャンネル] ウィンドウに移動します。
新しい通知チャンネルを追加するには、チャンネルの種類を見つけて [新しく追加] をクリックし、以前の表に含まれるチャンネル固有の手順に沿って操作します。
元のタブに戻り、通知ダイアログで [ 更新] をクリックします。
更新されたリストから通知チャンネルを選択します。

サポートされていないチャンネルに関する通知を受け取る

目的の通知チャンネルがサポートされていない場合は、Pub/Sub への通知の送信に依存するパイプラインの作成を検討してください。Flask を使用する Python の例については、Cloud Monitoring と Cloud Run を使用したカスタム通知の作成をご覧ください。他の例については、cloud-alerting-notification-forwarding Git リポジトリをご覧ください。

通知チャンネルをテストする

Cloud Monitoring は通知チャンネルのテストオプションをサポートしていません。ただし、アラートポリシーを作成し、満たす条件を構成することで、通知チャンネルが正しく構成されていることを確認できます。

通知チャンネルを手動でテストするには、いずれかの仮想マシン（VM）インスタンスの CPU 使用率をモニタリングするアラートポリシーを作成します。

省略可: Google Cloud プロジェクトに VM がない場合や、テストに別の VM を使用する場合は、VM を作成します。
1. Google Cloud コンソールで [VM インスタンス] ページに移動します。
  [VM インスタンス] に移動
  
  このページを検索バーで検索する場合は、小見出しが「Compute Engine」の結果を選択します。
2. Google Cloud コンソールのツールバーで、 Google Cloud プロジェクトを選択します。App Hub 構成の場合は、App Hub ホストプロジェクトまたはアプリ対応フォルダの管理プロジェクトを選択します。
3. [インスタンスを作成] を選択し、VM を構成します。VM の作成の詳細については、公開イメージから VM インスタンスを作成するをご覧ください。
Google Cloud コンソールで、[ アラート] ページに移動します。
[アラート] に移動

このページを検索バーで検索する場合は、小見出しが「Monitoring」の結果を選択します。
Google Cloud コンソールのツールバーで、 Google Cloud プロジェクトを選択します。App Hub 構成の場合は、App Hub ホストプロジェクトまたはアプリ対応フォルダの管理プロジェクトを選択します。
[ポリシーを作成] を選択します。
[指標を選択] メニューを使用して、VM インスタンスの [CPU 使用率] 指標を選択します。
[フィルタを追加] をクリックし、VM 用のフィルタを追加します。
[トリガーの設定] フィールドを次のように更新します。
1. [しきい値の位置] フィールドで [しきい値より下] を選択します。
2. インスタンスの CPU 使用率より大きい値を選択します。たとえば、グラフに CPU 使用率が約 5% と表示されている場合は、しきい値を 10% に設定します。
  
  これらの設定は、VM インスタンスの CPU 使用率が指定したしきい値を下回った場合に満たす条件を構成します。しきい値を VM インスタンスの CPU 使用率よりも大きく選択したため、アラートポリシーの条件が満たされています。
ポリシーに通知チャンネルを追加します。
[インシデントの自動クローズ期間] を開き、[30 分] を選択します。
ポリシー名を入力し、[ポリシーを作成] をクリックします。
条件が満たされたら、各通知チャンネルで通知を受け取ったことを確認します。
アラートポリシーを削除します。自動クローズ期間が終了すると、インシデントは自動的にクローズされます。
このテスト用に VM インスタンスを作成した場合は、それを削除します。

想定した通知が届かない場合は、ログエクスプローラで、欠落している通知に関する情報を含むログエントリを検索できます。詳しくは、通知が受信されないをご覧ください。

通知チャンネルの編集と削除

Google Cloud コンソールを使用して通知チャンネルを編集または削除するには、次の操作を行います。

Google Cloud コンソールで、[ アラート] ページに移動します。
[アラート] に移動

このページを検索バーで検索する場合は、小見出しが「Monitoring」の結果を選択します。
[Edit notification channels] をクリックします。

[通知チャンネル] ダッシュボードには、通知チャネルの種類ごとにセクションがあります。各セクションには、その種類のすべての構成が一覧表示されます。
- エントリを変更するには、[ 編集] をクリックします。変更が完了したら、[保存] をクリックします。
- エントリを削除するには、[ 削除] をクリックします。確認ダイアログで、[削除] をクリックします。

通知チャンネルのログを表示する

ログエクスプローラを使用して、通知チャンネルのエラーを表示できます。

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

このページを検索バーで検索する場合は、小見出しが「Logging」の結果を選択します。
Google Cloud コンソールのツールバーで、 Google Cloud プロジェクトを選択します。App Hub 構成の場合は、App Hub ホストプロジェクトまたはアプリ対応フォルダの管理プロジェクトを選択します。
クエリを入力して実行します。通知チャンネルエラーに固有のクエリについては、Cloud Monitoring のクエリをご覧ください。

次のステップ

インシデントの詳細については、次のドキュメントをご覧ください。

通知チャンネルを作成して管理する コレクションでコンテンツを整理 必要に応じて、コンテンツの保存と分類を行います。

始める前に

作成する通知チャンネルを決定する

通知チャンネルを作成する

メール

モバイルアプリ

PagerDuty

JSON の例

スキーマの構造、バージョン 1.2

非推奨ポリシー

重大度レベルをマッピングするように PagerDuty を構成する

SMS

Slack

Webhook

Webhook 通知チャンネルを構成する

JSON の例

スキーマの構造、バージョン 1.2

基本認証

トークン認証

非推奨ポリシー

Pub/Sub

始める前に

必要な API を有効にしてトピックを作成する

トピックの通知を構成する

サービス アカウントを認可する

特定のトピックのサービス アカウントを認可する

すべてのトピックでサービス アカウントを認可する

アラート ポリシーで通知チャンネルを設定する

スキーマの例

JSON の例

スキーマの構造、バージョン 1.2

非推奨ポリシー

Google Chat

始める前に

Google Cloud Monitoring アプリをインストールする

オンデマンドでチャンネルを作成する

サポートされていないチャンネルに関する通知を受け取る

通知チャンネルをテストする

通知チャンネルの編集と削除

通知チャンネルのログを表示する

次のステップ

通知チャンネルを作成して管理する

サービスアカウントを認可する

特定のトピックのサービスアカウントを認可する

すべてのトピックでサービスアカウントを認可する

アラートポリシーで通知チャンネルを設定する