Datadog Python APM Client¶
ddtrace
is Datadog’s Python APM client. It is used to profile code and
trace requests as they flow across web servers, databases and microservices.
This enables developers to have greater visibility into bottlenecks and
troublesome requests in their application.
Getting Started¶
For a basic product overview: check out the setup documentation.
For details about developing and contributing: refer to the development guide.
For descriptions of the terminology of Datadog APM: take a look at the official documentation.
Supported Libraries¶
We officially support Python 2.7, 3.5 and above.
The versions listed are the versions that we have tested, but ddtrace
can
still be compatible with other versions of these libraries. If a version of a
library you use is unsupported, feel free to contribute or request it by
contacting support.
Integration |
Supported Version |
Automatically Instrumented 1 |
---|---|---|
>= 0.2.3 |
No |
|
aiohttp (client) |
>= 2.0 |
Yes |
aiohttp (server) |
>= 2.0 |
No |
>= 0.1.0 |
Yes |
|
>= 0.12.0, <= 0.16 |
Yes |
|
>= 1.3.0 |
Yes |
|
>= 1.20.0 |
Yes |
|
>= 1.1.0 |
Yes |
|
>= 2.0 |
No |
|
* |
Yes 4 |
|
>= 0.18.0 |
Yes |
|
>= 2.29.0 |
Yes |
|
>= 1.4.51 |
Yes |
|
>= 0.11 |
No |
|
>= 3.5 |
Yes |
|
>= 3.1 |
Yes |
|
>= 11.2.0 |
No |
|
>= 0.7 |
Yes 2 |
|
>= 1.8 |
Yes |
|
>= 3.4 |
No |
|
>= 0.6 |
Yes |
|
>= 1.6 |
Yes |
|
>= 1.0 |
No |
|
>= 0.51 |
Yes |
|
>= 0.10 |
Yes |
|
>= 0.12 |
No |
|
>= 1.1 |
No |
|
>= 1.12.0 |
Yes 5 |
|
>= 2.0.0 |
Yes |
|
>= 2.0.0 |
Yes |
|
* |
Yes |
|
>= 0.14.0 |
Yes |
|
>= 2.7 |
Yes |
|
>= 4.0 |
No |
|
>= 0.1.0 |
Yes |
|
>= 1.0.0 |
Yes |
|
>= 0.7.0 |
Yes |
|
>= 0.11 |
Yes |
|
>= 2.1 |
No |
|
>= 1.3 |
No |
|
>= 2.7 |
Yes |
|
>= 1.4 |
Yes |
|
>= 0.9.6 |
No |
|
>= 1.3 |
Yes |
|
>= 3.0 |
Yes |
|
>= 0.7 |
Yes |
|
>= 4.0 |
Yes |
|
>= 4.0 |
Yes |
|
>= 1.7 |
No |
|
>= 4.0.0 |
Yes |
|
>= 2.6 |
Yes |
|
>= 1.3.5 |
Yes |
|
>= 2.08 |
Yes |
|
>= 1.00 |
Yes |
|
>= 19.6.0 |
Yes 3 |
|
>= 2.0.0 |
No |
|
>= 1.0 |
No |
|
* |
Yes |
|
>= 0.13.0 |
Yes |
|
>= 4.0 |
No |
|
>= 1.22 |
No |
|
>= 0.6 |
Yes |
|
* |
No |
|
>= 2.0.0 |
Yes |
- 1
Libraries that are automatically instrumented when the ddtrace-run command is used or the
patch_all()
method is called. Always usepatch()
andpatch_all()
as soon as possible in your Python entrypoint.- 2
only the synchronous client
- 3
only in Python 3.7 and above.
- 4
Activating the legacy context provider is required in Python < 3.7. See asyncio for more details.
- 5
grpc.aio
is automatically instrumented starting withgrpcio>=1.32.0
.
Instrumentation Telemetry¶
Datadog may gather environmental and diagnostic information about instrumentation libraries; this includes information about the host running an application, operating system, programming language and runtime, APM integrations used, and application dependencies. Additionally, Datadog may collect information such as diagnostic logs, crash dumps with obfuscated stack traces, and various system performance metrics.
To disable set DD_INSTRUMENTATION_TELEMETRY_ENABLED=false
environment variable.
See our official datadog documentation <https://docs.datadoghq.com/tracing/configure_data_security#telemetry-collection> _ for more details.