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

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

イベントの識別方法

ダッシュボードでは、Google Cloud プロジェクト内の Cloud Logging シンクを通過するログエントリを分析し、イベントをクエリします。これらのログエントリには、プロジェクトで生成されたものや、プロジェクトにルーティングされたものが含まれます。

これらのイベントのいずれかが発生したときに通知を受け取るには、ログベースのアラートポリシーを作成します。アラートポリシーで、[イベントタイプ] ページで提供されるクエリを使用します。

イベントの表示方法

ダッシュボードのグラフには、イベントが発生するとアノテーションが付けられます。ログエントリの分析によって特定されたイベントは、1 つの時間参照で表示されます。

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

イベントアノテーションを表示するグラフ。

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

イベント名。
イベントの原因となった Google Cloud サービスまたはリソース。
イベントの日付と開始時刻。
[表示] ボタンを選択すると、イベントに関する詳細情報を表示するページが開きます。たとえば、ログエクスプローラを開いて、ログエントリを表示できます。

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

カスタムダッシュボードの場合は、Cloud Monitoring API を使用してイベントを表示するかどうかも構成できます。

始める前に

グラフとログエントリを表示し、アラートポリシーを作成するために必要な権限を取得するには、プロジェクトに対する次の IAM ロールの付与を管理者に依頼してください。
- グラフを表示し、アラートポリシーを表示および作成するには: モニタリング編集者（roles/monitoring.editor）。
- Google Cloud プロジェクトで作成されたデータアクセスログエントリを除くすべてのログエントリを表示する: ログビューア（roles/logging.viewer）。
- Google Cloud プロジェクトで作成されたデータアクセスログエントリを表示する: プライベートログビューア（roles/logging.privateLogViewer）。
ロールの付与の詳細については、アクセスの管理をご覧ください。

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

イベントを表示

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

コンソール

現在のセッションでイベントを表示するには、次の操作を行います。

Google Cloud コンソールで [ダッシュボード] ページに移動します。
[ダッシュボード] に移動

検索バーを使用してこのページを検索する場合は、小見出しが [Monitoring] である結果を選択します。
表示するダッシュボードを選択します。
ダッシュボードのツールバーで、 [Events] 切り替えボタンがオンになっていることを確認します。

[Events] 切り替えボタンが表示されない場合、ダッシュボードでイベントの表示がサポートされません。
表示するイベントタイプごとに、ダッシュボードツールバーで [Add event] をクリックし、メニューからイベントタイプを選択します。

たとえば、「GKE ワークロードのデプロイ」イベントを表示するようにダッシュボードを構成できます。

イベントタイプを追加すると、Cloud Monitoring はログデータをクエリします。これには少し時間がかかります。その後、ダッシュボードのグラフにアノテーションを追加します。
- 情報: 情報メッセージ。
- 警告: 再起動やクラッシュなどの障害を示します。
- アラート: インシデントが開かれたことを示します。
イベントの概要を表示するか、またはログエントリへのリンクにアクセスするには、ポインタを使用してツールチップを有効にします。
省略可: 構成は現在のセッションにのみ適用されます。構成を保存するには、次の操作を行います。
1. ダッシュボードツールバーで、 [設定] をクリックし、[JSON] を選択してから、[JSON エディタ] を選択します。
2. JSON エディタで、annotations オブジェクトを追加します。このオブジェクトには、表示するイベントタイプを指定する EventAnnotation オブジェクトの配列が含まれます。
  以下は、クラスタ更新イベントの annotations オブジェクトの例です。この例の filter フィールドは、イベントを特定のクラスタに制限しています。
```
"annotations": {
  "defaultResourceNames": [],
  "eventAnnotations": [
    {
      "displayName": "",
      "enabled": true,
      "eventType": "GKE_CLUSTER_UPDATE",
      "filter": "resource.labels.cluster_name=my-cluster",
      "resourceNames": []
    }
  ]
}
```
  annotations オブジェクトの詳細については、この表の [API] タブを選択します。
3. [変更を適用] をクリックし、[保存] をクリックします。

API

イベントを表示するようにカスタムダッシュボードを構成するには、Dashboard オブジェクトに annotations フィールドを含めます。annotations フィールドには、次の 2 つのフィールドを含む DashboardAnnotations オブジェクトのインスタンスが含まれています。

