通知チャネルの管理

このページでは、Cloud Monitoring アラートポリシーで使用可能な、サポートされている通知チャネルの種類を紹介し、Google Cloud Console を使用して通知チャネルを構成する方法について説明します。Cloud Monitoring API を使用して通知チャネルを構成するには、通知チャネルの管理をご覧ください。

アラートポリシーの通知については、次のページをご覧ください。

問題の発生からアラートが作成されるまでの間の遅延については、通知レイテンシをご覧ください。
アラートポリシーに対して生成される通知の数については、インシデントごとの通知をご覧ください。

デフォルトでは、アラートポリシーはインシデントが作成された場合にのみ通知を送信します。インシデントが開かれたときと閉じたときに通知を受け取るには、アラートポリシーを編集し、[通知] セクションで [Notify on incident closure] を選択します。

チャネルの作成

通知チャンネルを構成するには、指標スコープのスコープ対象プロジェクトに対して次のいずれかの Identity and Access Management ロールを持っている必要があります。

モニタリング通知チャネルの編集者
モニタリング編集者
モニタリング管理者
プロジェクト編集者
プロジェクトオーナー

これらのロールの詳細については、アクセス制御をご覧ください。

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

Cloud Console を使用して通知チャネルを作成する手順は次のとおりです。

Cloud Console で、プロジェクト選択ツールを使用して Google Cloud プロジェクトを選択し、[Monitoring] を選択するか、次のボタンをクリックします。

[Monitoring] に移動
Monitoring のナビゲーションパネルで、 [アラート] をクリックします。
[Edit notification channels] をクリックします。
新しい通知チャネルを追加するには、チャネルの種類を見つけて [新しく追加] をクリックし、次の表に示すチャネル固有の手順に従います。

Email

メールを追加するには、[メール] セクションで [新規追加] をクリックし、手順に沿って操作します。

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

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

モバイルアプリ

Cloud Console モバイルアプリで、どこからでも Cloud Console リソースと Monitoring の情報をモニタリングできます。

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

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

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

通知されるデバイスについて

[通知チャンネル] ページの [モバイルデバイス] セクションの [スコープ] 列で、通知の送信先を指定します。

Cloud Console モバイルアプリ通知チャンネルのリスト。

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

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

PagerDuty

PagerDuty と統合すれば、Monitoring との一方向または双方向の同期が可能になります。構成に関係なく、以下のようになります。

Monitoring でインシデントが作成された場合、そのインシデントは PagerDuty で開かれます。
PagerDuty を使用して Monitoring のインシデントを閉じることはできません。

一方向の同期を使用し、PagerDuty でインシデントを解決した場合、PagerDuty のインシデントの状態は Monitoring のインシデントの状態から切り離されます。PagerDuty でインシデントを解決した場合、そのインシデントは PagerDuty で完全にクローズされ、再び開くことはできません。

双方向同期を使用する場合、PagerDuty で表示される状態は Monitoring によって制御されます。PagerDuty でインシデントを解決し、Monitoring がインシデントを開いている場合、そのインシデントは PagerDuty で再度開かれます。

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

PagerDuty で: PagerDuty サイトで PagerDuty アカウントを作成します。
PagerDuty の Stackdriver 統合ガイド^†に記載されている手順に従って、PagerDuty と Monitoring の統合を完了します。
Google Cloud Console の [通知チャネル] ウィンドウで、PagerDuty 通知チャネルを追加します。
1. [PagerDuty] セクションで、[Add new] をクリックします。
2. [表示名] を入力します。この名前は、統合を追加したときに PagerDuty に指定した名前と一致する必要があります。
3. PagerDuty によって生成された Integration Service Key を [Service Key] フィールドに入力します。
4. [保存] をクリックします。
（省略可）双方向同期を構成する場合は、次の操作を行います。
1. PagerDuty で、[構成]、[サービス] の順に選択し、統合の構成時に入力したサービス名を選択します。
2. [設定を編集] をクリックして [インシデントの作成] を選択し、[アラートとインシデントの作成] をクリアします。

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

^† このドキュメントの Stackdriver のスクリーンショットは古いバージョンのものですが、情報は正確です。

SMS

SMS 通知を設定するには、次の手順を行います。

[SMS] セクションの [新規追加] をクリックして、表示される手順を行います。
[保存] をクリックします。

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

Slack

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

Slackの場合: Slack サイトで Slack ワークスペースとチャネルを作成します。チャネル URL をメモしておきます。
Cloud Console で、[モニタリング] を選択します。

