Python Compatibility Requirements

Releases

The Python APM Client library follows a versioning policy that specifies the support level for the different versions of the library and Python runtime.

Two release branches are supported:

ReleaseSupport level
>=1.0,<2Maintenance
>=2.0,<3General Availability

And the library supports the following runtimes:

OSCPURuntimeRuntime versionSupported ddtrace versions
Linuxx86-64, i686, AArch64CPython2.7, 3.5-3.11<2
MacOSIntel, Apple SiliconCPython2.7, 3.5-3.11<2
Windows64bit, 32bitCPython2.7, 3.5-3.11<2
Linuxx86-64, i686, AArch64CPython3.7+>=2
MacOSIntel, Apple SiliconCPython3.7+>=2
Windows64bit, 32bitCPython3.7+>=2

Integrations

To request support for additional libraries, contact our awesome support team.

Web framework compatibility

The ddtrace library includes support for a number of web frameworks, including:

FrameworkSupported VersionAutomaticLibrary Documentation
asgi>= 2.0nohttps://ddtrace.readthedocs.io/en/stable/integrations.html#asgi
aiohttp (client)>= 2.0yeshttps://ddtrace.readthedocs.io/en/stable/integrations.html#aiohttp
aiohttp (server)>= 2.0nohttps://ddtrace.readthedocs.io/en/stable/integrations.html#aiohttp
Bottle>= 0.11nohttps://ddtrace.readthedocs.io/en/stable/integrations.html#bottle
CherryPy>= 11.2.0nohttps://ddtrace.readthedocs.io/en/stable/integrations.html#cherrypy
Django>= 1.8yeshttps://ddtrace.readthedocs.io/en/stable/integrations.html#django
djangorestframework>= 3.4yeshttps://ddtrace.readthedocs.io/en/stable/integrations.html#django
Falcon>= 1.0nohttps://ddtrace.readthedocs.io/en/stable/integrations.html#falcon
Flask>= 0.10yeshttps://ddtrace.readthedocs.io/en/stable/integrations.html#flask
FastAPI>= 0.51yeshttps://ddtrace.readthedocs.io/en/stable/integrations.html#fastapi
Gunicorn>= 20.0.04nohttps://ddtrace.readthedocs.io/en/stable/integrations.html#gunicorn
Molten>= 0.7.0yeshttps://ddtrace.readthedocs.io/en/stable/integrations.html#molten
Pylons>= 0.9.6nohttps://ddtrace.readthedocs.io/en/stable/integrations.html#pylons
Pyramid>= 1.7nohttps://ddtrace.readthedocs.io/en/stable/integrations.html#pyramid
Sanic>= 19.6.0yeshttps://ddtrace.readthedocs.io/en/stable/integrations.html#sanic
Starlette>= 0.13.0yeshttps://ddtrace.readthedocs.io/en/stable/integrations.html#starlette
Tornado>= 4.0nohttps://ddtrace.readthedocs.io/en/stable/integrations.html#tornado

Datastore compatibility

The ddtrace library includes support for the following data stores:

