Setup Data Streams Monitoring for Python
Prerequisites
Supported libraries
Technology | Library | Minimal tracer version | Recommended tracer version |
---|
Kafka | confluent-kafka | 1.16.0 | 2.11.0 or later |
RabbitMQ | Kombu | 2.6.0 | 2.6.0 or later |
Amazon SQS | Botocore | 1.20.0 | 2.8.0 or later |
Amazon Kinesis | Botocore | 1.20.0 | 2.8.0 or later |
Amazon SNS | Botocore | 1.20.0 | 2.8.0 or later |
Installation
Python uses auto-instrumentation to inject and extract additional metadata required by Data Streams Monitoring for measuring end-to-end latencies and the relationship between queues and services. To enable Data Streams Monitoring, set the DD_DATA_STREAMS_ENABLED
environment variable to true
on services sending messages to (or consuming messages from) Kafka.
For example:
environment:
- DD_DATA_STREAMS_ENABLED: "true"
Monitoring SQS Pipelines
Data Streams Monitoring uses one message attribute to track a message’s path through an SQS queue. As Amazon SQS has a maximum limit of 10 message attributes allowed per message, all messages streamed through the data pipelines must have 9 or less message attributes set, allowing the remaining attribute for Data Streams Monitoring.
Monitoring Kinesis Pipelines
There are no message attributes in Kinesis to propagate context and track a message’s full path through a Kinesis stream. As a result, Data Streams Monitoring’s end-to-end latency metrics are approximated based on summing latency on segments of a message’s path, from the producing service through a Kinesis Stream, to a consumer service. Throughput metrics are based on segments from the producing service through a Kinesis Stream, to the consumer service. The full topology of data streams can still be visualized through instrumenting services.
Manual instrumentation
Data Streams Monitoring propagates context through message headers. If you are using a message queue technology that is not supported by DSM, a technology without headers (such as Kinesis), or Lambdas, use manual instrumentation to set up DSM.
Further Reading
Additional helpful documentation, links, and articles: