Coverage for faststream/kafka/opentelemetry/provider.py: 89%
28 statements
« prev ^ index » next coverage.py v7.17.3, created at 2026-11-17 21:20 +0000
« prev ^ index » next coverage.py v7.17.3, created at 2026-11-17 21:20 +0000
1from collections.abc import Sequence
2from typing import TYPE_CHECKING, Any, Union, cast
4from opentelemetry.semconv.trace import SpanAttributes
5from typing_extensions import override
7from faststream._internal.types import MsgType
8from faststream.kafka.response import KafkaPublishCommand
9from faststream.opentelemetry import TelemetrySettingsProvider
10from faststream.opentelemetry.consts import MESSAGING_DESTINATION_PUBLISH_NAME
12if TYPE_CHECKING:
13 from aiokafka import ConsumerRecord
15 from faststream.message import StreamMessage
16 from faststream.response import PublishCommand
19class BaseKafkaTelemetrySettingsProvider(
20 TelemetrySettingsProvider[MsgType, KafkaPublishCommand],
21):
22 __slots__ = ("messaging_system",)
24 def __init__(self) -> None:
25 self.messaging_system = "kafka"
27 def get_publish_attrs_from_cmd(
28 self,
29 cmd: "KafkaPublishCommand",
30 ) -> dict[str, Any]:
31 attrs: dict[str, Any] = {
32 SpanAttributes.MESSAGING_SYSTEM: self.messaging_system,
33 SpanAttributes.MESSAGING_DESTINATION_NAME: cmd.destination,
34 SpanAttributes.MESSAGING_MESSAGE_CONVERSATION_ID: cmd.correlation_id,
35 }
37 if cmd.partition is not None: 37 ↛ 38line 37 didn't jump to line 38 because the condition on line 37 was never true
38 attrs[SpanAttributes.MESSAGING_KAFKA_DESTINATION_PARTITION] = cmd.partition
40 if cmd.key is not None: 40 ↛ 41line 40 didn't jump to line 41 because the condition on line 40 was never true
41 attrs[SpanAttributes.MESSAGING_KAFKA_MESSAGE_KEY] = cmd.key
43 return attrs
45 @override
46 def get_publish_destination_name(
47 self,
48 cmd: "PublishCommand",
49 ) -> str:
50 return cmd.destination
53class KafkaTelemetrySettingsProvider(
54 BaseKafkaTelemetrySettingsProvider["ConsumerRecord"],
55):
56 __slots__ = ()
58 def get_consume_attrs_from_message(
59 self,
60 msg: "StreamMessage[ConsumerRecord]",
61 ) -> dict[str, Any]:
62 attrs = {
63 SpanAttributes.MESSAGING_SYSTEM: self.messaging_system,
64 SpanAttributes.MESSAGING_MESSAGE_ID: msg.message_id,
65 SpanAttributes.MESSAGING_MESSAGE_CONVERSATION_ID: msg.correlation_id,
66 SpanAttributes.MESSAGING_MESSAGE_PAYLOAD_SIZE_BYTES: len(msg.body),
67 SpanAttributes.MESSAGING_KAFKA_DESTINATION_PARTITION: msg.raw_message.partition,
68 SpanAttributes.MESSAGING_KAFKA_MESSAGE_OFFSET: msg.raw_message.offset,
69 MESSAGING_DESTINATION_PUBLISH_NAME: msg.raw_message.topic,
70 }
72 if msg.raw_message.key is not None:
73 attrs[SpanAttributes.MESSAGING_KAFKA_MESSAGE_KEY] = msg.raw_message.key
75 return attrs
77 @override
78 def get_consume_destination_name(
79 self,
80 msg: "StreamMessage[ConsumerRecord]",
81 ) -> str:
82 return cast("str", msg.raw_message.topic)
85class BatchKafkaTelemetrySettingsProvider(
86 BaseKafkaTelemetrySettingsProvider[tuple["ConsumerRecord", ...]],
87):
88 __slots__ = ()
90 def get_consume_attrs_from_message(
91 self,
92 msg: "StreamMessage[tuple[ConsumerRecord, ...]]",
93 ) -> dict[str, Any]:
94 raw_message = msg.raw_message[0]
96 return {
97 SpanAttributes.MESSAGING_SYSTEM: self.messaging_system,
98 SpanAttributes.MESSAGING_MESSAGE_ID: msg.message_id,
99 SpanAttributes.MESSAGING_MESSAGE_CONVERSATION_ID: msg.correlation_id,
100 SpanAttributes.MESSAGING_MESSAGE_PAYLOAD_SIZE_BYTES: len(
101 bytearray().join(cast("Sequence[bytes]", msg.body)),
102 ),
103 SpanAttributes.MESSAGING_BATCH_MESSAGE_COUNT: len(msg.raw_message),
104 SpanAttributes.MESSAGING_KAFKA_DESTINATION_PARTITION: raw_message.partition,
105 MESSAGING_DESTINATION_PUBLISH_NAME: raw_message.topic,
106 }
108 @override
109 def get_consume_destination_name(
110 self,
111 msg: "StreamMessage[tuple[ConsumerRecord, ...]]",
112 ) -> str:
113 return cast("str", msg.raw_message[0].topic)
116def telemetry_attributes_provider_factory(
117 msg: Union["ConsumerRecord", Sequence["ConsumerRecord"], None],
118) -> KafkaTelemetrySettingsProvider | BatchKafkaTelemetrySettingsProvider:
119 if isinstance(msg, Sequence):
120 return BatchKafkaTelemetrySettingsProvider()
121 return KafkaTelemetrySettingsProvider()