カスタム ダッシュボードの作成と管理

このドキュメントでは、 Google Cloud コンソールを使用してカスタム ダッシュボードを作成、管理する方法について説明します。カスタム ダッシュボードを使用すると、自分が関心のある情報を、自分が使いやすい方法で整理して表示できます。たとえば、本番環境にある仮想マシン(VM)のログ、パフォーマンス指標、アラート ポリシーを表示するダッシュボードを作成できます。カスタム ダッシュボードの作成後、それをコピー、変更、共有することもできます。ダッシュボードの作成には、 Google Cloud コンソール、Cloud Monitoring API、または Google Cloud CLI を使用できます。

このドキュメントでは、 Google Cloud コンソールを使用してカスタム ダッシュボードを作成、管理する方法について説明します。

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

カスタム ダッシュボードについて

カスタム ダッシュボードはさまざまなウィジェット タイプをサポートしており、データに最適な表示方法を選択できます。デフォルトでは、ダッシュボードには Google Cloud プロジェクトで使用可能なすべての指標データが表示されます。指標スコープを構成すると、ダッシュボードに複数の Google Cloud プロジェクトの指標データを表示できます。

カスタム ダッシュボードには、次のすべてを表示できます。

ウィジェットをグループ化すると、ダッシュボードの読み込み時間やユーザビリティを改善できます。たとえば、ダッシュボードにセクションを追加できます。あるいは、展開された、または折りたたまれたコンテナにウィジェットを追加することもできます。

ダッシュボードを作成したら、フィルタ、変数、イベント、ユーザー定義ラベルを追加できます。

  • ダッシュボード全体のフィルタは、ダッシュボード上のすべてのウィジェットに適用されます。これらのフィルタは、トラブルシューティングを行う際に役立ちます。たとえば、これらのフィルタを使用して、特定のゾーンのデータのみを表示できます。詳しくは、フィルタを追加または削除するをご覧ください。

  • 変数は選択したウィジェットに適用されます。たとえば、変数を使用して、ウィジェットによって発行されるクエリを変更したり、ウィジェットの表示を制御したりできます。詳細については、変数と固定フィルタの作成と管理をご覧ください。

  • Google Kubernetes Engine Pod のクラッシュなどのイベントは、問題のトラブルシューティング時にさまざまなソースのデータの相関関係を把握するのに役立ちます。詳細については、ダッシュボードにイベントを表示するをご覧ください。

  • ラベルを使用すると、表示されるコンテンツの種類に基づいてダッシュボードを探すことができます。たとえば、本番環境システムに関する情報を表示するダッシュボードにラベル prod を追加できます。同様に、ラベル staging を追加して、ダッシュボードにステージング システムに関する情報が表示されることを示します。

始める前に

ダッシュボードを作成して管理する Google Cloud プロジェクトで、次のことを行います。

プロジェクトにカスタム ダッシュボードを追加する

Google Cloud プロジェクトにカスタム ダッシュボードを追加するには、さまざまな方法があります。

  • ダッシュボードを作成できます。
  • ダッシュボードをコピーまたは複製できます。
  • ダッシュボードはプロジェクト間でコピーできます。
  • 共有の場所からダッシュボードをアップロードまたはインストールできます。
  • Grafana からダッシュボードをインポートできます。

たとえば、複数の Google Cloud プロジェクトがあり、それらが同じカスタム ダッシュボードを定義するようにするとします。このような場合は、1 つのプロジェクトでダッシュボードを作成し、ダッシュボードのテンプレートをローカル システムにダウンロード します。次に、他のGoogle Cloud プロジェクトにそのテンプレートをインストールできます。

新しいダッシュボードを作成する

