Skip to content

Commit 7413895

Browse files
ocelotlocelotl
authored
Make metrics public (#2684)
* Make metrics public Fixes #2682 * Make environment variable public * Make environment variable public * Fix example * Make exporter public * Fix environment variable import path * Fix exporter * Fix lint * Fix import order * Add tag * Fix import path
1 parent 91211b3 commit 7413895

File tree

58 files changed

+259
-285
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

58 files changed

+259
-285
lines changed

‎CHANGELOG.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,8 @@ 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+
- Make metrics components public
11+
([#2684](https://github.com/open-telemetry/opentelemetry-python/pull/2684))
1012
- Update to semantic conventions v1.11.0
1113
([#2669](https://github.com/open-telemetry/opentelemetry-python/pull/2669))
1214
- Update opentelemetry-proto to v0.17.0

‎docs/api/metrics.rst‎

Lines changed: 3 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,10 @@
1-
opentelemetry._metrics package
2-
==============================
3-
4-
.. warning::
5-
OpenTelemetry Python metrics are in an experimental state. The APIs within
6-
:mod:`opentelemetry._metrics` are subject to change in minor/patch releases and make no
7-
backward compatability guarantees at this time.
8-
9-
Once metrics become stable, this package will be be renamed to ``opentelemetry.metrics``.
1+
opentelemetry.metrics package
2+
=============================
103

114
.. toctree::
125

136

147
Module contents
158
---------------
169

17-
.. automodule:: opentelemetry._metrics
10+
.. automodule:: opentelemetry.metrics

‎docs/conf.py‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -99,11 +99,11 @@
9999
("py:class", "ValueT"),
100100
(
101101
"py:class",
102-
"opentelemetry.sdk._metrics._internal.instrument._Synchronous",
102+
"opentelemetry.sdk.metrics._internal.instrument._Synchronous",
103103
),
104104
(
105105
"py:class",
106-
"opentelemetry.sdk._metrics._internal.instrument._Asynchronous",
106+
"opentelemetry.sdk.metrics._internal.instrument._Asynchronous",
107107
),
108108
# Even if wrapt is added to intersphinx_mapping, sphinx keeps failing
109109
# with "class reference target not found: ObjectProxy".

‎docs/examples/metrics/README.rst‎

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,6 @@
11
OpenTelemetry Metrics SDK
22
=========================
33

4-
.. warning::
5-
OpenTelemetry Python metrics are in an experimental state. The APIs within
6-
:mod:`opentelemetry.sdk._metrics` are subject to change in minor/patch releases and there are no
7-
backward compatability guarantees at this time.
8-
94
Start the Collector locally to see data being exported. Write the following file:
105

116
.. code-block:: yaml
@@ -45,4 +40,4 @@ The resulting metrics will appear in the output from the collector and look simi
4540

4641
.. code-block:: sh
4742
48-
TODO
43+
TODO

‎docs/examples/metrics/example.py‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
11
from typing import Iterable
22

3-
from opentelemetry._metrics import (
3+
from opentelemetry.exporter.otlp.proto.grpc.metric_exporter import (
4+
OTLPMetricExporter,
5+
)
6+
from opentelemetry.metrics import (
7+
CallbackOptions,
48
Observation,
59
get_meter_provider,
610
set_meter_provider,
711
)
8-
from opentelemetry._metrics._internal.instrument import CallbackOptions
9-
from opentelemetry.exporter.otlp.proto.grpc._metric_exporter import (
10-
OTLPMetricExporter,
11-
)
12-
from opentelemetry.sdk._metrics import MeterProvider
13-
from opentelemetry.sdk._metrics.export import PeriodicExportingMetricReader
12+
from opentelemetry.sdk.metrics import MeterProvider
13+
from opentelemetry.sdk.metrics.export import PeriodicExportingMetricReader
1414

1515
exporter = OTLPMetricExporter(insecure=True)
1616
reader = PeriodicExportingMetricReader(exporter)

‎docs/getting_started/metrics_example.py‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,14 +17,14 @@
1717

1818
from typing import Iterable
1919

20-
from opentelemetry._metrics import (
20+
from opentelemetry.metrics import (
2121
CallbackOptions,
2222
Observation,
2323
get_meter_provider,
2424
set_meter_provider,
2525
)
26-
from opentelemetry.sdk._metrics import MeterProvider
27-
from opentelemetry.sdk._metrics.export import (
26+
from opentelemetry.sdk.metrics import MeterProvider
27+
from opentelemetry.sdk.metrics.export import (
2828
ConsoleMetricExporter,
2929
PeriodicExportingMetricReader,
3030
)

‎docs/sdk/metrics.export.rst‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
opentelemetry.sdk._metrics.export
2-
=================================
1+
opentelemetry.sdk.metrics.export
2+
================================
33

4-
.. automodule:: opentelemetry.sdk._metrics.export
4+
.. automodule:: opentelemetry.sdk.metrics.export
55
:members:
66
:undoc-members:
77
:show-inheritance:

‎docs/sdk/metrics.rst‎

Lines changed: 2 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,6 @@
1-
opentelemetry.sdk._metrics package
1+
opentelemetry.sdk.metrics package
22
==================================
33

4-
.. warning::
5-
OpenTelemetry Python metrics are in an experimental state. The APIs within
6-
:mod:`opentelemetry.sdk._metrics` are subject to change in minor/patch releases and there are no
7-
backward compatability guarantees at this time.
8-
9-
Once metrics become stable, this package will be be renamed to ``opentelemetry.sdk.metrics``.
10-
114
Submodules
125
----------
136

@@ -16,7 +9,7 @@ Submodules
169
metrics.export
1710
metrics.view
1811

19-
.. automodule:: opentelemetry.sdk._metrics
12+
.. automodule:: opentelemetry.sdk.metrics
2013
:members:
2114
:undoc-members:
2215
:show-inheritance:

‎docs/sdk/metrics.view.rst‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
opentelemetry.sdk._metrics.view
2-
===============================
1+
opentelemetry.sdk.metrics.view
2+
==============================
33

4-
.. automodule:: opentelemetry.sdk._metrics.view
4+
.. automodule:: opentelemetry.sdk.metrics.view
55
:members:
66
:undoc-members:
77
:show-inheritance:

exporter/opentelemetry-exporter-otlp-proto-grpc/src/opentelemetry/exporter/otlp/proto/grpc/_metric_exporter/__init__.py renamed to exporter/opentelemetry-exporter-otlp-proto-grpc/src/opentelemetry/exporter/otlp/proto/grpc/metric_exporter/__init__.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,14 +30,14 @@
3030
from opentelemetry.sdk.environment_variables import (
3131
OTEL_EXPORTER_OTLP_METRICS_INSECURE,
3232
)
33-
from opentelemetry.sdk._metrics.export import (
33+
from opentelemetry.sdk.metrics.export import (
3434
Gauge,
3535
Histogram,
3636
Metric,
3737
Sum,
3838
)
3939

40-
from opentelemetry.sdk._metrics.export import (
40+
from opentelemetry.sdk.metrics.export import (
4141
MetricExporter,
4242
MetricExportResult,
4343
MetricsData,

0 commit comments

Comments
 (0)