OpenTelemetry Instrumentation for Django
Project description
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.
Request attributes
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.
For example,
export OTEL_PYTHON_DJANGO_TRACED_REQUEST_ATTRS='path_info,content_type'
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)
References
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for opentelemetry-instrumentation-django-0.25b0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5b310d92c08ef246f0de7e0882c8fd517965f98fe908b46687582e3e04a5f6bb |
|
MD5 | e06ee1e38b76e8bc8dc2436535b24cd6 |
|
BLAKE2b-256 | 3c30eaef39d6fda17bd3e6ca53c6b7b41b3ece567bfe03d51ccddfb830abf66d |
Hashes for opentelemetry_instrumentation_django-0.25b0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | e4fb7106c0483773555a00288b06cb926e17f219b00aa908be65efae316d7832 |
|
MD5 | 42e71b5113e1be0f846fcd297fde07da |
|
BLAKE2b-256 | 5c406087253bd18adb1b72703cc0976b03fb4fec771d4900e86e00de40166596 |