Get the FREE Ultimate OpenClaw Setup Guide →

Monitoring Dashboards

npx machina-cli add skill yu-iskw/google-cloud-observability-plugin/monitoring-dashboards --openclaw
Files (1)
SKILL.md
842 B

Dashboards List

List custom and default dashboards in Cloud Monitoring.

Purpose

Identify high-level dashboards that may contain relevant visualizations for the current context.

Inputs

  • project (optional): The Google Cloud project ID to list dashboards from.
  • display_name (optional): Filter for dashboards with a matching display name (case-insensitive).

Behavior

  1. Execute gcloud monitoring dashboards list --project=[PROJECT] --format=json.
  2. If project is not provided, use the active project from gcp-context.
  3. If display_name is provided, filter the results in the CLI or script using --filter="displayName:[DISPLAY_NAME]".

Output

Returns a JSON list of dashboards.

References

Source

git clone https://github.com/yu-iskw/google-cloud-observability-plugin/blob/main/skills/monitoring-dashboards/SKILL.mdView on GitHub

Overview

Identify and access both custom and default dashboards in Cloud Monitoring. This helps surface high-level visualizations relevant to the current context. Filter by project and display name to focus your inventory.

How This Skill Works

The skill runs gcloud monitoring dashboards list with optional --project and --format=json. If a project isn't provided, it uses the active project from gcp-context. If display_name is provided, filter results using --filter=displayName:[DISPLAY_NAME].

When to Use It

  • Auditing available dashboards for a project to understand what is deployed.
  • Locating dashboards with specific visualizations when investigating an incident.
  • Onboarding new team members by surfacing the recommended dashboards.
  • Filtering dashboards by displayName to find a matched view quickly.
  • Automating dashboard inventory retrieval in scripts or CI workflows.

Quick Start

  1. Step 1: Install and authenticate the gcloud CLI.
  2. Step 2: Run gcloud monitoring dashboards list --project=[PROJECT] --format=json.
  3. Step 3: If needed, filter by displayName with --filter=displayName:[DISPLAY_NAME] and parse the JSON.

Best Practices

  • Query both custom and default dashboards to get a complete inventory.
  • Prefer --format=json for machine-readable output suitable for parsing.
  • Use --project and --filter to narrow results by displayName.
  • If the project is omitted, rely on the active gcp-context project.
  • Store or cache the JSON output for auditing or change-tracking.

Example Use Cases

  • List dashboards for a production project to verify dashboards are in place.
  • Filter dashboards by a displayName like 'Latency' to locate relevant views.
  • Export the list to JSON for dashboard governance and change logs.
  • Cross-check dashboards across multiple projects during an outage.
  • Script inventory of dashboards for automation and reporting.

Frequently Asked Questions

Add this skill to your agents
Sponsor this space

Reach thousands of developers