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.25b1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | b420eb757781fbc749b349dd608aac9e42df6eef22023e9a0ca78a03920d6dbc |
|
MD5 | da0f70f3705ae224b24d0937b0fd83bc |
|
BLAKE2b-256 | e74ad3ae9106fa7c86ce9add35b985e52291632947bc0f4e1e1f1c7ee9239539 |
Hashes for opentelemetry_instrumentation_django-0.25b1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | f3fd5d116e89ca0bb450582ed29d17fca4d02a5ccd4e9d275f7d511e2836e556 |
|
MD5 | c98f86ea1a1e29736e9b8fa1421ceb63 |
|
BLAKE2b-256 | b9a0496b49326a95f90392f291b41ec3998868fcb65f62a2b79fe891c93627c2 |