カスタム ダッシュボードを作成する方法は次のとおりです。

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

    [ダッシュボード] に移動

    このページを検索バーで検索する場合は、小見出しが「Monitoring」の結果を選択します。

  2. Google Cloud コンソールのツールバーで、 Google Cloud プロジェクトを選択します。App Hub 構成の場合は、App Hub ホスト プロジェクトまたはアプリ管理用フォルダの管理プロジェクトを選択します。
  3. [ダッシュボード] ページで、[カスタム ダッシュボードを作成] をクリックします。
  4. ダッシュボードにウィジェットを追加する手順は次のとおりです。

    1. ダッシュボードのツールバーで [ウィジェットを追加] をクリックします。
    2. [ウィジェットを追加] ペインで、ダッシュボードに追加するウィジェットを選択します。

      表示するデータの種類やデータの表示方法に基づいてウィジェットを選択できます。いずれの場合も、構成ペインが開きます。たとえば、[指標] ウィジェットを選択して、可視化を [積み上げ面] に設定できます。または、[積み上げ面] ウィジェットを選択してから、指標を選択することもできます。

    3. ウィジェットを構成します。

    4. 変更をダッシュボードに適用するには、ツールバーで [適用] をクリックします。変更を破棄するには、[キャンセル] をクリックします。

      ウィジェットをダッシュボードに追加したら、ウィジェットの構成を変更できます。

  5. 変更したダッシュボードを保存するには、ツールバーで [保存] をクリックします。

  6. 省略可: ダッシュボードにユーザー定義のラベルを追加します。

    1. ダッシュボードのリストでダッシュボードを見つけて、 [ダッシュボードにラベルを追加] をクリックします。
    2. 次のいずれかを行います。
      • ラベルを作成してダッシュボードに追加するには、[新しいラベルを作成] セクションのテキスト ボックスにラベルの名前を入力し、[作成して適用] をクリックします。

      • ダッシュボードに追加するラベルを構成するには、 [適用するラベルを選択] をクリックし、ラベルを選択して [OK] をクリックします。
    3. 変更を保存するには、[確認] をクリックします。

ダッシュボードをコピーする

さまざまな指標や集計オプションを試したいときは、ダッシュボードをコピーして、テスト目的で新しいダッシュボードを使用できます。

ダッシュボードをコピーする手順は、次のとおりです。

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

    [ダッシュボード] に移動

    このページを検索バーで検索する場合は、小見出しが「Monitoring」の結果を選択します。

  2. Google Cloud コンソールのツールバーで、 Google Cloud プロジェクトを選択します。App Hub 構成の場合は、App Hub ホスト プロジェクトまたはアプリ管理用フォルダの管理プロジェクトを選択します。
  3. [ダッシュボードの概要] ページで、コピーするダッシュボードを見つけて、 [ダッシュボードのコピー] をクリックします。
  4. 省略可: ダッシュボードの名前を更新します。
  5. 確認ダイアログで、[Copy] をクリックする。

ダッシュボードを別のプロジェクトにコピーする

ダッシュボードをあるプロジェクトから別のプロジェクトにコピーするには、宛先となる Google Cloud プロジェクトの IAM ロールにモニタリング編集者の権限が含まれている必要があります。ロールの詳細については、Identity and Access Management を使用してアクセスを制御するをご覧ください。

ダッシュボードを別の Google Cloud プロジェクトにコピーする手順は次のとおりです。

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

    [ダッシュボード] に移動

    このページを検索バーで検索する場合は、小見出しが「Monitoring」の結果を選択します。

  2. Google Cloud コンソールのツールバーで、 Google Cloud プロジェクトを選択します。App Hub 構成の場合は、App Hub ホスト プロジェクトまたはアプリ管理用フォルダの管理プロジェクトを選択します。
  3. ダッシュボードの JSON をクリップボードにコピーします。

    1. ダッシュボード ツールバーで、 [設定]、[JSON]、[JSON エディタ] の順にクリックします。
    2. エディタのツールバーで、 [コピー] をクリックします。
  4. クリップボードの JSON を、別のプロジェクトに作成された新しいダッシュボードに貼り付けます。

    1. Google Cloud コンソールのプロジェクト選択ツールを使用して、コピーを作成するプロジェクトを選択します。
    2. [CREATE DASHBOARD] をクリックします。
    3. ダッシュボード ツールバーで、 [設定] をクリックし、[JSON] をクリックしてから、[JSON エディタ] をクリックします。
    4. クリップボードの内容をエディタに貼り付けます。
    5. [変更を適用] をクリックします。
    6. 変更したダッシュボードを保存するには、ツールバーで [保存] をクリックします。

