feat(urllib3)!: add method and url parameters to the request hook

Author: eigenein

Diff for: CHANGELOG.md

@@ -9,8 +9,6 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Added
 
-- `opentelemetry-instrumentation-sklearn` Deprecated the sklearn instrumentation
-  ([#2708](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/2708))
 - `opentelemetry-instrumentation-pyramid` Record exceptions raised when serving a request
   ([#2622](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/2622))
 - `opentelemetry-sdk-extension-aws` Add AwsXrayLambdaPropagator
@@ -31,21 +29,18 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
   ([#2630](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/2630))
 - `opentelemetry-instrumentation-system-metrics` Add support for capture open file descriptors
   ([#2652](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/2652))
-- `opentelemetry-instrumentation-httpx` Add support for instrument client with proxy
-  ([#2664](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/2664))
 - `opentelemetry-instrumentation-aiohttp-client` Implement new semantic convention opt-in migration
   ([#2673](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/2673))
-- `opentelemetry-instrumentation-django` Add `http.target` to Django duration metric attributes
-  ([#2624](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/2624))
 
 ### Breaking changes
 
 - `opentelemetry-instrumentation-asgi`, `opentelemetry-instrumentation-fastapi`, `opentelemetry-instrumentation-starlette` Use `tracer` and `meter` of originating components instead of one from `asgi` middleware
   ([#2580](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/2580))
 - Populate `{method}` as `HTTP` on `_OTHER` methods from scope for `asgi` middleware
   ([#2610](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/2610))
-  - Populate `{method}` as `HTTP` on `_OTHER` methods from scope for `fastapi` middleware
-  ([#2682](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/2682))
+- Populate `{method}` as `HTTP` on `_OTHER` methods from scope for `fastapi` middleware
+([#2682](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/2682))
+- `urllib3`: refactor request hook to also include `method` and `url` parameters ([#2711](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/2711))
 
 ### Fixed
 - Handle `redis.exceptions.WatchError` as a non-error event in redis instrumentation
@@ -65,7 +60,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - `opentelemetry-instrumentation-asgi` Fix generation of `http.target` and `http.url` attributes for ASGI apps
   using sub apps
   ([#2477](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/2477))
-- `opentelemetry-instrumentation-aws-lambda` Bugfix: AWS Lambda event source key incorrect for SNS in instrumentation library.
+- `opentelemetry-instrumentation-aws-lambda` Bugfix: AWS Lambda event source key incorrect for SNS in instrumentation library. 
   ([#2612](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/2612))
 - `opentelemetry-instrumentation-asyncio` instrumented `asyncio.wait_for` properly raises `asyncio.TimeoutError` as expected
   ([#2637](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/2637))

Diff for: instrumentation/opentelemetry-instrumentation-urllib3/src/opentelemetry/instrumentation/urllib3/__init__.py

@@ -47,13 +47,21 @@ def strip_query_params(url: str) -> str:
 
 .. code:: python
 
-    # `request` is an instance of urllib3.connectionpool.HTTPConnectionPool
-    def request_hook(span, request):
+    def request_hook(
+        span: Span,
+        instance: urllib3.connectionpool.HTTPConnectionPool,
+        method: str,
+        url: str,
+        headers: dict[str, str],
+        body: str | None,
+    ):
         pass
 
-    # `request` is an instance of urllib3.connectionpool.HTTPConnectionPool
-    # `response` is an instance of urllib3.response.HTTPResponse
-    def response_hook(span, request, response):
+    def response_hook(
+        span: Span,
+        instance: urllib3.connectionpool.HTTPConnectionPool,
+        response: urllib3.response.HTTPResponse,
+    ):
         pass
 
     URLLib3Instrumentor().instrument(
@@ -117,6 +125,8 @@ def response_hook(span, request, response):
         [
             Span,
             urllib3.connectionpool.HTTPConnectionPool,
+            str,
+            str,
             typing.Dict,
             typing.Optional[str],
         ],
@@ -243,7 +253,7 @@ def instrumented_urlopen(wrapped, instance, args, kwargs):
             span_name, kind=SpanKind.CLIENT, attributes=span_attributes
         ) as span, set_ip_on_next_http_connection(span):
             if callable(request_hook):
-                request_hook(span, instance, headers, body)
+                request_hook(span, instance, method, url, headers, body)
             inject(headers)
 
             with suppress_http_instrumentation():

Diff for: instrumentation/opentelemetry-instrumentation-urllib3/tests/test_urllib3_integration.py

@@ -315,10 +315,10 @@ def test_credential_removal(self):
         self.assert_success_span(response, self.HTTP_URL)
 
     def test_hooks(self):
-        def request_hook(span, request, body, headers):
+        def request_hook(span, instance, method, url, body, headers):
             span.update_name("name set from hook")
 
-        def response_hook(span, request, response):
+        def response_hook(span, instance, response):
             span.set_attribute("response_hook_attr", "value")
 
         URLLib3Instrumentor().uninstrument()
@@ -335,7 +335,9 @@ def response_hook(span, request, response):
         self.assertEqual(span.attributes["response_hook_attr"], "value")
 
     def test_request_hook_params(self):
-        def request_hook(span, request, headers, body):
+        def request_hook(span, instance, method, url, headers, body):
+            span.set_attribute("request_hook_method", method)
+            span.set_attribute("request_hook_url", url)
             span.set_attribute(
                 "request_hook_headers", json.dumps(dict(headers))
             )
@@ -358,6 +360,10 @@ def request_hook(span, request, headers, body):
 
         span = self.assert_span()
 
+        self.assertEqual(span.attributes["request_hook_method"], "POST")
+        self.assertEqual(
+            span.attributes["request_hook_url"], "http://mock/status/200"
+        )
         self.assertIn("request_hook_headers", span.attributes)
         self.assertEqual(
             span.attributes["request_hook_headers"], json.dumps(headers)
@@ -366,7 +372,7 @@ def request_hook(span, request, headers, body):
         self.assertEqual(span.attributes["request_hook_body"], body)
 
     def test_request_positional_body(self):
-        def request_hook(span, request, headers, body):
+        def request_hook(span, instance, method, url, headers, body):
             span.set_attribute("request_hook_body", body)
 
         URLLib3Instrumentor().uninstrument()