Change interface to a dataclass instead of a typed dict

Author: xrmx

docs/examples/metrics/instruments/example.py

@@ -11,6 +11,7 @@
 )
 from opentelemetry.sdk.metrics import MeterProvider
 from opentelemetry.sdk.metrics.export import PeriodicExportingMetricReader
+from opentelemetry.util.types import MetricsHistogramAdvisory
 
 exporter = OTLPMetricExporter(insecure=True)
 reader = PeriodicExportingMetricReader(exporter)
@@ -59,10 +60,12 @@ def observable_gauge_func(options: CallbackOptions) -> Iterable[Observation]:
 histogram.record(99.9)
 
 
-# Histogram with explicit_bucket_boundaries advisory
+# Histogram with explicit bucket boundaries advisory
 histogram = meter.create_histogram(
     "histogram_with_advisory",
-    advisory={"explicit_bucket_boundaries": [0.0, 1.0, 2.0]},
+    advisory=MetricsHistogramAdvisory(
+        explicit_bucket_boundaries=[0.0, 1.0, 2.0]
+    ),
 )
 histogram.record(99.9)
 

opentelemetry-api/src/opentelemetry/metrics/_internal/__init__.py

@@ -75,7 +75,11 @@
 )
 from opentelemetry.util._once import Once
 from opentelemetry.util._providers import _load_provider
-from opentelemetry.util.types import Attributes, MetricsInstrumentAdvisory
+from opentelemetry.util.types import (
+    Attributes,
+    MetricsHistogramAdvisory,
+    MetricsInstrumentAdvisory,
+)
 
 _logger = getLogger(__name__)
 
