Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 6 additions & 7 deletions ddtrace/contrib/django/__init__.py
Original file line number Diff line number Diff line change
@@ -1,10 +1,9 @@
"""
The Django integration will trace requests, database calls and template
renderers.
The Django integration will trace users requests, template renderers, database and cache
calls.

To enable the Django integration, add the application to your installed
apps and our tracing middleware **as a first middleware** in your ``MIDDLEWARE``
list, as follows::
apps, as follows::

INSTALLED_APPS = [
# your Django apps...
Expand All @@ -21,7 +20,7 @@
'TAGS': {'env': 'production'},
}

If you need to access to integration settings, you should::
If you need to access to Datadog settings, you can::

from ddtrace.contrib.django.conf import settings

Expand All @@ -45,6 +44,8 @@
are sent to the trace agent. This setting cannot be changed at runtime
and a restart is required. By default the tracer is disabled when in ``DEBUG``
mode, enabled otherwise.
* ``AGENT_HOSTNAME`` (default: ``localhost``): define the hostname of the trace agent.
* ``AGENT_PORT`` (default: ``8126``): define the port of the trace agent.
* ``AUTO_INSTRUMENT`` (default: ``True``): if set to false the code will not be
instrumented (even if ``INSTRUMENT_DATABASE``, ``INSTRUMENT_CACHE`` or
``INSTRUMENT_TEMPLATE`` are set to ``True``), while the tracer may be active
Expand All @@ -58,8 +59,6 @@
* ``INSTRUMENT_TEMPLATE`` (default: ``True``): if set to ``False`` template
rendering will not be instrumented. Only configurable when ``AUTO_INSTRUMENT``
is set to ``True``.
* ``AGENT_HOSTNAME`` (default: ``localhost``): define the hostname of the trace agent.
* ``AGENT_PORT`` (default: ``8126``): define the port of the trace agent.
"""
from ..util import require_modules

Expand Down