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.22b0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9d9b38dec08930944915f5bdb1f2d3484df121c8bb72bf097f30336437627676 |
|
MD5 | 6788ddac059b6de722d4c97897e95044 |
|
BLAKE2b-256 | 5795b31586f0f4e3e1141a23a9fb76cf08075cc8dbfee2c37c763e288883317f |
Hashes for opentelemetry_instrumentation_django-0.22b0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | ac9a07016d986944eb448516fb5479256a1f3fb5d97b076a3c9a99b2db31e02f |
|
MD5 | d1e0498d9184438ad1baa4b470f4da5c |
|
BLAKE2b-256 | f53d79cfa3cce373d42dc3d535a419e932a7ceda1a9bc88930fd23660ffa000c |