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.27b0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | d026377491c534239ccb7330db435deb8394e6a0386b8b89edc603113767cc45 |
|
MD5 | 73fd880e00a279c6ab311d9c8b2e2037 |
|
BLAKE2b-256 | d511f572e90a482da189f1ed98b1043e7960af16600d2d2b707e74b3da65cbb4 |
Hashes for opentelemetry_instrumentation_flask-0.27b0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | c82149cbc6a72606b3af1af6e4131644b5c431b36b88d0e1bca0ceb267bb387c |
|
MD5 | 38fa5b981f5009dbe49bbe885f945cc0 |
|
BLAKE2b-256 | e00837229d4596d7b85893699d1866d2813bba179b477207a16608987e47699f |