clarify that enabled applies to synchronous instruments

The Enabled API is only to be applied to synchronous instruments. Fix open-telemetry#4200 Signed-off-by: Alex Boten <[email protected]>
codeboten · Sep 12, 2024 · 8cab133 · 8cab133
1 parent 7a5ff20
commit 8cab133
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 1 deletion.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -19,6 +19,8 @@ release.
 
 ### Metrics
 
+- Clarify that `Enabled` only applies to synchronous instruments.
+
 ### Logs
 
 - Clarify that log record mutations are visible in next registered processors.

diff --git a/specification/metrics/api.md b/specification/metrics/api.md
@@ -486,7 +486,8 @@ All instruments SHOULD provide functions to:
 **Status**: [Development](../document-status.md)
 
 To help users avoid performing computationally expensive operations when
-recording measurements, instruments SHOULD provide this `Enabled` API.
+recording measurements, [synchronous Instrument](#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