From 96e6c5b267bfa26ac4528d5e8e484d19b7dd5e09 Mon Sep 17 00:00:00 2001 From: Chris Wildman Date: Thu, 15 Oct 2020 10:43:59 -0700 Subject: [PATCH 1/5] Semantic conventions for `up` metric on Resources. #1078 --- .../semantic_conventions/resource-metrics.md | 22 +++++++++++++++++++ 1 file changed, 22 insertions(+) create mode 100644 specification/metrics/semantic_conventions/resource-metrics.md diff --git a/specification/metrics/semantic_conventions/resource-metrics.md b/specification/metrics/semantic_conventions/resource-metrics.md new file mode 100644 index 00000000000..94a2ae6fd88 --- /dev/null +++ b/specification/metrics/semantic_conventions/resource-metrics.md @@ -0,0 +1,22 @@ +# Semantic conventions for Resource metrics + +This document describes metrics created about [Resources](../../resource/sdk.md), the entities +producing telemetry in a system. + +**Disclaimer:** These are initial Resource metric instruments and labels, more may be added + in the future. + +## 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` | ValueRecorder | yes/no | A value of `1` indicates the Resource is healthy, `0` if the Resource is unhealthy. | + From c237741a9302306b21d0b079c4758bb2249a4a4c Mon Sep 17 00:00:00 2001 From: Chris Wildman Date: Fri, 16 Oct 2020 10:23:13 -0700 Subject: [PATCH 2/5] CHANGELOG --- CHANGELOG.md | 2 ++ 1 file changed, 2 insertions(+) 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. From 6e9f8ca5301e0851329b93fc966bdb1e0b688aa6 Mon Sep 17 00:00:00 2001 From: Chris Wildman Date: Mon, 19 Oct 2020 14:19:07 -0700 Subject: [PATCH 3/5] PR feedback. --- .../metrics/semantic_conventions/resource-metrics.md | 7 ++----- 1 file changed, 2 insertions(+), 5 deletions(-) diff --git a/specification/metrics/semantic_conventions/resource-metrics.md b/specification/metrics/semantic_conventions/resource-metrics.md index 94a2ae6fd88..2162e113537 100644 --- a/specification/metrics/semantic_conventions/resource-metrics.md +++ b/specification/metrics/semantic_conventions/resource-metrics.md @@ -1,10 +1,7 @@ # Semantic conventions for Resource metrics This document describes metrics created about [Resources](../../resource/sdk.md), the entities -producing telemetry in a system. - -**Disclaimer:** These are initial Resource metric instruments and labels, more may be added - in the future. +producing telemetry in a system. ## Labels @@ -18,5 +15,5 @@ telemetry. | Name | Instrument | Units | Description | |----------------------|---------------|--------------|-------------| -| `resource.up` | ValueRecorder | yes/no | A value of `1` indicates the Resource is healthy, `0` if the Resource is unhealthy. | +| `resource.up` | ValueRecorder | 1 | A value of `1` indicates the Resource is healthy, `0` if the Resource is unhealthy. | From 9cffe4b016bd5eb80b1943262785767218004d72 Mon Sep 17 00:00:00 2001 From: Chris Wildman Date: Mon, 19 Oct 2020 14:22:37 -0700 Subject: [PATCH 4/5] Remove extra line break. --- specification/metrics/semantic_conventions/resource-metrics.md | 1 - 1 file changed, 1 deletion(-) diff --git a/specification/metrics/semantic_conventions/resource-metrics.md b/specification/metrics/semantic_conventions/resource-metrics.md index 2162e113537..6123934839e 100644 --- a/specification/metrics/semantic_conventions/resource-metrics.md +++ b/specification/metrics/semantic_conventions/resource-metrics.md @@ -16,4 +16,3 @@ telemetry. | Name | Instrument | Units | Description | |----------------------|---------------|--------------|-------------| | `resource.up` | ValueRecorder | 1 | A value of `1` indicates the Resource is healthy, `0` if the Resource is unhealthy. | - From 94ef57ba5430258e0080a0174b5a8a9b80c1ed6e Mon Sep 17 00:00:00 2001 From: Chris Wildman Date: Thu, 12 Nov 2020 11:03:11 -0800 Subject: [PATCH 5/5] Switch to UpDownSumObserver. --- specification/metrics/semantic_conventions/resource-metrics.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/specification/metrics/semantic_conventions/resource-metrics.md b/specification/metrics/semantic_conventions/resource-metrics.md index 6123934839e..b20b3d785ff 100644 --- a/specification/metrics/semantic_conventions/resource-metrics.md +++ b/specification/metrics/semantic_conventions/resource-metrics.md @@ -15,4 +15,4 @@ telemetry. | Name | Instrument | Units | Description | |----------------------|---------------|--------------|-------------| -| `resource.up` | ValueRecorder | 1 | A value of `1` indicates the Resource is healthy, `0` if the Resource is unhealthy. | +| `resource.up` | UpDownSumObserver | 1 | A value of `1` indicates the Resource is healthy, `0` if the Resource is unhealthy. |