Skip to content

Commit 35f6fd5

Browse files
authored
[editorial] Remove implementation specific specification from metric API (open-telemetry#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 open-telemetry#3171 and open-telemetry#3071.
1 parent 793698e commit 35f6fd5

File tree

2 files changed

+13
-13
lines changed

2 files changed

+13
-13
lines changed

CHANGELOG.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,9 @@ release.
1313

1414
### Metrics
1515

16+
- Remove implementation specific specification from metric API.
17+
([#3890](https://github.com/open-telemetry/opentelemetry-specification/pull/3890))
18+
1619
### Logs
1720

1821
### Resource

specification/metrics/api.md

Lines changed: 10 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -103,9 +103,6 @@ the metrics API:
103103

104104
`Meter`s can be accessed with a `MeterProvider`.
105105

106-
In implementations of the API, the `MeterProvider` is expected to be the
107-
stateful object that holds any configuration.
108-
109106
Normally, the `MeterProvider` is expected to be accessed from a central place.
110107
Thus, the API SHOULD provide a way to set/register and access a global default
111108
`MeterProvider`.
@@ -599,9 +596,9 @@ language idiomatic name(s), for example `CreateUInt64ObservableCounter`,
599596
`CreateDoubleObservableCounter`, `CreateObservableCounter<UInt64>`,
600597
`CreateObservableCounter<double>`.
601598

602-
It is highly recommended that implementations use the name `ObservableCounter`
603-
(or any language idiomatic variation, e.g. `observable_counter`) unless there is
604-
a strong reason not to do so. Please note that the name has nothing to do with
599+
It is highly recommended that the name `ObservableCounter` (or any language
600+
idiomatic variation, e.g. `observable_counter`) be used unless there is a
601+
strong reason not to do so. Please note that the name has nothing to do with
605602
[asynchronous
606603
pattern](https://en.wikipedia.org/wiki/Asynchronous_method_invocation) and
607604
[observer pattern](https://en.wikipedia.org/wiki/Observer_pattern).
@@ -922,9 +919,9 @@ idiomatic name(s), for example `CreateUInt64ObservableGauge`,
922919
`CreateDoubleObservableGauge`, `CreateObservableGauge<UInt64>`,
923920
`CreateObservableGauge<double>`.
924921

925-
It is highly recommended that implementations use the name `ObservableGauge`
926-
(or any language idiomatic variation, e.g. `observable_gauge`) unless there is
927-
a strong reason not to do so. Please note that the name has nothing to do with
922+
It is highly recommended that the name `ObservableGauge` (or any language
923+
idiomatic variation, e.g. `observable_gauge`) be used unless there is a strong
924+
reason not to do so. Please note that the name has nothing to do with
928925
[asynchronous
929926
pattern](https://en.wikipedia.org/wiki/Asynchronous_method_invocation) and
930927
[observer pattern](https://en.wikipedia.org/wiki/Observer_pattern).
@@ -1165,10 +1162,10 @@ decide the language idiomatic name(s), for example
11651162
`CreateObservableUpDownCounter<UInt64>`,
11661163
`CreateObservableUpDownCounter<double>`.
11671164

1168-
It is highly recommended that implementations use the name
1169-
`ObservableUpDownCounter` (or any language idiomatic variation, e.g.
1170-
`observable_up_down_counter`) unless there is a strong reason not to do so. Please
1171-
note that the name has nothing to do with [asynchronous
1165+
It is highly recommended that the name `ObservableUpDownCounter` (or any
1166+
language idiomatic variation, e.g. `observable_up_down_counter`) be used unless
1167+
there is a strong reason not to do so. Please note that the name has nothing to
1168+
do with [asynchronous
11721169
pattern](https://en.wikipedia.org/wiki/Asynchronous_method_invocation) and
11731170
[observer pattern](https://en.wikipedia.org/wiki/Observer_pattern).
11741171

0 commit comments

Comments
 (0)