opentelemetry-instrumentation-requests 0.50b0__py3-none-any.whl → 0.52b0__py3-none-any.whl

opentelemetry/instrumentation/requests/__init__.py

@@ -41,20 +41,22 @@ The hooks can be configured as follows:
 
 .. code:: python
 
+    import requests
+    from opentelemetry.instrumentation.requests import RequestsInstrumentor
+
     # `request_obj` is an instance of requests.PreparedRequest
     def request_hook(span, request_obj):
         pass
 
     # `request_obj` is an instance of requests.PreparedRequest
     # `response` is an instance of requests.Response
-    def response_hook(span, request_obj, response)
+    def response_hook(span, request_obj, response):
         pass
 
     RequestsInstrumentor().instrument(
-        request_hook=request_hook, response_hook=response_hook)
+        request_hook=request_hook, response_hook=response_hook
     )
 
-
 Exclude lists
 *************
 To exclude certain URLs from being tracked, set the environment variable ``OTEL_PYTHON_REQUESTS_EXCLUDED_URLS``
@@ -72,10 +74,12 @@ API
 ---
 """
 
+from __future__ import annotations
+
 import functools
 import types
 from timeit import default_timer
-from typing import Callable, Collection, Optional
+from typing import Any, Callable, Collection, Optional
 from urllib.parse import urlparse
 
 from requests.models import PreparedRequest, Response
@@ -87,7 +91,6 @@ from opentelemetry.instrumentation._semconv import (
     _client_duration_attrs_old,
     _filter_semconv_duration_attrs,
     _get_schema_url,
-    _HTTPStabilityMode,
     _OpenTelemetrySemanticConventionStability,
     _OpenTelemetryStabilitySignalType,
     _report_new,
@@ -98,14 +101,14 @@ from opentelemetry.instrumentation._semconv import (
     _set_http_network_protocol_version,
     _set_http_peer_port_client,
     _set_http_scheme,
-    _set_http_status_code,
     _set_http_url,
+    _set_status,
+    _StabilityMode,
 )
 from opentelemetry.instrumentation.instrumentor import BaseInstrumentor
 from opentelemetry.instrumentation.requests.package import _instruments
 from opentelemetry.instrumentation.requests.version import __version__
 from opentelemetry.instrumentation.utils import (
-    http_status_to_status_code,
     is_http_instrumentation_enabled,
     suppress_http_instrumentation,
 )
@@ -122,7 +125,6 @@ from opentelemetry.semconv.metrics.http_metrics import (
 )
 from opentelemetry.trace import SpanKind, Tracer, get_tracer
 from opentelemetry.trace.span import Span
-from opentelemetry.trace.status import StatusCode
 from opentelemetry.util.http import (
     ExcludeList,
     get_excluded_urls,
@@ -138,6 +140,32 @@ _RequestHookT = Optional[Callable[[Span, PreparedRequest], None]]
 _ResponseHookT = Optional[Callable[[Span, PreparedRequest, Response], None]]
 
 
+def _set_http_status_code_attribute(
+    span,
+    status_code,
+    metric_attributes=None,
+    sem_conv_opt_in_mode=_StabilityMode.DEFAULT,
+):
+    status_code_str = str(status_code)
+    try:
+        status_code = int(status_code)
+    except ValueError:
+        status_code = -1
+    if metric_attributes is None:
+        metric_attributes = {}
+    # When we have durations we should set metrics only once
+    # Also the decision to include status code on a histogram should
+    # not be dependent on tracing decisions.
+    _set_status(
+        span,
+        metric_attributes,
+        status_code,
+        status_code_str,
+        server_span=False,
+        sem_conv_opt_in_mode=sem_conv_opt_in_mode,
+    )
+
+
 # pylint: disable=unused-argument
 # pylint: disable=R0915
 def _instrument(
@@ -146,8 +174,8 @@ def _instrument(
     duration_histogram_new: Histogram,
     request_hook: _RequestHookT = None,
     response_hook: _ResponseHookT = None,
-    excluded_urls: ExcludeList = None,
-    sem_conv_opt_in_mode: _HTTPStabilityMode = _HTTPStabilityMode.DEFAULT,
+    excluded_urls: ExcludeList | None = None,
+    sem_conv_opt_in_mode: _StabilityMode = _StabilityMode.DEFAULT,
 ):
     """Enables tracing of all requests calls that go through
     :code:`requests.session.Session.request` (this includes
@@ -164,7 +192,9 @@ def _instrument(
 
     # pylint: disable-msg=too-many-locals,too-many-branches
     @functools.wraps(wrapped_send)
-    def instrumented_send(self, request, **kwargs):
+    def instrumented_send(
+        self: Session, request: PreparedRequest, **kwargs: Any
+    ):
         if excluded_urls and excluded_urls.url_disabled(request.url):
             return wrapped_send(self, request, **kwargs)
 
@@ -263,25 +293,12 @@ def _instrument(
 
             if isinstance(result, Response):
                 span_attributes = {}
-                if span.is_recording():
-                    _set_http_status_code(
-                        span_attributes,
-                        result.status_code,
-                        sem_conv_opt_in_mode,
-                    )
-                    _set_http_status_code(
-                        metric_labels, result.status_code, sem_conv_opt_in_mode
-                    )
-                    status_code = http_status_to_status_code(
-                        result.status_code
-                    )
-                    span.set_status(status_code)
-                    if (
-                        _report_new(sem_conv_opt_in_mode)
-                        and status_code is StatusCode.ERROR
-                    ):
-                        span_attributes[ERROR_TYPE] = str(result.status_code)
-                        metric_labels[ERROR_TYPE] = str(result.status_code)
+                _set_http_status_code_attribute(
+                    span,
+                    result.status_code,
+                    metric_labels,
+                    sem_conv_opt_in_mode,
+                )
 
                 if result.raw is not None:
                     version = getattr(result.raw, "version", None)
@@ -312,7 +329,7 @@ def _instrument(
                     metric_labels,
                     _client_duration_attrs_old,
                     _client_duration_attrs_new,
-                    _HTTPStabilityMode.DEFAULT,
+                    _StabilityMode.DEFAULT,
                 )
                 duration_histogram_old.record(
                     max(round(elapsed_time * 1000), 0),
@@ -323,7 +340,7 @@ def _instrument(
                     metric_labels,
                     _client_duration_attrs_old,
                     _client_duration_attrs_new,
-                    _HTTPStabilityMode.HTTP,
+                    _StabilityMode.HTTP,
                 )
                 duration_histogram_new.record(
                     elapsed_time, attributes=duration_attrs_new
@@ -345,7 +362,7 @@ def _uninstrument():
     _uninstrument_from(Session)
 
 
-def _uninstrument_from(instr_root, restore_as_bound_func=False):
+def _uninstrument_from(instr_root, restore_as_bound_func: bool = False):
     for instr_func_name in ("request", "send"):
         instr_func = getattr(instr_root, instr_func_name)
         if not getattr(
@@ -361,7 +378,7 @@ def _uninstrument_from(instr_root, restore_as_bound_func=False):
         setattr(instr_root, instr_func_name, original)
 
 
-def get_default_span_name(method):
+def get_default_span_name(method: str) -> str:
     """
     Default implementation for name_callback, returns HTTP {method_name}.
     https://opentelemetry.io/docs/reference/specification/trace/semantic_conventions/http/#name
@@ -385,7 +402,7 @@ class RequestsInstrumentor(BaseInstrumentor):
     def instrumentation_dependencies(self) -> Collection[str]:
         return _instruments
 
-    def _instrument(self, **kwargs):
+    def _instrument(self, **kwargs: Any):
         """Instruments requests module
 
         Args:
@@ -443,10 +460,10 @@ class RequestsInstrumentor(BaseInstrumentor):
             sem_conv_opt_in_mode=semconv_opt_in_mode,
         )
 
-    def _uninstrument(self, **kwargs):
+    def _uninstrument(self, **kwargs: Any):
         _uninstrument()
 
     @staticmethod
-    def uninstrument_session(session):
+    def uninstrument_session(session: Session):
         """Disables instrumentation on the session object."""
         _uninstrument_from(session, restore_as_bound_func=True)

opentelemetry/instrumentation/requests/version.py

@@ -12,4 +12,4 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-__version__ = "0.50b0"
+__version__ = "0.52b0"

{opentelemetry_instrumentation_requests-0.50b0.dist-info → opentelemetry_instrumentation_requests-0.52b0.dist-info}/METADATA

@@ -1,10 +1,12 @@
-Metadata-Version: 2.3
+Metadata-Version: 2.4
 Name: opentelemetry-instrumentation-requests
-Version: 0.50b0
+Version: 0.52b0
 Summary: OpenTelemetry requests instrumentation
 Project-URL: Homepage, https://github.com/open-telemetry/opentelemetry-python-contrib/tree/main/instrumentation/opentelemetry-instrumentation-requests
+Project-URL: Repository, https://github.com/open-telemetry/opentelemetry-python-contrib
 Author-email: OpenTelemetry Authors <cncf-opentelemetry-contributors@lists.cncf.io>
-License: Apache-2.0
+License-Expression: Apache-2.0
+License-File: LICENSE
 Classifier: Development Status :: 4 - Beta
 Classifier: Intended Audience :: Developers
 Classifier: License :: OSI Approved :: Apache Software License
@@ -15,11 +17,12 @@ Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
 Requires-Python: >=3.8
 Requires-Dist: opentelemetry-api~=1.12
-Requires-Dist: opentelemetry-instrumentation==0.50b0
-Requires-Dist: opentelemetry-semantic-conventions==0.50b0
-Requires-Dist: opentelemetry-util-http==0.50b0
+Requires-Dist: opentelemetry-instrumentation==0.52b0
+Requires-Dist: opentelemetry-semantic-conventions==0.52b0
+Requires-Dist: opentelemetry-util-http==0.52b0
 Provides-Extra: instruments
 Requires-Dist: requests~=2.0; extra == 'instruments'
 Description-Content-Type: text/x-rst

opentelemetry_instrumentation_requests-0.52b0.dist-info/RECORD

@@ -0,0 +1,9 @@
+opentelemetry/instrumentation/requests/__init__.py,sha256=Cjqt-1i4X6MhTS6FHe9KoooI9rsaTFGvgXZ_RzFjv1w,16781
+opentelemetry/instrumentation/requests/package.py,sha256=84lK70NyCoRefASXKjU5f4byJhf5qWDL6IdYjch-UTM,679
+opentelemetry/instrumentation/requests/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+opentelemetry/instrumentation/requests/version.py,sha256=8ybzJrIcr5CRW9fxlL7vXcvj3IIncnVl6eHpEEIxEYk,608
+opentelemetry_instrumentation_requests-0.52b0.dist-info/METADATA,sha256=iw_jfaZX8UwOmHzaNM9F7SqTvqJgwlqyIlDjIlaskxg,2670
+opentelemetry_instrumentation_requests-0.52b0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+opentelemetry_instrumentation_requests-0.52b0.dist-info/entry_points.txt,sha256=w_cFVp9h9IXzWm2YeBaOEUANSn9iuUlNAl0QC3PDf94,100
+opentelemetry_instrumentation_requests-0.52b0.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+opentelemetry_instrumentation_requests-0.52b0.dist-info/RECORD,,

{opentelemetry_instrumentation_requests-0.50b0.dist-info → opentelemetry_instrumentation_requests-0.52b0.dist-info}/WHEEL

@@ -1,4 +1,4 @@
 Wheel-Version: 1.0
-Generator: hatchling 1.26.3
+Generator: hatchling 1.27.0
 Root-Is-Purelib: true
 Tag: py3-none-any

opentelemetry_instrumentation_requests-0.50b0.dist-info/RECORD

@@ -1,8 +0,0 @@
-opentelemetry/instrumentation/requests/__init__.py,sha256=GGN5ykITzJitPTZJX76PjBUvLxNWXjUx9Ap7UNaV7mM,16623
-opentelemetry/instrumentation/requests/package.py,sha256=84lK70NyCoRefASXKjU5f4byJhf5qWDL6IdYjch-UTM,679
-opentelemetry/instrumentation/requests/version.py,sha256=sBsbV8VQNTte60quPySrr3hMzVnRCO8AnGlwnGPP60o,608
-opentelemetry_instrumentation_requests-0.50b0.dist-info/METADATA,sha256=R8x_4qInbkbmcBIY0q3RamYqJXs7YHvacnIMqUvfVYI,2498
-opentelemetry_instrumentation_requests-0.50b0.dist-info/WHEEL,sha256=C2FUgwZgiLbznR-k0b_5k3Ai_1aASOXDss3lzCUsUug,87
-opentelemetry_instrumentation_requests-0.50b0.dist-info/entry_points.txt,sha256=w_cFVp9h9IXzWm2YeBaOEUANSn9iuUlNAl0QC3PDf94,100
-opentelemetry_instrumentation_requests-0.50b0.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
-opentelemetry_instrumentation_requests-0.50b0.dist-info/RECORD,,