opentelemetry-python-contrib/instrumentation/opentelemetry-instrumentati...
Simon THOBY 7de89b2005 ext/django: accept middlewares declared as tuples (#950) 2020-08-05 11:29:02 -07:00
..
src/opentelemetry/instrumentation/django ext/django: accept middlewares declared as tuples (#950) 2020-08-05 11:29:02 -07:00
tests Rename web framework packages from "ext" to "instrumentation" (#961) 2020-08-03 10:10:45 -07:00
CHANGELOG.md Rename web framework packages from "ext" to "instrumentation" (#961) 2020-08-03 10:10:45 -07:00
LICENSE Rename web framework packages from "ext" to "instrumentation" (#961) 2020-08-03 10:10:45 -07:00
MANIFEST.in Rename web framework packages from "ext" to "instrumentation" (#961) 2020-08-03 10:10:45 -07:00
README.rst Rename web framework packages from "ext" to "instrumentation" (#961) 2020-08-03 10:10:45 -07:00
setup.cfg Rename web framework packages from "ext" to "instrumentation" (#961) 2020-08-03 10:10:45 -07:00
setup.py Rename web framework packages from "ext" to "instrumentation" (#961) 2020-08-03 10:10:45 -07:00

README.rst

OpenTelemetry Django Tracing
============================

|pypi|

.. |pypi| image:: https://badge.fury.io/py/opentelemetry-instrumentation-django.svg
   :target: https://pypi.org/project/opentelemetry-instrumentation-django/

This library allows tracing requests for Django applications.

Installation
------------

::

    pip install opentelemetry-instrumentation-django

Configuration
-------------

Exclude lists
*************
To exclude certain URLs from being tracked, set the environment variable ``OTEL_PYTHON_DJANGO_EXCLUDED_URLS`` with comma delimited regexes representing which URLs to exclude.

For example,

::

    export OTEL_PYTHON_DJANGO_EXCLUDED_URLS="client/.*/info,healthcheck"

will exclude requests such as ``https://site/client/123/info`` and ``https://site/xyz/healthcheck``.

References
----------

* `Django <https://www.djangoproject.com/>`_
* `OpenTelemetry Instrumentation for Django <https://opentelemetry-python.readthedocs.io/en/latest/instrumentation/django/django.html>`_
* `OpenTelemetry Project <https://opentelemetry.io/>`_