defaultResourceName フィールドには、Google Cloud プロジェクトでイベントを検索するためのダッシュボードレベルのデフォルトが一覧表示されます。このフィールドを指定しない場合は、選択したプロジェクトが検索されます。
EventAnnotation オブジェクトの配列。各オブジェクトには次のものが含まれます。
- displayName フィールド。イベント固有の切り替えでラベルを定義できます。このフィールドが指定されていない場合、またはこのフィールドの値が空の文字列の場合は、イベントのデフォルト名が表示されます。
- enabled フィールド。イベントの切り替え値を制御します。 true の場合、切り替えは on の位置にあり、イベントがダッシュボードに表示されます。false の場合、切り替えは off の位置にあります。
- eventType フィールド。EventType 列挙値が含まれます。
- filter フィールド。イベント固有のクエリに追加するクエリを指定できます。このフィールドの値が空の文字列の場合、イベント固有のクエリが使用されます。
- resourceNames フィールド。イベントを検索する Google Cloud プロジェクトのリストを定義できます。このフィールドが空の配列の場合は、選択したプロジェクトが検索されます。

以下は、クラスタ更新イベントの annotations オブジェクトの例です。この例の filter フィールドは、イベントを特定のクラスタに制限しています。

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

Cloud Monitoring API を使用してダッシュボードを作成する方法の詳細については、API を使用してダッシュボードを作成、管理すると例: ダッシュボードでイベントを有効にするをご覧ください。

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

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

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

[表示] ボタンで開かれるページは、イベントタイプによって異なります。たとえば、稼働時間チェックイベントの場合、このボタンをクリックすると、稼働時間チェックのダッシュボードが開きます。イベントタイプによっては、ログエクスプローラが開く場合があります。
アノテーションと一致するタイムスタンプを持つログエントリを表示するには、ポインタを使用してアノテーションのツールチップを有効にし、ツールチップの概要行に移動してから、[ログを表示] をクリックします。

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

ログにイベントが表示されたときに通知を受け取るには、ログベースのアラートを構成します。ログベースのアラートポリシーは、ログエントリを受け取るとクエリを実行します。クエリで空でない結果が返されると、インシデントが作成され、通知が送信されます。

コンソール

ログベースのアラートを作成するには、次の操作を行います。

通知チャンネルを構成していない場合は、次の手順を行います。
1. Google Cloud コンソールで [アラート] ページに移動します。
  アラートに移動
  
  検索バーを使用してこのページを検索する場合は、小見出しが [Monitoring] である結果を選択します。
2. [Edit notification channel] をクリックします。
3. 構成する通知チャネルの種類に移動し、[Add new] をクリックして、ダイアログを完了します。
Google Cloud コンソールのナビゲーションパネルで、[Logging] を選択してから、[ログエクスプローラ] を選択します。
[ログエクスプローラ] に移動
ツールバーで [Create Alert] を選択します。
アラートポリシーの名前を入力し、[Next] をクリックします。
[Define log entries to alert on] セクションでクエリを入力するか、[Create Alert] を選択したときに [Query] ペインからコピーしたクエリを更新します。

イベントタイプのページには、イベントタイプごとに、ログベースのアラートポリシーで使用するのに適したクエリが一覧表示されます。
ダイアログを完成させて、[Save] をクリックします。

API

Cloud Monitoring API を使用してログベースのアラートポリシーを作成するには、次の操作を行います。

アラートポリシーの条件に含めるクエリを特定します。イベントタイプのページには、イベントタイプごとに、ログベースのアラートポリシーで使用するのに適したクエリが一覧表示されます。
アラートポリシーの表現を含む JSON ファイルを作成します。この手順と例の詳細については、アラートポリシーの設計をご覧ください。
alertPolicies.create API メソッドを呼び出します。たとえば、gcloud alpha monitoring policies create コマンドを発行します。

イベントを非表示

コンソール

すべてのイベントを非表示にするには、ダッシュボードツールバーで [Events] 切り替えボタンがオフになっていることを確認します。

1 種類のイベントを非表示にするには、そのイベントタイプの切り替えボタンをオフの位置に設定します。

API

カスタムダッシュボードで 1 種類のイベントを非表示にするには、イベントタイプの EventAnnotation オブジェクトを見つけてから、enabled フィールドを false に設定します。

Cloud Monitoring API の使用方法について詳しくは、API を使用してダッシュボードを作成、管理するをご覧ください。

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

イベントの識別方法

イベントの表示方法

始める前に

イベントを表示

コンソール

API

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

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

コンソール

API

イベントを非表示

コンソール

API

次のステップ

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