Observability Demo
Human verified
A human reviewed this page, but it may be out of date. Later edits may not have been reviewed.
Overview
Use Demo Observability Smoke to check the disposable monitoring chart and the Grafana views backed by fixture metrics and OpenTelemetry Protocol (OTLP) logs. The lane installs a real Kubernetes monitoring stack; its telemetry is test data.
Trigger
The workflow runs on pull requests and main pushes that match its path filters,
plus merge groups and manual dispatch. Filters cover the demo chart, its tests
and helpers, CI scripts/actions, and the lockfile; the workflow is the exact list.
It is separate from CI Required and is not a merge or publication gate.
Full Integration also selects this lane when all is requested.
Scenarios
| Setup and action | Expected outcome | Test source |
|---|---|---|
| Render the chart with supported release names and values that resemble YAML scalars. | Service names, identifiers, and Grafana URLs remain valid and aligned. | Chart tests. |
| Configure disposable Grafana storage and repeat installation after a cold-cache timeout. | SQLite stays off node disk and the documented installation can be rerun. | Chart tests. |
| Install the demo in k3d and send fixture telemetry. | Grafana's Prometheus connection returns fixture metrics; dashboards exist and log queries return expected events. | Kubernetes test. |
| Open the dashboard in Chromium, inspect log details, and apply a worker filter. | Navigation and displayed log records match the expected queries; screenshots record the rendered views. | Kubernetes test. |
Execution
For a hosted run, dispatch from the Actions page or the repository root:
gh workflow run observability-demo.yml --ref mainFor local reproduction, follow the
Kubernetes observability prerequisites
and use the shared lane preparation and cleanup
with k3d-observability-demo. The manifest requires a disposable context and
explicit monitoring images. Keep other clusters and the default kubeconfig intact.
Results and limits
Check Demo Observability Smoke, its demo-results lane artifacts, and
demo-log-dashboard. The dashboard upload retains PNGs and failure diagnostics
for seven days. A successful lane with missing dashboard artifacts fails upload;
setup failures do not create a second missing-artifact error.
This proves the demo's fixture ingestion and browser views, not production telemetry from a deployed Agent fleet. Inspect the images as well as the job conclusion when investigating rendering failures. Clean up run-owned resources through the lane procedure after local failures.
Files
- Workflow: exact triggers and artifact policy.
- Manifest: files, cases, images, and context requirements.
- Chart tests and Kubernetes test: scenario assertions.
- Demo helper: fixture stack and telemetry.
- Demo Helm chart: installed monitoring components.