From 94fabf7fc82ab285a243245b4037412308b75932 Mon Sep 17 00:00:00 2001 From: Tyler Yahn Date: Fri, 23 Feb 2024 05:32:54 -0800 Subject: [PATCH] [editorial] Remove implementation specific specification from metric API (#3890) The api.md document specifies the Metric API, it does not defined the OpenTelemetry defined implementations of this API. Remove or correct the details within this API and leave it for the implementation specification to define. Importantly, the API is decoupled from implementation for a reason. Third-party implementation may exists that OTel does not have domain over. This document needs to written with that in mind. Related to https://github.com/open-telemetry/opentelemetry-specification/pull/3171 and https://github.com/open-telemetry/opentelemetry-specification/issues/3071. --- CHANGELOG.md | 3 +++ specification/metrics/api.md | 23 ++++++++++------------- 2 files changed, 13 insertions(+), 13 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 7d2589048d0..39270b98039 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -13,6 +13,9 @@ release. ### Metrics +- Remove implementation specific specification from metric API. + ([#3890](https://github.com/open-telemetry/opentelemetry-specification/pull/3890)) + ### Logs ### Resource diff --git a/specification/metrics/api.md b/specification/metrics/api.md index 600dcd2c387..3a857307940 100644 --- a/specification/metrics/api.md +++ b/specification/metrics/api.md @@ -103,9 +103,6 @@ the metrics API: `Meter`s can be accessed with a `MeterProvider`. -In implementations of the API, the `MeterProvider` is expected to be the -stateful object that holds any configuration. - Normally, the `MeterProvider` is expected to be accessed from a central place. Thus, the API SHOULD provide a way to set/register and access a global default `MeterProvider`. @@ -599,9 +596,9 @@ language idiomatic name(s), for example `CreateUInt64ObservableCounter`, `CreateDoubleObservableCounter`, `CreateObservableCounter`, `CreateObservableCounter`. -It is highly recommended that implementations use the name `ObservableCounter` -(or any language idiomatic variation, e.g. `observable_counter`) unless there is -a strong reason not to do so. Please note that the name has nothing to do with +It is highly recommended that the name `ObservableCounter` (or any language +idiomatic variation, e.g. `observable_counter`) be used unless there is a +strong reason not to do so. Please note that the name has nothing to do with [asynchronous pattern](https://en.wikipedia.org/wiki/Asynchronous_method_invocation) and [observer pattern](https://en.wikipedia.org/wiki/Observer_pattern). @@ -922,9 +919,9 @@ idiomatic name(s), for example `CreateUInt64ObservableGauge`, `CreateDoubleObservableGauge`, `CreateObservableGauge`, `CreateObservableGauge`. -It is highly recommended that implementations use the name `ObservableGauge` -(or any language idiomatic variation, e.g. `observable_gauge`) unless there is -a strong reason not to do so. Please note that the name has nothing to do with +It is highly recommended that the name `ObservableGauge` (or any language +idiomatic variation, e.g. `observable_gauge`) be used unless there is a strong +reason not to do so. Please note that the name has nothing to do with [asynchronous pattern](https://en.wikipedia.org/wiki/Asynchronous_method_invocation) and [observer pattern](https://en.wikipedia.org/wiki/Observer_pattern). @@ -1165,10 +1162,10 @@ decide the language idiomatic name(s), for example `CreateObservableUpDownCounter`, `CreateObservableUpDownCounter`. -It is highly recommended that implementations use the name -`ObservableUpDownCounter` (or any language idiomatic variation, e.g. -`observable_up_down_counter`) unless there is a strong reason not to do so. Please -note that the name has nothing to do with [asynchronous +It is highly recommended that the name `ObservableUpDownCounter` (or any +language idiomatic variation, e.g. `observable_up_down_counter`) be used unless +there is a strong reason not to do so. Please note that the name has nothing to +do with [asynchronous pattern](https://en.wikipedia.org/wiki/Asynchronous_method_invocation) and [observer pattern](https://en.wikipedia.org/wiki/Observer_pattern).