Allow django to be instrumented automatically (#1239)

open-telemetry · Oct 14, 2020 · c782f14 · c782f14
1 parent 6019a91
commit c782f14
Show file tree

Hide file tree

Showing 4 changed files with 10 additions and 21 deletions.
diff --git a/docs/examples/django/README.rst b/docs/examples/django/README.rst
@@ -36,7 +36,6 @@ Execution of the Django app
 
 Set these environment variables first:
 
-#. ``export OTEL_PYTHON_DJANGO_INSTRUMENT=True``
 #. ``export DJANGO_SETTINGS_MODULE=instrumentation_example.settings``
 
 The way to achieve OpenTelemetry instrumentation for your Django app is to use
@@ -100,6 +99,13 @@ output similar to this one:
 The last output shows spans automatically generated by the OpenTelemetry Django
 Instrumentation package.
 
+Disabling Django Instrumentation
+--------------------------------
+
+Django's instrumentation can be disabled by setting the following environment variable.
+
+#. ``export OTEL_PYTHON_DJANGO_INSTRUMENT=False``
+
 References
 ----------
 

diff --git a/instrumentation/opentelemetry-instrumentation-django/CHANGELOG.md b/instrumentation/opentelemetry-instrumentation-django/CHANGELOG.md
@@ -2,6 +2,8 @@
 
 ## Unreleased
 
+- Django instrumentation is now enabled by default but can be disabled by setting `OTEL_PYTHON_DJANGO_INSTRUMENT` to `False` ([#1239](https://github.com/open-telemetry/opentelemetry-python/pull/1239))
+
 ## Version 0.14b0
 
 Released 2020-10-13

diff --git a/...opentelemetry-instrumentation-django/src/opentelemetry/instrumentation/django/__init__.py b/...opentelemetry-instrumentation-django/src/opentelemetry/instrumentation/django/__init__.py
@@ -41,7 +41,7 @@ def _instrument(self, **kwargs):
         # built inside the Configuration class itself with the magic method
         # __bool__
 
-        if not Configuration().DJANGO_INSTRUMENT:
+        if Configuration().DJANGO_INSTRUMENT is False:
             return
 
         # This can not be solved, but is an inherent problem of this approach:

diff --git a/instrumentation/opentelemetry-instrumentation-django/tests/conftest.py b/instrumentation/opentelemetry-instrumentation-django/tests/conftest.py