Skip to content

Commit 51150e0

Browse files
docs: kafka message header limitation (#13236)
This is in the DSM docs, but also adding it to the python documentation too. DataDog/documentation#28871 <img width="1004" alt="Screenshot 2025-04-18 at 5 40 52 pm" src="https://github.com/user-attachments/assets/7d8cdb7d-7e33-495a-b6a1-82a7dc1d75ba" /> ## Checklist - [x] PR author has checked that all the criteria below are met - The PR description includes an overview of the change - The PR description articulates the motivation for the change - The change includes tests OR the PR description describes a testing strategy - The PR description notes risks associated with the change, if any - Newly-added code is easy to change - The change follows the [library release note guidelines](https://ddtrace.readthedocs.io/en/stable/releasenotes.html) - The change includes or references documentation updates if necessary - Backport labels are set (if [applicable](https://ddtrace.readthedocs.io/en/latest/contributing.html#backporting)) ## Reviewer Checklist - [x] Reviewer has checked that all the criteria below are met - Title is accurate - All changes are related to the pull request's stated goal - Avoids breaking [API](https://ddtrace.readthedocs.io/en/stable/versioning.html#interfaces) changes - Testing strategy adequately addresses listed risks - Newly-added code is easy to change - Release note makes sense to a user of the library - If necessary, author has acknowledged and discussed the performance implications of this PR as reported in the benchmarks PR comment - Backport labels are set in a manner that is consistent with the [release branch maintenance policy](https://ddtrace.readthedocs.io/en/latest/contributing.html#backporting)
1 parent 6fdbeb5 commit 51150e0

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

ddtrace/contrib/_kafka.py

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,15 @@
2727
2828
Default: ``"kafka"``
2929
30+
.. py:data:: ddtrace.config.kafka["distributed_tracing_enabled"]
31+
32+
Whether to enable distributed tracing between Kafka messages.
33+
34+
This option can also be set with the ``DD_KAFKA_PROPAGATION_ENABLED`` environment
35+
variable.
36+
37+
Default: ``"False"``
38+
3039
3140
To configure the kafka integration using the
3241
``Pin`` API::
@@ -40,4 +49,8 @@
4049
import confluent_kafka
4150
4251
Pin.override(confluent_kafka, service="custom-service-name")
52+
53+
**Note**: `Data Streams Monitoring <https://docs.datadoghq.com/data_streams/>`_ (``DD_DATA_STREAMS_ENABLED=true``) or
54+
distributed tracing (``DD_KAFKA_PROPAGATION_ENABLED=true``) will only work if Kafka message headers are supported.
55+
If `log.message.format.version` is set in the Kafka broker configuration, it must be set to `0.11.0.0` or higher.
4356
"""

0 commit comments

Comments
 (0)