opentelemetry-instrumentation-requests 0.53b0__tar.gz → 0.54b0__tar.gz

{opentelemetry_instrumentation_requests-0.53b0 → opentelemetry_instrumentation_requests-0.54b0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: opentelemetry-instrumentation-requests
-Version: 0.53b0
+Version: 0.54b0
 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
@@ -20,9 +20,9 @@ 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.53b0
-Requires-Dist: opentelemetry-semantic-conventions==0.53b0
-Requires-Dist: opentelemetry-util-http==0.53b0
+Requires-Dist: opentelemetry-instrumentation==0.54b0
+Requires-Dist: opentelemetry-semantic-conventions==0.54b0
+Requires-Dist: opentelemetry-util-http==0.54b0
 Provides-Extra: instruments
 Requires-Dist: requests~=2.0; extra == 'instruments'
 Description-Content-Type: text/x-rst

{opentelemetry_instrumentation_requests-0.53b0 → opentelemetry_instrumentation_requests-0.54b0}/pyproject.toml

@@ -27,9 +27,9 @@ classifiers = [
 ]
 dependencies = [
   "opentelemetry-api ~= 1.12",
-  "opentelemetry-instrumentation == 0.53b0",
-  "opentelemetry-semantic-conventions == 0.53b0",
-  "opentelemetry-util-http == 0.53b0",
+  "opentelemetry-instrumentation == 0.54b0",
+  "opentelemetry-semantic-conventions == 0.54b0",
+  "opentelemetry-util-http == 0.54b0",
 ]
 
 [project.optional-dependencies]

{opentelemetry_instrumentation_requests-0.53b0 → opentelemetry_instrumentation_requests-0.54b0}/src/opentelemetry/instrumentation/requests/__init__.py

@@ -57,6 +57,22 @@ The hooks can be configured as follows:
         request_hook=request_hook, response_hook=response_hook
     )
 
+Custom Duration Histogram Boundaries
+************************************
+To customize the duration histogram bucket boundaries used for HTTP client request duration metrics,
+you can provide a list of values when instrumenting:
+
+.. code:: python
+
+    import requests
+    from opentelemetry.instrumentation.requests import RequestsInstrumentor
+
+    custom_boundaries = [0.0, 5.0, 10.0, 25.0, 50.0, 100.0]
+
+    RequestsInstrumentor().instrument(
+        duration_histogram_boundaries=custom_boundaries
+    )
+
 Exclude lists
 *************
 To exclude certain URLs from being tracked, set the environment variable ``OTEL_PYTHON_REQUESTS_EXCLUDED_URLS``
