opentelemetry-instrumentation 0.45b0__tar.gz → 0.47b0__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (30) hide show
  1. {opentelemetry_instrumentation-0.45b0 → opentelemetry_instrumentation-0.47b0}/.gitignore +3 -0
  2. {opentelemetry_instrumentation-0.45b0 → opentelemetry_instrumentation-0.47b0}/LICENSE +1 -1
  3. {opentelemetry_instrumentation-0.45b0 → opentelemetry_instrumentation-0.47b0}/PKG-INFO +2 -1
  4. {opentelemetry_instrumentation-0.45b0 → opentelemetry_instrumentation-0.47b0}/pyproject.toml +1 -0
  5. opentelemetry_instrumentation-0.47b0/src/opentelemetry/instrumentation/_semconv.py +396 -0
  6. {opentelemetry_instrumentation-0.45b0 → opentelemetry_instrumentation-0.47b0}/src/opentelemetry/instrumentation/bootstrap.py +25 -16
  7. {opentelemetry_instrumentation-0.45b0 → opentelemetry_instrumentation-0.47b0}/src/opentelemetry/instrumentation/bootstrap_gen.py +55 -54
  8. {opentelemetry_instrumentation-0.45b0 → opentelemetry_instrumentation-0.47b0}/src/opentelemetry/instrumentation/distro.py +4 -3
  9. {opentelemetry_instrumentation-0.45b0 → opentelemetry_instrumentation-0.47b0}/src/opentelemetry/instrumentation/utils.py +11 -4
  10. {opentelemetry_instrumentation-0.45b0 → opentelemetry_instrumentation-0.47b0}/src/opentelemetry/instrumentation/version.py +1 -1
  11. {opentelemetry_instrumentation-0.45b0 → opentelemetry_instrumentation-0.47b0}/tests/auto_instrumentation/test_load.py +9 -5
  12. {opentelemetry_instrumentation-0.45b0 → opentelemetry_instrumentation-0.47b0}/tests/test_utils.py +54 -0
  13. opentelemetry_instrumentation-0.45b0/src/opentelemetry/instrumentation/_semconv.py +0 -217
  14. {opentelemetry_instrumentation-0.45b0 → opentelemetry_instrumentation-0.47b0}/README.rst +0 -0
  15. {opentelemetry_instrumentation-0.45b0 → opentelemetry_instrumentation-0.47b0}/src/opentelemetry/instrumentation/auto_instrumentation/__init__.py +0 -0
  16. {opentelemetry_instrumentation-0.45b0 → opentelemetry_instrumentation-0.47b0}/src/opentelemetry/instrumentation/auto_instrumentation/_load.py +0 -0
  17. {opentelemetry_instrumentation-0.45b0 → opentelemetry_instrumentation-0.47b0}/src/opentelemetry/instrumentation/auto_instrumentation/sitecustomize.py +0 -0
  18. {opentelemetry_instrumentation-0.45b0 → opentelemetry_instrumentation-0.47b0}/src/opentelemetry/instrumentation/dependencies.py +0 -0
  19. {opentelemetry_instrumentation-0.45b0 → opentelemetry_instrumentation-0.47b0}/src/opentelemetry/instrumentation/environment_variables.py +0 -0
  20. {opentelemetry_instrumentation-0.45b0 → opentelemetry_instrumentation-0.47b0}/src/opentelemetry/instrumentation/instrumentor.py +0 -0
  21. {opentelemetry_instrumentation-0.45b0 → opentelemetry_instrumentation-0.47b0}/src/opentelemetry/instrumentation/propagators.py +0 -0
  22. {opentelemetry_instrumentation-0.45b0 → opentelemetry_instrumentation-0.47b0}/src/opentelemetry/instrumentation/py.typed +0 -0
  23. {opentelemetry_instrumentation-0.45b0 → opentelemetry_instrumentation-0.47b0}/src/opentelemetry/instrumentation/sqlcommenter_utils.py +0 -0
  24. {opentelemetry_instrumentation-0.45b0 → opentelemetry_instrumentation-0.47b0}/tests/__init__.py +0 -0
  25. {opentelemetry_instrumentation-0.45b0 → opentelemetry_instrumentation-0.47b0}/tests/auto_instrumentation/test_run.py +0 -0
  26. {opentelemetry_instrumentation-0.45b0 → opentelemetry_instrumentation-0.47b0}/tests/test_bootstrap.py +0 -0
  27. {opentelemetry_instrumentation-0.45b0 → opentelemetry_instrumentation-0.47b0}/tests/test_dependencies.py +0 -0
  28. {opentelemetry_instrumentation-0.45b0 → opentelemetry_instrumentation-0.47b0}/tests/test_distro.py +0 -0
  29. {opentelemetry_instrumentation-0.45b0 → opentelemetry_instrumentation-0.47b0}/tests/test_instrumentor.py +0 -0
  30. {opentelemetry_instrumentation-0.45b0 → opentelemetry_instrumentation-0.47b0}/tests/test_propagators.py +0 -0
@@ -58,3 +58,6 @@ _build/
58
58
  # mypy
59
59
  .mypy_cache/
60
60
  target
61
+
62
+ # Benchmark result files
63
+ *-benchmark.json
@@ -186,7 +186,7 @@
186
186
  same "printed page" as the copyright notice for easier
187
187
  identification within third-party archives.
188
188
 
189
- Copyright The OpenTelemetry Authors
189
+ Copyright [yyyy] [name of copyright owner]
190
190
 
191
191
  Licensed under the Apache License, Version 2.0 (the "License");
192
192
  you may not use this file except in compliance with the License.
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.3
2
2
  Name: opentelemetry-instrumentation
3
- Version: 0.45b0
3
+ Version: 0.47b0
4
4
  Summary: Instrumentation Tools & Auto Instrumentation for OpenTelemetry Python
5
5
  Project-URL: Homepage, https://github.com/open-telemetry/opentelemetry-python-contrib/tree/main/opentelemetry-instrumentation
6
6
  Author-email: OpenTelemetry Authors <cncf-opentelemetry-contributors@lists.cncf.io>
@@ -15,6 +15,7 @@ Classifier: Programming Language :: Python :: 3.8
15
15
  Classifier: Programming Language :: Python :: 3.9
16
16
  Classifier: Programming Language :: Python :: 3.10
17
17
  Classifier: Programming Language :: Python :: 3.11
18
+ Classifier: Programming Language :: Python :: 3.12
18
19
  Requires-Python: >=3.8
19
20
  Requires-Dist: opentelemetry-api~=1.4
20
21
  Requires-Dist: setuptools>=16.0
@@ -22,6 +22,7 @@ classifiers = [
22
22
  "Programming Language :: Python :: 3.9",
23
23
  "Programming Language :: Python :: 3.10",
24
24
  "Programming Language :: Python :: 3.11",
25
+ "Programming Language :: Python :: 3.12",
25
26
  ]