[Monitoring] に移動
[アラート]、[Edit notification channel] の順にクリックします。
[Slack] セクションで、[新規追加] をクリックして Slack のログインページを開きます。
1. Slack ワークスペースを選択します。
2. [許可] をクリックして Cloud Monitoring の Slack ワークスペースへのアクセスを有効にします。この操作を行うと、通知チャンネルの Monitoring 構成ページに戻ります。
3. 通知に使用する Slack チャンネルの名前を入力します。
4. Slack 通知チャンネルの表示名を入力します。
5. （省略可）Cloud Monitoring と Slack ワークスペースの間の接続をテストするには、[接続をテスト] をクリックします。接続に成功すると、指定した Slack 通知チャネルに This is a test alert notification... というメッセージが表示されます。
Slack の場合:
1. Monitoring の通知チャンネルとして指定したチャンネルに移動します。
2. チャネルに次のメッセージを送信して、Monitoring アプリをチャネルに招待します。
```
/invite @Google Cloud Monitoring
```
  Monitoring で通知チャンネルを作成するときに指定したチャネルに、Monitoring アプリを招待するようにしてください。
アラートポリシーを作成するときは、[通知] セクションの [Slack] を選択し、Slack の構成を選択します。

Webhook

通知に Webhook を使用するには、パブリックエンドポイント URL が必要です。Webhooks 通知を設定するには、次の手順を行います。

webhook ハンドラ: Monitoring から webhook データを受信するパブリックエンドポイント URL を指定します。
[Webhooks] セクションの [Add new] をクリックして表示される手順を行います。
[接続をテスト] をクリックして、テストペイロードを Webhook エンドポイントに送信します。受信エンドポイントに移動して、配信状況を確認できます。
[保存] をクリックします。

アラートポリシーを作成する場合は、[通知] セクションで [Webhook] を選択し、webhook 構成を選択します。

JSON の例

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

以下は、そのようなパケットの例です。

   {
     "incident": {
       "incident_id": "0.opqiw61fsv7p",
       "resource_id": "11223344",
       "resource_name": "internal-project gke-cluster-1-default-pool-e2df4cbd-dgp3",
       "resource": {
         "type": "gce_instance",
         "labels": {
           "instance_id": "11223344",
           "project_id": "internal-project",
           "zone": "us-central1-c"
         }
       },
       "resource_display_name": "gke-cluster-1-default-pool-e2df4cbd-dgp3",
       "resource_type_display_name": "VM Instance",
       "metric": {
         "type": "compute.googleapis.com/instance/cpu/utilization",
         "displayName": "CPU utilization"
       },
       "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]",
       "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
           }
         }
       },
       "url": "https://console.cloud.google.com/monitoring/alerting/incidents/0.lxfiw61fsv7p?project=internal-project",
       "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"
       },
       "state": "closed",
       "started_at": 1577840461,
       "ended_at": 1577877071,
       "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.1 形式の JSON パケットを生成します。この場合、バージョン 1.1 のデータは errors フィールドで強化されます。errors フィールドには 1 つ以上の google.rpc.Status オブジェクトが含まれ、各オブジェクトが特定のエラーを説明します。以下に、バージョン 1.1 のパケットを示します。

   {
    "incident": {
      "incident_id": "f2e08c333dc64cb09f75eaab355393bz",
      "resource_id": "i-4a266a2d",
      "resource_name": "webserver-85",
      "state": "open",
      "started_at": 1385085727,
      "ended_at": null,
      "policy_name": "Webserver Health",
      "condition_name": "CPU usage",
      "errors": [{ "error": { "code": 500, "status": "INTERNAL", "message": "Failed to render as 1.2; downgrading to 1.1."} }]
      "url": "https://console.cloud.google.com/monitoring/alerting/incidents?project=PROJECT_ID",
      "summary": "CPU for webserver-85 is above the threshold of 1% with a value of 28.5%"
    },
    "version": "1.1"
   }

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

このセクションでは、Webhook スキーマのバージョン 1.2 について説明します。アラートポリシーの構成、インシデントの状態、モニタリング対象のリソースによっては、返されたパケットに一部のフィールドが含まれず、値が空の場合もあります。一部のフィールドには、埋め込み構造が値として取り込まれます。これらの構造は内容もさまざまであるため、参照によって記述されます。

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

{
  "version": "1.2",
  "incident": {
    # インシデントに関する情報。
    "incident_id": このインシデントに対して生成された ID。
    "url": このインシデントの Google Cloud Console の URL。
    "state": インシデントの状態: open または closed。open の場合、"ended_at" は null です。
    "started_at": インシデントが開かれた時刻（Unix エポック秒単位）。
    "ended_at": インシデントが終了した時刻（Unix エポック秒単位）。"state" が closed の場合にのみ入力されます。
    "summary": 生成されたインシデントのテキスト要約。
    "apigee_url": このインシデントの Apigee URL。Apigee リソースタイプ Environment と Proxy*。

    # インシデントが開かれたモニタリング対象リソースに関する情報。
    "resource": {
      "type": アラート対象のモニタリング対象リソースタイプの識別子（gce_instance など）。モニタリング対象リソースのリストをご覧ください。
      "labels": { ... },: モニタリング対象リソースタイプに関連付けられたラベルの Key-Value ペア。
    },
    "resource_type_display_name": モニタリング対象リソースタイプの表示名。
    "resource_id": resource.labels.instance_id と同じ値の、モニタリング対象リソースのインスタンス ID。
    "resource_display_name": モニタリング対象リソースの表示名。
    "resource_name": このモニタリング対象リソースの生成名。他のフィールドの値が含まれます。

    # 時系列データの指標タイプに関する情報。
    "metric": {
      "type": アラート対象の指標タイプの ID（例: compute.googleapis.com/instance/cpu/utilization）。詳細: 指標のリスト。
      "displayName": 指標タイプの表示名。
    },

    # インシデントをオープンしたアラートポリシーと条件に関する情報;
    # 値は関連する AlertPolicy オブジェクトから取得されます。
    "policy_name": アラートポリシーの表示名。
    "policy_user_labels": { ... },: ポリシーに添付されたユーザーラベルの Key-Value ペア。
    "documentation": { ... },: 形式の埋め込み構造。 Documentation。
    "condition": { ... },: 形式の埋め込み構造。 Condition。
    "condition_name": 条件の表示名。condition.displayName と同じ値。
  },
}

