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.21b0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 20b25a26526354e80d6692ec2956f44bfa9579a9a68facfaf5f7937cd9d8778b |
|
MD5 | 3959853ab485d90a6efd7e96bc572ea9 |
|
BLAKE2b-256 | 49d897f92a065756f391a0ea81973ea2d014913df429592f288a5f0d6f95528f |
Hashes for opentelemetry_instrumentation_django-0.21b0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | b5b50c9bc68d4b439677ba194a956a19cb55733e88b585bf09e79271fda0d0f0 |
|
MD5 | b94f0958db05a3ee71da7b45b9639ebb |
|
BLAKE2b-256 | fdcc69f3170a133c7ea55273879118263fc2dd308918d83d9a4aa0b8fe9d9966 |