DatastoreSupported VersionAutomaticLibrary Documentation
algoliasearch>= 1.20.0yeshttps://ddtrace.readthedocs.io/en/stable/integrations.html#algoliasearch
asyncpg>= 0.18.0yeshttps://ddtrace.readthedocs.io/en/stable/integrations.html#asyncpg
Cassandra>= 3.5yeshttps://ddtrace.readthedocs.io/en/stable/integrations.html#cassandra
Elasticsearch>= 1.6yeshttps://ddtrace.readthedocs.io/en/stable/integrations.html#elasticsearch
Flask Cache>= 0.12nohttps://ddtrace.readthedocs.io/en/stable/integrations.html#flask-cache
Mariadb>= 1.0.0yeshttps://ddtrace.readthedocs.io/en/stable/integrations.html#mariadb
Memcached pylibmc>= 1.4yeshttps://ddtrace.readthedocs.io/en/stable/integrations.html#pylibmc
Memcached pymemcache>= 1.3yeshttps://ddtrace.readthedocs.io/en/stable/integrations.html#pymemcache
MongoDB Mongoengine>= 0.11yeshttps://ddtrace.readthedocs.io/en/stable/integrations.html#mongoengine
MongoDB Pymongo>= 3.0yeshttps://ddtrace.readthedocs.io/en/stable/integrations.html#pymongo
MySQL MySQL-python>= 1.2.3yeshttps://ddtrace.readthedocs.io/en/stable/integrations.html#module-ddtrace.contrib.mysqldb
MySQL mysqlclient>= 1.3yeshttps://ddtrace.readthedocs.io/en/stable/integrations.html#module-ddtrace.contrib.mysqldb
MySQL mysql-connector>= 2.1yeshttps://ddtrace.readthedocs.io/en/stable/integrations.html#mysql-connector
Opensearch>= 1.0yeshttps://ddtrace.readthedocs.io/en/stable/integrations.html#elasticsearch
Postgres aiopg>= 0.12.0, <= 0.16yeshttps://ddtrace.readthedocs.io/en/stable/integrations.html#aiopg
Postgres psycopg>= 2.4yeshttps://ddtrace.readthedocs.io/en/stable/integrations.html#module-ddtrace.contrib.psycopg
PyMySQL>= 0.7yeshttps://ddtrace.readthedocs.io/en/stable/integrations.html?highlight=pymysql#pymysql
PynamoDB>= 4.0yeshttps://ddtrace.readthedocs.io/en/stable/integrations.html#pynamodb
PyODBC>= 4.0yeshttps://ddtrace.readthedocs.io/en/stable/integrations.html#pyodbc
Redis>= 2.6yeshttps://ddtrace.readthedocs.io/en/stable/integrations.html#redis
Redis redis-py-cluster>= 1.3.5yeshttps://ddtrace.readthedocs.io/en/stable/integrations.html#module-ddtrace.contrib.rediscluster
snowflake-connector-python>= 2.1nohttps://ddtrace.readthedocs.io/en/stable/integrations.html#snowflake
SQLAlchemy>= 1.0nohttps://ddtrace.readthedocs.io/en/stable/integrations.html#sqlalchemy
SQLite3Fully Supportedyeshttps://ddtrace.readthedocs.io/en/stable/integrations.html#sqlite
Vertica>= 0.6yeshttps://ddtrace.readthedocs.io/en/stable/integrations.html#vertica

Library compatibility

The ddtrace library includes support for the following libraries:

LibrarySupported VersionAutomaticLibrary Documentation
aiobotocore>= 0.2.3nohttps://ddtrace.readthedocs.io/en/stable/integrations.html#aiobotocore
asyncioFully Supported> Python 3.7 yeshttps://ddtrace.readthedocs.io/en/stable/integrations.html#asyncio
Botocore>= 1.4.51yeshttps://ddtrace.readthedocs.io/en/stable/integrations.html#botocore
Boto2>= 2.29.0yeshttps://ddtrace.readthedocs.io/en/stable/integrations.html#boto2
Celery>= 4.4.0yeshttps://ddtrace.readthedocs.io/en/stable/integrations.html#celery
Consul>= 0.7yeshttps://ddtrace.readthedocs.io/en/stable/integrations.html#consul
FuturesFully Supportedyeshttps://ddtrace.readthedocs.io/en/stable/integrations.html#futures
gevent>= 20.12yeshttps://ddtrace.readthedocs.io/en/stable/integrations.html#gevent
Grpc>= 1.8.0yeshttps://ddtrace.readthedocs.io/en/stable/integrations.html#grpc
httplibFully Supportednohttps://ddtrace.readthedocs.io/en/stable/integrations.html#httplib
Logbook>= 1.0.0nohttps://ddtrace.readthedocs.io/en/stable/integrations.html#logbook
Loguru>= 0.4.0nohttps://ddtrace.readthedocs.io/en/stable/integrations.html#loguru
Jinja2>= 2.7yeshttps://ddtrace.readthedocs.io/en/stable/integrations.html#jinja2
Kombu>= 4.0nohttps://ddtrace.readthedocs.io/en/stable/integrations.html#kombu
Mako>= 0.1.0yeshttps://ddtrace.readthedocs.io/en/stable/integrations.html#mako
Requests>= 2.08yeshttps://ddtrace.readthedocs.io/en/stable/integrations.html#requests
structlog>= 20.2.0nohttps://ddtrace.readthedocs.io/en/stable/integrations.html#structlog
urllib3>= 1.22nohttps://ddtrace.readthedocs.io/en/stable/integrations.html#urllib3
graphql-core>= 2.0yeshttps://ddtrace.readthedocs.io/en/stable/integrations.html#graphql
pytest>= 3.0nohttps://ddtrace.readthedocs.io/en/stable/integrations.html#pytest

Further Reading

Additional helpful documentation, links, and articles:

Instrument Your ApplicationDOCUMENTATION more more
PREVIEWING: may/unit-testing