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.25b2.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | edac5b8f5dc97e1b473ec91137fd1e10b9ac23d09844ec3c2932dc993304bc61 |
|
MD5 | 93e9544891e946c439ee26c093e6e342 |
|
BLAKE2b-256 | b742201d4662c3469fc3e6258500094e97cbd76ae507d867224d1c7baa4b9fc5 |
Hashes for opentelemetry_instrumentation_django-0.25b2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 46929034d5643bf8ab37e58e125ef39f3ac3c0f695626f5902c445ddb42e383c |
|
MD5 | 3c71555b5dc4fb3ea800c2fbffb2dd4f |
|
BLAKE2b-256 | 3ee7be0aa07073e5a3e31d3c761ac46c9e3e643316158288e89182ca871edb1e |