ダッシュボード テンプレートをインストールする

共有の場所に保存されているダッシュボードのテンプレートを、 Google Cloud プロジェクトにアップロードできます。たとえば、Cloud Monitoring には、さまざまな Google Cloud サービスに固有のダッシュボード テンプレートのキュレートされたセットが GitHub で提供されています。これらのダッシュボードのグラフには、特定のサービスに関連する一連の指標が表示されます。

ダッシュボード テンプレートをアップロードした後、カスタマイズできます。たとえば、グラフを追加したり、ラベルを追加したり、表示するイベントを構成したりできます。

詳細については、ダッシュボード テンプレートをインストールするをご覧ください。

Grafana からダッシュボードをインポートする

Cloud Monitoring には、Grafana JSON 形式のダッシュボード ファイルを Cloud Monitoring にインポートするために使用できるインポータが用意されています。 詳細については、Grafana ダッシュボードを Cloud Monitoring にインポートするをご覧ください。

ダッシュボードを検索して表示する

カスタム ダッシュボードは、 Google Cloud プロジェクトにリソースを追加すると Cloud Monitoring によって作成されるサービス固有のダッシュボードと同じリストに表示されます。

ダッシュボードを表示する方法は次のとおりです。

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

    [ダッシュボード] に移動

    このページを検索バーで検索する場合は、小見出しが「Monitoring」の結果を選択します。

  2. Google Cloud コンソールのツールバーで、 Google Cloud プロジェクトを選択します。App Hub 構成の場合は、App Hub ホスト プロジェクトまたはアプリ管理用フォルダの管理プロジェクトを選択します。

    [ダッシュボード] ページには、Google Cloud プロジェクトのすべてのダッシュボードが一覧表示されます。

  3. ダッシュボードを見つけるには、次のいずれかの操作を行います。

    • [最近表示したもの] と [お気に入り] のオプションを使用して、表示するダッシュボードを制限します。

    • [統合] メニューを使用すると、特定の統合に関連付けられているダッシュボードのみを一覧表示できます。

    • [タイプ] メニューを使用して、特定のタイプのダッシュボードのみを一覧表示します。たとえば、Google Cloud サービスの使用状況に基づいて Google Cloud によって自動的に作成されたダッシュボードを一覧表示するには、[タイプ] メニューで [Google サービス] を選択します。リストをさらに絞り込むには、 [フィルタ] バーを使用します。

    • [ラベル] メニューを使用して、特定のユーザー定義ラベルが付いているダッシュボードのみを一覧表示します。たとえば、Staging という名前のラベルを作成し、ステージング リソースに関する情報を表示するダッシュボードにそのラベルを適用したとします。これらのダッシュボードを一覧表示するには、ラベル [Staging] を選択します。リストをさらに絞り込むには、 [フィルタ] バーを使用します。

    • フィルタバーにフィルタを追加します。

      • 名前または説明に特定のテキストを含むダッシュボードを一覧表示するには、そのテキストを [フィルタ] バーに入力します。

      • ダッシュボード フィールドの値でフィルタした後、ダッシュボードを一覧参照するには、次の操作を行います。

        1. [ダッシュボードを検索] を選択し、フィルタするフィールドを選択します。次のダッシュボード フィールドでフィルタできます。名前、説明、タイプ、ユーザー定義ラベル。

        2. フィルタの値を入力するか、メニューから選択します。

      • グラフのないダッシュボードを一覧表示するには、[ダッシュボードを検索]、[ラベル]、[(空)] の順に選択します。

      複数のフィルタを追加して、2 つのフィルタの間に OR 演算子を含めないと、AND 演算子によってフィルタが結合されます。

  4. ダッシュボードを見つけたら、選択します。

