diff --git a/CHANGELOG.md b/CHANGELOG.md index c0dfeb3401d..641e18a4b1f 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -9,6 +9,8 @@ release. New: +- Semantic conventions for `up` metric on Resources. + ([#1102](https://github.com/open-telemetry/opentelemetry-specification/pull/1102)) - Add performance benchmark specification ([#748](https://github.com/open-telemetry/opentelemetry-specification/pull/748)) - Enforce that the Baggage API must be fully functional, even without an installed SDK. diff --git a/specification/metrics/semantic_conventions/resource-metrics.md b/specification/metrics/semantic_conventions/resource-metrics.md new file mode 100644 index 00000000000..b20b3d785ff --- /dev/null +++ b/specification/metrics/semantic_conventions/resource-metrics.md @@ -0,0 +1,18 @@ +# Semantic conventions for Resource metrics + +This document describes metrics created about [Resources](../../resource/sdk.md), the entities +producing telemetry in a system. + +## Labels + +The current Resource metrics do not have any explicit labels. They SHOULD inherit the [attributes +of the encapsulating](../../resource/semantic_conventions/README.md) Resource when being exported. + +## Metric Instruments + +The following metric instruments SHOULD be synthesized every time a Resource produces some +telemetry. + +| Name | Instrument | Units | Description | +|----------------------|---------------|--------------|-------------| +| `resource.up` | UpDownSumObserver | 1 | A value of `1` indicates the Resource is healthy, `0` if the Resource is unhealthy. |