OpenTelemetry Django Instrumentation¶
Instrument django to trace Django applications.
from opentelemetry.instrumentation.django import DjangoInstrumentor DjangoInstrumentor().instrument()
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.
will exclude requests such as
To extract certain attributes from Django’s request object and use them as span attributes, set the environment variable
OTEL_PYTHON_DJANGO_TRACED_REQUEST_ATTRS to a comma
delimited list of request attribute names.
will extract path_info and content_type attributes from every traced request and add them as span attritbues.
Django Request object reference: https://docs.djangoproject.com/en/3.1/ref/request-response/#attributes
Request and Response hooks¶
The instrumentation supports specifying request and response hooks. These are functions that get called back by the instrumentation right after a Span is created for a request and right before the span is finished while processing a response. The hooks can be configured as follows:
def request_hook(span, request): pass def response_hook(span, request, response): pass DjangoInstrumentation().instrument(request_hook=request_hook, response_hook=response_hook)
- class opentelemetry.instrumentation.django.DjangoInstrumentor(*args, **kwargs)¶
An instrumentor for Django
Return a list of python packages with versions that the will be instrumented.
The format should be the same as used in requirements.txt or setup.py.
For example, if an instrumentation instruments requests 1.x, this method should look like:
- def instrumentation_dependencies(self) -> Collection[str]:
return [‘requests ~= 1.0’]
This will ensure that the instrumentation will only be used when the specified library is present in the environment.