ダッシュボードにイベントを表示する

このドキュメントでは、イベント アノテーションを表示するようにダッシュボードを構成する方法について説明します。イベントとは、システムのオペレーションに影響するデプロイやクラッシュなどのアクティビティです。イベント アノテーションを表示すると、問題のトラブルシューティング時にさまざまなソースのデータの相関関係を把握できます。

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

イベント アノテーションについて

Google Cloud コンソールの [ダッシュボード] ページに一覧表示されるほとんどのダッシュボードでイベントを表示できます。同様に、Compute Engine や Google Kubernetes Engine など、サービス固有の [オブザーバビリティ] タブを構成して、イベントを表示することもできます。ダッシュボードまたは [オブザーバビリティ] タブに表示されるイベントタイプを構成するには、 Google Cloud コンソールを使用します。作成したダッシュボード（カスタム ダッシュボードと分類）では Cloud Monitoring API を使用することもできます。

Cloud Monitoring API を使用するか、イベントタイプの選択を保存する操作を行わない限り、選択内容は現在のセッションにのみ適用されます。 Google Cloud コンソールを使用する場合は、選択内容を固定すると保存されます。

イベントタイプのリスト、トラブルシューティングのリファレンスなどの情報については、イベントタイプのページをご覧ください。

推奨されるイベントタイプ

イベントタイプを選択していない場合でも、ダッシュボードまたは [オブザーバビリティ] タブで次のイベントタイプが有効になっていることがあります。

• 開始状態のアラート。
• Personalized Service Health インシデント（Service Health API が有効になっている場合）。
• ダッシュボードにデータが表示されるリソースのタイプごとに、1 つのイベントタイプ。

イベントタイプが自動的に追加される場合、それは推奨イベントタイプです。これらのイベントタイプを推奨状態のままにするか、ダッシュボード JSON に保存するか、これらを閉じて推奨事項を削除します。保存されているイベントタイプを確認するには、[アノテーション] メニューを開き、[固定] セクションを表示します。

イベントの特定方法

ダッシュボードは、さまざまなデータソースにクエリを実行して、ダッシュボードに表示するイベントを特定します。

• アラート イベントは Monitoring によって特定されます。アラート イベントには、インシデントが開かれた日時に関する情報が表示されます。

• Personalized Service Health イベントは、Monitoring が Service Health API に送信するクエリによって特定されます。これらのイベントは、 Google Cloud サービスの中断がいつ発生したかを示します。

• 他のすべてのイベントタイプは、 Google Cloud プロジェクトの Cloud Logging シンクを通過するログエントリを分析することで特定されます。これらのログエントリには、プロジェクトによって生成されたエントリと、プロジェクトに転送されたエントリが含まれます。これらのイベントのいずれかが発生したときに通知を受け取るには、ログベースのアラート ポリシーを作成します。アラート ポリシーで、[イベントタイプ] ページに表示されているクエリを使用します。

イベントの表示方法

すべてのイベントについて、イベントが発生すると、ダッシュボードのグラフにアノテーションが付けられます。ログエントリの分析によって特定されたイベントは、1 つの時間参照とともに表示されます。一方、Service Health イベントは開始時間とともに表示され、イベントの期間中はグラフの背景が変更されます。これらのイベントではハートアイコンも表示されます。

次のスクリーンショットは、ログエントリの分析によって特定された複数のイベントと、1 つの Service Health イベントが表示されているグラフを示しています。

上のスクリーンショットに示すとおり、イベントのツールチップには次のような情報が表示されます。

• イベント名。
• イベントの日時と開始時間。
• Service Health イベントの場合、影響を受けるプロダクトとロケーションの数を示すチップ。影響を受けるプロダクトまたはロケーションを一覧表示するには、対応するチップの上にポインタを置きます。
• [表示] ボタン。選択すると、イベントの詳細情報が表示されるページが開きます。たとえば、ログ エクスプローラを開いてログエントリを表示したり、Service Health イベントの詳細ページを開いたりできます。

