From 79af5d1ad67cf5dca0fb5727a5f4dc68ded87ce5 Mon Sep 17 00:00:00 2001 From: Alex Boten <223565+codeboten@users.noreply.github.com> Date: Thu, 19 Sep 2024 16:30:08 -0700 Subject: [PATCH 1/4] Mark Enabled API for synchronous instruments stable This marks the API stable. Fixes #4215 Signed-off-by: Alex Boten <223565+codeboten@users.noreply.github.com> --- CHANGELOG.md | 2 ++ spec-compliance-matrix.md | 1 + specification/metrics/api.md | 2 +- 3 files changed, 4 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 77101cf7801..8d9b8d48fe7 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -17,6 +17,8 @@ release. ([#4188](https://github.com/open-telemetry/opentelemetry-specification/pull/4188)) - Clarify that `Enabled` only applies to synchronous instruments. ([#4211](https://github.com/open-telemetry/opentelemetry-specification/pull/4211)) +- Mark the `Enabled` method as stable. + ([]()) ### Logs diff --git a/spec-compliance-matrix.md b/spec-compliance-matrix.md index 790875d9e32..7f5203650b2 100644 --- a/spec-compliance-matrix.md +++ b/spec-compliance-matrix.md @@ -126,6 +126,7 @@ formats is required. Implementing more than one format is optional. | Instrument descriptions conform to the specified syntax. | | - | + | | - | | - | | | - | + | | | Instrument supports the advisory ExplicitBucketBoundaries parameter. | | | + | | | | + | | | | | | | Instrument supports the advisory Attributes parameter. | | | + | | | | - | | | | | | +| Synchronous instruments supports the Enabled method. | | | | | | | | | | | | | | All methods of `MeterProvider` are safe to be called concurrently. | | + | + | + | - | | + | | | + | + | | | All methods of `Meter` are safe to be called concurrently. | | + | + | + | - | | + | | | + | + | | | All methods of any instrument are safe to be called concurrently. | | + | + | + | - | | + | | | + | + | | diff --git a/specification/metrics/api.md b/specification/metrics/api.md index 28069f60fdb..558fc9fae0e 100644 --- a/specification/metrics/api.md +++ b/specification/metrics/api.md @@ -483,7 +483,7 @@ All instruments SHOULD provide functions to: #### Enabled -**Status**: [Development](../document-status.md) +**Status**: [Stable](../document-status.md) To help users avoid performing computationally expensive operations when recording measurements, [synchronous Instruments](#synchronous-instrument-api) From 5b475ddaab381079c3799307cf440932775563d1 Mon Sep 17 00:00:00 2001 From: Alex Boten <223565+codeboten@users.noreply.github.com> Date: Mon, 23 Sep 2024 10:41:59 -0700 Subject: [PATCH 2/4] Update CHANGELOG.md --- CHANGELOG.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 8d9b8d48fe7..ff18ba32cd9 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -18,7 +18,7 @@ release. - Clarify that `Enabled` only applies to synchronous instruments. ([#4211](https://github.com/open-telemetry/opentelemetry-specification/pull/4211)) - Mark the `Enabled` method as stable. - ([]()) + ([#4219](https://github.com/open-telemetry/opentelemetry-specification/pull/4219)) ### Logs From d213db023e3f249e61b626aefa691b665b75b349 Mon Sep 17 00:00:00 2001 From: Alex Boten <223565+codeboten@users.noreply.github.com> Date: Mon, 23 Sep 2024 10:49:01 -0700 Subject: [PATCH 3/4] update matrix to include separate line for api/sdk Signed-off-by: Alex Boten <223565+codeboten@users.noreply.github.com> --- spec-compliance-matrix.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/spec-compliance-matrix.md b/spec-compliance-matrix.md index 7f5203650b2..f9271fb5a81 100644 --- a/spec-compliance-matrix.md +++ b/spec-compliance-matrix.md @@ -126,7 +126,8 @@ formats is required. Implementing more than one format is optional. | Instrument descriptions conform to the specified syntax. | | - | + | | - | | - | | | - | + | | | Instrument supports the advisory ExplicitBucketBoundaries parameter. | | | + | | | | + | | | | | | | Instrument supports the advisory Attributes parameter. | | | + | | | | - | | | | | | -| Synchronous instruments supports the Enabled method. | | | | | | | | | | | | | +| Instrument API supports Enabled method and returns false when there is no SDK enabled. | | | | | | | | | | | | | +| SDK implementation supports Enabled method and returns false based on View, MeterConfig etc. | | | | | | | | | | | | | | All methods of `MeterProvider` are safe to be called concurrently. | | + | + | + | - | | + | | | + | + | | | All methods of `Meter` are safe to be called concurrently. | | + | + | + | - | | + | | | + | + | | | All methods of any instrument are safe to be called concurrently. | | + | + | + | - | | + | | | + | + | | From a4dae0b55420849b8a91ca4bc454dc8189096852 Mon Sep 17 00:00:00 2001 From: Alex Boten <223565+codeboten@users.noreply.github.com> Date: Mon, 7 Oct 2024 14:47:12 -0700 Subject: [PATCH 4/4] remove paragraph about adding parameters in the future Signed-off-by: Alex Boten <223565+codeboten@users.noreply.github.com> --- specification/metrics/api.md | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/specification/metrics/api.md b/specification/metrics/api.md index fd746269c9d..218121de379 100644 --- a/specification/metrics/api.md +++ b/specification/metrics/api.md @@ -483,9 +483,7 @@ To help users avoid performing computationally expensive operations when recording measurements, [synchronous Instruments](#synchronous-instrument-api) SHOULD provide this `Enabled` API. -There are currently no required parameters for this API. Parameters can be -added in the future, therefore, the API MUST be structured in a way for -parameters to be added. +There are currently no required parameters for this API. This API MUST return a language idiomatic boolean type. A returned value of `true` means the instrument is enabled for the provided arguments, and a returned