Available on the Enterprise plan. Contact sales to learn more.
terraform-google-ona-runner repository under the monitoring/ directory and are designed to work with the Prometheus metrics your runner already exposes.
Before using these alerts and dashboards, you need to configure metrics collection on your runner. See Custom metrics pipeline for setup instructions.
Prerequisites
- A deployed GCP Runner with metrics collection enabled
- A Grafana instance (or compatible alerting system) connected to your Prometheus data source
Dashboard
The repository includes a Grafana dashboard atmonitoring/dashboards/gitpod-runner-overview.json.
What it covers
The dashboard uses template variables (
$project_id, $region, $runner_name, $instance) so you can filter by deployment.
Import the dashboard
- In Grafana, go to Dashboards → Import
- Upload
gitpod-runner-overview.jsonfrom the repository - Select your Prometheus data source
- Configure the template variables to match your deployment
Alerts
The repository includes 19 alert definitions atmonitoring/alerts/, each in its own folder with an alert.yaml (Grafana-compatible alert rule) and a runbook.md (troubleshooting steps).
Alert overview
Critical — immediate response required
These indicate a service outage or severe degradation.High — prompt attention required
These indicate degraded performance or functionality.Medium — monitor and track
These indicate reduced capacity or resource constraints.Info — optimization opportunities
Import alerts into Grafana
Each alert folder contains analert.yaml file:
- In Grafana, go to Alerting → Alert Rules
- Click Import
- Upload the
alert.yamlfrom the alert folder you want (e.g.,service-down/alert.yaml) - Configure notification channels for the alert’s severity level
Customize thresholds
The default thresholds work for most deployments. Adjust them based on your scale:- Smaller deployments may need lower thresholds to catch issues earlier
- Larger deployments may need higher thresholds to reduce noise
- Development environments may want less sensitive alerts
Runbooks
Each alert folder also contains arunbook.md with step-by-step troubleshooting instructions. Before using a runbook, set up these environment variables:
gcloud compute ssh commands to inspect the runner instance and include resolution steps and escalation procedures.
Notification channels
Configure notification channels in Grafana based on alert severity:Next steps
- Custom metrics pipeline — Enable metrics collection and see all available metrics
- Troubleshooting GCP Runners — Diagnose common runner issues
monitoring/on GitHub — Browse alert definitions and dashboard source