Flask instrumentation for OpenTelemetry
Project description
This library builds on the OpenTelemetry WSGI middleware to track web requests in Flask applications.
Installation
pip install opentelemetry-instrumentation-flask
Configuration
Exclude lists
To exclude certain URLs from being tracked, set the environment variable OTEL_PYTHON_FLASK_EXCLUDED_URLS (or OTEL_PYTHON_EXCLUDED_URLS as fallback) with comma delimited regexes representing which URLs to exclude.
For example,
export OTEL_PYTHON_FLASK_EXCLUDED_URLS="client/.*/info,healthcheck"
will exclude requests such as https://site/client/123/info and https://site/xyz/healthcheck.
You can also pass the comma delimited regexes to the instrument_app method directly:
FlaskInstrumentor().instrument_app(app, excluded_urls="client/.*/info,healthcheck")
Request/Response hooks
Utilize request/reponse hooks to execute custom logic to be performed before/after performing a request. Environ is an instance of WSGIEnvironment (flask.request.environ). Response_headers is a list of key-value (tuples) representing the response headers returned from the response.
def request_hook(span: Span, environ: WSGIEnvironment):
if span and span.is_recording():
span.set_attribute("custom_user_attribute_from_request_hook", "some-value")
def response_hook(span: Span, status: str, response_headers: List):
if span and span.is_recording():
span.set_attribute("custom_user_attribute_from_response_hook", "some-value")
FlaskInstrumentation().instrument(request_hook=request_hook, response_hook=response_hook)
Flask Request object reference: https://flask.palletsprojects.com/en/2.0.x/api/#flask.Request
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-flask-0.30b1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | cd821b28c71ef293c68fb324ac48c97ae1f47e4899e68616273de47fe6b8f516 |
|
MD5 | cdad56aadbdbbbb1f98de6c43cc6b5d3 |
|
BLAKE2b-256 | 0b32836f4f95a49c12de256c50bc854a976fdbefb9434d15ea23e6cfc1c94beb |
Hashes for opentelemetry_instrumentation_flask-0.30b1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | ffbe0326f19f04924b14e634952332e007bd281b3a1de63a00ddcb1d95ef092a |
|
MD5 | 4c7f88de831500c5b5e999a136641d6e |
|
BLAKE2b-256 | 8fa012c61367007b58d9054b425af8ac8c68a9c970848c311e9cf43267ceecdc |