OpenTelemetry Django Instrumentation
Instrument django to trace Django applications.
SQLCOMMENTER
You can optionally configure Django instrumentation to enable sqlcommenter which enriches the query with contextual information.
Usage
from opentelemetry.instrumentation.django import DjangoInstrumentor
DjangoInstrumentor().instrument(is_sql_commentor_enabled=True)
For example,
Invoking Users().objects.all() will lead to sql query "select * from auth_users" but when SQLCommenter is enabled
the query will get appended with some configurable tags like "select * from auth_users /*metrics=value*/;"
SQLCommenter Configurations
We can configure the tags to be appended to the sqlquery log by adding below variables to the settings.py
SQLCOMMENTER_WITH_FRAMEWORK = True(Default) or False
For example, :: Enabling this flag will add django framework and it’s version which is /framework=’django%3A2.2.3/
SQLCOMMENTER_WITH_CONTROLLER = True(Default) or False
For example, :: Enabling this flag will add controller name that handles the request /controller=’index’/
SQLCOMMENTER_WITH_ROUTE = True(Default) or False
For example, :: Enabling this flag will add url path that handles the request /route=’polls/’/
SQLCOMMENTER_WITH_APP_NAME = True(Default) or False
For example, :: Enabling this flag will add app name that handles the request /app_name=’polls’/
SQLCOMMENTER_WITH_OPENTELEMETRY = True(Default) or False
For example, :: Enabling this flag will add opentelemetry traceparent /traceparent=’00-fd720cffceba94bbf75940ff3caaf3cc-4fd1a2bdacf56388-01’/
SQLCOMMENTER_WITH_DB_DRIVER = True(Default) or False
For example, :: Enabling this flag will add name of the db driver /db_driver=’django.db.backends.postgresql’/
Usage
from opentelemetry.instrumentation.django import DjangoInstrumentor
DjangoInstrumentor().instrument()
Configuration
Exclude lists
To exclude certain URLs from tracking, set the environment variable OTEL_PYTHON_DJANGO_EXCLUDED_URLS
(or OTEL_PYTHON_EXCLUDED_URLS
to cover all instrumentations) to a string of comma delimited regexes that match the
URLs.
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 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 the path_info
and content_type
attributes from every traced request and add them as span attributes.
Django Request object reference: https://docs.djangoproject.com/en/3.1/ref/request-response/#attributes
Request and Response hooks
This instrumentation supports request and response hooks. These are functions that get called right after a span is created for a request and right before the span is finished for the response. The hooks can be configured as follows:
def request_hook(span, request):
pass
def response_hook(span, request, response):
pass
DjangoInstrumentor().instrument(request_hook=request_hook, response_hook=response_hook)
Django Request object: https://docs.djangoproject.com/en/3.1/ref/request-response/#httprequest-objects Django Response object: https://docs.djangoproject.com/en/3.1/ref/request-response/#httpresponse-objects
Capture HTTP request and response headers
You can configure the agent to capture specified HTTP headers as span attributes, according to the semantic convention.
Request headers
To capture HTTP request headers as span attributes, set the environment variable
OTEL_INSTRUMENTATION_HTTP_CAPTURE_HEADERS_SERVER_REQUEST
to a comma delimited list of HTTP header names.
For example,
export OTEL_INSTRUMENTATION_HTTP_CAPTURE_HEADERS_SERVER_REQUEST="content-type,custom_request_header"
will extract content-type
and custom_request_header
from the request headers and add them as span attributes.
Request header names in Django are case-insensitive. So, giving the header name as CUStom-Header
in the environment
variable will capture the header named custom-header
.
Regular expressions may also be used to match multiple headers that correspond to the given pattern. For example:
export OTEL_INSTRUMENTATION_HTTP_CAPTURE_HEADERS_SERVER_REQUEST="Accept.*,X-.*"
Would match all request headers that start with Accept
and X-
.
To capture all request headers, set OTEL_INSTRUMENTATION_HTTP_CAPTURE_HEADERS_SERVER_REQUEST
to ".*"
.
export OTEL_INSTRUMENTATION_HTTP_CAPTURE_HEADERS_SERVER_REQUEST=".*"
The name of the added span attribute will follow the format http.request.header.<header_name>
where <header_name>
is the normalized HTTP header name (lowercase, with -
replaced by _
). The value of the attribute will be a
single item list containing all the header values.
For example:
http.request.header.custom_request_header = ["<value1>,<value2>"]
Response headers
To capture HTTP response headers as span attributes, set the environment variable
OTEL_INSTRUMENTATION_HTTP_CAPTURE_HEADERS_SERVER_RESPONSE
to a comma delimited list of HTTP header names.
For example,
export OTEL_INSTRUMENTATION_HTTP_CAPTURE_HEADERS_SERVER_RESPONSE="content-type,custom_response_header"
will extract content-type
and custom_response_header
from the response headers and add them as span attributes.
Response header names in Django are case-insensitive. So, giving the header name as CUStom-Header
in the environment
variable will capture the header named custom-header
.
Regular expressions may also be used to match multiple headers that correspond to the given pattern. For example:
export OTEL_INSTRUMENTATION_HTTP_CAPTURE_HEADERS_SERVER_RESPONSE="Content.*,X-.*"
Would match all response headers that start with Content
and X-
.
To capture all response headers, set OTEL_INSTRUMENTATION_HTTP_CAPTURE_HEADERS_SERVER_RESPONSE
to ".*"
.
export OTEL_INSTRUMENTATION_HTTP_CAPTURE_HEADERS_SERVER_RESPONSE=".*"
The name of the added span attribute will follow the format http.response.header.<header_name>
where <header_name>
is the normalized HTTP header name (lowercase, with -
replaced by _
). The value of the attribute will be a
single item list containing all the header values.
For example:
http.response.header.custom_response_header = ["<value1>,<value2>"]
Sanitizing headers
In order to prevent storing sensitive data such as personally identifiable information (PII), session keys, passwords,
etc, set the environment variable OTEL_INSTRUMENTATION_HTTP_CAPTURE_HEADERS_SANITIZE_FIELDS
to a comma delimited list of HTTP header names to be sanitized. Regexes may be used, and all header names will be
matched in a case-insensitive manner.
For example,
export OTEL_INSTRUMENTATION_HTTP_CAPTURE_HEADERS_SANITIZE_FIELDS=".*session.*,set-cookie"
will replace the value of headers such as session-id
and set-cookie
with [REDACTED]
in the span.
Note
The environment variable names used to capture HTTP headers are still experimental, and thus are subject to change.
API
- class opentelemetry.instrumentation.django.DjangoInstrumentor(*args, **kwargs)[source]
Bases:
BaseInstrumentor
An instrumentor for Django
See BaseInstrumentor
- instrumentation_dependencies()[source]
Return a list of python packages with versions that the will be instrumented.
The format should be the same as used in requirements.txt or pyproject.toml.
For example, if an instrumentation instruments requests 1.x, this method should look like: :rtype:
Collection
[str
]- def instrumentation_dependencies(self) -> Collection[str]:
return [‘requests ~= 1.0’]
This will ensure that the instrumentation will only be used when the specified library is present in the environment.