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.23b0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2b3192cb331eb3581b43842b271b5d07feb5ce9c1ffb17bc68b2852faf9c13fc |
|
MD5 | f8dd49937595ce2cc7af176c916f43ab |
|
BLAKE2b-256 | a618553080ff7880dd38e28c3d2860225c67357b23f270f66b0bf809e7329626 |
Hashes for opentelemetry_instrumentation_django-0.23b0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 932e67abc6c8de8a03ffd6e85bcd5f52862b49c0b0b167aa3ea72356c7ce0864 |
|
MD5 | a18bfcdaf6e3f90d85b2ecb08445199b |
|
BLAKE2b-256 | 0737a71dc31ff58181edcadde69000248e845daccefc0c8f5c28f69ec8eb48bc |