Skip to content

feat(observability): add runner VM hostmetrics Grafana dashboard #187

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
cbartz wants to merge 3 commits into
base: main
Choose a base branch
from
+1,178 −3
Draft

feat(observability): add runner VM hostmetrics Grafana dashboard #187

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ef7f2e5
feat(observability): add runner VM hostmetrics Grafana dashboard
cbartz Apr 23, 2026
c4dc6df
docs: document observability layout and rename dashboard directory
cbartz Apr 23, 2026
44d577e
fix: align dashboard labels with OTel config from github-runner-operator
cbartz Apr 24, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 33 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,39 @@
# GitHub runner operators


![WIP](https://img.shields.io/badge/status-WIP-yellow)

A monorepo containing charms to operate Self-Hosted GitHub Action Runners.

At the moment, it contains initial code for the `webhook-gateway`
application, that receives and forwards GitHub webhooks to an AMQP queue.
## Repository layout

```
charms/
planner-operator/ # Juju charm: GitHub runner planner
cos_custom/
grafana_dashboards/ # Grafana dashboards for the planner charm
# (served via cos-configuration-k8s, path: charms/planner-operator/cos_custom/grafana_dashboards)
webhook-gateway-operator/ # Juju charm: GitHub webhook gateway

runner_grafana_dashboards/ # Grafana dashboards for runner VM host metrics
# (served via cos-configuration-k8s, path: runner_grafana_dashboards)
```

## Observability: Grafana dashboards

Dashboards in this repo are delivered to Grafana through
[`cos-configuration-k8s`](https://charmhub.io/cos-configuration-k8s), which syncs
JSON files from this Git repository and provisions them via the `grafana-dashboard`
relation. Provisioned dashboards are **immutable** in Grafana regardless of user
role — they cannot be edited or deleted through the UI.

### Conventions

| Directory | Purpose | `grafana_dashboards_path` config value |
|---|---|---|
| `charms/<charm>/cos_custom/grafana_dashboards/` | Dashboards for a specific charm's workload metrics | `charms/<charm>/cos_custom/grafana_dashboards` |
| `runner_grafana_dashboards/` | Dashboards for runner VM host-level metrics (CPU, memory, disk, network) | `runner_grafana_dashboards` |

Dashboard JSON files must use `__inputs` to declare the datasource (type `prometheus`) and
set `"editable": false`. Metric names follow the
[OpenTelemetry hostmetrics receiver](https://opentelemetry.io/docs/collector/components/#receiver)
Prometheus naming convention (e.g. `system_cpu_time_seconds_total`).
Loading
Loading