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.33b0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | cb5674325a14aa5ddc83fa91aaa23a3dcb1b16353a5c948505a57f639f16e3a5 |
|
MD5 | 4495850b829b32022589226366e3ca42 |
|
BLAKE2b-256 | 971152ba5186a8a735434083a1dd49ee17e7032efe4889d48e0be650b6b73025 |
Hashes for opentelemetry_instrumentation_flask-0.33b0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 41dc69d8b705d79895e1dd0c974ca9c5f8f9f43cd0b845b133bf972e545bb76e |
|
MD5 | e86f55af7ae07a58a540205078521b3d |
|
BLAKE2b-256 | 02da8d6915366a85cb549d332fe656323a3ba303d6a9fe9a952bce71d242c2d3 |