基本認証

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 API を有効にします。

Pub/Sub API を有効にする
1. 正しい Google Cloud プロジェクトが選択されていることを確認します。
2. [有効にする] ボタンが表示されている場合は、ボタンをクリックします。
3. [API が有効です] が表示されている場合、API はすでに有効になっています。
Pub/Sub トピックをまだ持っていない場合は、トピックの作成の説明に従って作成します。トピックは、通知チャネルとして使用する前に作成しておく必要があります。トピックを作成する次のコマンドは、notificationTopic というものです。
```
gcloud pubsub topics create notificationTopic
```
トピックを使用する通知チャネルを作成します。Monitoring API、gcloud コマンドラインツール、Cloud Console を使用できます。

Cloud Console を使用して通知チャネルを作成するには、[Edit notification channels] ウィンドウに移動して、次の操作を行います。
1. [Cloud Pub/Sub] セクションで、[新しく追加] をクリックします。
2. チャネルの表示名を入力し、Pub/Sub トピック名を入力して [Add channel] をクリックします。
Monitoring API または gcloud コマンドラインツールを使用して通知チャネルを作成する方法については、チャネルの作成をご覧ください。
通知サービスアカウントに、通知チャネルとして使用する各 Pub/Sub トピックを公開する権限を付与します。

最初の Pub/Sub チャネルを作成すると、Cloud Monitoring は、チャネルが作成されたプロジェクトの Monitoring Notification Service Agent 用のサービスアカウントを作成します。このサービスアカウントは、このプロジェクトの通知チャネルへの Pub/Sub ベースでの通知の送信を管理します。

このサービスアカウントには、次の構造の ID があります。

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

サービスアカウントを表示するには、[IAM] ページに移動します。

IAM に移動

サービスアカウントが表示されない場合は、次の手順を試してください。
- 次のスクリーンショットに示すように、[Google 提供のロール付与を含む] を選択します。
- ページを再読み込みします。
このアカウントにトピックへの公開を許可するには、サービスアカウントにトピックの 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
```
コマンドが成功すると、次のような出力が返されます。
```
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 リファレンスページをご覧ください。

プロジェクト番号がプロジェクト ID と同じではありません。プロジェクト ID は通常、my-test-project のようにプロジェクト名を表す文字列です。プロジェクト番号は一意の数値の ID です。プロジェクトの名前、ID、番号は、Cloud Console のプロジェクトのランディングページで確認できます。また、次のコマンドでも取得できます。
```
gcloud projects describe [PROJECT_ID] --format="value(project_number)"
```
チャネルタイプとして Pub/Sub を、通知チャネルとして名前付きトピックを選択して、アラートポリシーに Pub/Sub チャネルを追加します。

オンデマンドでのチャネルの作成

アラートポリシーに通知チャネルを追加する際は、リストからチャネルを選択する必要があります。使用する通知チャネルがリストにない場合は、次の手順で構成済みの通知チャネルを更新できます。

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

チャネルの編集と削除

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

Cloud Console で [モニタリング] を選択するか、次のボタンをクリックします。

[Monitoring] に移動
Monitoring のナビゲーションパネルで、 [アラート] をクリックします。
[Edit notification channels] をクリックします。

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

Slack チャンネルへの Monitoring アプリの追加

2020 年 11 月 21 日から 12 月 3 日までの間に Slack 通知チャネルを作成した場合、そのチャネルには通知が届きません。この問題を解決するには、このセクションで説明するように、Monitoring アプリをチャンネルに追加する必要があります。

新しい Slack ワークスペースでチャネルを構成するには、新しい Slack チャネルの設定をご覧ください。

既存の Slack チャンネルを更新して Cloud Monitoring を含めるには、次の手順に沿って操作します。

更新する Slack チャンネルに移動します。
チャネルに次のメッセージを送信して、Monitoring アプリをチャネルに招待します。
```
/invite @Google Cloud Monitoring
```
Monitoring で通知チャンネルを作成するときに指定したチャネルに、Monitoring アプリを招待するようにしてください。

注: 招待状が Monitoring アプリを認識できない場合、最も可能性の高い理由は、Slack ワークスペース用のアプリを承認していないことです。新しい Slack チャンネルの設定の手順に沿って操作します。