Skip to content

Commit

Permalink
[django] minor on docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Emanuele Palazzetti committed Sep 21, 2016
1 parent cae82d4 commit 70c6d25
Showing 1 changed file with 5 additions and 4 deletions.
9 changes: 5 additions & 4 deletions ddtrace/contrib/django/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
installed apps and in your middleware classes in ``settings.py``::
INSTALLED_APPS = [
# ...
# your Django apps...
# the order is not important
'ddtrace.contrib.django',
Expand All @@ -15,7 +15,8 @@
MIDDLEWARE_CLASSES = (
# the tracer must be the first middleware
'ddtrace.contrib.django.TraceMiddleware',
...
# your middleware...
)
The configuration of this integration is all namespaced inside a single
Expand All @@ -36,15 +37,15 @@
The available settings are:
* ``TRACER`` (default ``ddtrace.tracer``): set the default tracer
* ``TRACER`` (default: ``ddtrace.tracer``): set the default tracer
instance that is used to trace Django internals. By default the ``ddtrace``
tracer is used.
* ``DEFAULT_SERVICE`` (default: ``django``): set the service name used by the
tracer. Usually this configuration must be updated with a meaningful name.
* ``ENABLED``: (default: ``not django_settings.DEBUG``): set if the tracer
is enabled or not. When a tracer is disabled, Django internals are not
automatically instrumented and the requests are not traced even if the
``TraceMiddleware`` is properly installed. This settings cannot be changed
``TraceMiddleware`` is properly installed. This setting cannot be changed
at runtime and a restart is required. By default the tracer is disabled
when in ``DEBUG`` mode, enabled otherwise.
"""
Expand Down

0 comments on commit 70c6d25

Please sign in to comment.