Resources / MonitoringDashboard
MonitoringDashboard
A real-time Monitoring dashboard over TelemetryStreams (spec 0042).
Overview
| API | monitoring.etorm.com/v1alpha1 |
| Resource | monitoringdashboards (cluster-scoped inside its cluster) |
| Short names | mondash |
| Available in | project clusters only |
| Status | written by a controller through /status |
Minimal example
apiVersion: monitoring.etorm.com/v1alpha1
kind: MonitoringDashboard
metadata:
name: example
spec:
workspaceRef:
name: "<name>"
title: "<title>"
Spec
| Field | Type | Required | Default | Allowed | Description |
workspaceRef | reference to MonitoringWorkspace | yes | | | Target MonitoringWorkspace. |
title | string | yes | | length 1 to 128 | Dashboard title. |
refreshSeconds | integer | | 5 | 1 to 300 | Auto-refresh interval in seconds. |
panels | list of object | | | | Visualization panels. |
panels[].title | string | yes | | | Panel title. |
panels[].kind | string (one of) | yes | | timeseries, logs, traces, network-map, stat | Panel visualization type. |
panels[].streamRef | string | yes | | | Target TelemetryStream name. |
panels[].query | string | yes | | | Panel query. |
Status
| Field | Type | Required | Default | Allowed | Description |
phase | string | | | | Pending or Ready. |
conditions | list of object | | | | Status conditions. |
conditions[].type | string | | | | Condition type. |
conditions[].status | string | | | | True or False. |
conditions[].reason | string | | | | Machine-readable reason. |
conditions[].message | string | | | | Human-readable detail. |
Columns in listings
| Column | From |
|---|
| Title | .spec.title |
| Refresh | .spec.refreshSeconds |
| Phase | .status.phase |
All resources