Merge branch 'main' into issue_2555

Author: jgibo

CHANGELOG.md

@@ -9,6 +9,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Breaking changes
 
+- Add return statement to Confluent kafka Producer poll() and flush() calls when instrumented by ConfluentKafkaInstrumentor().instrument_producer() ([#2527](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/2527))
 - Rename `type` attribute to `asgi.event.type` in `opentelemetry-instrumentation-asgi`
   ([#2300](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/2300))
 - Rename AwsLambdaInstrumentor span attributes `faas.id` to `cloud.resource_id`, `faas.execution` to `faas.invocation_id`
@@ -41,7 +42,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Fixed
 
-- `opentelemetry-instrumentation-dbapi` Fix compatibility with Psycopg3 to extract libpq build version (#2500)[https://github.com/open-telemetry/opentelemetry-python-contrib/pull/2500]
+- `opentelemetry-instrumentation-dbapi` Fix compatibility with Psycopg3 to extract libpq build version
+  ([#2500](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/2500))
+- `opentelemetry-instrumentation-httpx` Ensure httpx.get or httpx.request like methods are instrumented
+  ([#2538](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/2538))
 - `opentelemetry-instrumentation-grpc` AioClientInterceptor should propagate with a Metadata object
   ([#2363](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/2363))
 - `opentelemetry-instrumentation-boto3sqs` Instrument Session and resource
@@ -65,6 +69,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - `opentelemetry-util-http` Preserve brackets around literal IPv6 hosts ([#2552](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/2552))
 - `opentelemetry-instrumentation-tornado` Fix not handling a http client exception
   ([#2563](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/2563))
+- `opentelemetry-util-redis` Fix net peer attribute for unix socket connection ([#2493](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/2493))
 
 ## Version 1.24.0/0.45b0 (2024-03-28)
 

instrumentation/opentelemetry-instrumentation-boto/test-requirements.txt

@@ -1,69 +1,39 @@
-annotated-types==0.6.0
 asgiref==3.7.2
 attrs==23.2.0
-aws-sam-translator==1.85.0
-aws-xray-sdk==2.12.1
 boto==2.49.0
 boto3==1.34.44
 botocore==1.34.44
 certifi==2024.2.2
 cffi==1.16.0
-cfn-lint==0.85.2
 charset-normalizer==3.3.2
 cryptography==42.0.3
 Deprecated==1.2.14
 docker==7.0.0
-ecdsa==0.18.0
-graphql-core==3.2.3
 idna==3.6
 importlib-metadata==6.11.0
-importlib-resources==6.1.1
 iniconfig==2.0.0
-Jinja2==3.1.3
+Jinja2==3.1.4
 jmespath==1.0.1
-jschema-to-python==1.2.3
-jsondiff==2.0.0
-jsonpatch==1.33
-jsonpickle==3.0.2
-jsonpointer==2.4
-jsonschema==4.21.1
-jsonschema-specifications==2023.12.1
-junit-xml==1.9
 MarkupSafe==2.1.5
 moto==2.3.2
-mpmath==1.3.0
-networkx==3.1
 packaging==23.2
-pbr==6.0.0
-pkgutil_resolve_name==1.3.10
 pluggy==1.4.0
 py==1.11.0
 py-cpuinfo==9.0.0
-pyasn1==0.5.1
 pycparser==2.21
-pydantic==2.6.1
-pydantic_core==2.16.2
 pytest==7.1.3
 pytest-benchmark==4.0.0
 python-dateutil==2.8.2
-python-jose==3.3.0
 pytz==2024.1
 PyYAML==6.0.1
-referencing==0.33.0
-regex==2023.12.25
 requests==2.31.0
 responses==0.25.0
-rpds-py==0.18.0
-rsa==4.9
 s3transfer==0.10.0
-sarif-om==1.0.4
 six==1.16.0
-sshpubkeys==3.3.1
-sympy==1.12
 tomli==2.0.1
 typing_extensions==4.9.0
 urllib3==1.26.18
-Werkzeug==3.0.1
+Werkzeug==2.1.2
 wrapt==1.16.0
 xmltodict==0.13.0
 zipp==3.17.0

instrumentation/opentelemetry-instrumentation-botocore/test-requirements.txt

@@ -1,63 +1,35 @@
-annotated-types==0.6.0
 asgiref==3.7.2
 attrs==23.2.0
-aws-sam-translator==1.85.0
 aws-xray-sdk==2.12.1
 boto3==1.28.80
 botocore==1.31.80
 certifi==2024.2.2
 cffi==1.16.0
-cfn-lint==0.85.2
 charset-normalizer==3.3.2
 cryptography==42.0.5
 Deprecated==1.2.14
 docker==7.0.0
-ecdsa==0.18.0
 idna==3.6
 importlib-metadata==6.11.0
-importlib-resources==6.1.1
 iniconfig==2.0.0
-Jinja2==3.1.3
+Jinja2==3.1.4
 jmespath==1.0.1
-jschema-to-python==1.2.3
-jsondiff==2.0.0
-jsonpatch==1.33
-jsonpickle==3.0.3
-jsonpointer==2.4
-jsonschema==4.21.1
-jsonschema-specifications==2023.12.1
-junit-xml==1.9
 MarkupSafe==2.0.1
 moto==3.1.19
-mpmath==1.3.0
-networkx==3.1
 packaging==23.2
-pbr==6.0.0
-pkgutil_resolve_name==1.3.10
 pluggy==1.4.0
 py==1.11.0
 py-cpuinfo==9.0.0
-pyasn1==0.5.1
 pycparser==2.21
-pydantic==2.6.2
-pydantic_core==2.16.3
 pytest==7.1.3
 pytest-benchmark==4.0.0
 python-dateutil==2.8.2
-python-jose==3.3.0
 pytz==2024.1
 PyYAML==6.0.1
-referencing==0.33.0
-regex==2023.12.25
 requests==2.31.0
 responses==0.25.0
-rpds-py==0.18.0
-rsa==4.9
 s3transfer==0.7.0
-sarif-om==1.0.4
 six==1.16.0
-sshpubkeys==3.3.1
-sympy==1.12
 tomli==2.0.1
 typing_extensions==4.9.0
 urllib3==1.26.18

instrumentation/opentelemetry-instrumentation-confluent-kafka/src/opentelemetry/instrumentation/confluent_kafka/__init__.py

@@ -151,10 +151,10 @@ def __init__(self, producer: Producer, tracer: Tracer):
         self._tracer = tracer
 
     def flush(self, timeout=-1):
-        self._producer.flush(timeout)
+        return self._producer.flush(timeout)
 
     def poll(self, timeout=-1):
-        self._producer.poll(timeout)
+        return self._producer.poll(timeout)
 
     def produce(
         self, topic, value=None, *args, **kwargs

instrumentation/opentelemetry-instrumentation-confluent-kafka/tests/test_instrumentation.py

@@ -31,7 +31,7 @@
 )
 from opentelemetry.test.test_base import TestBase
 
-from .utils import MockConsumer, MockedMessage
+from .utils import MockConsumer, MockedMessage, MockedProducer
 
 
 class TestConfluentKafka(TestBase):
@@ -246,3 +246,35 @@ def _compare_spans(self, spans, expected_spans):
                 self.assertEqual(
                     expected_attribute_value, span.attributes[attribute_key]
                 )
+
+    def test_producer_poll(self) -> None:
+        instrumentation = ConfluentKafkaInstrumentor()
+        message_queue = []
+
+        producer = MockedProducer(
+            message_queue,
+            {
+                "bootstrap.servers": "localhost:29092",
+            },
+        )
+
+        producer = instrumentation.instrument_producer(producer)
+        producer.produce(topic="topic-1", key="key-1", value="value-1")
+        msg = producer.poll()
+        self.assertIsNotNone(msg)
+
+    def test_producer_flush(self) -> None:
+        instrumentation = ConfluentKafkaInstrumentor()
+        message_queue = []
+
+        producer = MockedProducer(
+            message_queue,
+            {
+                "bootstrap.servers": "localhost:29092",
+            },
+        )
+
+        producer = instrumentation.instrument_producer(producer)
+        producer.produce(topic="topic-1", key="key-1", value="value-1")
+        msg = producer.flush()
+        self.assertIsNotNone(msg)

instrumentation/opentelemetry-instrumentation-confluent-kafka/tests/utils.py

@@ -1,4 +1,6 @@
-from confluent_kafka import Consumer
+from typing import Optional
+
+from confluent_kafka import Consumer, Producer
 
 
 class MockConsumer(Consumer):
@@ -20,11 +22,21 @@ def poll(self, timeout=None):
 
 
 class MockedMessage:
-    def __init__(self, topic: str, partition: int, offset: int, headers):
+    def __init__(
+        self,
+        topic: str,
+        partition: int,
+        offset: int,
+        headers,
+        key: Optional[str] = None,
+        value: Optional[str] = None,
+    ):
         self._topic = topic
         self._partition = partition
         self._offset = offset
         self._headers = headers
+        self._key = key
+        self._value = value
 
     def topic(self):
         return self._topic
@@ -37,3 +49,35 @@ def offset(self):
 
     def headers(self):
         return self._headers
+
+    def key(self):
+        return self._key
+
+    def value(self):
+        return self._value
+
+
+class MockedProducer(Producer):
+    def __init__(self, queue, config):
+        self._queue = queue
+        super().__init__(config)
+
+    def produce(
+        self, *args, **kwargs
+    ):  # pylint: disable=keyword-arg-before-vararg
+        self._queue.append(
+            MockedMessage(
+                topic=kwargs.get("topic"),
+                partition=0,
+                offset=0,
+                headers=[],
+                key=kwargs.get("key"),
+                value=kwargs.get("value"),
+            )
+        )
+
+    def poll(self, *args, **kwargs):
+        return len(self._queue)
+
+    def flush(self, *args, **kwargs):
+        return len(self._queue)

instrumentation/opentelemetry-instrumentation-httpx/src/opentelemetry/instrumentation/httpx/__init__.py

@@ -564,11 +564,13 @@ def _instrument(self, **kwargs):
         tracer_provider = kwargs.get("tracer_provider")
         _InstrumentedClient._tracer_provider = tracer_provider
         _InstrumentedAsyncClient._tracer_provider = tracer_provider
-        httpx.Client = _InstrumentedClient
+        # Intentionally using a private attribute here, see:
+        # https://github.com/open-telemetry/opentelemetry-python-contrib/pull/2538#discussion_r1610603719
+        httpx.Client = httpx._api.Client = _InstrumentedClient
         httpx.AsyncClient = _InstrumentedAsyncClient
 
     def _uninstrument(self, **kwargs):
-        httpx.Client = self._original_client
+        httpx.Client = httpx._api.Client = self._original_client
         httpx.AsyncClient = self._original_async_client
         _InstrumentedClient._tracer_provider = None
         _InstrumentedClient._request_hook = None

instrumentation/opentelemetry-instrumentation-httpx/tests/test_httpx_integration.py

@@ -532,12 +532,36 @@ def test_instrument_client(self):
             self.assertEqual(result.text, "Hello!")
             self.assert_span(num_spans=1)
 
+        def test_instrumentation_without_client(self):
+
+            HTTPXClientInstrumentor().instrument()
+            results = [
+                httpx.get(self.URL),
+                httpx.request("GET", self.URL),
+            ]
+            with httpx.stream("GET", self.URL) as stream:
+                stream.read()
+                results.append(stream)
+
+            spans = self.assert_span(num_spans=len(results))
+            for idx, res in enumerate(results):
+                with self.subTest(idx=idx, res=res):
+                    self.assertEqual(res.text, "Hello!")
+                    self.assertEqual(
+                        spans[idx].attributes[SpanAttributes.HTTP_URL],
+                        self.URL,
+                    )
+
+            HTTPXClientInstrumentor().uninstrument()
+
         def test_uninstrument(self):
             HTTPXClientInstrumentor().instrument()
             HTTPXClientInstrumentor().uninstrument()
             client = self.create_client()
             result = self.perform_request(self.URL, client=client)
+            result_no_client = httpx.get(self.URL)
             self.assertEqual(result.text, "Hello!")
+            self.assertEqual(result_no_client.text, "Hello!")
             self.assert_span(num_spans=0)
 
         def test_uninstrument_client(self):

instrumentation/opentelemetry-instrumentation-redis/src/opentelemetry/instrumentation/redis/util.py

@@ -29,7 +29,12 @@ def _extract_conn_attributes(conn_kwargs):
     }
     db = conn_kwargs.get("db", 0)
     attributes[SpanAttributes.DB_REDIS_DATABASE_INDEX] = db
-    try:
+    if "path" in conn_kwargs:
+        attributes[SpanAttributes.NET_PEER_NAME] = conn_kwargs.get("path", "")
+        attributes[SpanAttributes.NET_TRANSPORT] = (
+            NetTransportValues.OTHER.value
+        )
+    else:
         attributes[SpanAttributes.NET_PEER_NAME] = conn_kwargs.get(
             "host", "localhost"
         )
@@ -39,11 +44,6 @@ def _extract_conn_attributes(conn_kwargs):
         attributes[SpanAttributes.NET_TRANSPORT] = (
             NetTransportValues.IP_TCP.value
         )
-    except KeyError:
-        attributes[SpanAttributes.NET_PEER_NAME] = conn_kwargs.get("path", "")
-        attributes[SpanAttributes.NET_TRANSPORT] = (
-            NetTransportValues.OTHER.value
-        )
 
     return attributes