@@ -87,6 +103,8 @@ from requests.sessions import Session
 from requests.structures import CaseInsensitiveDict
 
 from opentelemetry.instrumentation._semconv import (
+    HTTP_DURATION_HISTOGRAM_BUCKETS_NEW,
+    HTTP_DURATION_HISTOGRAM_BUCKETS_OLD,
     _client_duration_attrs_new,
     _client_duration_attrs_old,
     _filter_semconv_duration_attrs,
@@ -410,8 +428,8 @@ class RequestsInstrumentor(BaseInstrumentor):
                 ``tracer_provider``: a TracerProvider, defaults to global
                 ``request_hook``: An optional callback that is invoked right after a span is created.
                 ``response_hook``: An optional callback which is invoked right before the span is finished processing a response.
-                ``excluded_urls``: A string containing a comma-delimited
-                    list of regexes used to exclude URLs from tracking
+                ``excluded_urls``: A string containing a comma-delimited list of regexes used to exclude URLs from tracking
+                ``duration_histogram_boundaries``: A list of float values representing the explicit bucket boundaries for the duration histogram.
         """
         semconv_opt_in_mode = _OpenTelemetrySemanticConventionStability._get_opentelemetry_stability_opt_in_mode(
             _OpenTelemetryStabilitySignalType.HTTP,
@@ -426,6 +444,9 @@ class RequestsInstrumentor(BaseInstrumentor):
         )
         excluded_urls = kwargs.get("excluded_urls")
         meter_provider = kwargs.get("meter_provider")
+        duration_histogram_boundaries = kwargs.get(
+            "duration_histogram_boundaries"
+        )
         meter = get_meter(
             __name__,
             __version__,
@@ -438,6 +459,8 @@ class RequestsInstrumentor(BaseInstrumentor):
                 name=MetricInstruments.HTTP_CLIENT_DURATION,
                 unit="ms",
                 description="measures the duration of the outbound HTTP request",
+                explicit_bucket_boundaries_advisory=duration_histogram_boundaries
+                or HTTP_DURATION_HISTOGRAM_BUCKETS_OLD,
             )
         duration_histogram_new = None
         if _report_new(semconv_opt_in_mode):
@@ -445,6 +468,8 @@ class RequestsInstrumentor(BaseInstrumentor):
                 name=HTTP_CLIENT_REQUEST_DURATION,
                 unit="s",
                 description="Duration of HTTP client requests.",
+                explicit_bucket_boundaries_advisory=duration_histogram_boundaries
+                or HTTP_DURATION_HISTOGRAM_BUCKETS_NEW,
             )
         _instrument(
             tracer,

{opentelemetry_instrumentation_requests-0.53b0 → opentelemetry_instrumentation_requests-0.54b0}/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.53b0"
+__version__ = "0.54b0"

{opentelemetry_instrumentation_requests-0.53b0 → opentelemetry_instrumentation_requests-0.54b0}/tests/test_requests_integration.py

@@ -23,6 +23,8 @@ from requests.models import Response
 import opentelemetry.instrumentation.requests
 from opentelemetry import trace
 from opentelemetry.instrumentation._semconv import (
+    HTTP_DURATION_HISTOGRAM_BUCKETS_NEW,
+    HTTP_DURATION_HISTOGRAM_BUCKETS_OLD,
     OTEL_SEMCONV_STABILITY_OPT_IN,
     _OpenTelemetrySemanticConventionStability,
 )
@@ -123,6 +125,7 @@ class RequestsIntegrationTestBase(abc.ABC):
     def tearDown(self):
         super().tearDown()
         self.env_patch.stop()
+        _OpenTelemetrySemanticConventionStability._initialized = False
         RequestsInstrumentor().uninstrument()
         httpretty.disable()
 
@@ -730,6 +733,7 @@ class TestRequestsIntergrationMetric(TestBase):
     def tearDown(self):
         super().tearDown()
         self.env_patch.stop()
+        _OpenTelemetrySemanticConventionStability._initialized = False
         RequestsInstrumentor().uninstrument()
         httpretty.disable()
 
@@ -762,6 +766,10 @@ class TestRequestsIntergrationMetric(TestBase):
                         "measures the duration of the outbound HTTP request",
                     )
                     for data_point in metric.data.data_points:
+                        self.assertEqual(
+                            data_point.explicit_bounds,
+                            HTTP_DURATION_HISTOGRAM_BUCKETS_OLD,
+                        )
                         self.assertDictEqual(
                             expected_attributes, dict(data_point.attributes)
                         )
@@ -788,6 +796,10 @@ class TestRequestsIntergrationMetric(TestBase):
                         metric.description, "Duration of HTTP client requests."
                     )
                     for data_point in metric.data.data_points:
+                        self.assertEqual(
+                            data_point.explicit_bounds,
+                            HTTP_DURATION_HISTOGRAM_BUCKETS_NEW,
+                        )
                         self.assertDictEqual(
                             expected_attributes, dict(data_point.attributes)
                         )
@@ -833,6 +845,38 @@ class TestRequestsIntergrationMetric(TestBase):
                             )
                         self.assertEqual(data_point.count, 1)
 
+    def test_custom_histogram_boundaries(self):
+        RequestsInstrumentor().uninstrument()
+        custom_boundaries = (0.0, 1.0, 2.0, 5.0, 10.0, 20.0, 50.0, 100.0)
+        meter_provider, memory_reader = self.create_meter_provider()
+        RequestsInstrumentor().instrument(
+            meter_provider=meter_provider,
+            duration_histogram_boundaries=custom_boundaries,
+        )
+
+        self.perform_request(self.URL)
+        metrics = memory_reader.get_metrics_data().resource_metrics[0]
+        self.assertEqual(len(metrics.scope_metrics), 1)
+        data_point = metrics.scope_metrics[0].metrics[0].data.data_points[0]
+        self.assertEqual(data_point.explicit_bounds, custom_boundaries)
+        self.assertEqual(data_point.count, 1)
+
+    def test_custom_histogram_boundaries_new_semconv(self):
+        RequestsInstrumentor().uninstrument()
+        custom_boundaries = (0.0, 5.0, 10.0, 25.0, 50.0, 100.0)
+        meter_provider, memory_reader = self.create_meter_provider()
+        RequestsInstrumentor().instrument(
+            meter_provider=meter_provider,
+            duration_histogram_boundaries=custom_boundaries,
+        )
+
+        self.perform_request(self.URL)
+        metrics = memory_reader.get_metrics_data().resource_metrics[0]
+        self.assertEqual(len(metrics.scope_metrics), 1)
+        data_point = metrics.scope_metrics[0].metrics[0].data.data_points[0]
+        self.assertEqual(data_point.explicit_bounds, custom_boundaries)
+        self.assertEqual(data_point.count, 1)
+
     def test_basic_metric_non_recording_span(self):
         expected_attributes = {
             SpanAttributes.HTTP_STATUS_CODE: 200,