Skip to content

Latest commit

 

History

History
228 lines (197 loc) · 14 KB

index.rst

File metadata and controls

228 lines (197 loc) · 14 KB

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]
:ref:`aiobotocore` >= 0.2.3 No
:ref:`aiohttp` (client) >= 2.0 Yes
:ref:`aiohttp` (server) >= 2.0 No
:ref:`aiomysql` >= 0.1.0 Yes
:ref:`aiopg` >= 0.12.0, <= 0.16 Yes
:ref:`aioredis` >= 1.3.0 Yes
:ref:`algoliasearch` >= 1.20.0 Yes
:ref:`aredis` >= 1.1.0 Yes
:ref:`asgi` >= 2.0 No
:ref:`asyncio` * Yes [4]
:ref:`asyncpg` >= 0.18.0 Yes
:ref:`boto2` >= 2.29.0 Yes
:ref:`botocore` >= 1.4.51 Yes
:ref:`bottle` >= 0.11 No
:ref:`cassandra` >= 3.5 Yes
:ref:`celery` >= 3.1 Yes
:ref:`cherrypy` >= 11.2.0 No
:ref:`consul` >= 0.7 Yes [2]
:ref:`django` >= 1.8 Yes
:ref:`djangorestframework <djangorestframework>` >= 3.4 No
:ref:`dogpile.cache` >= 0.6 Yes
:ref:`elasticsearch` >= 1.6 Yes
:ref:`falcon` >= 1.0 No
:ref:`fastapi` >= 0.51 Yes
:ref:`flask` >= 0.10 Yes
:ref:`flask_cache` >= 0.12 No
:ref:`gevent` >= 1.1 No
:ref:`grpc` >= 1.12.0 Yes [5]
:ref:`graphene <graphql>` >= 2.0.0 Yes
:ref:`graphql-core <graphql>` >= 2.0.0 Yes
:ref:`gunicorn <gunicorn>` >= 20.0 No
:ref:`httplib` * Yes
:ref:`httpx` >= 0.9.0 Yes
:ref:`jinja2` >= 2.7 Yes
:ref:`kombu` >= 4.0 No
:ref:`mako` >= 0.1.0 Yes
:ref:`mariadb` >= 1.0.0 Yes
:ref:`molten` >= 0.7.0 Yes
:ref:`mongoengine` >= 0.11 Yes
:ref:`mysql-connector` >= 2.1 No
:ref:`mysqlclient <mysqlclient>` >= 1.3 No
:ref:`opensearch-py <elasticsearch>` >= 1.0 Yes
:ref:`psycopg2` >= 2.7 Yes
:ref:`pylibmc` >= 1.4 Yes
:ref:`pylons` >= 0.9.6 No
:ref:`pymemcache` >= 1.3 Yes
:ref:`pymongo` >= 3.0 Yes
:ref:`pymysql` >= 0.7 Yes
:ref:`pynamodb` >= 4.0 Yes
:ref:`pyodbc` >= 4.0 Yes
:ref:`pyramid` >= 1.7 No
:ref:`pytest` >= 4.0.0 Yes
:ref:`redis` >= 2.6 Yes
:ref:`rediscluster` >= 1.3.5 Yes
:ref:`requests` >= 2.08 Yes
:ref:`rq` >= 1.00 Yes
:ref:`sanic` >= 19.6.0 Yes [3]
:ref:`snowflake` >= 2.0.0 No
:ref:`sqlalchemy` >= 1.0 No
:ref:`sqlite` * Yes
:ref:`starlette` >= 0.13.0 Yes
:ref:`tornado` >= 4.0 No
:ref:`urllib3` >= 1.22 No
:ref:`vertica` >= 0.6 Yes
:ref:`wsgi` * No
:ref:`yaaredis` >= 2.0.0 Yes
[1]Libraries that are automatically instrumented when the :ref:`ddtrace-run<ddtracerun>` command is used or the patch_all() method is called. Always use patch() and patch_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 :ref:`asyncio` for more details.
[5]grpc.aio is automatically instrumented starting with grpcio>=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 for more details.

Indices and tables

.. toctree::
    :hidden:

    installation_quickstart
    configuration
    integrations
    basic_usage
    advanced_usage
    benchmarks
    contributing
    troubleshooting
    versioning
    upgrading
    api
    release_notes