Skip to content

Commit 181596b

Browse files
committed
Rename ExplicitBucketBoundaries to explicit_bucket_boundaries
1 parent e5ca6a4 commit 181596b

File tree

5 files changed

+10
-10
lines changed

5 files changed

+10
-10
lines changed

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,4 +58,4 @@
5858

5959

6060
class MetricsInstrumentAdvisory(TypedDict):
61-
ExplicitBucketBoundaries: Optional[AnyValue]
61+
explicit_bucket_boundaries: Optional[AnyValue]

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -207,7 +207,7 @@ def create_histogram(
207207
if advisory is not None:
208208
raise_error = False
209209
try:
210-
boundaries = advisory["ExplicitBucketBoundaries"]
210+
boundaries = advisory["explicit_bucket_boundaries"]
211211
raise_error = not (
212212
boundaries
213213
and all(isinstance(e, (int, float)) for e in boundaries)
@@ -217,7 +217,7 @@ def create_histogram(
217217

218218
if raise_error:
219219
raise ValueError(
220-
"Advisory must be a dict with ExplicitBucketBoundaries key containing a sequence of numbers"
220+
"Advisory must be a dict with explicit_bucket_boundaries key containing a sequence of numbers"
221221
)
222222

223223
(

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1277,7 +1277,7 @@ def _create_aggregation(
12771277

12781278
if isinstance(instrument, Histogram):
12791279
boundaries: Optional[Sequence[float]] = (
1280-
instrument.advisory.get("ExplicitBucketBoundaries")
1280+
instrument.advisory.get("explicit_bucket_boundaries")
12811281
if instrument.advisory is not None
12821282
else None
12831283
)

opentelemetry-sdk/tests/metrics/test_aggregation.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -636,7 +636,7 @@ def test_histogram_with_advisory(self):
636636
"name",
637637
Mock(),
638638
Mock(),
639-
advisory={"ExplicitBucketBoundaries": boundaries},
639+
advisory={"explicit_bucket_boundaries": boundaries},
640640
),
641641
Mock(),
642642
_default_reservoir_factory,

opentelemetry-sdk/tests/metrics/test_metrics.py

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -505,22 +505,22 @@ def test_create_histogram_with_advisory(self):
505505
"name",
506506
unit="unit",
507507
description="description",
508-
advisory={"ExplicitBucketBoundaries": [0, 1, 2]},
508+
advisory={"explicit_bucket_boundaries": [0, 1, 2]},
509509
)
510510

511511
self.assertIsInstance(histogram, Histogram)
512512
self.assertEqual(histogram.name, "name")
513513
self.assertEqual(
514-
histogram.advisory, {"ExplicitBucketBoundaries": [0, 1, 2]}
514+
histogram.advisory, {"explicit_bucket_boundaries": [0, 1, 2]}
515515
)
516516

517517
def test_create_histogram_advisory_validation(self):
518518
advisories = [
519-
{"ExplicitBucketBoundaries": None},
520-
{"ExplicitBucketBoundaries": []},
519+
{"explicit_bucket_boundaries": None},
520+
{"explicit_bucket_boundaries": []},
521521
{},
522522
[],
523-
{"ExplicitBucketBoundaries": [1, 2.0, "3"]},
523+
{"explicit_bucket_boundaries": [1, 2.0, "3"]},
524524
]
525525
for advisory in advisories:
526526
with self.subTest(advisory=advisory):

0 commit comments

Comments
 (0)