Skip to content

Commit 2972ebc

Browse files
authored
Move Metrics API behind internal package (#2651)
* Move __init__.py file * Move Metrics API behind internal package
1 parent a4b4c45 commit 2972ebc

File tree

24 files changed

+888
-825
lines changed

24 files changed

+888
-825
lines changed

.github/workflows/test.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ env:
1010
# Otherwise, set variable to the commit of your branch on
1111
# opentelemetry-python-contrib which is compatible with these Core repo
1212
# changes.
13-
CONTRIB_REPO_SHA: 4cfca481f8e2c8af5f7cfd032997fac692995f67
13+
CONTRIB_REPO_SHA: 008cd2370dcd3e87cca8c0ddbb0b820681fd7346
1414
# This is needed because we do not clone the core repo in contrib builds anymore.
1515
# When running contrib builds as part of core builds, we use actions/checkout@v2 which
1616
# does not set an environment variable (simply just runs tox), which is different when

CHANGELOG.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
77

88
## [Unreleased](https://github.com/open-telemetry/opentelemetry-python/compare/v1.11.1-0.30b1...HEAD)
99

10-
## [1.11.1-0.30b1](https://github.com/open-telemetry/opentelemetry-python/releases/tag/v1.11.1-0.30b1) - 2022-04-21
10+
- Move Metrics API behind internal package
11+
([#2651](https://github.com/open-telemetry/opentelemetry-python/pull/2651))
1112

13+
## [1.11.1-0.30b1](https://github.com/open-telemetry/opentelemetry-python/releases/tag/v1.11.1-0.30b1) - 2022-04-21
1214

1315
- Add parameter to MetricReader constructor to select aggregation per instrument kind
1416
([#2638](https://github.com/open-telemetry/opentelemetry-python/pull/2638))

docs/api/metrics.instrument.rst

-8
This file was deleted.

docs/api/metrics.observation.rst

-7
This file was deleted.

docs/api/metrics.rst

-5
Original file line numberDiff line numberDiff line change
@@ -8,13 +8,8 @@ opentelemetry._metrics package
88

99
Once metrics become stable, this package will be be renamed to ``opentelemetry.metrics``.
1010

11-
Submodules
12-
----------
13-
1411
.. toctree::
1512

16-
metrics.instrument
17-
metrics.observation
1813

1914
Module contents
2015
---------------

docs/conf.py

+1-21
Original file line numberDiff line numberDiff line change
@@ -97,9 +97,6 @@
9797
# https://github.com/sphinx-doc/sphinx/pull/3744
9898
nitpick_ignore = [
9999
("py:class", "ValueT"),
100-
("py:class", "MetricT"),
101-
("py:class", "InstrumentT"),
102-
("py:obj", "opentelemetry._metrics.instrument.InstrumentT"),
103100
# Even if wrapt is added to intersphinx_mapping, sphinx keeps failing
104101
# with "class reference target not found: ObjectProxy".
105102
("py:class", "ObjectProxy"),
@@ -142,24 +139,7 @@
142139
"examples/error_handler/error_handler_1",
143140
]
144141

145-
_exclude_members = [
146-
"_ProxyObservableUpDownCounter",
147-
"_ProxyHistogram",
148-
"_ProxyObservableGauge",
149-
"_ProxyInstrument",
150-
"_ProxyAsynchronousInstrument",
151-
"_ProxyCounter",
152-
"_ProxyUpDownCounter",
153-
"_ProxyObservableCounter",
154-
"_ProxyObservableGauge",
155-
"_abc_impl",
156-
"_Adding",
157-
"_Grouping",
158-
"_Monotonic",
159-
"_NonMonotonic",
160-
"Synchronous",
161-
"Asynchronous",
162-
]
142+
_exclude_members = ["_abc_impl"]
163143

164144
autodoc_default_options = {
165145
"members": True,

docs/examples/metrics/example.py

+5-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,10 @@
11
from typing import Iterable
22

3-
from opentelemetry._metrics import get_meter_provider, set_meter_provider
4-
from opentelemetry._metrics.observation import Observation
3+
from opentelemetry._metrics import (
4+
Observation,
5+
get_meter_provider,
6+
set_meter_provider,
7+
)
58
from opentelemetry.exporter.otlp.proto.grpc._metric_exporter import (
69
OTLPMetricExporter,
710
)

docs/getting_started/metrics_example.py

+5-2
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,11 @@
1717

1818
from typing import Iterable
1919

20-
from opentelemetry._metrics import get_meter_provider, set_meter_provider
21-
from opentelemetry._metrics.observation import Observation
20+
from opentelemetry._metrics import (
21+
Observation,
22+
get_meter_provider,
23+
set_meter_provider,
24+
)
2225
from opentelemetry.sdk._metrics import MeterProvider
2326
from opentelemetry.sdk._metrics.export import (
2427
ConsoleMetricExporter,

0 commit comments

Comments
 (0)