Install a dashboard template

Google Cloud console

To install a dashboard template by using the Google Cloud console, do the following:

1. In the Google Cloud console, go to the  Dashboards page:

   Go to Dashboards

   If you use the search bar to find this page, then select the result whose subheading is Monitoring.

2. In the toolbar of the Google Cloud console, select your Google Cloud project. For App Hub configurations, select the App Hub host project or the app-enabled folder's management project.

3. Do one of the following:

   • To install a template from the library available in the Google Cloud console, do the following:

     1. Click Dashboard Templates.
     2. Find the dashboard that you want to install.
     3. Optional: To preview the dashboard, select it.

     4. Click playlist_add Add dashboard to your list and then complete the dialog.

        The dialog lets you select the name of the dashboard, and add labels to the dashboard.

   • To install a dashboard by uploading a JSON file, do the following:

     1. Optional: To install a curated dashboard template, download the GitHub repository:

        git clone https://github.com/GoogleCloudPlatform/monitoring-dashboard-samples.git

     2. Click Create Dashboard.

     3. In the dashboard toolbar, settings Settings, then JSON, and then select JSON Editor.

        For a new dashboard, the displayed code is similar to the following:

        {
        "displayName": "New Dashboard",
        "mosaicLayout": {
           "columns": 12,
           "tiles": []
        },
        "dashboardFilters": [],
        "labels": {}
        }
        

     4. In the editor's toolbar, click File Upload.

     5. Select the file that contains the template and then click Open.

        After the file is uploaded, the dashboard's JSON is updated.

        If you see the following message, "Unable to save dashboard: Field mosaicLayout.tiles[0] has an invalid value", then select Grid in the dashboard toolbar.

     6. Optional: Customize the dashboard. For example, you can update the title, add a text widget that indicates the dashboard source, delete unwanted charts, or add charts.

     7. To save your modified dashboard, in the toolbar, click Save.

gcloud CLI

To install a dashboard definition by using the Google Cloud CLI, do the following:

1. Ensure the dashboard definition is accessible to your local system.

   For dashboards stored in the GitHub repository, you can save specific dashboards, or you can download the entire repository:

   git clone https://github.com/GoogleCloudPlatform/monitoring-dashboard-samples.git
   

2. Identify the dashboards you want to install.

   For example, in the GitHub repository, the directory monitoring-dashboard-samples/dashboards/compute contains a file named gce-vm-instance-monitoring.json.

3. Issue the gcloud monitoring dashboards create command and provide the JSON representation of the dashboard.

   For example, to install the dashboard gce-vm-instance-monitoring.json, issue the following command:

   gcloud monitoring dashboards create --config-from-file=gce-vm-instance-monitoring.json --project=PROJECT_ID
   

   Before you run the previous command, replace the following:

   • PROJECT_ID: The identifier of the project. For App Hub configurations, select the App Hub host project or the app-enabled folder's management project.

Cloud Monitoring API

To install a dashboard definition by using the Google Cloud CLI, do the following:

1. Ensure the dashboard definition is accessible to your local system.

   For dashboards stored in the GitHub repository, you can save specific dashboards, or you can download the entire repository:

   git clone https://github.com/GoogleCloudPlatform/monitoring-dashboard-samples.git
   

2. Identify the dashboards you want to install.

   For example, in the GitHub repository, the directory monitoring-dashboard-samples/dashboards/compute contains a file named gce-vm-instance-monitoring.json.

3. Call dashboards.create and provide the JSON representation of the dashboard. In the API call, the parent is the project in which to create the synthetic monitor. For App Hub configurations, select the App Hub host project or the app-enabled folder's management project. This field has the following format:

   projects/PROJECT_ID
   

For more information, see Create and manage dashboards.