ダッシュボードのバージョン履歴を表示する

バージョン履歴を表示すると、ダッシュボードに加えられた変更内容を確認できます。バージョン履歴には、変更を加えたユーザーと変更回数が表示されます。ダッシュボードの以前のバージョンに戻すことも、差分を表示して以前のバージョンと現在のバージョンを比較することもできます。既存のダッシュボードの変更は 90 日間保持されますが、最新の変更は無期限に保持されます。

ダッシュボードのバージョン履歴を表示する手順は次のとおりです。

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

    [ダッシュボード] に移動

    このページを検索バーで検索する場合は、小見出しが「Monitoring」の結果を選択します。

  2. Google Cloud コンソールのツールバーで、 Google Cloud プロジェクトを選択します。App Hub 構成の場合は、App Hub ホスト プロジェクトまたはアプリ管理用フォルダの管理プロジェクトを選択します。

  3. ダッシュボードのツールバーで、 [設定] に移動し、[変更履歴を表示] を選択します。変更履歴パネルが開きます。

  4. 省略可: ダッシュボードの以前のバージョンを復元するには、リストからバージョンを選択して [元に戻す] ボタンをクリックします。ダッシュボードが再読み込みされ、以前のバージョンが表示されます。

ダッシュボードを変更する

ダッシュボードを作成した後、より便利にするために変更が必要になることがあります。たとえば、ウィジェットの追加や削除、レイアウトの変更、ウィジェットでのデータの表示方法の変更などを行うことができます。また、ダッシュボードを見つけやすくしたり、ダッシュボードのコンテンツの種類を示したりするために、ダッシュボードにラベルを追加することもできます。

ラベルを追加または削除します

ラベルを使用すると、表示されるコンテンツの種類に基づいてダッシュボードを探すことができます。たとえば、本番環境システムに関する情報を表示するダッシュボードにラベル prod を追加できます。同様に、ラベル staging を追加して、ダッシュボードにステージング システムに関する情報が表示されることを示します。次に、ダッシュボードを一覧表示するときに、ラベルを選択して、選択したラベルを含むダッシュボードのリストをフィルタできます。

ダッシュボードにユーザー定義のラベルを追加または削除する手順は次のとおりです。

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

    [ダッシュボード] に移動

    このページを検索バーで検索する場合は、小見出しが「Monitoring」の結果を選択します。

  2. Google Cloud コンソールのツールバーで、 Google Cloud プロジェクトを選択します。App Hub 構成の場合は、App Hub ホスト プロジェクトまたはアプリ管理用フォルダの管理プロジェクトを選択します。
  3. ダッシュボードのリストでダッシュボードを見つけて、 [ダッシュボードにラベルを追加] をクリックします。
  4. 次のいずれかを行います。
    • ラベルを作成してダッシュボードに追加するには、[新しいラベルを作成] セクションのテキスト ボックスにラベルの名前を入力し、[作成して適用] をクリックします。

    • ダッシュボードに追加するラベルを構成するには、 [適用するラベルを選択] をクリックし、ラベルを選択して [OK] をクリックします。
  5. 変更を保存するには、[確認] をクリックします。

ラベルの一覧表示、編集、削除を行うには、 [ラベルを管理] をクリックします。

フィルタと変数を追加または削除する

