Skip to content

Commit e164347

Browse files
author
Emanuele Palazzetti
authored
Merge pull request #306 from palazzem/update-docs
[docs] add the list of auto-instrumented modules
2 parents ecdac8e + 3763563 commit e164347

File tree

1 file changed

+24
-1
lines changed

1 file changed

+24
-1
lines changed

docs/index.rst

Lines changed: 24 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,10 @@ Then let's patch widely used Python libraries::
8383
from ddtrace import patch_all
8484
patch_all()
8585

86-
Start your web server and you should be off to the races.
86+
Start your web server and you should be off to the races. Here you can find
87+
which `framework is automatically instrumented`_ with the ``patch_all()`` method.
88+
89+
.. _framework is automatically instrumented: #instrumented-libraries
8790

8891
Custom
8992
~~~~~~
@@ -423,6 +426,26 @@ These are the fully tested versions but `ddtrace` can be compatible with lower v
423426
If some versions are missing, you can contribute or ask for it by contacting our support.
424427
For deprecated library versions, the support is best-effort.
425428

429+
Instrumented libraries
430+
======================
431+
432+
The following is the list of libraries that are automatically instrumented when the
433+
``patch_all()`` method is called. Always use ``patch()`` and ``patch_all()`` as
434+
soon as possible in your Python entrypoint.
435+
436+
* sqlite3
437+
* mysql
438+
* psycopg
439+
* redis
440+
* cassandra
441+
* pymongo
442+
* mongoengine
443+
* elasticsearch
444+
* pylibmc
445+
* celery
446+
* aiopg
447+
* aiohttp (only third-party modules such as ``aiohttp_jinja2``)
448+
426449
Indices and tables
427450
==================
428451

0 commit comments

Comments
 (0)