gcloud alpha monitoring dashboards create

NAME

gcloud alpha monitoring dashboards create - create a new Cloud Monitoring dashboard

SYNOPSIS

gcloud alpha monitoring dashboards create (--config=CONFIG     | --config-from-file=PATH_TO_FILE) [--validate-only] [GCLOUD_WIDE_FLAG …]

DESCRIPTION

(ALPHA) Create a new Monitoring dashboard. A dashboard can be specified as a JSON/YAML value passed in as a string through the --config flag or as a file through the --config-from-file flag. Validate a dashboard config without saving by setting the --validate-only flag.

For information about the format of a dashboard: https://cloud.google.com/monitoring/api/ref_v3/rest/v1/projects.dashboards

EXAMPLES

To create a dashboard with a YAML config, run:

gcloud alpha monitoring dashboards create --config='''
  displayName: New Dashboard
  gridLayout:
    widgets:
    - text:
        content: Hello World
  '''

To validate a dashboard and not save it, run:

gcloud alpha monitoring dashboards create --validate-only --config='''
  displayName: New Dashboard
  gridLayout:
    widgets:
    - text:
        content: Hello World
  '''

To create a dashboard with a JSON config, run:

gcloud alpha monitoring dashboards create --config='''
  {
    "displayName": "New Dashboard",
    "gridLayout": {
      "widgets": [
        {
          "text": {
            "content": "Hello World",
          }
        }
      ]
    },
  }
  '''

To create a dashboard with a specific dashboard ID, run:

gcloud alpha monitoring dashboards create --config='''
  name: projects/MY-PROJECT/dashboards/MY-DASHBOARD
  displayName: New Dashboard
  gridLayout:
    widgets:
    - text:
        content: Hello World
  '''

To create a dashboard within a specific project, run:

gcloud alpha monitoring dashboards create --project=MY-PROJECT --config='''
  displayName: New Dashboard
  gridLayout:
    widgets:
    - text:
        content: Hello World
  '''

To create a dashboard with a file, run:

gcloud alpha monitoring dashboards create --config-from-file=MY-FILE

Sample contents of MY-FILE:

displayName: New Dashboard
gridLayout:
  widgets:
  - text:
      content: Hello World

REQUIRED FLAGS

Exactly one of these must be specified:

--config=CONFIG

Dashboard configuration, in either JSON or YAML format, as a string.

--config-from-file=PATH_TO_FILE

Path to a JSON or YAML file containing the dashboard configuration. Use a full or relative path to a local file containing the value of config.

OPTIONAL FLAGS

--validate-only

When set, validate the dashboard but do not save it.

GCLOUD WIDE FLAGS

These flags are available to all commands: --access-token-file, --account, --billing-project, --configuration, --flags-file, --flatten, --format, --help, --impersonate-service-account, --log-http, --project, --quiet, --trace-token, --user-output-enabled, --verbosity.

Run $ gcloud help for details.

API REFERENCE

This command uses the monitoring/v1 API. The full documentation for this API can be found at: https://cloud.google.com/monitoring/api/

NOTES

This command is currently in alpha and might change without notice. If this command fails with API permission errors despite specifying the correct project, you might be trying to access an API with an invitation-only early access allowlist. These variants are also available:

gcloud monitoring dashboards create

gcloud beta monitoring dashboards create