ダッシュボードを作成したら、フィルタと変数を追加できます。フィルタは、ダッシュボードのすべてのウィジェットに適用されます。変数は、ダッシュボードの一部のウィジェットに適用されます。フィルタと変数は、トラブルシューティングを行う際に役立ちます。たとえば、特定のゾーンのデータのみがダッシュボードに表示されるようにフィルタを設定できます。

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

    [ダッシュボード] に移動

    このページを検索バーで検索する場合は、小見出しが「Monitoring」の結果を選択します。

  2. Google Cloud コンソールのツールバーで、 Google Cloud プロジェクトを選択します。App Hub 構成の場合は、App Hub ホスト プロジェクトまたはアプリ管理用フォルダの管理プロジェクトを選択します。
  3. ダッシュボードを見つけて選択します。

    • 現在のセッションにのみ適用されるダッシュボード全体のフィルタを追加するには、ダッシュボードの フィルタバーを使用します。詳細については、一時フィルタをご覧ください。

    • 永続的なダッシュボード全体のフィルタを追加するには、ダッシュボード ツールバーで [設定] に移動し、[フィルタの管理] を選択します。詳細については、変数と固定フィルタの作成と管理をご覧ください。

ウィジェットを変更する、またはレイアウトを変更する

ダッシュボードのウィジェットやレイアウトを変更するには、次のいずれかの操作を行います。

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

    [ダッシュボード] に移動

    このページを検索バーで検索する場合は、小見出しが「Monitoring」の結果を選択します。

  2. Google Cloud コンソールのツールバーで、 Google Cloud プロジェクトを選択します。App Hub 構成の場合は、App Hub ホスト プロジェクトまたはアプリ管理用フォルダの管理プロジェクトを選択します。
  3. ダッシュボードを見つけて選択します。
  4. 省略可: ダッシュボードにウィジェットを追加するには、ダッシュボードのツールバーで [ウィジェットを追加] をクリックし、ウィジェットを選択して構成します。変更をダッシュボードに適用するには、ツールバーで [適用] をクリックします。変更を破棄するには、[キャンセル] をクリックします。

    詳しくは次のページをご覧ください。

  5. 省略可: ウィジェットを変更するには、次のいずれかを行います。

    • ウィジェットの上にポインタを置いてツールバーを有効にし、 [ウィジェットを編集] をクリックして、ウィジェットを更新します。変更をダッシュボードに適用するには、ツールバーで [適用] をクリックします。変更を破棄するには、[キャンセル] をクリックします。

      ウィジェットの種類など、ウィジェットのほとんどの設定は変更できます。たとえば、折れ線グラフを積み上げ面グラフに変換するには、[折れ線グラフ] をクリックして、メニューから [積み上げ面グラフ] を選択します。詳しくは、ウィジェットの種類を変更するをご覧ください。

    • [設定]、[JSON]、[JSON エディタ] の順にクリックします。JSON を変更した場合は、[変更を適用] をクリックする必要があります。

      ウィジェット ツールバーでウィジェットを編集し、 [コードを表示] をクリックして、ウィジェットの JSON にアクセスすることもできます。

  6. 省略可: ウィジェットを削除するには、ウィジェットにポインタを置いてツールバーを有効にし、次のいずれかを行います。

    • ウィジェットのツールバーに [削除] ボタンが表示されている場合は、このボタンをクリックします。
    • 削除する場合は、 [その他のオプション]、[ウィジェットを削除] の順にクリックします。

    変更をダッシュボードに適用するには、ツールバーで [適用] をクリックします。変更を破棄するには、[キャンセル] をクリックします。

  7. オプション: ウィジェットの位置を変更するには、ポインタを使用してウィジェットのヘッダーを新しい場所にドラッグします。変更をダッシュボードに適用するには、ツールバーで [適用] をクリックします。変更を破棄するには、[キャンセル] をクリックします。

    ダッシュボードがグリッドモードの場合、ウィジェットの位置を変更することはできません。

  8. オプション: ウィジェットのサイズを変更するには、ポインタを使用してウィジェットの右端の位置を変更します。変更をダッシュボードに適用するには、ツールバーで [適用] をクリックします。変更を破棄するには、[キャンセル] をクリックします。

    ダッシュボードがグリッドモードの場合、ウィジェットのサイズは変更できません。

  9. 変更したダッシュボードを保存するには、ツールバーで [保存] をクリックします。

