Skip to content

Commit cc62d1f

Browse files
emdnetoemdneto
authored
prepare semconv utilities to support database stability opt-in (open-telemetry#3111)
1 parent d155540 commit cc62d1f

File tree

17 files changed

+422
-133
lines changed

17 files changed

+422
-133
lines changed

‎CHANGELOG.md‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,11 +11,17 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
1111
1212
## Unreleased
1313

14+
### Added
15+
16+
- Add support to database stability opt-in in `_semconv` utilities and add tests
17+
([#3111](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/3111))
18+
1419
### Fixed
1520

1621
- `opentelemetry-instrumentation-httpx` Fix `RequestInfo`/`ResponseInfo` type hints
1722
([#3105](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/3105))
1823

24+
1925
## Version 1.29.0/0.50b0 (2024-12-11)
2026

2127
### Added

‎instrumentation/opentelemetry-instrumentation-aiohttp-client/src/opentelemetry/instrumentation/aiohttp_client/__init__.py‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -92,13 +92,13 @@ def response_hook(span: Span, params: typing.Union[
9292
from opentelemetry import trace
9393
from opentelemetry.instrumentation._semconv import (
9494
_get_schema_url,
95-
_HTTPStabilityMode,
9695
_OpenTelemetrySemanticConventionStability,
9796
_OpenTelemetryStabilitySignalType,
9897
_report_new,
9998
_set_http_method,
10099
_set_http_url,
101100
_set_status,
101+
_StabilityMode,
102102
)
103103
from opentelemetry.instrumentation.aiohttp_client.package import _instruments
104104
from opentelemetry.instrumentation.aiohttp_client.version import __version__
@@ -142,7 +142,7 @@ def _set_http_status_code_attribute(
142142
span,
143143
status_code,
144144
metric_attributes=None,
145-
sem_conv_opt_in_mode=_HTTPStabilityMode.DEFAULT,
145+
sem_conv_opt_in_mode=_StabilityMode.DEFAULT,
146146
):
147147
status_code_str = str(status_code)
148148
try:
@@ -169,7 +169,7 @@ def create_trace_config(
169169
request_hook: _RequestHookT = None,
170170
response_hook: _ResponseHookT = None,
171171
tracer_provider: TracerProvider = None,
172-
sem_conv_opt_in_mode: _HTTPStabilityMode = _HTTPStabilityMode.DEFAULT,
172+
sem_conv_opt_in_mode: _StabilityMode = _StabilityMode.DEFAULT,
173173
) -> aiohttp.TraceConfig:
174174
"""Create an aiohttp-compatible trace configuration.
175175
@@ -326,7 +326,7 @@ def _instrument(
326326
trace_configs: typing.Optional[
327327
typing.Sequence[aiohttp.TraceConfig]
328328
] = None,
329-
sem_conv_opt_in_mode: _HTTPStabilityMode = _HTTPStabilityMode.DEFAULT,
329+
sem_conv_opt_in_mode: _StabilityMode = _StabilityMode.DEFAULT,
330330
):
331331
"""Enables tracing of all ClientSessions
332332

‎instrumentation/opentelemetry-instrumentation-aiohttp-client/tests/test_aiohttp_client_integration.py‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -29,8 +29,8 @@
2929
from opentelemetry.instrumentation import aiohttp_client
3030
from opentelemetry.instrumentation._semconv import (
3131
OTEL_SEMCONV_STABILITY_OPT_IN,
32-
_HTTPStabilityMode,
3332
_OpenTelemetrySemanticConventionStability,
33+
_StabilityMode,
3434
)
3535
from opentelemetry.instrumentation.aiohttp_client import (
3636
AioHttpClientInstrumentor,
@@ -150,7 +150,7 @@ def test_status_codes_new_semconv(self):
150150
path = "test-path?query=param#foobar"
151151
host, port = self._http_request(
152152
trace_config=aiohttp_client.create_trace_config(
153-
sem_conv_opt_in_mode=_HTTPStabilityMode.HTTP
153+
sem_conv_opt_in_mode=_StabilityMode.HTTP
154154
),
155155
url=f"/{path}",
156156
status_code=status_code,
@@ -173,7 +173,7 @@ def test_status_codes_both_semconv(self):
173173
path = "test-path?query=param#foobar"
174174
host, port = self._http_request(
175175
trace_config=aiohttp_client.create_trace_config(
176-
sem_conv_opt_in_mode=_HTTPStabilityMode.HTTP_DUP
176+
sem_conv_opt_in_mode=_StabilityMode.HTTP_DUP
177177
),
178178
url=f"/{path}",
179179
status_code=status_code,
@@ -213,7 +213,7 @@ def test_schema_url_new_semconv(self):
213213
with self.subTest(status_code=200):
214214
self._http_request(
215215
trace_config=aiohttp_client.create_trace_config(
216-
sem_conv_opt_in_mode=_HTTPStabilityMode.HTTP
216+
sem_conv_opt_in_mode=_StabilityMode.HTTP
217217
),
218218
url="/test-path?query=param#foobar",
219219
status_code=200,
@@ -230,7 +230,7 @@ def test_schema_url_both_semconv(self):
230230
with self.subTest(status_code=200):
231231
self._http_request(
232232
trace_config=aiohttp_client.create_trace_config(
233-
sem_conv_opt_in_mode=_HTTPStabilityMode.HTTP_DUP
233+
sem_conv_opt_in_mode=_StabilityMode.HTTP_DUP
234234
),
235235
url="/test-path?query=param#foobar",
236236
status_code=200,
@@ -398,7 +398,7 @@ async def request_handler(request):
398398

399399
host, port = self._http_request(
400400
trace_config=aiohttp_client.create_trace_config(
401-
sem_conv_opt_in_mode=_HTTPStabilityMode.HTTP
401+
sem_conv_opt_in_mode=_StabilityMode.HTTP
402402
),
403403
url="/test",
404404
request_handler=request_handler,
@@ -426,7 +426,7 @@ async def request_handler(request):
426426

427427
host, port = self._http_request(
428428
trace_config=aiohttp_client.create_trace_config(
429-
sem_conv_opt_in_mode=_HTTPStabilityMode.HTTP_DUP
429+
sem_conv_opt_in_mode=_StabilityMode.HTTP_DUP
430430
),
431431
url="/test",
432432
request_handler=request_handler,
@@ -546,7 +546,7 @@ async def do_request(url):
546546
def test_nonstandard_http_method_new_semconv(self):
547547
trace_configs = [
548548
aiohttp_client.create_trace_config(
549-
sem_conv_opt_in_mode=_HTTPStabilityMode.HTTP
549+
sem_conv_opt_in_mode=_StabilityMode.HTTP
550550
)
551551
]
552552
app = HttpServerMock("nonstandard_method")

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

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -205,7 +205,6 @@ def client_response_hook(span: Span, scope: dict[str, Any], message: dict[str, A
205205
_filter_semconv_active_request_count_attr,
206206
_filter_semconv_duration_attrs,
207207
_get_schema_url,
208-
_HTTPStabilityMode,
209208
_OpenTelemetrySemanticConventionStability,
210209
_OpenTelemetryStabilitySignalType,
211210
_report_new,
@@ -225,6 +224,7 @@ def client_response_hook(span: Span, scope: dict[str, Any], message: dict[str, A
225224
_set_http_url,
226225
_set_http_user_agent,
227226
_set_status,
227+
_StabilityMode,
228228
)
229229
from opentelemetry.instrumentation.asgi.types import (
230230
ClientRequestHook,
@@ -324,7 +324,7 @@ def set(self, carrier: dict, key: str, value: str) -> None: # pylint: disable=n
324324

325325
# pylint: disable=too-many-branches
326326
def collect_request_attributes(
327-
scope, sem_conv_opt_in_mode=_HTTPStabilityMode.DEFAULT
327+
scope, sem_conv_opt_in_mode=_StabilityMode.DEFAULT
328328
):
329329
"""Collects HTTP request attributes from the ASGI scope and returns a
330330
dictionary to be used as span creation attributes."""
@@ -356,7 +356,7 @@ def collect_request_attributes(
356356
_set_http_url(
357357
result,
358358
remove_url_credentials(http_url),
359-
_HTTPStabilityMode.DEFAULT,
359+
_StabilityMode.DEFAULT,
360360
)
361361
http_method = scope.get("method", "")
362362
if http_method:
@@ -439,7 +439,7 @@ def set_status_code(
439439
span,
440440
status_code,
441441
metric_attributes=None,
442-
sem_conv_opt_in_mode=_HTTPStabilityMode.DEFAULT,
442+
sem_conv_opt_in_mode=_StabilityMode.DEFAULT,
443443
):
444444
"""Adds HTTP response attributes to span using the status_code argument."""
445445
status_code_str = str(status_code)
@@ -755,12 +755,12 @@ async def __call__(
755755
)
756756
duration_s = default_timer() - start
757757
duration_attrs_old = _parse_duration_attrs(
758-
attributes, _HTTPStabilityMode.DEFAULT
758+
attributes, _StabilityMode.DEFAULT
759759
)
760760
if target:
761761
duration_attrs_old[SpanAttributes.HTTP_TARGET] = target
762762
duration_attrs_new = _parse_duration_attrs(
763-
attributes, _HTTPStabilityMode.HTTP
763+
attributes, _StabilityMode.HTTP
764764
)
765765
if self.duration_histogram_old:
766766
self.duration_histogram_old.record(
@@ -960,7 +960,7 @@ async def otel_send(message: dict[str, Any]):
960960

961961

962962
def _parse_duration_attrs(
963-
req_attrs, sem_conv_opt_in_mode=_HTTPStabilityMode.DEFAULT
963+
req_attrs, sem_conv_opt_in_mode=_StabilityMode.DEFAULT
964964
):
965965
return _filter_semconv_duration_attrs(
966966
req_attrs,
@@ -971,7 +971,7 @@ def _parse_duration_attrs(
971971

972972

973973
def _parse_active_request_count_attrs(
974-
req_attrs, sem_conv_opt_in_mode=_HTTPStabilityMode.DEFAULT
974+
req_attrs, sem_conv_opt_in_mode=_StabilityMode.DEFAULT
975975
):
976976
return _filter_semconv_active_request_count_attr(
977977
req_attrs,

‎instrumentation/opentelemetry-instrumentation-asgi/tests/test_asgi_middleware.py‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -24,12 +24,12 @@
2424
from opentelemetry import trace as trace_api
2525
from opentelemetry.instrumentation._semconv import (
2626
OTEL_SEMCONV_STABILITY_OPT_IN,
27-
_HTTPStabilityMode,
2827
_OpenTelemetrySemanticConventionStability,
2928
_server_active_requests_count_attrs_new,
3029
_server_active_requests_count_attrs_old,
3130
_server_duration_attrs_new,
3231
_server_duration_attrs_old,
32+
_StabilityMode,
3333
)
3434
from opentelemetry.instrumentation.propagators import (
3535
TraceResponsePropagator,
@@ -1652,7 +1652,7 @@ def test_request_attributes_new_semconv(self):
16521652

16531653
attrs = otel_asgi.collect_request_attributes(
16541654
self.scope,
1655-
_HTTPStabilityMode.HTTP,
1655+
_StabilityMode.HTTP,
16561656
)
16571657

16581658
self.assertDictEqual(
@@ -1677,7 +1677,7 @@ def test_request_attributes_both_semconv(self):
16771677

16781678
attrs = otel_asgi.collect_request_attributes(
16791679
self.scope,
1680-
_HTTPStabilityMode.HTTP_DUP,
1680+
_StabilityMode.HTTP_DUP,
16811681
)
16821682

16831683
self.assertDictEqual(
@@ -1715,7 +1715,7 @@ def test_query_string_new_semconv(self):
17151715
self.scope["query_string"] = b"foo=bar"
17161716
attrs = otel_asgi.collect_request_attributes(
17171717
self.scope,
1718-
_HTTPStabilityMode.HTTP,
1718+
_StabilityMode.HTTP,
17191719
)
17201720
self.assertEqual(attrs[URL_SCHEME], "http")
17211721
self.assertEqual(attrs[CLIENT_ADDRESS], "127.0.0.1")
@@ -1726,7 +1726,7 @@ def test_query_string_both_semconv(self):
17261726
self.scope["query_string"] = b"foo=bar"
17271727
attrs = otel_asgi.collect_request_attributes(
17281728
self.scope,
1729-
_HTTPStabilityMode.HTTP_DUP,
1729+
_StabilityMode.HTTP_DUP,
17301730
)
17311731
self.assertEqual(
17321732
attrs[SpanAttributes.HTTP_URL], "http://127.0.0.1/?foo=bar"
@@ -1762,7 +1762,7 @@ def test_response_attributes_new_semconv(self):
17621762
self.span,
17631763
404,
17641764
None,
1765-
_HTTPStabilityMode.HTTP,
1765+
_StabilityMode.HTTP,
17661766
)
17671767
expected = (mock.call(HTTP_RESPONSE_STATUS_CODE, 404),)
17681768
self.assertEqual(self.span.set_attribute.call_count, 1)
@@ -1774,7 +1774,7 @@ def test_response_attributes_both_semconv(self):
17741774
self.span,
17751775
404,
17761776
None,
1777-
_HTTPStabilityMode.HTTP_DUP,
1777+
_StabilityMode.HTTP_DUP,
17781778
)
17791779
expected = (mock.call(SpanAttributes.HTTP_STATUS_CODE, 404),)
17801780
expected2 = (mock.call(HTTP_RESPONSE_STATUS_CODE, 404),)

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

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -25,13 +25,13 @@
2525
from opentelemetry.instrumentation._semconv import (
2626
_filter_semconv_active_request_count_attr,
2727
_filter_semconv_duration_attrs,
28-
_HTTPStabilityMode,
2928
_report_new,
3029
_report_old,
3130
_server_active_requests_count_attrs_new,
3231
_server_active_requests_count_attrs_old,
3332
_server_duration_attrs_new,
3433
_server_duration_attrs_old,
34+
_StabilityMode,
3535
)
3636
from opentelemetry.instrumentation.propagators import (
3737
get_global_response_propagator,
@@ -158,7 +158,7 @@ class _DjangoMiddleware(MiddlewareMixin):
158158
_duration_histogram_old = None
159159
_duration_histogram_new = None
160160
_active_request_counter = None
161-
_sem_conv_opt_in_mode = _HTTPStabilityMode.DEFAULT
161+
_sem_conv_opt_in_mode = _StabilityMode.DEFAULT
162162

163163
_otel_request_hook: Callable[[Span, HttpRequest], None] = None
164164
_otel_response_hook: Callable[[Span, HttpRequest, HttpResponse], None] = (
@@ -430,7 +430,7 @@ def process_response(self, request, response):
430430
duration_s = default_timer() - request_start_time
431431
if self._duration_histogram_old:
432432
duration_attrs_old = _parse_duration_attrs(
433-
duration_attrs, _HTTPStabilityMode.DEFAULT
433+
duration_attrs, _StabilityMode.DEFAULT
434434
)
435435
# http.target to be included in old semantic conventions
436436
target = duration_attrs.get(SpanAttributes.HTTP_TARGET)
@@ -441,7 +441,7 @@ def process_response(self, request, response):
441441
)
442442
if self._duration_histogram_new:
443443
duration_attrs_new = _parse_duration_attrs(
444-
duration_attrs, _HTTPStabilityMode.HTTP
444+
duration_attrs, _StabilityMode.HTTP
445445
)
446446
self._duration_histogram_new.record(
447447
max(duration_s, 0), duration_attrs_new
@@ -455,7 +455,7 @@ def process_response(self, request, response):
455455

456456

457457
def _parse_duration_attrs(
458-
req_attrs, sem_conv_opt_in_mode=_HTTPStabilityMode.DEFAULT
458+
req_attrs, sem_conv_opt_in_mode=_StabilityMode.DEFAULT
459459
):
460460
return _filter_semconv_duration_attrs(
461461
req_attrs,
@@ -466,7 +466,7 @@ def _parse_duration_attrs(
466466

467467

468468
def _parse_active_request_count_attrs(
469-
req_attrs, sem_conv_opt_in_mode=_HTTPStabilityMode.DEFAULT
469+
req_attrs, sem_conv_opt_in_mode=_StabilityMode.DEFAULT
470470
):
471471
return _filter_semconv_active_request_count_attr(
472472
req_attrs,

‎instrumentation/opentelemetry-instrumentation-fastapi/src/opentelemetry/instrumentation/fastapi/__init__.py‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -186,9 +186,9 @@ def client_response_hook(span: Span, scope: dict[str, Any], message: dict[str, A
186186

187187
from opentelemetry.instrumentation._semconv import (
188188
_get_schema_url,
189-
_HTTPStabilityMode,
190189
_OpenTelemetrySemanticConventionStability,
191190
_OpenTelemetryStabilitySignalType,
191+
_StabilityMode,
192192
)
193193
from opentelemetry.instrumentation.asgi import OpenTelemetryMiddleware
194194
from opentelemetry.instrumentation.asgi.types import (
@@ -362,7 +362,7 @@ class _InstrumentedFastAPI(fastapi.FastAPI):
362362
_client_request_hook: ClientRequestHook = None
363363
_client_response_hook: ClientResponseHook = None
364364
_instrumented_fastapi_apps = set()
365-
_sem_conv_opt_in_mode = _HTTPStabilityMode.DEFAULT
365+
_sem_conv_opt_in_mode = _StabilityMode.DEFAULT
366366

367367
def __init__(self, *args, **kwargs):
368368
super().__init__(*args, **kwargs)

0 commit comments

Comments
 (0)