26
27
  dependencies = [
27
28
  "opentelemetry-api ~= 1.4",
@@ -0,0 +1,396 @@
1
+ # Copyright The OpenTelemetry Authors
2
+ #
3
+ # Licensed under the Apache License, Version 2.0 (the "License");
4
+ # you may not use this file except in compliance with the License.
5
+ # You may obtain a copy of the License at
6
+ #
7
+ # http://www.apache.org/licenses/LICENSE-2.0
8
+ #
9
+ # Unless required by applicable law or agreed to in writing, software
10
+ # distributed under the License is distributed on an "AS IS" BASIS,
11
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12
+ # See the License for the specific language governing permissions and
13
+ # limitations under the License.
14
+
15
+ import os
16
+ import threading
17
+ from enum import Enum
18
+
19
+ from opentelemetry.instrumentation.utils import http_status_to_status_code
20
+ from opentelemetry.semconv.attributes.client_attributes import (
21
+ CLIENT_ADDRESS,
22
+ CLIENT_PORT,
23
+ )
24
+ from opentelemetry.semconv.attributes.error_attributes import ERROR_TYPE
25
+ from opentelemetry.semconv.attributes.http_attributes import (
26
+ HTTP_REQUEST_METHOD,
27
+ HTTP_REQUEST_METHOD_ORIGINAL,
28
+ HTTP_RESPONSE_STATUS_CODE,
29
+ HTTP_ROUTE,
30
+ )
31
+ from opentelemetry.semconv.attributes.network_attributes import (
32
+ NETWORK_PROTOCOL_VERSION,
33
+ )
34
+ from opentelemetry.semconv.attributes.server_attributes import (
35
+ SERVER_ADDRESS,
36
+ SERVER_PORT,
37
+ )
38
+ from opentelemetry.semconv.attributes.url_attributes import (
39
+ URL_FULL,
40
+ URL_PATH,
41
+ URL_QUERY,
42
+ URL_SCHEME,
43
+ )
44
+ from opentelemetry.semconv.attributes.user_agent_attributes import (
45
+ USER_AGENT_ORIGINAL,
46
+ )
47
+ from opentelemetry.semconv.trace import SpanAttributes
48
+ from opentelemetry.trace.status import Status, StatusCode
49
+
50
+ # These lists represent attributes for metrics that are currently supported
51
+
52
+ _client_duration_attrs_old = [
53
+ SpanAttributes.HTTP_STATUS_CODE,
54
+ SpanAttributes.HTTP_HOST,
55
+ SpanAttributes.NET_PEER_PORT,
56
+ SpanAttributes.NET_PEER_NAME,
57
+ SpanAttributes.HTTP_METHOD,
58
+ SpanAttributes.HTTP_FLAVOR,
59
+ SpanAttributes.HTTP_SCHEME,
60
+ ]
61
+
62
+ _client_duration_attrs_new = [
63
+ ERROR_TYPE,
64
+ HTTP_REQUEST_METHOD,
65
+ HTTP_RESPONSE_STATUS_CODE,
66
+ NETWORK_PROTOCOL_VERSION,
67
+ SERVER_ADDRESS,
68
+ SERVER_PORT,
69
+ # TODO: Support opt-in for scheme in new semconv
70
+ # URL_SCHEME,
71
+ ]
72
+
73
+ _server_duration_attrs_old = [
74
+ SpanAttributes.HTTP_METHOD,
75
+ SpanAttributes.HTTP_HOST,
76
+ SpanAttributes.HTTP_SCHEME,
77
+ SpanAttributes.HTTP_STATUS_CODE,
78
+ SpanAttributes.HTTP_FLAVOR,
79
+ SpanAttributes.HTTP_SERVER_NAME,
80
+ SpanAttributes.NET_HOST_NAME,
81
+ SpanAttributes.NET_HOST_PORT,
82
+ ]
83
+
84
+ _server_duration_attrs_new = [
85
+ ERROR_TYPE,
86
+ HTTP_REQUEST_METHOD,
87
+ HTTP_RESPONSE_STATUS_CODE,
88
+ HTTP_ROUTE,
89
+ NETWORK_PROTOCOL_VERSION,
90
+ URL_SCHEME,
91
+ ]
92
+
93
+ _server_active_requests_count_attrs_old = [
94
+ SpanAttributes.HTTP_METHOD,
95
+ SpanAttributes.HTTP_HOST,
96
+ SpanAttributes.HTTP_SCHEME,
97
+ SpanAttributes.HTTP_FLAVOR,
98
+ SpanAttributes.HTTP_SERVER_NAME,
99
+ ]
100
+
101
+ _server_active_requests_count_attrs_new = [
102
+ HTTP_REQUEST_METHOD,
103
+ URL_SCHEME,
104
+ # TODO: Support SERVER_ADDRESS AND SERVER_PORT
105
+ ]
106
+
107
+ OTEL_SEMCONV_STABILITY_OPT_IN = "OTEL_SEMCONV_STABILITY_OPT_IN"
108
+
109
+
110
+ class _OpenTelemetryStabilitySignalType:
111
+ HTTP = "http"
112
+
113
+
114
+ class _HTTPStabilityMode(Enum):
115
+ # http - emit the new, stable HTTP and networking conventions ONLY
116
+ HTTP = "http"
117
+ # http/dup - emit both the old and the stable HTTP and networking conventions
118
+ HTTP_DUP = "http/dup"
119
+ # default - continue emitting old experimental HTTP and networking conventions
120
+ DEFAULT = "default"
121
+
122
+
123
+ def _report_new(mode):
124
+ return mode.name != _HTTPStabilityMode.DEFAULT.name
125
+
126
+
127
+ def _report_old(mode):
128
+ return mode.name != _HTTPStabilityMode.HTTP.name
129
+
130
+
131
+ class _OpenTelemetrySemanticConventionStability:
132
+ _initialized = False
133
+ _lock = threading.Lock()
134
+ _OTEL_SEMCONV_STABILITY_SIGNAL_MAPPING = {}
135
+
136
+ @classmethod
137
+ def _initialize(cls):
138
+ with _OpenTelemetrySemanticConventionStability._lock:
139
+ if not _OpenTelemetrySemanticConventionStability._initialized:
140
+ # Users can pass in comma delimited string for opt-in options
141
+ # Only values for http stability are supported for now
142
+ opt_in = os.environ.get(OTEL_SEMCONV_STABILITY_OPT_IN, "")
143
+ opt_in_list = []
144
+ if opt_in:
145
+ opt_in_list = [s.strip() for s in opt_in.split(",")]
146
+ http_opt_in = _HTTPStabilityMode.DEFAULT
147
+ if opt_in_list:
148
+ # Process http opt-in
149
+ # http/dup takes priority over http
150
+ if _HTTPStabilityMode.HTTP_DUP.value in opt_in_list:
151
+ http_opt_in = _HTTPStabilityMode.HTTP_DUP
152
+ elif _HTTPStabilityMode.HTTP.value in opt_in_list:
153
+ http_opt_in = _HTTPStabilityMode.HTTP
154
+ _OpenTelemetrySemanticConventionStability._OTEL_SEMCONV_STABILITY_SIGNAL_MAPPING[
155
+ _OpenTelemetryStabilitySignalType.HTTP
156
+ ] = http_opt_in
157
+ _OpenTelemetrySemanticConventionStability._initialized = True
158
+
159
+ @classmethod
160
+ # Get OpenTelemetry opt-in mode based off of signal type (http, messaging, etc.)
161
+ def _get_opentelemetry_stability_opt_in_mode(
162
+ cls,
163
+ signal_type: _OpenTelemetryStabilitySignalType,
164
+ ) -> _HTTPStabilityMode:
165
+ return _OpenTelemetrySemanticConventionStability._OTEL_SEMCONV_STABILITY_SIGNAL_MAPPING.get(
166
+ signal_type, _HTTPStabilityMode.DEFAULT
167
+ )
168
+
169
+
170
+ def _filter_semconv_duration_attrs(
171
+ attrs,
172
+ old_attrs,
173
+ new_attrs,
174
+ sem_conv_opt_in_mode=_HTTPStabilityMode.DEFAULT,
175
+ ):
176
+ filtered_attrs = {}
177
+ # duration is two different metrics depending on sem_conv_opt_in_mode, so no DUP attributes
178
+ allowed_attributes = (
179
+ new_attrs
180
+ if sem_conv_opt_in_mode == _HTTPStabilityMode.HTTP
181
+ else old_attrs
182
+ )
183
+ for key, val in attrs.items():
184
+ if key in allowed_attributes:
185
+ filtered_attrs[key] = val
186
+ return filtered_attrs
187
+
188
+
189
+ def _filter_semconv_active_request_count_attr(
190
+ attrs,
191
+ old_attrs,
192
+ new_attrs,
193
+ sem_conv_opt_in_mode=_HTTPStabilityMode.DEFAULT,
194
+ ):
195
+ filtered_attrs = {}
196
+ if _report_old(sem_conv_opt_in_mode):
197
+ for key, val in attrs.items():
198
+ if key in old_attrs:
199
+ filtered_attrs[key] = val
200
+ if _report_new(sem_conv_opt_in_mode):
201
+ for key, val in attrs.items():
202
+ if key in new_attrs:
203
+ filtered_attrs[key] = val
204
+ return filtered_attrs
205
+
206
+
207
+ def set_string_attribute(result, key, value):
208
+ if value:
209
+ result[key] = value
210
+
211
+
212
+ def set_int_attribute(result, key, value):
213
+ if value:
214
+ try:
215
+ result[key] = int(value)
216
+ except ValueError:
217
+ return
218
+
219
+
220
+ def _set_http_method(result, original, normalized, sem_conv_opt_in_mode):
221
+ original = original.strip()
222
+ normalized = normalized.strip()
223
+ # See https://github.com/open-telemetry/semantic-conventions/blob/main/docs/http/http-spans.md#common-attributes
224
+ # Method is case sensitive. "http.request.method_original" should not be sanitized or automatically capitalized.
225
+ if original != normalized and _report_new(sem_conv_opt_in_mode):
226
+ set_string_attribute(result, HTTP_REQUEST_METHOD_ORIGINAL, original)
227
+
228
+ if _report_old(sem_conv_opt_in_mode):
229
+ set_string_attribute(result, SpanAttributes.HTTP_METHOD, normalized)
230
+ if _report_new(sem_conv_opt_in_mode):
231
+ set_string_attribute(result, HTTP_REQUEST_METHOD, normalized)
232
+
233
+
234
+ def _set_http_status_code(result, code, sem_conv_opt_in_mode):
235
+ if _report_old(sem_conv_opt_in_mode):
236
+ set_int_attribute(result, SpanAttributes.HTTP_STATUS_CODE, code)
237
+ if _report_new(sem_conv_opt_in_mode):
238
+ set_int_attribute(result, HTTP_RESPONSE_STATUS_CODE, code)
239
+
240
+
241
+ def _set_http_url(result, url, sem_conv_opt_in_mode):
242
+ if _report_old(sem_conv_opt_in_mode):
243
+ set_string_attribute(result, SpanAttributes.HTTP_URL, url)
244
+ if _report_new(sem_conv_opt_in_mode):
245
+ set_string_attribute(result, URL_FULL, url)
246
+
247
+
248
+ def _set_http_scheme(result, scheme, sem_conv_opt_in_mode):
249
+ if _report_old(sem_conv_opt_in_mode):
250
+ set_string_attribute(result, SpanAttributes.HTTP_SCHEME, scheme)
251
+ if _report_new(sem_conv_opt_in_mode):
252
+ set_string_attribute(result, URL_SCHEME, scheme)
253
+
254
+
255
+ def _set_http_host(result, host, sem_conv_opt_in_mode):
256
+ if _report_old(sem_conv_opt_in_mode):
257
+ set_string_attribute(result, SpanAttributes.HTTP_HOST, host)
258
+ if _report_new(sem_conv_opt_in_mode):
259
+ set_string_attribute(result, SERVER_ADDRESS, host)
260
+
261
+
262
+ # Client
263
+
264
+
265
+ def _set_http_net_peer_name_client(result, peer_name, sem_conv_opt_in_mode):
266
+ if _report_old(sem_conv_opt_in_mode):
267
+ set_string_attribute(result, SpanAttributes.NET_PEER_NAME, peer_name)
268
+ if _report_new(sem_conv_opt_in_mode):
269
+ set_string_attribute(result, SERVER_ADDRESS, peer_name)
270
+
271
+
272
+ def _set_http_peer_port_client(result, port, sem_conv_opt_in_mode):
273
+ if _report_old(sem_conv_opt_in_mode):
274
+ set_int_attribute(result, SpanAttributes.NET_PEER_PORT, port)
275
+ if _report_new(sem_conv_opt_in_mode):
276
+ set_int_attribute(result, SERVER_PORT, port)
277
+
278
+
279
+ def _set_http_network_protocol_version(result, version, sem_conv_opt_in_mode):
280
+ if _report_old(sem_conv_opt_in_mode):
281
+ set_string_attribute(result, SpanAttributes.HTTP_FLAVOR, version)
282
+ if _report_new(sem_conv_opt_in_mode):
283
+ set_string_attribute(result, NETWORK_PROTOCOL_VERSION, version)
284
+
285
+
286
+ # Server
287
+
288
+
289
+ def _set_http_net_host(result, host, sem_conv_opt_in_mode):
290
+ if _report_old(sem_conv_opt_in_mode):
291
+ set_string_attribute(result, SpanAttributes.NET_HOST_NAME, host)
292
+ if _report_new(sem_conv_opt_in_mode):
293
+ set_string_attribute(result, SERVER_ADDRESS, host)
294
+
295
+
296
+ def _set_http_net_host_port(result, port, sem_conv_opt_in_mode):
297
+ if _report_old(sem_conv_opt_in_mode):
298
+ set_int_attribute(result, SpanAttributes.NET_HOST_PORT, port)
299
+ if _report_new(sem_conv_opt_in_mode):
300
+ set_int_attribute(result, SERVER_PORT, port)
301
+
302
+
303
+ def _set_http_target(result, target, path, query, sem_conv_opt_in_mode):
304
+ if _report_old(sem_conv_opt_in_mode):
305
+ set_string_attribute(result, SpanAttributes.HTTP_TARGET, target)
306
+ if _report_new(sem_conv_opt_in_mode):
307
+ if path:
308
+ set_string_attribute(result, URL_PATH, path)
309
+ if query:
310
+ set_string_attribute(result, URL_QUERY, query)
311
+
312
+
313
+ def _set_http_peer_ip(result, ip, sem_conv_opt_in_mode):
314
+ if _report_old(sem_conv_opt_in_mode):
315
+ set_string_attribute(result, SpanAttributes.NET_PEER_IP, ip)
316
+ if _report_new(sem_conv_opt_in_mode):
317
+ set_string_attribute(result, CLIENT_ADDRESS, ip)
318
+
319
+
320
+ def _set_http_peer_port_server(result, port, sem_conv_opt_in_mode):
321
+ if _report_old(sem_conv_opt_in_mode):
322
+ set_int_attribute(result, SpanAttributes.NET_PEER_PORT, port)
323
+ if _report_new(sem_conv_opt_in_mode):
324
+ set_int_attribute(result, CLIENT_PORT, port)
325
+
326
+
327
+ def _set_http_user_agent(result, user_agent, sem_conv_opt_in_mode):
328
+ if _report_old(sem_conv_opt_in_mode):
329
+ set_string_attribute(
330
+ result, SpanAttributes.HTTP_USER_AGENT, user_agent
331
+ )
332
+ if _report_new(sem_conv_opt_in_mode):
333
+ set_string_attribute(result, USER_AGENT_ORIGINAL, user_agent)
334
+
335
+
336
+ def _set_http_net_peer_name_server(result, name, sem_conv_opt_in_mode):
337
+ if _report_old(sem_conv_opt_in_mode):
338
+ set_string_attribute(result, SpanAttributes.NET_PEER_NAME, name)
339
+ if _report_new(sem_conv_opt_in_mode):
340
+ set_string_attribute(result, CLIENT_ADDRESS, name)
341
+
342
+
343
+ def _set_http_flavor_version(result, version, sem_conv_opt_in_mode):
344
+ if _report_old(sem_conv_opt_in_mode):
345
+ set_string_attribute(result, SpanAttributes.HTTP_FLAVOR, version)
346
+ if _report_new(sem_conv_opt_in_mode):
347
+ set_string_attribute(result, NETWORK_PROTOCOL_VERSION, version)
348
+
349
+
350
+ def _set_status(
351
+ span,
352
+ metrics_attributes: dict,
353
+ status_code: int,
354
+ status_code_str: str,
355
+ server_span: bool = True,
356
+ sem_conv_opt_in_mode: _HTTPStabilityMode = _HTTPStabilityMode.DEFAULT,
357
+ ):
358
+ if status_code < 0:
359
+ metrics_attributes[ERROR_TYPE] = status_code_str
360
+ if span.is_recording():
361
+ if _report_new(sem_conv_opt_in_mode):
362
+ span.set_attribute(ERROR_TYPE, status_code_str)
363
+ span.set_status(
364
+ Status(
365
+ StatusCode.ERROR,
366
+ "Non-integer HTTP status: " + status_code_str,
367
+ )
368
+ )
369
+ else:
370
+ status = http_status_to_status_code(
371
+ status_code, server_span=server_span
372
+ )
373
+
374
+ if _report_old(sem_conv_opt_in_mode):
375
+ if span.is_recording():
376
+ span.set_attribute(
377
+ SpanAttributes.HTTP_STATUS_CODE, status_code
378
+ )
379
+ metrics_attributes[SpanAttributes.HTTP_STATUS_CODE] = status_code
380
+ if _report_new(sem_conv_opt_in_mode):
381
+ if span.is_recording():
382
+ span.set_attribute(HTTP_RESPONSE_STATUS_CODE, status_code)
383
+ metrics_attributes[HTTP_RESPONSE_STATUS_CODE] = status_code
384
+ if status == StatusCode.ERROR:
385
+ if span.is_recording():
386
+ span.set_attribute(ERROR_TYPE, status_code_str)
387
+ metrics_attributes[ERROR_TYPE] = status_code_str
388
+ if span.is_recording():
389
+ span.set_status(Status(status))
390
+
391
+
392
+ # Get schema version based off of opt-in mode
393
+ def _get_schema_url(mode: _HTTPStabilityMode) -> str:
394
+ if mode is _HTTPStabilityMode.DEFAULT:
395
+ return "https://opentelemetry.io/schemas/1.11.0"
396
+ return SpanAttributes.SCHEMA_URL
@@ -14,8 +14,14 @@
14
14
 
15
15
  import argparse
16
16
  import logging
17
- import subprocess
18
17
  import sys
18
+ from subprocess import (
19
+ PIPE,
20
+ CalledProcessError,
21
+ Popen,
22
+ SubprocessError,
23
+ check_call,
24
+ )
19
25
 
20
26
  import pkg_resources
21
27
 
@@ -34,7 +40,7 @@ def _syscall(func):
34
40
  if package:
35
41
  return func(package)
36
42
  return func()
37
- except subprocess.SubprocessError as exp:
43
+ except SubprocessError as exp:
38
44
  cmd = getattr(exp, "cmd", None)
39
45
  if cmd:
40
46
  msg = f'Error calling system command "{" ".join(cmd)}"'
@@ -48,18 +54,21 @@ def _syscall(func):
48
54
  @_syscall
49
55
  def _sys_pip_install(package):
50
56
  # explicit upgrade strategy to override potential pip config
51
- subprocess.check_call(
52
- [
53
- sys.executable,
54
- "-m",
55
- "pip",
56
- "install",
57
- "-U",
58
- "--upgrade-strategy",
59
- "only-if-needed",
60
- package,
61
- ]
62
- )
57
+ try:
58
+ check_call(
59
+ [
60
+ sys.executable,
61
+ "-m",
62
+ "pip",
63
+ "install",
64
+ "-U",
65
+ "--upgrade-strategy",
66
+ "only-if-needed",
67
+ package,
68
+ ]
69
+ )
70
+ except CalledProcessError as error:
71
+ print(error)
63
72
 
64
73
 
65
74
  def _pip_check():
@@ -70,8 +79,8 @@ def _pip_check():
70
79
  'opentelemetry-instrumentation-flask 1.0.1 has requirement opentelemetry-sdk<2.0,>=1.0, but you have opentelemetry-sdk 0.5.'
71
80
  To not be too restrictive, we'll only check for relevant packages.
72
81
  """
73
- with subprocess.Popen(
74
- [sys.executable, "-m", "pip", "check"], stdout=subprocess.PIPE
82
+ with Popen(
83
+ [sys.executable, "-m", "pip", "check"], stdout=PIPE
75
84
  ) as check_pipe:
76
85
  pip_check = check_pipe.communicate()[0].decode()
77
86
  pip_check_lower = pip_check.lower()
@@ -18,179 +18,180 @@
18
18
  libraries = [
19
19
  {
20
20
  "library": "aio_pika >= 7.2.0, < 10.0.0",
21
- "instrumentation": "opentelemetry-instrumentation-aio-pika==0.45b0",
21
+ "instrumentation": "opentelemetry-instrumentation-aio-pika==0.47b0",
22
22
  },
23
23
  {
24
24
  "library": "aiohttp ~= 3.0",
25
- "instrumentation": "opentelemetry-instrumentation-aiohttp-client==0.45b0",
25
+ "instrumentation": "opentelemetry-instrumentation-aiohttp-client==0.47b0",
26
26
  },
27
27
  {
28
28
  "library": "aiohttp ~= 3.0",
29
- "instrumentation": "opentelemetry-instrumentation-aiohttp-server==0.45b0",
29
+ "instrumentation": "opentelemetry-instrumentation-aiohttp-server==0.47b0",
30
30
  },
31
31
  {
32
32
  "library": "aiopg >= 0.13.0, < 2.0.0",
33
- "instrumentation": "opentelemetry-instrumentation-aiopg==0.45b0",
33
+ "instrumentation": "opentelemetry-instrumentation-aiopg==0.47b0",
34
34
  },
35
35
  {
36
36
  "library": "asgiref ~= 3.0",
37
- "instrumentation": "opentelemetry-instrumentation-asgi==0.45b0",
37
+ "instrumentation": "opentelemetry-instrumentation-asgi==0.47b0",
38
38
  },
39
39
  {
40
40
  "library": "asyncpg >= 0.12.0",
41
- "instrumentation": "opentelemetry-instrumentation-asyncpg==0.45b0",
41
+ "instrumentation": "opentelemetry-instrumentation-asyncpg==0.47b0",
42
42
  },
43
43
  {
44
44
  "library": "boto~=2.0",
45
- "instrumentation": "opentelemetry-instrumentation-boto==0.45b0",
45
+ "instrumentation": "opentelemetry-instrumentation-boto==0.47b0",
46
46
  },
47
47
  {
48
48
  "library": "boto3 ~= 1.0",
49
- "instrumentation": "opentelemetry-instrumentation-boto3sqs==0.45b0",
49
+ "instrumentation": "opentelemetry-instrumentation-boto3sqs==0.47b0",
50
50
  },
51
51
  {
52
52
  "library": "botocore ~= 1.0",
53
- "instrumentation": "opentelemetry-instrumentation-botocore==0.45b0",
53
+ "instrumentation": "opentelemetry-instrumentation-botocore==0.47b0",
54
54
  },
55
55
  {
56
56
  "library": "cassandra-driver ~= 3.25",
57
- "instrumentation": "opentelemetry-instrumentation-cassandra==0.45b0",
57
+ "instrumentation": "opentelemetry-instrumentation-cassandra==0.47b0",
58
58
  },
59
59
  {
60
60
  "library": "scylla-driver ~= 3.25",
61
- "instrumentation": "opentelemetry-instrumentation-cassandra==0.45b0",
61
+ "instrumentation": "opentelemetry-instrumentation-cassandra==0.47b0",
62
62
  },
63
63
  {
64
64
  "library": "celery >= 4.0, < 6.0",
65
- "instrumentation": "opentelemetry-instrumentation-celery==0.45b0",
65
+ "instrumentation": "opentelemetry-instrumentation-celery==0.47b0",
66
66
  },
67
67
  {
68
- "library": "confluent-kafka >= 1.8.2, <= 2.3.0",
69
- "instrumentation": "opentelemetry-instrumentation-confluent-kafka==0.45b0",
68
+ "library": "confluent-kafka >= 1.8.2, <= 2.4.0",
69
+ "instrumentation": "opentelemetry-instrumentation-confluent-kafka==0.47b0",
70
70
  },
71
71
  {
72
72
  "library": "django >= 1.10",
73
- "instrumentation": "opentelemetry-instrumentation-django==0.45b0",
73
+ "instrumentation": "opentelemetry-instrumentation-django==0.47b0",
74
74
  },
75
75
  {
76
- "library": "elasticsearch >= 2.0",
77
- "instrumentation": "opentelemetry-instrumentation-elasticsearch==0.45b0",
76
+ "library": "elasticsearch >= 6.0",
77
+ "instrumentation": "opentelemetry-instrumentation-elasticsearch==0.47b0",
78
78
  },
79
79
  {
80
80
  "library": "falcon >= 1.4.1, < 3.1.2",
81
- "instrumentation": "opentelemetry-instrumentation-falcon==0.45b0",
81
+ "instrumentation": "opentelemetry-instrumentation-falcon==0.47b0",
82
82
  },
83
83
  {
84
84
  "library": "fastapi ~= 0.58",
85
- "instrumentation": "opentelemetry-instrumentation-fastapi==0.45b0",
85
+ "instrumentation": "opentelemetry-instrumentation-fastapi==0.47b0",
86
+ },
87
+ {
88
+ "library": "fastapi-slim ~= 0.111.0",
89
+ "instrumentation": "opentelemetry-instrumentation-fastapi==0.47b0",
86
90
  },
87
91
  {
88
92
  "library": "flask >= 1.0",
89
- "instrumentation": "opentelemetry-instrumentation-flask==0.45b0",
93
+ "instrumentation": "opentelemetry-instrumentation-flask==0.47b0",
90
94
  },
91
95
  {
92
96
  "library": "grpcio ~= 1.27",
93
- "instrumentation": "opentelemetry-instrumentation-grpc==0.45b0",
97
+ "instrumentation": "opentelemetry-instrumentation-grpc==0.47b0",
94
98
  },
95
99
  {
96
100
  "library": "httpx >= 0.18.0",
97
- "instrumentation": "opentelemetry-instrumentation-httpx==0.45b0",
101
+ "instrumentation": "opentelemetry-instrumentation-httpx==0.47b0",
98
102
  },
99
103
  {
100
104
  "library": "jinja2 >= 2.7, < 4.0",
101
- "instrumentation": "opentelemetry-instrumentation-jinja2==0.45b0",
105
+ "instrumentation": "opentelemetry-instrumentation-jinja2==0.47b0",
102
106
  },
103
107
  {
104
108
  "library": "kafka-python >= 2.0",
105
- "instrumentation": "opentelemetry-instrumentation-kafka-python==0.45b0",
109
+ "instrumentation": "opentelemetry-instrumentation-kafka-python==0.47b0",
106
110
  },
107
111
  {
108
112
  "library": "mysql-connector-python ~= 8.0",
109
- "instrumentation": "opentelemetry-instrumentation-mysql==0.45b0",
113
+ "instrumentation": "opentelemetry-instrumentation-mysql==0.47b0",
110
114
  },
111
115
  {
112
116
  "library": "mysqlclient < 3",
113
- "instrumentation": "opentelemetry-instrumentation-mysqlclient==0.45b0",
117
+ "instrumentation": "opentelemetry-instrumentation-mysqlclient==0.47b0",
114
118
  },
115
119
  {
116
120
  "library": "pika >= 0.12.0",
117
- "instrumentation": "opentelemetry-instrumentation-pika==0.45b0",
121
+ "instrumentation": "opentelemetry-instrumentation-pika==0.47b0",
118
122
  },
119
123
  {
120
124
  "library": "psycopg >= 3.1.0",
121
- "instrumentation": "opentelemetry-instrumentation-psycopg==0.45b0",
125
+ "instrumentation": "opentelemetry-instrumentation-psycopg==0.47b0",
122
126
  },
123
127
  {
124
128
  "library": "psycopg2 >= 2.7.3.1",
125
- "instrumentation": "opentelemetry-instrumentation-psycopg2==0.45b0",
129
+ "instrumentation": "opentelemetry-instrumentation-psycopg2==0.47b0",
126
130
  },
127
131
  {
128
132
  "library": "pymemcache >= 1.3.5, < 5",
129
- "instrumentation": "opentelemetry-instrumentation-pymemcache==0.45b0",
133
+ "instrumentation": "opentelemetry-instrumentation-pymemcache==0.47b0",
130
134
  },
131
135
  {
132
136
  "library": "pymongo >= 3.1, < 5.0",
133
- "instrumentation": "opentelemetry-instrumentation-pymongo==0.45b0",
137
+ "instrumentation": "opentelemetry-instrumentation-pymongo==0.47b0",
134
138
  },
135
139
  {
136
140
  "library": "PyMySQL < 2",
137
- "instrumentation": "opentelemetry-instrumentation-pymysql==0.45b0",
141
+ "instrumentation": "opentelemetry-instrumentation-pymysql==0.47b0",
138
142
  },
139
143
  {
140
144
  "library": "pyramid >= 1.7",
141
- "instrumentation": "opentelemetry-instrumentation-pyramid==0.45b0",
145
+ "instrumentation": "opentelemetry-instrumentation-pyramid==0.47b0",
142
146
  },
143
147
  {
144
148
  "library": "redis >= 2.6",
145
- "instrumentation": "opentelemetry-instrumentation-redis==0.45b0",
149
+ "instrumentation": "opentelemetry-instrumentation-redis==0.47b0",
146
150
  },
147
151
  {
148
152
  "library": "remoulade >= 0.50",
149
- "instrumentation": "opentelemetry-instrumentation-remoulade==0.45b0",
153
+ "instrumentation": "opentelemetry-instrumentation-remoulade==0.47b0",
150
154
  },
151
155
  {
152
156
  "library": "requests ~= 2.0",
153
- "instrumentation": "opentelemetry-instrumentation-requests==0.45b0",
154
- },
155
- {
156
- "library": "scikit-learn ~= 0.24.0",
157
- "instrumentation": "opentelemetry-instrumentation-sklearn==0.45b0",
157
+ "instrumentation": "opentelemetry-instrumentation-requests==0.47b0",
158
158
  },
159
159
  {
160
160
  "library": "sqlalchemy",
161
- "instrumentation": "opentelemetry-instrumentation-sqlalchemy==0.45b0",
161
+ "instrumentation": "opentelemetry-instrumentation-sqlalchemy==0.47b0",
162
162
  },
163
163
  {
164
164
  "library": "starlette ~= 0.13.0",
165
- "instrumentation": "opentelemetry-instrumentation-starlette==0.45b0",
165
+ "instrumentation": "opentelemetry-instrumentation-starlette==0.47b0",
166
166
  },
167
167
  {
168
168
  "library": "psutil >= 5",
169
- "instrumentation": "opentelemetry-instrumentation-system-metrics==0.45b0",
169
+ "instrumentation": "opentelemetry-instrumentation-system-metrics==0.47b0",
170
170
  },
171
171
  {
172
172
  "library": "tornado >= 5.1.1",
173
- "instrumentation": "opentelemetry-instrumentation-tornado==0.45b0",
173
+ "instrumentation": "opentelemetry-instrumentation-tornado==0.47b0",
174
174
  },
175
175
  {
176
176
  "library": "tortoise-orm >= 0.17.0",
177
- "instrumentation": "opentelemetry-instrumentation-tortoiseorm==0.45b0",
177
+ "instrumentation": "opentelemetry-instrumentation-tortoiseorm==0.47b0",
178
178
  },
179
179
  {
180
180
  "library": "pydantic >= 1.10.2",
181
- "instrumentation": "opentelemetry-instrumentation-tortoiseorm==0.45b0",
181
+ "instrumentation": "opentelemetry-instrumentation-tortoiseorm==0.47b0",
182
182
  },
183
183
  {
184
184
  "library": "urllib3 >= 1.0.0, < 3.0.0",
185
- "instrumentation": "opentelemetry-instrumentation-urllib3==0.45b0",
185
+ "instrumentation": "opentelemetry-instrumentation-urllib3==0.47b0",
186
186
  },
187
187
  ]
188
188
  default_instrumentations = [
189
- "opentelemetry-instrumentation-asyncio==0.45b0",
190
- "opentelemetry-instrumentation-aws-lambda==0.45b0",
191
- "opentelemetry-instrumentation-dbapi==0.45b0",
192
- "opentelemetry-instrumentation-logging==0.45b0",
193
- "opentelemetry-instrumentation-sqlite3==0.45b0",
194
- "opentelemetry-instrumentation-urllib==0.45b0",
195
- "opentelemetry-instrumentation-wsgi==0.45b0",
189
+ "opentelemetry-instrumentation-asyncio==0.47b0",
190
+ "opentelemetry-instrumentation-aws-lambda==0.47b0",
191
+ "opentelemetry-instrumentation-dbapi==0.47b0",
192
+ "opentelemetry-instrumentation-logging==0.47b0",
193
+ "opentelemetry-instrumentation-sqlite3==0.47b0",
194
+ "opentelemetry-instrumentation-threading==0.47b0",
195
+ "opentelemetry-instrumentation-urllib==0.47b0",
196
+ "opentelemetry-instrumentation-wsgi==0.47b0",
196
197
  ]
@@ -50,9 +50,10 @@ class BaseDistro(ABC):
50
50
  def load_instrumentor( # pylint: disable=no-self-use
51
51
  self, entry_point: EntryPoint, **kwargs
52
52
  ):
53
- """Takes a collection of instrumentation entry points
54
- and activates them by instantiating and calling instrument()
55
- on each one.
53
+ """Takes an instrumentation entry point and activates it by instantiating
54
+ and calling instrument() on it.
55
+ This is called for each opentelemetry_instrumentor entry point by auto
56
+ instrumentation.
56
57
 
57
58
  Distros can override this method to customize the behavior by
58
59
  inspecting each entry point and configuring them in special ways,
@@ -37,6 +37,10 @@ from opentelemetry.trace.propagation.tracecontext import (
37
37
 
38
38
  propagator = TraceContextTextMapPropagator()
39
39
 
40
+ _SUPPRESS_INSTRUMENTATION_KEY_PLAIN = (
41
+ "suppress_instrumentation" # Set for backward compatibility
42
+ )
43
+
40
44
 
41
45
  def extract_attributes_from_object(
42
46
  obj: any, attributes: Sequence[str], existing: Dict[str, str] = None
@@ -161,9 +165,10 @@ def _python_path_without_directory(python_path, directory, path_separator):
161
165
 
162
166
 
163
167
  def is_instrumentation_enabled() -> bool:
164
- if context.get_value(_SUPPRESS_INSTRUMENTATION_KEY):
165
- return False
166
- return True
168
+ return not (
169
+ context.get_value(_SUPPRESS_INSTRUMENTATION_KEY)
170
+ or context.get_value(_SUPPRESS_INSTRUMENTATION_KEY_PLAIN)
171
+ )
167
172
 
168
173
 
169
174
  def is_http_instrumentation_enabled() -> bool:
@@ -188,7 +193,9 @@ def _suppress_instrumentation(*keys: str) -> Iterable[None]:
188
193
  @contextmanager
189
194
  def suppress_instrumentation() -> Iterable[None]:
190
195
  """Suppress instrumentation within the context."""
191
- with _suppress_instrumentation(_SUPPRESS_INSTRUMENTATION_KEY):
196
+ with _suppress_instrumentation(
197
+ _SUPPRESS_INSTRUMENTATION_KEY, _SUPPRESS_INSTRUMENTATION_KEY_PLAIN
198
+ ):
192
199
  yield
193
200
 
194
201
 
@@ -12,4 +12,4 @@
12
12
  # See the License for the specific language governing permissions and
13
13
  # limitations under the License.
14
14
 
15
- __version__ = "0.45b0"
15
+ __version__ = "0.47b0"
@@ -32,7 +32,9 @@ class TestLoad(TestCase):
32
32
  @patch(
33
33
  "opentelemetry.instrumentation.auto_instrumentation._load.iter_entry_points"
34
34
  )
35
- def test_load_configurators(self, iter_mock):
35
+ def test_load_configurators(
36
+ self, iter_mock
37
+ ): # pylint: disable=no-self-use
36
38
  # Add multiple entry points but only specify the 2nd in the environment variable.
37
39
  ep_mock1 = Mock()
38
40
  ep_mock1.name = "custom_configurator1"
@@ -62,9 +64,8 @@ class TestLoad(TestCase):
62
64
  "opentelemetry.instrumentation.auto_instrumentation._load.iter_entry_points"
63
65
  )
64
66
  def test_load_configurators_no_ep(
65
- self,
66
- iter_mock,
67
- ):
67
+ self, iter_mock
68
+ ): # pylint: disable=no-self-use
68
69
  iter_mock.return_value = ()
69
70
  # Confirm method does not crash if not entry points exist.
70
71
  _load._load_configurators()
@@ -214,6 +215,7 @@ class TestLoad(TestCase):
214
215
  )
215
216
  def test_load_instrumentors(self, iter_mock, dep_mock):
216
217
  # Mock opentelemetry_pre_instrument entry points
218
+ # pylint: disable=too-many-locals
217
219
  pre_ep_mock1 = Mock()
218
220
  pre_ep_mock1.name = "pre1"
219
221
  pre_mock1 = Mock()
@@ -285,7 +287,9 @@ class TestLoad(TestCase):
285
287
  @patch(
286
288
  "opentelemetry.instrumentation.auto_instrumentation._load.iter_entry_points"
287
289
  )
288
- def test_load_instrumentors_dep_conflict(self, iter_mock, dep_mock):
290
+ def test_load_instrumentors_dep_conflict(
291
+ self, iter_mock, dep_mock
292
+ ): # pylint: disable=no-self-use
289
293
  ep_mock1 = Mock()
290
294
  ep_mock1.name = "instr1"
291
295
 
@@ -15,10 +15,20 @@
15
15
  import unittest
16
16
  from http import HTTPStatus
17
17
 
18
+ from opentelemetry.context import (
19
+ _SUPPRESS_HTTP_INSTRUMENTATION_KEY,
20
+ _SUPPRESS_INSTRUMENTATION_KEY,
21
+ get_current,
22
+ get_value,
23
+ )
18
24
  from opentelemetry.instrumentation.sqlcommenter_utils import _add_sql_comment
19
25
  from opentelemetry.instrumentation.utils import (
20
26
  _python_path_without_directory,
21
27
  http_status_to_status_code,
28
+ is_http_instrumentation_enabled,
29
+ is_instrumentation_enabled,
30
+ suppress_http_instrumentation,
31
+ suppress_instrumentation,
22
32
  )
23
33
  from opentelemetry.trace import StatusCode
24
34
 
@@ -186,3 +196,47 @@ class TestUtils(unittest.TestCase):
186
196
  )
187
197
 
188
198
  self.assertEqual(commented_sql_without_semicolon, "Select 1")
199
+
200
+ def test_is_instrumentation_enabled_by_default(self):
201
+ self.assertTrue(is_instrumentation_enabled())
202
+ self.assertTrue(is_http_instrumentation_enabled())
203
+
204
+ def test_suppress_instrumentation(self):
205
+ with suppress_instrumentation():
206
+ self.assertFalse(is_instrumentation_enabled())
207
+ self.assertFalse(is_http_instrumentation_enabled())
208
+
209
+ self.assertTrue(is_instrumentation_enabled())
210
+ self.assertTrue(is_http_instrumentation_enabled())
211
+
212
+ def test_suppress_http_instrumentation(self):
213
+ with suppress_http_instrumentation():
214
+ self.assertFalse(is_http_instrumentation_enabled())
215
+ self.assertTrue(is_instrumentation_enabled())
216
+
217
+ self.assertTrue(is_instrumentation_enabled())
218
+ self.assertTrue(is_http_instrumentation_enabled())
219
+
220
+ def test_suppress_instrumentation_key(self):
221
+ self.assertIsNone(get_value(_SUPPRESS_INSTRUMENTATION_KEY))
222
+ self.assertIsNone(get_value("suppress_instrumentation"))
223
+
224
+ with suppress_instrumentation():
225
+ ctx = get_current()
226
+ self.assertIn(_SUPPRESS_INSTRUMENTATION_KEY, ctx)
227
+ self.assertIn("suppress_instrumentation", ctx)
228
+ self.assertTrue(get_value(_SUPPRESS_INSTRUMENTATION_KEY))
229
+ self.assertTrue(get_value("suppress_instrumentation"))
230
+
231
+ self.assertIsNone(get_value(_SUPPRESS_INSTRUMENTATION_KEY))
232
+ self.assertIsNone(get_value("suppress_instrumentation"))
233
+
234
+ def test_suppress_http_instrumentation_key(self):
235
+ self.assertIsNone(get_value(_SUPPRESS_HTTP_INSTRUMENTATION_KEY))
236
+
237
+ with suppress_http_instrumentation():
238
+ ctx = get_current()
239
+ self.assertIn(_SUPPRESS_HTTP_INSTRUMENTATION_KEY, ctx)
240
+ self.assertTrue(get_value(_SUPPRESS_HTTP_INSTRUMENTATION_KEY))
241
+
242
+ self.assertIsNone(get_value(_SUPPRESS_HTTP_INSTRUMENTATION_KEY))
@@ -1,217 +0,0 @@
1
- # Copyright The OpenTelemetry Authors
2
- #
3
- # Licensed under the Apache License, Version 2.0 (the "License");
4
- # you may not use this file except in compliance with the License.
5
- # You may obtain a copy of the License at
6
- #
7
- # http://www.apache.org/licenses/LICENSE-2.0
8
- #
9
- # Unless required by applicable law or agreed to in writing, software
10
- # distributed under the License is distributed on an "AS IS" BASIS,
11
- # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12
- # See the License for the specific language governing permissions and
13
- # limitations under the License.
14
-
15
- import os
16
- import threading
17
- from enum import Enum
18
-
19
- from opentelemetry.semconv.trace import SpanAttributes
20
-
21
- # TODO: will come through semconv package once updated
22
- _SPAN_ATTRIBUTES_ERROR_TYPE = "error.type"
23
- _SPAN_ATTRIBUTES_NETWORK_PEER_ADDRESS = "network.peer.address"
24
- _SPAN_ATTRIBUTES_NETWORK_PEER_PORT = "network.peer.port"
25
- _METRIC_ATTRIBUTES_CLIENT_DURATION_NAME = "http.client.request.duration"
26
-
27
- _client_duration_attrs_old = [
28
- SpanAttributes.HTTP_STATUS_CODE,
29
- SpanAttributes.HTTP_HOST,
30
- SpanAttributes.NET_PEER_PORT,
31
- SpanAttributes.NET_PEER_NAME,
32
- SpanAttributes.HTTP_METHOD,
33
- SpanAttributes.HTTP_FLAVOR,
34
- SpanAttributes.HTTP_SCHEME,
35
- ]
36
-
37
- _client_duration_attrs_new = [
38
- _SPAN_ATTRIBUTES_ERROR_TYPE,
39
- SpanAttributes.HTTP_REQUEST_METHOD,
40
- SpanAttributes.HTTP_RESPONSE_STATUS_CODE,
41
- SpanAttributes.NETWORK_PROTOCOL_VERSION,
42
- SpanAttributes.SERVER_ADDRESS,
43
- SpanAttributes.SERVER_PORT,
44
- # TODO: Support opt-in for scheme in new semconv
45
- # SpanAttributes.URL_SCHEME,
46
- ]
47
-
48
-
49
- def _filter_duration_attrs(attrs, sem_conv_opt_in_mode):
50
- filtered_attrs = {}
51
- allowed_attributes = (
52
- _client_duration_attrs_new
53
- if sem_conv_opt_in_mode == _OpenTelemetryStabilityMode.HTTP
54
- else _client_duration_attrs_old
55
- )
56
- for key, val in attrs.items():
57
- if key in allowed_attributes:
58
- filtered_attrs[key] = val
59
- return filtered_attrs
60
-
61
-
62
- def set_string_attribute(result, key, value):
63
- if value:
64
- result[key] = value
65
-
66
-
67
- def set_int_attribute(result, key, value):
68
- if value:
69
- try:
70
- result[key] = int(value)
71
- except ValueError:
72
- return
73
-
74
-
75
- def _set_http_method(result, original, normalized, sem_conv_opt_in_mode):
76
- original = original.strip()
77
- normalized = normalized.strip()
78
- # See https://github.com/open-telemetry/semantic-conventions/blob/main/docs/http/http-spans.md#common-attributes
79
- # Method is case sensitive. "http.request.method_original" should not be sanitized or automatically capitalized.
80
- if original != normalized and _report_new(sem_conv_opt_in_mode):
81
- set_string_attribute(
82
- result, SpanAttributes.HTTP_REQUEST_METHOD_ORIGINAL, original
83
- )
84
-
85
- if _report_old(sem_conv_opt_in_mode):
86
- set_string_attribute(result, SpanAttributes.HTTP_METHOD, normalized)
87
- if _report_new(sem_conv_opt_in_mode):
88
- set_string_attribute(
89
- result, SpanAttributes.HTTP_REQUEST_METHOD, normalized
90
- )
91
-
92
-
93
- def _set_http_url(result, url, sem_conv_opt_in_mode):
94
- if _report_old(sem_conv_opt_in_mode):
95
- set_string_attribute(result, SpanAttributes.HTTP_URL, url)
96
- if _report_new(sem_conv_opt_in_mode):
97
- set_string_attribute(result, SpanAttributes.URL_FULL, url)
98
-
99
-
100
- def _set_http_scheme(result, scheme, sem_conv_opt_in_mode):
101
- if _report_old(sem_conv_opt_in_mode):
102
- set_string_attribute(result, SpanAttributes.HTTP_SCHEME, scheme)
103
- # TODO: Support opt-in for scheme in new semconv
104
- # if _report_new(sem_conv_opt_in_mode):
105
- # set_string_attribute(result, SpanAttributes.URL_SCHEME, scheme)
106
-
107
-
108
- def _set_http_hostname(result, hostname, sem_conv_opt_in_mode):
109
- if _report_old(sem_conv_opt_in_mode):
110
- set_string_attribute(result, SpanAttributes.HTTP_HOST, hostname)
111
- if _report_new(sem_conv_opt_in_mode):
112
- set_string_attribute(result, SpanAttributes.SERVER_ADDRESS, hostname)
113
-
114
-
115
- def _set_http_net_peer_name(result, peer_name, sem_conv_opt_in_mode):
116
- if _report_old(sem_conv_opt_in_mode):
117
- set_string_attribute(result, SpanAttributes.NET_PEER_NAME, peer_name)
118
- if _report_new(sem_conv_opt_in_mode):
119
- set_string_attribute(result, SpanAttributes.SERVER_ADDRESS, peer_name)
120
-
121
-
122
- def _set_http_port(result, port, sem_conv_opt_in_mode):
123
- if _report_old(sem_conv_opt_in_mode):
124
- set_int_attribute(result, SpanAttributes.NET_PEER_PORT, port)
125
- if _report_new(sem_conv_opt_in_mode):
126
- set_int_attribute(result, SpanAttributes.SERVER_PORT, port)
127
-
128
-
129
- def _set_http_status_code(result, code, sem_conv_opt_in_mode):
130
- if _report_old(sem_conv_opt_in_mode):
131
- set_int_attribute(result, SpanAttributes.HTTP_STATUS_CODE, code)
132
- if _report_new(sem_conv_opt_in_mode):
133
- set_int_attribute(
134
- result, SpanAttributes.HTTP_RESPONSE_STATUS_CODE, code
135
- )
136
-
137
-
138
- def _set_http_network_protocol_version(result, version, sem_conv_opt_in_mode):
139
- if _report_old(sem_conv_opt_in_mode):
140
- set_string_attribute(result, SpanAttributes.HTTP_FLAVOR, version)
141
- if _report_new(sem_conv_opt_in_mode):
142
- set_string_attribute(
143
- result, SpanAttributes.NETWORK_PROTOCOL_VERSION, version
144
- )
145
-
146
-
147
- _OTEL_SEMCONV_STABILITY_OPT_IN_KEY = "OTEL_SEMCONV_STABILITY_OPT_IN"
148
-
149
-
150
- class _OpenTelemetryStabilitySignalType:
151
- HTTP = "http"
152
-
153
-
154
- class _OpenTelemetryStabilityMode(Enum):
155
- # http - emit the new, stable HTTP and networking conventions ONLY
156
- HTTP = "http"
157
- # http/dup - emit both the old and the stable HTTP and networking conventions
158
- HTTP_DUP = "http/dup"
159
- # default - continue emitting old experimental HTTP and networking conventions
160
- DEFAULT = "default"
161
-
162
-
163
- def _report_new(mode):
164
- return mode.name != _OpenTelemetryStabilityMode.DEFAULT.name
165
-
166
-
167
- def _report_old(mode):
168
- return mode.name != _OpenTelemetryStabilityMode.HTTP.name
169
-
170
-
171
- class _OpenTelemetrySemanticConventionStability:
172
- _initialized = False
173
- _lock = threading.Lock()
174
- _OTEL_SEMCONV_STABILITY_SIGNAL_MAPPING = {}
175
-
176
- @classmethod
177
- def _initialize(cls):
178
- with _OpenTelemetrySemanticConventionStability._lock:
179
- if not _OpenTelemetrySemanticConventionStability._initialized:
180
- # Users can pass in comma delimited string for opt-in options
181
- # Only values for http stability are supported for now
182
- opt_in = os.environ.get(_OTEL_SEMCONV_STABILITY_OPT_IN_KEY, "")
183
- opt_in_list = []
184
- if opt_in:
185
- opt_in_list = [s.strip() for s in opt_in.split(",")]
186
- http_opt_in = _OpenTelemetryStabilityMode.DEFAULT
187
- if opt_in_list:
188
- # Process http opt-in
189
- # http/dup takes priority over http
190
- if (
191
- _OpenTelemetryStabilityMode.HTTP_DUP.value
192
- in opt_in_list
193
- ):
194
- http_opt_in = _OpenTelemetryStabilityMode.HTTP_DUP
195
- elif _OpenTelemetryStabilityMode.HTTP.value in opt_in_list:
196
- http_opt_in = _OpenTelemetryStabilityMode.HTTP
197
- _OpenTelemetrySemanticConventionStability._OTEL_SEMCONV_STABILITY_SIGNAL_MAPPING[
198
- _OpenTelemetryStabilitySignalType.HTTP
199
- ] = http_opt_in
200
- _OpenTelemetrySemanticConventionStability._initialized = True
201
-
202
- @classmethod
203
- # Get OpenTelemetry opt-in mode based off of signal type (http, messaging, etc.)
204
- def _get_opentelemetry_stability_opt_in_mode(
205
- cls,
206
- signal_type: _OpenTelemetryStabilitySignalType,
207
- ) -> _OpenTelemetryStabilityMode:
208
- return _OpenTelemetrySemanticConventionStability._OTEL_SEMCONV_STABILITY_SIGNAL_MAPPING.get(
209
- signal_type, _OpenTelemetryStabilityMode.DEFAULT
210
- )
211
-
212
-
213
- # Get schema version based off of opt-in mode
214
- def _get_schema_url(mode: _OpenTelemetryStabilityMode) -> str:
215
- if mode is _OpenTelemetryStabilityMode.DEFAULT:
216
- return "https://opentelemetry.io/schemas/1.11.0"
217
- return SpanAttributes.SCHEMA_URL