New announcements for Serverless, Network, RUM, and more from Dash! New announcements from Dash!

Tracing Python Applications

For Python Django applications, note that tracing is disabled when your application is launched in DEBUG mode. Find more here.

Installation and Getting Started

If you already have a Datadog account you can find step-by-step instructions in our in-app guides for host-based and container-based set ups.

To begin tracing applications written in Python, first install and configure the Datadog Agent, see the additional documentation for tracing Docker applications or Kubernetes applications.

Next, install the Datadog Tracing library, ddtrace, using pip:

pip install ddtrace

Then to instrument your Python application use the included ddtrace-run command. To use it, prefix your Python entry-point command with ddtrace-run.

For example, if your application is started with python then:

$ ddtrace-run python

For more advanced usage, configuration, and fine-grain control, see Datadog’s API documentation.

Change Agent Hostname

Configure your application level tracers to submit traces to a custom Agent hostname:

The Python Tracing Module automatically looks for and initializes with the ENV variables DD_AGENT_HOST and DD_TRACE_AGENT_PORT

import os
from ddtrace import tracer



Python versions 2.7 and 3.4 and onwards are supported.


Web Framework Compatibility

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

FrameworkSupported VersionPyPi Datadog Documentation
aiohttp>= 1.2
Bottle>= 0.11
Django>= 1.8
djangorestframework>= 3.4
Falcon>= 1.0
Flask>= 0.10
Molten>= 0.7.0
Pylons>= 0.9.6
Pyramid>= 1.7
Tornado>= 4.0

Datastore Compatibility

The ddtrace library includes support for the following data stores:

DatastoreSupported VersionPyPi Datadog Documentation
Cassandra>= 3.5
Elasticsearch>= 1.6
Flask Cache>= 0.12
Memcached pylibmc>= 1.4
Memcached pymemcache>= 1.3
MongoDB Mongoengine>= 0.11
MongoDB Pymongo>= 3.0
MySQL MySQL-python>= 1.2.3
MySQL mysqlclient>= 1.3
MySQL mysql-connector>= 2.1
Postgres aiopg>= 0.12.0
Postgres psycopg>= 2.4
Redis>= 2.6
Redis redis-py-cluster>= 1.3.5
SQLAlchemy>= 1.0
SQLite3Fully Supported
Vertica>= 0.6

Library Compatibility

The ddtrace library includes support for the following libraries:

LibrarySupported VersionPyPi Datadog Documentation
asyncioFully Supported
gevent>= 1.0
aiobotocore>= 0.2.3
Boto2>= 2.29.0
Botocore>= 1.4.51
Celery>= 4.0.2
FuturesFully Supported
Grpc>= 1.8.0
httplibFully Supported
Jinja2>= 2.7
Kombu>= 4.0
Mako>= 0.1.0
Requests>= 2.08

Further Reading