ダッシュボードに表示されるデータを制限するダッシュボード フィルタは、通常、時系列データとイベントの両方をフィルタします。

始める前に

ダッシュボードでイベントを表示する Google Cloud プロジェクトで、次の操作を行います。

• ダッシュボードでイベントを確認および表示するために必要な権限を取得し、アラート ポリシーを作成するには、プロジェクトに対する次の IAM ロールの付与を管理者に依頼してください。

  • ダッシュボードとアラート ポリシーを表示して作成する: モニタリング編集者（roles/monitoring.editor）。
  • Google Cloud プロジェクトで作成されたデータアクセス以外のログエントリから特定されたイベントを確認および表示する: ログ閲覧者（roles/logging.viewer）。
  • Google Cloud プロジェクトで作成されたログエントリから特定されたイベントを確認および表示する: プライベート ログ閲覧者（roles/logging.privateLogViewer）。
  • Service Health イベントを表示する: Personalized Service Health 閲覧者（roles/servicehealth.viewer）

  ロールの付与については、プロジェクト、フォルダ、組織に対するアクセス権の管理をご覧ください。

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

• Service Health イベントをダッシュボードに表示する場合は、Service Health API を有効にします。

  Roles required to enable APIs

  To enable APIs, you need the Service Usage Admin IAM role (roles/serviceusage.serviceUsageAdmin), which contains the serviceusage.services.enable permission. Learn how to grant roles.

  Enable the API

イベントを表示する

このセクションでは、イベントを表示するようにダッシュボードまたは [オブザーバビリティ] タブを構成する方法について説明します。

イベントを表示するようにダッシュボードを構成する

このセクションでは、 Google Cloud コンソールの [ダッシュボード] ページに一覧表示されるダッシュボードを構成して、イベントを表示する方法について説明します。

イベントタイプのリスト、トラブルシューティングのリファレンス、ログ エクスプローラまたはログベースのアラート ポリシーで使用できるクエリについては、イベントタイプのページをご覧ください。

"annotations": {
  "defaultResourceNames": [],
  "eventAnnotations": [
    {
      "displayName": "",
      "enabled": true,
      "eventType": "GKE_CLUSTER_UPDATE",
      "filter": "resource.labels.cluster_name=my-cluster",
      "resourceNames": []
    }
  ]
}

イベントを表示するように [オブザーバビリティ] タブを構成する

このセクションでは、イベントを表示するように [オブザーバビリティ] タブを構成する方法について説明します。Compute Engine や Google Kubernetes Engine などの一部のサービスには、指標とログデータを表示する [オブザーバビリティ] タブがあります。

イベントの詳細を表示する

イベント アノテーションが表示されているグラフを表示している場合は、ツールチップに表示されているリンクを使用して、詳細情報を確認できます。

特定のイベントの詳細を確認するには、[表示] をクリックします。

[表示] ボタンで開かれる Google Cloud コンソール ページは、イベントタイプに応じて決まります。たとえば、稼働時間チェック イベントの場合、このボタンをクリックすると、稼働時間チェックのダッシュボードが開きます。別のイベントタイプの場合、ログ エクスプローラが開くことがあります。

アラート ポリシーを作成する

Google Cloud プロジェクトの Cloud Logging シンクを通過するログエントリの分析によってイベントが特定された場合、ログベースのアラートを構成することで、それらのイベントが発生したときに通知を受け取ることができます。ログベースのアラート ポリシーは、ログエントリを受け取ると、ログエントリに対しクエリを実行します。クエリにより空ではない結果が返されると、インシデントが作成され、通知が送信されます。

イベントを非表示にする

次のステップ

• カスタム ダッシュボードを共有する
• グラフデータを確認する
• リソース固有のダッシュボードにアクセスする
• カスタム ダッシュボードに一時フィルタを追加する
• カスタム ダッシュボードに永続フィルタを追加する