opentelemetry-instrumentation-requests 0.46b0__tar.gz → 0.47b0__tar.gz

{opentelemetry_instrumentation_requests-0.46b0 → opentelemetry_instrumentation_requests-0.47b0}/.gitignore

@@ -58,3 +58,6 @@ _build/
 # mypy
 .mypy_cache/
 target
+
+# Benchmark result files
+*-benchmark.json

{opentelemetry_instrumentation_requests-0.46b0 → opentelemetry_instrumentation_requests-0.47b0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: opentelemetry-instrumentation-requests
-Version: 0.46b0
+Version: 0.47b0
 Summary: OpenTelemetry requests instrumentation
 Project-URL: Homepage, https://github.com/open-telemetry/opentelemetry-python-contrib/tree/main/instrumentation/opentelemetry-instrumentation-requests
 Author-email: OpenTelemetry Authors <cncf-opentelemetry-contributors@lists.cncf.io>
@@ -15,11 +15,12 @@ Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
 Requires-Python: >=3.8
 Requires-Dist: opentelemetry-api~=1.12
-Requires-Dist: opentelemetry-instrumentation==0.46b0
-Requires-Dist: opentelemetry-semantic-conventions==0.46b0
-Requires-Dist: opentelemetry-util-http==0.46b0
+Requires-Dist: opentelemetry-instrumentation==0.47b0
+Requires-Dist: opentelemetry-semantic-conventions==0.47b0
+Requires-Dist: opentelemetry-util-http==0.47b0
 Provides-Extra: instruments
 Requires-Dist: requests~=2.0; extra == 'instruments'
 Description-Content-Type: text/x-rst

{opentelemetry_instrumentation_requests-0.46b0 → opentelemetry_instrumentation_requests-0.47b0}/pyproject.toml

@@ -22,12 +22,13 @@ classifiers = [
   "Programming Language :: Python :: 3.9",
   "Programming Language :: Python :: 3.10",
   "Programming Language :: Python :: 3.11",
+  "Programming Language :: Python :: 3.12",
 ]
 dependencies = [
   "opentelemetry-api ~= 1.12",
-  "opentelemetry-instrumentation == 0.46b0",
-  "opentelemetry-semantic-conventions == 0.46b0",
-  "opentelemetry-util-http == 0.46b0",
+  "opentelemetry-instrumentation == 0.47b0",
+  "opentelemetry-semantic-conventions == 0.47b0",
+  "opentelemetry-util-http == 0.47b0",
 ]
 
 [project.optional-dependencies]

{opentelemetry_instrumentation_requests-0.46b0 → opentelemetry_instrumentation_requests-0.47b0}/src/opentelemetry/instrumentation/requests/__init__.py

@@ -31,6 +31,30 @@ Usage
 Configuration
 -------------
 
+Request/Response hooks
+**********************
+
+The requests instrumentation supports extending tracing behavior with the help of
+request and response hooks. These are functions that are called back by the instrumentation
+right after a Span is created for a request and right before the span is finished processing a response respectively.
+The hooks can be configured as follows:
+
+.. code:: python
+
+    # `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)
+        pass
+
+    RequestsInstrumentor().instrument(
+        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``
@@ -59,10 +83,6 @@ from requests.sessions import Session
 from requests.structures import CaseInsensitiveDict
 
 from opentelemetry.instrumentation._semconv import (
-    _METRIC_ATTRIBUTES_CLIENT_DURATION_NAME,
-    _SPAN_ATTRIBUTES_ERROR_TYPE,
-    _SPAN_ATTRIBUTES_NETWORK_PEER_ADDRESS,
-    _SPAN_ATTRIBUTES_NETWORK_PEER_PORT,
     _client_duration_attrs_new,
     _client_duration_attrs_old,
     _filter_semconv_duration_attrs,
@@ -91,7 +111,15 @@ from opentelemetry.instrumentation.utils import (
 )
 from opentelemetry.metrics import Histogram, get_meter
 from opentelemetry.propagate import inject
+from opentelemetry.semconv.attributes.error_attributes import ERROR_TYPE
+from opentelemetry.semconv.attributes.network_attributes import (
+    NETWORK_PEER_ADDRESS,
+    NETWORK_PEER_PORT,
+)
 from opentelemetry.semconv.metrics import MetricInstruments
+from opentelemetry.semconv.metrics.http_metrics import (
+    HTTP_CLIENT_REQUEST_DURATION,
+)
 from opentelemetry.trace import SpanKind, Tracer, get_tracer
 from opentelemetry.trace.span import Span
 from opentelemetry.trace.status import StatusCode
@@ -160,13 +188,19 @@ def _instrument(
 
         span_attributes = {}
         _set_http_method(
-            span_attributes, method, span_name, sem_conv_opt_in_mode
+            span_attributes,
+            method,
+            sanitize_method(method),
+            sem_conv_opt_in_mode,
         )
         _set_http_url(span_attributes, url, sem_conv_opt_in_mode)
 
         metric_labels = {}
         _set_http_method(
-            metric_labels, method, span_name, sem_conv_opt_in_mode
+            metric_labels,
+            method,
+            sanitize_method(method),
+            sem_conv_opt_in_mode,
         )
 
         try:
@@ -191,9 +225,7 @@ def _instrument(
                         sem_conv_opt_in_mode,
                     )
                     # Use semconv library when available
-                    span_attributes[_SPAN_ATTRIBUTES_NETWORK_PEER_ADDRESS] = (
-                        parsed_url.hostname
-                    )
+                    span_attributes[NETWORK_PEER_ADDRESS] = parsed_url.hostname
             if parsed_url.port:
                 _set_http_peer_port_client(
                     metric_labels, parsed_url.port, sem_conv_opt_in_mode
@@ -203,9 +235,7 @@ def _instrument(
                         span_attributes, parsed_url.port, sem_conv_opt_in_mode
                     )
                     # Use semconv library when available
-                    span_attributes[_SPAN_ATTRIBUTES_NETWORK_PEER_PORT] = (
-                        parsed_url.port
-                    )
+                    span_attributes[NETWORK_PEER_PORT] = parsed_url.port
         except ValueError:
             pass
 
@@ -250,12 +280,8 @@ def _instrument(
                         _report_new(sem_conv_opt_in_mode)
                         and status_code is StatusCode.ERROR
                     ):
-                        span_attributes[_SPAN_ATTRIBUTES_ERROR_TYPE] = str(
-                            result.status_code
-                        )
-                        metric_labels[_SPAN_ATTRIBUTES_ERROR_TYPE] = str(
-                            result.status_code
-                        )
+                        span_attributes[ERROR_TYPE] = str(result.status_code)
+                        metric_labels[ERROR_TYPE] = str(result.status_code)
 
                 if result.raw is not None:
                     version = getattr(result.raw, "version", None)
@@ -278,12 +304,8 @@ def _instrument(
                     response_hook(span, request, result)
 
             if exception is not None and _report_new(sem_conv_opt_in_mode):
-                span.set_attribute(
-                    _SPAN_ATTRIBUTES_ERROR_TYPE, type(exception).__qualname__
-                )
-                metric_labels[_SPAN_ATTRIBUTES_ERROR_TYPE] = type(
-                    exception
-                ).__qualname__
+                span.set_attribute(ERROR_TYPE, type(exception).__qualname__)
+                metric_labels[ERROR_TYPE] = type(exception).__qualname__
 
             if duration_histogram_old is not None:
                 duration_attrs_old = _filter_semconv_duration_attrs(
@@ -349,7 +371,7 @@ def get_default_span_name(method):
     Returns:
         span name
     """
-    method = sanitize_method(method.upper().strip())
+    method = sanitize_method(method.strip())
     if method == "_OTHER":
         return "HTTP"
     return method
@@ -403,7 +425,7 @@ class RequestsInstrumentor(BaseInstrumentor):
         duration_histogram_new = None
         if _report_new(semconv_opt_in_mode):
             duration_histogram_new = meter.create_histogram(
-                name=_METRIC_ATTRIBUTES_CLIENT_DURATION_NAME,
+                name=HTTP_CLIENT_REQUEST_DURATION,
                 unit="s",
                 description="Duration of HTTP client requests.",
             )

{opentelemetry_instrumentation_requests-0.46b0 → opentelemetry_instrumentation_requests-0.47b0}/src/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.46b0"
+__version__ = "0.47b0"

{opentelemetry_instrumentation_requests-0.46b0 → opentelemetry_instrumentation_requests-0.47b0}/tests/test_requests_integration.py

@@ -23,9 +23,6 @@ from requests.models import Response
 import opentelemetry.instrumentation.requests
 from opentelemetry import trace
 from opentelemetry.instrumentation._semconv import (
-    _SPAN_ATTRIBUTES_ERROR_TYPE,
-    _SPAN_ATTRIBUTES_NETWORK_PEER_ADDRESS,
-    _SPAN_ATTRIBUTES_NETWORK_PEER_PORT,
     OTEL_SEMCONV_STABILITY_OPT_IN,
     _OpenTelemetrySemanticConventionStability,
 )
@@ -36,6 +33,22 @@ from opentelemetry.instrumentation.utils import (
 )
 from opentelemetry.propagate import get_global_textmap, set_global_textmap
 from opentelemetry.sdk import resources
+from opentelemetry.semconv.attributes.error_attributes import ERROR_TYPE
+from opentelemetry.semconv.attributes.http_attributes import (
+    HTTP_REQUEST_METHOD,
+    HTTP_REQUEST_METHOD_ORIGINAL,
+    HTTP_RESPONSE_STATUS_CODE,
+)
+from opentelemetry.semconv.attributes.network_attributes import (
+    NETWORK_PEER_ADDRESS,
+    NETWORK_PEER_PORT,
+    NETWORK_PROTOCOL_VERSION,
+)
+from opentelemetry.semconv.attributes.server_attributes import (
+    SERVER_ADDRESS,
+    SERVER_PORT,
+)
+from opentelemetry.semconv.attributes.url_attributes import URL_FULL
 from opentelemetry.semconv.trace import SpanAttributes
 from opentelemetry.test.mock_textmap import MockTextMapPropagator
 from opentelemetry.test.test_base import TestBase
@@ -176,14 +189,14 @@ class RequestsIntegrationTestBase(abc.ABC):
         self.assertEqual(
             span.attributes,
             {
-                SpanAttributes.HTTP_REQUEST_METHOD: "GET",
-                SpanAttributes.URL_FULL: url_with_port,
-                SpanAttributes.SERVER_ADDRESS: "mock",
-                _SPAN_ATTRIBUTES_NETWORK_PEER_ADDRESS: "mock",
-                SpanAttributes.HTTP_RESPONSE_STATUS_CODE: 200,
-                SpanAttributes.NETWORK_PROTOCOL_VERSION: "1.1",
-                SpanAttributes.SERVER_PORT: 80,
-                _SPAN_ATTRIBUTES_NETWORK_PEER_PORT: 80,
+                HTTP_REQUEST_METHOD: "GET",
+                URL_FULL: url_with_port,
+                SERVER_ADDRESS: "mock",
+                NETWORK_PEER_ADDRESS: "mock",
+                HTTP_RESPONSE_STATUS_CODE: 200,
+                NETWORK_PROTOCOL_VERSION: "1.1",
+                SERVER_PORT: 80,
+                NETWORK_PEER_PORT: 80,
             },
         )
 
@@ -213,19 +226,19 @@ class RequestsIntegrationTestBase(abc.ABC):
             span.attributes,
             {
                 SpanAttributes.HTTP_METHOD: "GET",
-                SpanAttributes.HTTP_REQUEST_METHOD: "GET",
+                HTTP_REQUEST_METHOD: "GET",
                 SpanAttributes.HTTP_URL: url_with_port,
-                SpanAttributes.URL_FULL: url_with_port,
+                URL_FULL: url_with_port,
                 SpanAttributes.HTTP_HOST: "mock",
-                SpanAttributes.SERVER_ADDRESS: "mock",
-                _SPAN_ATTRIBUTES_NETWORK_PEER_ADDRESS: "mock",
+                SERVER_ADDRESS: "mock",
+                NETWORK_PEER_ADDRESS: "mock",
                 SpanAttributes.NET_PEER_PORT: 80,
                 SpanAttributes.HTTP_STATUS_CODE: 200,
-                SpanAttributes.HTTP_RESPONSE_STATUS_CODE: 200,
+                HTTP_RESPONSE_STATUS_CODE: 200,
                 SpanAttributes.HTTP_FLAVOR: "1.1",
-                SpanAttributes.NETWORK_PROTOCOL_VERSION: "1.1",
-                SpanAttributes.SERVER_PORT: 80,
-                _SPAN_ATTRIBUTES_NETWORK_PEER_PORT: 80,
+                NETWORK_PROTOCOL_VERSION: "1.1",
+                SERVER_PORT: 80,
+                NETWORK_PEER_PORT: 80,
             },
         )
 
@@ -235,6 +248,48 @@ class RequestsIntegrationTestBase(abc.ABC):
             span, opentelemetry.instrumentation.requests
         )
 
+    @mock.patch("httpretty.http.HttpBaseClass.METHODS", ("NONSTANDARD",))
+    def test_nonstandard_http_method(self):
+        httpretty.register_uri("NONSTANDARD", self.URL, status=405)
+        session = requests.Session()
+        session.request("NONSTANDARD", self.URL)
+        span = self.assert_span()
+        self.assertIs(span.kind, trace.SpanKind.CLIENT)
+        self.assertEqual(span.name, "HTTP")
+        self.assertEqual(
+            span.attributes,
+            {
+                SpanAttributes.HTTP_METHOD: "_OTHER",
+                SpanAttributes.HTTP_URL: self.URL,
+                SpanAttributes.HTTP_STATUS_CODE: 405,
+            },
+        )
+
+        self.assertIs(span.status.status_code, trace.StatusCode.ERROR)
+
+    @mock.patch("httpretty.http.HttpBaseClass.METHODS", ("NONSTANDARD",))
+    def test_nonstandard_http_method_new_semconv(self):
+        httpretty.register_uri("NONSTANDARD", self.URL, status=405)
+        session = requests.Session()
+        session.request("NONSTANDARD", self.URL)
+        span = self.assert_span()
+        self.assertIs(span.kind, trace.SpanKind.CLIENT)
+        self.assertEqual(span.name, "HTTP")
+        self.assertEqual(
+            span.attributes,
+            {
+                HTTP_REQUEST_METHOD: "_OTHER",
+                URL_FULL: self.URL,
+                SERVER_ADDRESS: "mock",
+                NETWORK_PEER_ADDRESS: "mock",
+                HTTP_RESPONSE_STATUS_CODE: 405,
+                NETWORK_PROTOCOL_VERSION: "1.1",
+                ERROR_TYPE: "405",
+                HTTP_REQUEST_METHOD_ORIGINAL: "NONSTANDARD",
+            },
+        )
+        self.assertIs(span.status.status_code, trace.StatusCode.ERROR)
+
     def test_hooks(self):
         def request_hook(span, request_obj):
             span.update_name("name set from hook")
@@ -328,12 +383,8 @@ class RequestsIntegrationTestBase(abc.ABC):
 
         span = self.assert_span()
 
-        self.assertEqual(
-            span.attributes.get(SpanAttributes.HTTP_RESPONSE_STATUS_CODE), 404
-        )
-        self.assertEqual(
-            span.attributes.get(_SPAN_ATTRIBUTES_ERROR_TYPE), "404"
-        )
+        self.assertEqual(span.attributes.get(HTTP_RESPONSE_STATUS_CODE), 404)
+        self.assertEqual(span.attributes.get(ERROR_TYPE), "404")
 
         self.assertIs(
             span.status.status_code,
@@ -355,12 +406,8 @@ class RequestsIntegrationTestBase(abc.ABC):
         self.assertEqual(
             span.attributes.get(SpanAttributes.HTTP_STATUS_CODE), 404
         )
-        self.assertEqual(
-            span.attributes.get(SpanAttributes.HTTP_RESPONSE_STATUS_CODE), 404
-        )
-        self.assertEqual(
-            span.attributes.get(_SPAN_ATTRIBUTES_ERROR_TYPE), "404"
-        )
+        self.assertEqual(span.attributes.get(HTTP_RESPONSE_STATUS_CODE), 404)
+        self.assertEqual(span.attributes.get(ERROR_TYPE), "404")
 
         self.assertIs(
             span.status.status_code,
@@ -527,13 +574,13 @@ class RequestsIntegrationTestBase(abc.ABC):
         self.assertEqual(
             span.attributes,
             {
-                SpanAttributes.HTTP_REQUEST_METHOD: "GET",
-                SpanAttributes.URL_FULL: url_with_port,
-                SpanAttributes.SERVER_ADDRESS: "mock",
-                SpanAttributes.SERVER_PORT: 80,
-                _SPAN_ATTRIBUTES_NETWORK_PEER_PORT: 80,
-                _SPAN_ATTRIBUTES_NETWORK_PEER_ADDRESS: "mock",
-                _SPAN_ATTRIBUTES_ERROR_TYPE: "RequestException",
+                HTTP_REQUEST_METHOD: "GET",
+                URL_FULL: url_with_port,
+                SERVER_ADDRESS: "mock",
+                SERVER_PORT: 80,
+                NETWORK_PEER_PORT: 80,
+                NETWORK_PEER_ADDRESS: "mock",
+                ERROR_TYPE: "RequestException",
             },
         )
         self.assertEqual(span.status.status_code, StatusCode.ERROR)
@@ -724,11 +771,11 @@ class TestRequestsIntergrationMetric(TestBase):
         self.perform_request(self.URL)
 
         expected_attributes = {
-            SpanAttributes.HTTP_RESPONSE_STATUS_CODE: 200,
-            SpanAttributes.SERVER_ADDRESS: "examplehost",
-            SpanAttributes.SERVER_PORT: 8000,
-            SpanAttributes.HTTP_REQUEST_METHOD: "GET",
-            SpanAttributes.NETWORK_PROTOCOL_VERSION: "1.1",
+            HTTP_RESPONSE_STATUS_CODE: 200,
+            SERVER_ADDRESS: "examplehost",
+            SERVER_PORT: 8000,
+            HTTP_REQUEST_METHOD: "GET",
+            NETWORK_PROTOCOL_VERSION: "1.1",
         }
         for (
             resource_metrics
@@ -760,11 +807,11 @@ class TestRequestsIntergrationMetric(TestBase):
         }
 
         expected_attributes_new = {
-            SpanAttributes.HTTP_RESPONSE_STATUS_CODE: 200,
-            SpanAttributes.SERVER_ADDRESS: "examplehost",
-            SpanAttributes.SERVER_PORT: 8000,
-            SpanAttributes.HTTP_REQUEST_METHOD: "GET",
-            SpanAttributes.NETWORK_PROTOCOL_VERSION: "1.1",
+            HTTP_RESPONSE_STATUS_CODE: 200,
+            SERVER_ADDRESS: "examplehost",
+            SERVER_PORT: 8000,
+            HTTP_REQUEST_METHOD: "GET",
+            NETWORK_PROTOCOL_VERSION: "1.1",
         }
 
         for (