Health Telemetry Reference
Health telemetry covers component availability — whether a component is running and stable. Every component must emit the health status gauge on a one-minute schedule.
All health signals are emitted via OpenTelemetry (OTel) Metrics to the TelemetryHub.
Version documented: rev1, June 2026 — aligned to the TPT metric specifications.
Configuration
| Field | Type | Default | Description |
|---|---|---|---|
endpoint |
String | "" |
OTLP endpoint URL |
isSecure |
bool | false |
Use HTTPS instead of HTTP |
exportIntervalSeconds |
int | 60 |
Recommended default |
enabled |
bool | false |
Enable/disable health metric export |
Common Resource Attributes
Included on all health metrics:
| Attribute | Type | Example | Description |
|---|---|---|---|
service.name |
String | hnr-msp-origin |
Component identifier — use the canonical Component Registry ID |
service.version |
String | 2.1.4 |
Deployed version |
service.instance.name |
String | hnr-origin-01 |
e.g. Hostname of the machine running the component |
deployment.environment |
String | hnr |
Testbed identifier |
health Metric
The mandatory status metric. Emitted by every component on a one-minute schedule. Latency priority: Highest — this signal is used by other components and dashboards to react to availability changes.
| Field | Value |
|---|---|
| Type | Gauge (integer-encoded enum) |
| Unit | {status} |
| Sample rate | 1m |
| Value | Meaning |
|---|---|
up |
Component is fully operational |
partial-up |
Component is running but degraded — some functions unavailable |
partial-down |
Component has significant failures but is partially responsive |
down |
Component is unavailable |