From 70c6d2515da6b40ca044f3a483ce62b551b556ff Mon Sep 17 00:00:00 2001 From: Emanuele Palazzetti Date: Wed, 21 Sep 2016 16:16:02 -0400 Subject: [PATCH] [django] minor on docs --- ddtrace/contrib/django/__init__.py | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/ddtrace/contrib/django/__init__.py b/ddtrace/contrib/django/__init__.py index 6b4f488bf9e..7a9a2ab8b52 100644 --- a/ddtrace/contrib/django/__init__.py +++ b/ddtrace/contrib/django/__init__.py @@ -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', @@ -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 @@ -36,7 +37,7 @@ 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 @@ -44,7 +45,7 @@ * ``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. """