diff --git a/docs/assets/monitoring-dashboard-logs.png b/docs/assets/monitoring-dashboard-logs.png new file mode 100644 index 0000000000..e0d36ad327 Binary files /dev/null and b/docs/assets/monitoring-dashboard-logs.png differ diff --git a/docs/assets/monitoring-dashboard-metrics.png b/docs/assets/monitoring-dashboard-metrics.png new file mode 100644 index 0000000000..7a4a1e221e Binary files /dev/null and b/docs/assets/monitoring-dashboard-metrics.png differ diff --git a/docs/assets/monitoring-dashboard-overview.png b/docs/assets/monitoring-dashboard-overview.png new file mode 100644 index 0000000000..d84f214766 Binary files /dev/null and b/docs/assets/monitoring-dashboard-overview.png differ diff --git a/docs/cli/telemetry.md b/docs/cli/telemetry.md index 4e0ceb0f94..df59b2fcff 100644 --- a/docs/cli/telemetry.md +++ b/docs/cli/telemetry.md @@ -8,8 +8,10 @@ Learn how to enable and setup OpenTelemetry for Gemini CLI. - [Configuration](#configuration) - [Google Cloud telemetry](#google-cloud-telemetry) - [Prerequisites](#prerequisites) + - [Authenticating with CLI Credentials](#authenticating-with-cli-credentials) - [Direct export (recommended)](#direct-export-recommended) - [Collector-based export (advanced)](#collector-based-export-advanced) + - [Monitoring Dashboards](#monitoring-dashboards) - [Local telemetry](#local-telemetry) - [File-based output (recommended)](#file-based-output-recommended) - [Collector-based export (advanced)](#collector-based-export-advanced-1) @@ -213,6 +215,24 @@ forward data to Google Cloud. - Open `~/.gemini/tmp//otel/collector-gcp.log` to view local collector logs. +### Monitoring Dashboards + +Gemini CLI provides a pre-configured +[Google Cloud Monitoring](https://cloud.google.com/monitoring) dashboard to +visualize your telemetry. + +This dashboard can be found under **Google Cloud Monitoring Dashboard +Templates** as "**Gemini CLI Monitoring**". + +![Gemini CLI Monitoring Dashboard Overview](../assets/monitoring-dashboard-overview.png) + +![Gemini CLI Monitoring Dashboard Metrics](../assets/monitoring-dashboard-metrics.png) + +![Gemini CLI Monitoring Dashboard Logs](../assets/monitoring-dashboard-logs.png) + +To learn more, check out this blog post: +[Instant insights: Gemini CLI’s new pre-configured monitoring dashboards](https://cloud.google.com/blog/topics/developers-practitioners/instant-insights-gemini-clis-new-pre-configured-monitoring-dashboards/). + ## Local telemetry For local development and debugging, you can capture telemetry data locally: