opentelemetry-instrumentation-confluent-kafka 0.40b0__py3-none-any.whl → 0.41b0__py3-none-any.whl

opentelemetry/instrumentation/confluent_kafka/__init__.py

@@ -112,6 +112,8 @@ from opentelemetry.trace import Link, SpanKind, Tracer
 from .package import _instruments
 from .utils import (
     KafkaPropertiesExtractor,
+    _end_current_consume_span,
+    _create_new_consume_span,
     _enrich_span,
     _get_span_name,
     _kafka_getter,
@@ -137,6 +139,12 @@ class AutoInstrumentedConsumer(Consumer):
     def poll(self, timeout=-1):  # pylint: disable=useless-super-delegation
         return super().poll(timeout)
 
+    # This method is deliberately implemented in order to allow wrapt to wrap this function
+    def consume(
+        self, *args, **kwargs
+    ):  # pylint: disable=useless-super-delegation
+        return super().consume(*args, **kwargs)
+
 
 class ProxiedProducer(Producer):
     def __init__(self, producer: Producer, tracer: Tracer):
@@ -177,10 +185,14 @@ class ProxiedConsumer(Consumer):
     def commit(self, *args, **kwargs):
         return self._consumer.commit(*args, **kwargs)
 
-    def consume(
-        self, num_messages=1, *args, **kwargs
-    ):  # pylint: disable=keyword-arg-before-vararg
-        return self._consumer.consume(num_messages, *args, **kwargs)
+    def consume(self, *args, **kwargs):
+        return ConfluentKafkaInstrumentor.wrap_consume(
+            self._consumer.consume,
+            self,
+            self._tracer,
+            args,
+            kwargs,
+        )
 
     def get_watermark_offsets(
         self, partition, timeout=-1, *args, **kwargs
@@ -275,6 +287,11 @@ class ConfluentKafkaInstrumentor(BaseInstrumentor):
                 func, instance, self._tracer, args, kwargs
             )
 
+        def _inner_wrap_consume(func, instance, args, kwargs):
+            return ConfluentKafkaInstrumentor.wrap_consume(
+                func, instance, self._tracer, args, kwargs
+            )
+
         wrapt.wrap_function_wrapper(
             AutoInstrumentedProducer,
             "produce",
@@ -287,6 +304,12 @@ class ConfluentKafkaInstrumentor(BaseInstrumentor):
             _inner_wrap_poll,
         )
 
+        wrapt.wrap_function_wrapper(
+            AutoInstrumentedConsumer,
+            "consume",
+            _inner_wrap_consume,
+        )
+
     def _uninstrument(self, **kwargs):
         confluent_kafka.Producer = self._original_kafka_producer
         confluent_kafka.Consumer = self._original_kafka_consumer
@@ -326,29 +349,14 @@ class ConfluentKafkaInstrumentor(BaseInstrumentor):
     @staticmethod
     def wrap_poll(func, instance, tracer, args, kwargs):
         if instance._current_consume_span:
-            context.detach(instance._current_context_token)
-            instance._current_context_token = None
-            instance._current_consume_span.end()
-            instance._current_consume_span = None
+            _end_current_consume_span(instance)
 
         with tracer.start_as_current_span(
             "recv", end_on_exit=True, kind=trace.SpanKind.CONSUMER
         ):
             record = func(*args, **kwargs)
             if record:
-                links = []
-                ctx = propagate.extract(record.headers(), getter=_kafka_getter)
-                if ctx:
-                    for item in ctx.values():
-                        if hasattr(item, "get_span_context"):
-                            links.append(Link(context=item.get_span_context()))
-
-                instance._current_consume_span = tracer.start_span(
-                    name=f"{record.topic()} process",
-                    links=links,
-                    kind=SpanKind.CONSUMER,
-                )
-
+                _create_new_consume_span(instance, tracer, [record])
                 _enrich_span(
                     instance._current_consume_span,
                     record.topic(),
@@ -361,3 +369,26 @@ class ConfluentKafkaInstrumentor(BaseInstrumentor):
         )
 
         return record
+
+    @staticmethod
+    def wrap_consume(func, instance, tracer, args, kwargs):
+        if instance._current_consume_span:
+            _end_current_consume_span(instance)
+
+        with tracer.start_as_current_span(
+            "recv", end_on_exit=True, kind=trace.SpanKind.CONSUMER
+        ):
+            records = func(*args, **kwargs)
+            if len(records) > 0:
+                _create_new_consume_span(instance, tracer, records)
+                _enrich_span(
+                    instance._current_consume_span,
+                    records[0].topic(),
+                    operation=MessagingOperationValues.PROCESS,
+                )
+
+        instance._current_context_token = context.attach(
+            trace.set_span_in_context(instance._current_consume_span)
+        )
+
+        return records

opentelemetry/instrumentation/confluent_kafka/utils.py

@@ -1,6 +1,8 @@
 from logging import getLogger
 from typing import List, Optional
 
+from opentelemetry import context, propagate
+from opentelemetry.trace import SpanKind, Link
 from opentelemetry.propagators import textmap
 from opentelemetry.semconv.trace import (
     MessagingDestinationKindValues,
@@ -81,6 +83,34 @@ class KafkaContextSetter(textmap.Setter):
 _kafka_getter = KafkaContextGetter()
 
 
+def _end_current_consume_span(instance):
+    context.detach(instance._current_context_token)
+    instance._current_context_token = None
+    instance._current_consume_span.end()
+    instance._current_consume_span = None
+
+
+def _create_new_consume_span(instance, tracer, records):
+    links = _get_links_from_records(records)
+    instance._current_consume_span = tracer.start_span(
+        name=f"{records[0].topic()} process",
+        links=links,
+        kind=SpanKind.CONSUMER,
+    )
+
+
+def _get_links_from_records(records):
+    links = []
+    for record in records:
+        ctx = propagate.extract(record.headers(), getter=_kafka_getter)
+        if ctx:
+            for item in ctx.values():
+                if hasattr(item, "get_span_context"):
+                    links.append(Link(context=item.get_span_context()))
+
+    return links
+
+
 def _enrich_span(
     span,
     topic,
@@ -94,7 +124,7 @@ def _enrich_span(
     span.set_attribute(SpanAttributes.MESSAGING_SYSTEM, "kafka")
     span.set_attribute(SpanAttributes.MESSAGING_DESTINATION, topic)
 
-    if partition:
+    if partition is not None:
         span.set_attribute(SpanAttributes.MESSAGING_KAFKA_PARTITION, partition)
 
     span.set_attribute(
@@ -109,7 +139,7 @@ def _enrich_span(
 
     # https://stackoverflow.com/questions/65935155/identify-and-find-specific-message-in-kafka-topic
     # A message within Kafka is uniquely defined by its topic name, topic partition and offset.
-    if partition and offset and topic:
+    if partition is not None and offset is not None and topic:
         span.set_attribute(
             SpanAttributes.MESSAGING_MESSAGE_ID,
             f"{topic}.{partition}.{offset}",

opentelemetry/instrumentation/confluent_kafka/version.py

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

{opentelemetry_instrumentation_confluent_kafka-0.40b0.dist-info → opentelemetry_instrumentation_confluent_kafka-0.41b0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: opentelemetry-instrumentation-confluent-kafka
-Version: 0.40b0
+Version: 0.41b0
 Summary: OpenTelemetry Confluent Kafka instrumentation
 Project-URL: Homepage, https://github.com/open-telemetry/opentelemetry-python-contrib/tree/main/instrumentation/opentelemetry-instrumentation-confluent-kafka
 Author-email: OpenTelemetry Authors <cncf-opentelemetry-contributors@lists.cncf.io>

opentelemetry_instrumentation_confluent_kafka-0.41b0.dist-info/RECORD

@@ -0,0 +1,9 @@
+opentelemetry/instrumentation/confluent_kafka/__init__.py,sha256=JIjbWOhqS7t1SA5q99EOITDMLN1jQANLw8C0IdjiI_w,13152
+opentelemetry/instrumentation/confluent_kafka/package.py,sha256=GAdglvW5Pp12xoeaym8zQjRE9fyX8PGFV-u8v8ZjWZI,641
+opentelemetry/instrumentation/confluent_kafka/utils.py,sha256=50fgsCnN72GMhlU1psVdi1jgzJ5n-n5BXHZ7nls1W-s,4507
+opentelemetry/instrumentation/confluent_kafka/version.py,sha256=9LtSy_KpXBRCK2aaMFk3l5qiAoEDLs7boZzuBeF3mPY,608
+opentelemetry_instrumentation_confluent_kafka-0.41b0.dist-info/METADATA,sha256=NN6GTpvP3roNdhJwkrm2EZTHbYk5pbHgSqEmu81lobA,1966
+opentelemetry_instrumentation_confluent_kafka-0.41b0.dist-info/WHEEL,sha256=KGYbc1zXlYddvwxnNty23BeaKzh7YuoSIvIMO4jEhvw,87
+opentelemetry_instrumentation_confluent_kafka-0.41b0.dist-info/entry_points.txt,sha256=hAIEwx8JI8eFsUgk3ewaMdYw215At11XX-1a4WjAHBY,120
+opentelemetry_instrumentation_confluent_kafka-0.41b0.dist-info/licenses/LICENSE,sha256=h8jwqxShIeVkc8vOo9ynxGYW16f4fVPxLhZKZs0H5U8,11350
+opentelemetry_instrumentation_confluent_kafka-0.41b0.dist-info/RECORD,,

opentelemetry_instrumentation_confluent_kafka-0.40b0.dist-info/RECORD

@@ -1,9 +0,0 @@
-opentelemetry/instrumentation/confluent_kafka/__init__.py,sha256=C12oyiGDgXtTdig3b8Wd0F0AIuLmvjB-NFuYSAAbeUM,12300
-opentelemetry/instrumentation/confluent_kafka/package.py,sha256=GAdglvW5Pp12xoeaym8zQjRE9fyX8PGFV-u8v8ZjWZI,641
-opentelemetry/instrumentation/confluent_kafka/utils.py,sha256=bWKcxUcnhP5J_WkqR8zuw0lskKmcHLWjq9HF0p4sV74,3541
-opentelemetry/instrumentation/confluent_kafka/version.py,sha256=3kOuQWAUh-WCYbTuY1DBtA72c_iLngqxwEVTesRRxTs,608
-opentelemetry_instrumentation_confluent_kafka-0.40b0.dist-info/METADATA,sha256=9VZwFhvuSiiiphcyZhKEGycMp9yR_59Gv6iBZQmGhWs,1966
-opentelemetry_instrumentation_confluent_kafka-0.40b0.dist-info/WHEEL,sha256=KGYbc1zXlYddvwxnNty23BeaKzh7YuoSIvIMO4jEhvw,87
-opentelemetry_instrumentation_confluent_kafka-0.40b0.dist-info/entry_points.txt,sha256=hAIEwx8JI8eFsUgk3ewaMdYw215At11XX-1a4WjAHBY,120
-opentelemetry_instrumentation_confluent_kafka-0.40b0.dist-info/licenses/LICENSE,sha256=h8jwqxShIeVkc8vOo9ynxGYW16f4fVPxLhZKZs0H5U8,11350
-opentelemetry_instrumentation_confluent_kafka-0.40b0.dist-info/RECORD,,