Skip to content

Commit 068d0c4

Browse files
Rename enhance to enrich
1 parent e10dc80 commit 068d0c4

File tree

7 files changed

+25
-25
lines changed
  • instrumentation
    • opentelemetry-instrumentation-asgi/src/opentelemetry/instrumentation/asgi
    • opentelemetry-instrumentation-django/src/opentelemetry/instrumentation/django/middleware
    • opentelemetry-instrumentation-falcon/src/opentelemetry/instrumentation/falcon
    • opentelemetry-instrumentation-flask/src/opentelemetry/instrumentation/flask
    • opentelemetry-instrumentation-wsgi/src/opentelemetry/instrumentation/wsgi
  • opentelemetry-instrumentation/src/opentelemetry/instrumentation/_labeler

7 files changed

+25
-25
lines changed

instrumentation/opentelemetry-instrumentation-asgi/src/opentelemetry/instrumentation/asgi/__init__.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -261,7 +261,7 @@ async def user_profile(user_id):
261261

262262
from opentelemetry import context, trace
263263
from opentelemetry.instrumentation._labeler import (
264-
enhance_metric_attributes,
264+
enrich_metric_attributes,
265265
get_labeler,
266266
)
267267
from opentelemetry.instrumentation._semconv import (
@@ -857,7 +857,7 @@ async def __call__(
857857
attributes, _StabilityMode.DEFAULT
858858
)
859859
# Enhance attributes with any custom labeler attributes
860-
duration_attrs_old = enhance_metric_attributes(
860+
duration_attrs_old = enrich_metric_attributes(
861861
duration_attrs_old
862862
)
863863
if target:
@@ -866,7 +866,7 @@ async def __call__(
866866
attributes, _StabilityMode.HTTP
867867
)
868868
# Enhance attributes with any custom labeler attributes
869-
duration_attrs_new = enhance_metric_attributes(
869+
duration_attrs_new = enrich_metric_attributes(
870870
duration_attrs_new
871871
)
872872
if self.duration_histogram_old:

instrumentation/opentelemetry-instrumentation-django/src/opentelemetry/instrumentation/django/middleware/otel_middleware.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@
2222
from django.http import HttpRequest, HttpResponse
2323

2424
from opentelemetry.context import detach
25-
from opentelemetry.instrumentation._labeler import enhance_metric_attributes
25+
from opentelemetry.instrumentation._labeler import enrich_metric_attributes
2626
from opentelemetry.instrumentation._semconv import (
2727
_filter_semconv_active_request_count_attr,
2828
_filter_semconv_duration_attrs,
@@ -438,7 +438,7 @@ def process_response(self, request, response):
438438
if target:
439439
duration_attrs_old[SpanAttributes.HTTP_TARGET] = target
440440
# Enhance attributes with any custom labeler attributes
441-
duration_attrs_old = enhance_metric_attributes(
441+
duration_attrs_old = enrich_metric_attributes(
442442
duration_attrs_old
443443
)
444444
self._duration_histogram_old.record(
@@ -449,7 +449,7 @@ def process_response(self, request, response):
449449
duration_attrs, _StabilityMode.HTTP
450450
)
451451
# Enhance attributes with any custom labeler attributes
452-
duration_attrs_new = enhance_metric_attributes(
452+
duration_attrs_new = enrich_metric_attributes(
453453
duration_attrs_new
454454
)
455455
self._duration_histogram_new.record(

instrumentation/opentelemetry-instrumentation-falcon/src/opentelemetry/instrumentation/falcon/__init__.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -233,7 +233,7 @@ def on_get(self, req, resp, user_id):
233233

234234
import opentelemetry.instrumentation.wsgi as otel_wsgi
235235
from opentelemetry import context, trace
236-
from opentelemetry.instrumentation._labeler import enhance_metric_attributes
236+
from opentelemetry.instrumentation._labeler import enrich_metric_attributes
237237
from opentelemetry.instrumentation._semconv import (
238238
HTTP_DURATION_HISTOGRAM_BUCKETS_NEW,
239239
_get_schema_url,
@@ -460,7 +460,7 @@ def _start_response(status, response_headers, *args, **kwargs):
460460
attributes, _StabilityMode.DEFAULT
461461
)
462462
# Enhance attributes with any custom labeler attributes
463-
duration_attrs = enhance_metric_attributes(duration_attrs)
463+
duration_attrs = enrich_metric_attributes(duration_attrs)
464464
self.duration_histogram_old.record(
465465
max(round(duration_s * 1000), 0), duration_attrs
466466
)
@@ -469,7 +469,7 @@ def _start_response(status, response_headers, *args, **kwargs):
469469
attributes, _StabilityMode.HTTP
470470
)
471471
# Enhance attributes with any custom labeler attributes
472-
duration_attrs = enhance_metric_attributes(duration_attrs)
472+
duration_attrs = enrich_metric_attributes(duration_attrs)
473473
self.duration_histogram_new.record(
474474
max(duration_s, 0), duration_attrs
475475
)

instrumentation/opentelemetry-instrumentation-flask/src/opentelemetry/instrumentation/flask/__init__.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -290,7 +290,7 @@ def response_hook(span: Span, status: str, response_headers: List):
290290

291291
import opentelemetry.instrumentation.wsgi as otel_wsgi
292292
from opentelemetry import context, trace
293-
from opentelemetry.instrumentation._labeler import enhance_metric_attributes
293+
from opentelemetry.instrumentation._labeler import enrich_metric_attributes
294294
from opentelemetry.instrumentation._semconv import (
295295
HTTP_DURATION_HISTOGRAM_BUCKETS_NEW,
296296
_get_schema_url,
@@ -443,7 +443,7 @@ def _start_response(status, response_headers, *args, **kwargs):
443443
duration_attrs_old[HTTP_TARGET] = str(request_route)
444444

445445
# Enhance attributes with any custom labeler attributes
446-
duration_attrs_old = enhance_metric_attributes(duration_attrs_old)
446+
duration_attrs_old = enrich_metric_attributes(duration_attrs_old)
447447

448448
duration_histogram_old.record(
449449
max(round(duration_s * 1000), 0), duration_attrs_old
@@ -457,7 +457,7 @@ def _start_response(status, response_headers, *args, **kwargs):
457457
duration_attrs_new[HTTP_ROUTE] = str(request_route)
458458

459459
# Enhance attributes with any custom labeler attributes
460-
duration_attrs_new = enhance_metric_attributes(duration_attrs_new)
460+
duration_attrs_new = enrich_metric_attributes(duration_attrs_new)
461461

462462
duration_histogram_new.record(
463463
max(duration_s, 0), duration_attrs_new

instrumentation/opentelemetry-instrumentation-wsgi/src/opentelemetry/instrumentation/wsgi/__init__.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -272,7 +272,7 @@ def response_hook(span: Span, environ: WSGIEnvironment, status: str, response_he
272272
from typing import TYPE_CHECKING, Any, Callable, Dict, Iterable, TypeVar, cast
273273

274274
from opentelemetry import context, trace
275-
from opentelemetry.instrumentation._labeler import enhance_metric_attributes
275+
from opentelemetry.instrumentation._labeler import enrich_metric_attributes
276276
from opentelemetry.instrumentation._semconv import (
277277
HTTP_DURATION_HISTOGRAM_BUCKETS_NEW,
278278
_filter_semconv_active_request_count_attr,
@@ -763,7 +763,7 @@ def __call__(
763763
req_attrs, _StabilityMode.DEFAULT
764764
)
765765
# Enhance attributes with any custom labeler attributes
766-
duration_attrs_old = enhance_metric_attributes(
766+
duration_attrs_old = enrich_metric_attributes(
767767
duration_attrs_old
768768
)
769769
self.duration_histogram_old.record(
@@ -774,7 +774,7 @@ def __call__(
774774
req_attrs, _StabilityMode.HTTP
775775
)
776776
# Enhance attributes with any custom labeler attributes
777-
duration_attrs_new = enhance_metric_attributes(
777+
duration_attrs_new = enrich_metric_attributes(
778778
duration_attrs_new
779779
)
780780
self.duration_histogram_new.record(

opentelemetry-instrumentation/src/opentelemetry/instrumentation/_labeler/__init__.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -63,13 +63,13 @@ def user_profile(user_id):
6363
6464
The labeler also works with auto-instrumentation.
6565
66-
Custom attributes are merged by any instrumentors that use ``enhance_metric_attributes`` before their calls to report individual metrics recording, such as ``Histogram.record``. ``enchance_metrics_attributes`` does not overwrite base attributes that exist at the same keys.
66+
Custom attributes are merged by any instrumentors that use ``enrich_metric_attributes`` before their calls to report individual metrics recording, such as ``Histogram.record``. ``enchance_metrics_attributes`` does not overwrite base attributes that exist at the same keys.
6767
"""
6868

6969
from opentelemetry.instrumentation._labeler._internal import (
7070
Labeler,
7171
clear_labeler,
72-
enhance_metric_attributes,
72+
enrich_metric_attributes,
7373
get_labeler,
7474
get_labeler_attributes,
7575
set_labeler,
@@ -81,5 +81,5 @@ def user_profile(user_id):
8181
"set_labeler",
8282
"clear_labeler",
8383
"get_labeler_attributes",
84-
"enhance_metric_attributes",
84+
"enrich_metric_attributes",
8585
]

opentelemetry-instrumentation/src/opentelemetry/instrumentation/_labeler/_internal/__init__.py

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -184,9 +184,9 @@ def get_labeler_attributes() -> Dict[str, Union[str, int, float, bool]]:
184184
return labeler.get_attributes()
185185

186186

187-
def enhance_metric_attributes(
187+
def enrich_metric_attributes(
188188
base_attributes: Dict[str, Any],
189-
include_custom: bool = True,
189+
enrich_enabled: bool = True,
190190
) -> Dict[str, Any]:
191191
"""
192192
Combines base_attributes with custom attributes from the current labeler,
@@ -197,13 +197,13 @@ def enhance_metric_attributes(
197197
198198
Args:
199199
base_attributes: The base attributes for the metric
200-
include_custom: Whether to include custom labeler attributes
200+
enrich_enabled: Whether to include custom labeler attributes
201201
202202
Returns:
203203
Dictionary combining base and custom attributes. If no custom attributes,
204204
returns a copy of the original base attributes.
205205
"""
206-
if not include_custom:
206+
if not enrich_enabled:
207207
return base_attributes.copy()
208208

209209
labeler = _labeler_context.get()
@@ -214,7 +214,7 @@ def enhance_metric_attributes(
214214
if not custom_attributes:
215215
return base_attributes.copy()
216216

217-
enhanced_attributes = base_attributes.copy()
217+
enriched_attributes = base_attributes.copy()
218218

219219
added_count = 0
220220
for key, value in custom_attributes.items():
@@ -229,7 +229,7 @@ def enhance_metric_attributes(
229229
):
230230
value = value[: labeler._max_attr_value_length]
231231

232-
enhanced_attributes[key] = value
232+
enriched_attributes[key] = value
233233
added_count += 1
234234

235-
return enhanced_attributes
235+
return enriched_attributes

0 commit comments

Comments
 (0)