Skip to content

Commit 79c27d9

Browse files
author
Emanuele Palazzetti
committed
[django] update docs: adding the middleware is not required
1 parent 7df27e0 commit 79c27d9

File tree

1 file changed

+6
-7
lines changed

1 file changed

+6
-7
lines changed

ddtrace/contrib/django/__init__.py

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,9 @@
11
"""
2-
The Django integration will trace requests, database calls and template
3-
renderers.
2+
The Django integration will trace users requests, template renderers, database and cache
3+
calls.
44
55
To enable the Django integration, add the application to your installed
6-
apps and our tracing middleware **as a first middleware** in your ``MIDDLEWARE``
7-
list, as follows::
6+
apps, as follows::
87
98
INSTALLED_APPS = [
109
# your Django apps...
@@ -21,7 +20,7 @@
2120
'TAGS': {'env': 'production'},
2221
}
2322
24-
If you need to access to integration settings, you should::
23+
If you need to access to Datadog settings, you can::
2524
2625
from ddtrace.contrib.django.conf import settings
2726
@@ -45,6 +44,8 @@
4544
are sent to the trace agent. This setting cannot be changed at runtime
4645
and a restart is required. By default the tracer is disabled when in ``DEBUG``
4746
mode, enabled otherwise.
47+
* ``AGENT_HOSTNAME`` (default: ``localhost``): define the hostname of the trace agent.
48+
* ``AGENT_PORT`` (default: ``8126``): define the port of the trace agent.
4849
* ``AUTO_INSTRUMENT`` (default: ``True``): if set to false the code will not be
4950
instrumented (even if ``INSTRUMENT_DATABASE``, ``INSTRUMENT_CACHE`` or
5051
``INSTRUMENT_TEMPLATE`` are set to ``True``), while the tracer may be active
@@ -58,8 +59,6 @@
5859
* ``INSTRUMENT_TEMPLATE`` (default: ``True``): if set to ``False`` template
5960
rendering will not be instrumented. Only configurable when ``AUTO_INSTRUMENT``
6061
is set to ``True``.
61-
* ``AGENT_HOSTNAME`` (default: ``localhost``): define the hostname of the trace agent.
62-
* ``AGENT_PORT`` (default: ``8126``): define the port of the trace agent.
6362
"""
6463
from ..util import require_modules
6564

0 commit comments

Comments
 (0)