@@ -411,7 +415,7 @@ def create_histogram(
         name: str,
         unit: str = "",
         description: str = "",
-        advisory: Optional[MetricsInstrumentAdvisory] = None,
+        advisory: Optional[MetricsHistogramAdvisory] = None,
     ) -> Histogram:
         """Creates a :class:`~opentelemetry.metrics.Histogram` instrument
 
@@ -565,7 +569,7 @@ def create_histogram(
         name: str,
         unit: str = "",
         description: str = "",
-        advisory: Optional[MetricsInstrumentAdvisory] = None,
+        advisory: Optional[MetricsHistogramAdvisory] = None,
     ) -> Histogram:
         with self._lock:
             if self._real_meter:
@@ -745,7 +749,7 @@ def create_histogram(
         name: str,
         unit: str = "",
         description: str = "",
-        advisory: Optional[MetricsInstrumentAdvisory] = None,
+        advisory: Optional[MetricsHistogramAdvisory] = None,
     ) -> Histogram:
         """Returns a no-op Histogram."""
         _, status = self._register_instrument(

opentelemetry-api/src/opentelemetry/metrics/_internal/instrument.py

@@ -35,7 +35,11 @@
 from opentelemetry import metrics
 from opentelemetry.context import Context
 from opentelemetry.metrics._internal.observation import Observation
-from opentelemetry.util.types import Attributes, MetricsInstrumentAdvisory
+from opentelemetry.util.types import (
+    Attributes,
+    MetricsHistogramAdvisory,
+    MetricsInstrumentAdvisory,
+)
 
 _logger = getLogger(__name__)
 
@@ -380,7 +384,7 @@ def __init__(
         name: str,
         unit: str = "",
         description: str = "",
-        advisory: Optional[MetricsInstrumentAdvisory] = None,
+        advisory: Optional[MetricsHistogramAdvisory] = None,
     ) -> None:
         self._name = name
         self._unit = unit

opentelemetry-api/src/opentelemetry/util/types.py

@@ -12,7 +12,8 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-from typing import Mapping, Optional, Sequence, Tuple, TypedDict, Union
+from dataclasses import dataclass
+from typing import Mapping, Optional, Sequence, Tuple, Union
 
 # This is the implementation of the "Any" type as specified by the specifications of OpenTelemetry data model for logs.
 # For more details, refer to the OTel specification:
@@ -57,5 +58,16 @@
 ]
 
 
-class MetricsInstrumentAdvisory(TypedDict):
+@dataclass
+class MetricsHistogramAdvisory:
     explicit_bucket_boundaries: Optional[Sequence[float]]
+
+
+@dataclass
+class MetricsCommonAdvisory:
+    pass
+
+
+MetricsInstrumentAdvisory = Union[
+    MetricsCommonAdvisory, MetricsHistogramAdvisory
+]

opentelemetry-sdk/src/opentelemetry/sdk/metrics/_internal/__init__.py

@@ -64,7 +64,10 @@
 from opentelemetry.sdk.resources import Resource
 from opentelemetry.sdk.util.instrumentation import InstrumentationScope
 from opentelemetry.util._once import Once
-from opentelemetry.util.types import Attributes, MetricsInstrumentAdvisory
+from opentelemetry.util.types import (
+    Attributes,
+    MetricsHistogramAdvisory,
+)
 
 _logger = getLogger(__name__)
 
@@ -215,12 +218,12 @@ def create_histogram(
         name: str,
         unit: str = "",
         description: str = "",
-        advisory: Optional[MetricsInstrumentAdvisory] = None,
+        advisory: Optional[MetricsHistogramAdvisory] = None,
     ) -> APIHistogram:
         if advisory is not None:
             invalid_advisory = False
             try:
-                boundaries = advisory["explicit_bucket_boundaries"]
+                boundaries = advisory.explicit_bucket_boundaries
                 invalid_advisory = not (
                     boundaries
                     and all(isinstance(e, float) for e in boundaries)

opentelemetry-sdk/src/opentelemetry/sdk/metrics/_internal/aggregation.py

@@ -1284,7 +1284,7 @@ def _create_aggregation(
 
         if isinstance(instrument, Histogram):
             boundaries: Optional[Sequence[float]] = (
-                instrument._advisory.get("explicit_bucket_boundaries")
+                instrument._advisory.explicit_bucket_boundaries
                 if instrument._advisory is not None
                 else None
             )

opentelemetry-sdk/tests/metrics/integration_test/test_histogram_advisory_explicit_buckets.py

@@ -20,6 +20,7 @@
     ExplicitBucketHistogramAggregation,
     View,
 )
+from opentelemetry.util.types import MetricsHistogramAdvisory
 
 
 class TestHistogramAdvisory(TestCase):
@@ -31,7 +32,9 @@ def test_default(self):
         meter = meter_provider.get_meter("testmeter")
         histogram = meter.create_histogram(
             "testhistogram",
-            advisory={"explicit_bucket_boundaries": [1.0, 2.0, 3.0]},
+            advisory=MetricsHistogramAdvisory(
+                explicit_bucket_boundaries=[1.0, 2.0, 3.0]
+            ),
         )
         histogram.record(1, {"label": "value"})
         histogram.record(2, {"label": "value"})
@@ -59,7 +62,9 @@ def test_view_default_aggregation(self):
         meter = meter_provider.get_meter("testmeter")
         histogram = meter.create_histogram(
             "testhistogram",
-            advisory={"explicit_bucket_boundaries": [1.0, 2.0, 3.0]},
+            advisory=MetricsHistogramAdvisory(
+                explicit_bucket_boundaries=[1.0, 2.0, 3.0]
+            ),
         )
         histogram.record(1, {"label": "value"})
         histogram.record(2, {"label": "value"})
@@ -92,7 +97,9 @@ def test_view_overrides_buckets(self):
         meter = meter_provider.get_meter("testmeter")
         histogram = meter.create_histogram(
             "testhistogram",
-            advisory={"explicit_bucket_boundaries": [1.0, 2.0, 3.0]},
+            advisory=MetricsHistogramAdvisory(
+                explicit_bucket_boundaries=[1.0, 2.0, 3.0]
+            ),
         )
         histogram.record(1, {"label": "value"})
         histogram.record(2, {"label": "value"})

opentelemetry-sdk/tests/metrics/test_aggregation.py

@@ -51,7 +51,7 @@
     LastValueAggregation,
     SumAggregation,
 )
-from opentelemetry.util.types import Attributes
+from opentelemetry.util.types import Attributes, MetricsHistogramAdvisory
 
 
 def measurement(
@@ -635,7 +635,9 @@ def test_histogram_with_advisory(self):
                 "name",
                 Mock(),
                 Mock(),
-                advisory={"explicit_bucket_boundaries": boundaries},
+                advisory=MetricsHistogramAdvisory(
+                    explicit_bucket_boundaries=boundaries
+                ),
             ),
             Mock(),
             _default_reservoir_factory,

opentelemetry-sdk/tests/metrics/test_metrics.py

@@ -46,6 +46,7 @@
 from opentelemetry.sdk.resources import Resource
 from opentelemetry.test import TestCase
 from opentelemetry.test.concurrency_test import ConcurrencyTestBase, MockFunc
+from opentelemetry.util.types import MetricsHistogramAdvisory
 
 
 class DummyMetricReader(MetricReader):
@@ -542,24 +543,26 @@ def test_create_histogram_with_advisory(self):
             "name",
             unit="unit",
             description="description",
-            advisory={"explicit_bucket_boundaries": [0.0, 1.0, 2.0]},
+            advisory=MetricsHistogramAdvisory(
+                explicit_bucket_boundaries=[0.0, 1.0, 2.0]
+            ),
         )
 
         self.assertIsInstance(histogram, Histogram)
         self.assertEqual(histogram.name, "name")
         self.assertEqual(
             histogram._advisory,
-            {"explicit_bucket_boundaries": [0.0, 1.0, 2.0]},
+            MetricsHistogramAdvisory(
+                explicit_bucket_boundaries=[0.0, 1.0, 2.0]
+            ),
         )
 
     def test_create_histogram_advisory_validation(self):
         advisories = [
-            {"explicit_bucket_boundaries": None},
-            {"explicit_bucket_boundaries": []},
-            {},
-            [],
-            {"explicit_bucket_boundaries": [1]},
-            {"explicit_bucket_boundaries": ["1"]},
+            MetricsHistogramAdvisory(explicit_bucket_boundaries=None),
+            MetricsHistogramAdvisory(explicit_bucket_boundaries=[]),
+            MetricsHistogramAdvisory(explicit_bucket_boundaries=[1]),
+            MetricsHistogramAdvisory(explicit_bucket_boundaries=["1"]),
         ]
         for advisory in advisories:
             with self.subTest(advisory=advisory):