このドキュメントでは、ダッシュボードのグラフにイベントを表示する方法について説明します。イベントは、システムのオペレーションに影響するデプロイやクラッシュなどのアクティビティです。イベントを表示すると、問題のトラブルシューティング時に、さまざまなソースのデータを関連付けることができます。
Google Cloud コンソールの [ダッシュボード] ページに記載されているほとんどのダッシュボードでイベントを表示できます。ダッシュボードに表示されるイベントタイプを構成するには、Google Cloud コンソールを使用します。カスタム ダッシュボードの場合、Cloud Monitoring API を使用することもできます。
イベントの識別方法
ダッシュボードでは、Google Cloud プロジェクトの Cloud Logging シンクを通過するログエントリを分析し、イベントのクエリを実行します。これらのログエントリには、プロジェクトで生成されたログエントリと、プロジェクトにルーティングされたログエントリが含まれます。
これらのイベントのいずれかが発生したときに通知を受け取るには、ログベースのアラート ポリシーを作成します。アラート ポリシーで、[イベントの種類] ページに表示されているクエリを使用します。
イベントの表示方法
すべてのイベントについて、それらのイベントが発生すると、ダッシュボードのグラフにアノテーションが付けられます。ログエントリの分析によって特定されたイベントは、1 つの時間参照で表示されます。
次のスクリーンショットは、ログエントリを分析して特定された 1 つのイベントが表示されているグラフを示しています。
上のスクリーンショットに示すように、イベントのツールチップには次のような情報が含まれています。
- イベント名。
- イベントの原因となった Google Cloud サービスまたはリソース。
- イベントの日付と開始時刻。
- [表示] ボタン。選択すると、イベントの詳細情報を表示するページが開きます。たとえば、ログ エクスプローラを開き、ログエントリを表示できます。
ダッシュボード フィルタは、ダッシュボードに表示されるデータを制限します。通常、時系列データとイベントの両方がフィルタリングされます。
始める前に
ダッシュボードでイベントを表示および表示するために必要な権限を取得し、アラート ポリシーを作成するには、プロジェクトに対する次の IAM ロールの付与を管理者に依頼してください。
-
ダッシュボードとアラート ポリシーを表示および作成するには: モニタリング編集者（
roles/monitoring.editor）。 -
Google Cloud プロジェクトで作成されたデータアクセス以外のログエントリから識別されたイベントを確認または表示する:
ログビューア（
roles/logging.viewer）。 -
Google Cloud プロジェクトで作成されたログエントリから識別されたイベントを確認または表示する: プライベート ログビューア（
roles/logging.privateLogViewer）。
ロールの付与の詳細については、アクセス権の管理をご覧ください。
必要な権限は、カスタムロールや他の事前定義ロールから取得することもできます。
イベントを表示
ログ エクスプローラまたはログベースのアラート ポリシーで使用できるイベントタイプ、トラブルシューティングのリファレンス、クエリのリストについては、イベントタイプのページをご覧ください。
コンソール
ダッシュボードにイベントを表示する方法は次のとおりです。
-
Google Cloud コンソールで [
ダッシュボード] ページに移動します。検索バーを使用してこのページを検索する場合は、小見出しが [Monitoring] である結果を選択します。
- 表示するダッシュボードを選択します。
ダッシュボードのツールバーで、
[Events] 切り替えボタンがオンになっていることを確認します。 [Events] 切り替えボタンが表示されない場合、ダッシュボードでイベントを表示できません。[イベントタイプを選択] をクリックし、ダッシュボードに表示するイベントタイプを選択して、次のいずれかを行います。
カスタム ダッシュボードを表示して、選択したイベントタイプを保存する場合は、[選択した項目を固定] をクリックします。ダッシュボードで自動保存を無効にしている場合は、ダッシュボードのツールバーに移動して [保存] をクリックします。
選択内容を固定すると、ダッシュボードの JSON 定義が変更されます。そのため、ダッシュボードを再度開くと、選択内容が読み込まれ、対応するイベントタイプのアノテーションがダッシュボードに表示されます。
そうでない場合は、[OK] をクリックします。
表示するイベントタイプのリストを更新すると、Cloud Monitoring はクエリを発行します。これには少し時間がかかります。その後、ダッシュボードのグラフにアノテーションを追加します。
イベントの概要を表示するか、またはログエントリへのリンクにアクセスするには、ポインタを使用してツールチップを有効にします。
API
イベントを表示するようにカスタム ダッシュボードを構成するには、Dashboard オブジェクトに annotations フィールドを含めます。annotations フィールドには、DashboardAnnotations オブジェクトのインスタンスが含まれており、次の 2 つのフィールドが含まれています。
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 を使用してダッシュボードを作成、管理すると例: ダッシュボードでイベントを有効にするをご覧ください。
イベントの詳細を表示する
イベントのアノテーションが表示されているグラフを表示している場合、ツールチップ内のリンクを使用して追加情報にアクセスできます。
特定のイベントの詳細を表示するには、[表示] をクリックします。
[表示] ボタンによって開かれる Google Cloud コンソール ページは、イベントタイプによって決まります。たとえば、稼働時間チェック イベントの場合、このボタンを押すと、稼働時間チェックのダッシュボードが開きます。イベントの種類によっては、ログ エクスプローラが開く場合があります。
アラート ポリシーを作成する
Google Cloud プロジェクトで Cloud Logging シンクを通過するログエントリを分析してイベントが識別されると、それらのイベントが発生したときにログベースのアラートの設定] をタップすることで通知を受け取ることができます。ログベースのアラート ポリシーは、ログエントリを受け取るとクエリを実行します。クエリで空でない結果が返されると、インシデントが作成され、通知が送信されます。
コンソール
ログベースのアラートを作成するには、次の操作を行います。
通知チャンネルを構成していない場合は、次の手順を行います。
-
Google Cloud コンソールで、notifications [アラート] ページに移動します。
検索バーを使用してこのページを検索する場合は、小見出しが [Monitoring] である結果を選択します。
- [通知チャネルを編集] をクリックします。
- 構成する通知チャネルの種類に移動し、[Add new] をクリックして、ダイアログを完了します。
-
-
Google Cloud コンソールで、[ログ エクスプローラ] ページに移動します。
検索バーを使用してこのページを検索する場合は、小見出しが [Logging] である結果を選択します。
ツールバーで [アラートを作成] を選択します。
アラート ポリシーの名前を入力し、[Next] をクリックします。
[Define log entries to alert on] セクションでクエリを入力するか、[Create Alert] を選択したときに [Query] ペインからコピーしたクエリを更新します。
イベントタイプのページには、イベントタイプごとに、ログベースのアラート ポリシーで使用するのに適したクエリが一覧表示されます。
ダイアログの項目を入力し、[保存] をクリックします。
API
Cloud Monitoring API を使用してログベースのアラート ポリシーを作成するには、次の操作を行います。
アラート ポリシーの条件に含めるクエリを特定します。イベントタイプのページには、イベントタイプごとに、ログベースのアラート ポリシーで使用するのに適したクエリが一覧表示されます。
アラート ポリシーの表現を含む JSON ファイルを作成します。この手順と例の詳細については、アラート ポリシーの設計をご覧ください。
alertPolicies.create API メソッドを呼び出します。 たとえば、
gcloud alpha monitoring policies createコマンドを実行します。
イベントを非表示
コンソール
すべてのイベントを非表示にするには、ダッシュボード ツールバーで toggle_off [Events] 切り替えボタンがオフになっていることを確認します。
1 種類のイベントを非表示にするには、そのイベントタイプの切り替えボタンをオフの位置に設定します。
API
カスタム ダッシュボードで 1 種類のイベントを非表示にするには、イベントタイプの EventAnnotation オブジェクトを見つけてから、enabled フィールドを false に設定します。
Cloud Monitoring API の使用方法の詳細については、API を使用してダッシュボードを作成、管理するをご覧ください。