ダッシュボードを削除する

アラート ポリシーのグラフを含むダッシュボードを削除しても、そのグラフにデータが表示されているアラート ポリシーは削除されません。したがって、ダッシュボードが削除された後に、これらのポリシーから通知が送信されることがあります。 Google Cloud コンソールの [アラート] ページで行うポリシー管理の方法については、アラート ポリシーを管理するをご覧ください。

カスタム ダッシュボードを削除する方法は次のとおりです。

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

    [ダッシュボード] に移動

    このページを検索バーで検索する場合は、小見出しが「Monitoring」の結果を選択します。

  2. Google Cloud コンソールのツールバーで、 Google Cloud プロジェクトを選択します。App Hub 構成の場合は、App Hub ホスト プロジェクトまたはアプリ管理用フォルダの管理プロジェクトを選択します。
  3. 削除操作を開始するには、削除するダッシュボードを見つけて、 [削除] をクリックします。
  4. 確認ダイアログで [削除] をクリックします。
  5. 変更したダッシュボードを保存するには、ツールバーで [保存] をクリックします。

ダッシュボードをテンプレートとしてローカル システムに保存する

チームや組織の他のユーザーがプロジェクトにインストールするカスタム ダッシュボードを作成しているとします。ダッシュボード テンプレートを共有する場合は、ローカル システムに保存して、テンプレートを共有ロケーションに移動またはコピーします。たとえば、テンプレートを共有ドライブや GitHub などのソースコード リポジトリにコピーできます。保存されたロケーションにアクセスできるユーザーは、ダッシュボードを自分の Google Cloud プロジェクトにインストールできます。

カスタム ダッシュボードのテンプレートをローカル システムに保存された JSON 形式のファイルに保存する手順は次のとおりです。

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

    [ダッシュボード] に移動

    このページを検索バーで検索する場合は、小見出しが「Monitoring」の結果を選択します。

  2. Google Cloud コンソールのツールバーで、 Google Cloud プロジェクトを選択します。App Hub 構成の場合は、App Hub ホスト プロジェクトまたはアプリ管理用フォルダの管理プロジェクトを選択します。
  3. ダッシュボード ツールバーで、 [設定] をクリックし、[JSON] をクリックしてから、[JSON エディタ] をクリックします。
  4. [ ファイルのダウンロード] をクリックします。

    作成されたファイル(ダッシュボードと同じ名前)には、ダッシュボードの JSON 表現が含まれています。このファイルはテンプレートにすぎず、時系列データは保存されません。

ダッシュボードを共有する

データ異常を調査する場合は、チーム内または組織内の別のユーザーに表示されている同じデータが表示されるようにしてください。たとえば、パフォーマンス指標が予期しない低下または急激に上昇した場合は、チームメイトに相談する必要があります。このシナリオでは、チームメイトにダッシュボードとそのデータを表示させます。

ダッシュボードへのリンクを共有する方法については、カスタム ダッシュボードを共有するをご覧ください。

データ更新を構成する

ダッシュボードを開くと、自動更新が無効になっている状態で構成されます。ツールバーには、この状態を切り替えるボタン が表示されます。

現在のセッションで自動更新を有効にするには、ツールバーに移動して 自動更新を有効にする)を選択します。

自動更新を有効にした後で無効にするには、ツールバーに移動して 自動更新を無効にする)を選択します。

構成変更の自動保存を有効にする

デフォルトではダッシュボードは変更内容を保存しません。自動保存を有効にするには、[自動保存] トグルが [オン] の位置になるまでクリックします。 [Cloud Done] が表示されたら、変更は保存されています。

次のステップ