This release is a pre-release and may not be stable for production use.
OpenTelemetry Flask Tracing
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
Metadata
Release files for opentelemetry-instrumentation-flask 0.28b0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| opentelemetry-instrumentation-flask-0.28b0.tar.gz | 12.7 kB | Without provenance | Details for opentelemetry-instrumentation-flask-0.28b0.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| opentelemetry_instrumentation_flask-0.28b0-py3-none-any.whl | Python 3 | none | any | Details for opentelemetry_instrumentation_flask-0.28b0-py3-none-any.whl |
Total release size: 24.8 kB
Release files / opentelemetry-instrumentation-flask-0.28b0.tar.gz
| Download URL | opentelemetry-instrumentation-flask-0.28b0.tar.gz |
|---|---|
| Size | 12.7 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
0af01894808c921ad8fa36aaa888623212ce74524bf131ada393e69705770429
|
|
BLAKE2b-256 checksum How to use checksums |
935a1f37d22611808d276a2ef8c3677c11946df3b21190941fd360b5d56e08ca
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.7.1 importlib_metadata/4.10.1 pkginfo/1.8.2 requests/2.27.1 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.7.12
|
Release files / opentelemetry_instrumentation_flask-0.28b0-py3-none-any.whl
| Download URL | opentelemetry_instrumentation_flask-0.28b0-py3-none-any.whl |
|---|---|
| Size | 12.1 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
950f37baaa9933b49aa43ea2f9e77fc16f506a676b9d0df83b34c58baa13a6c6
|
|
BLAKE2b-256 checksum How to use checksums |
0c2ede0a48fa6e28f05a1b054872e66bad30c2ae1648dc48e67aaea06da4d7d3
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.7.1 importlib_metadata/4.10.1 pkginfo/1.8.2 requests/2.27.1 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.7.12
|
Security for opentelemetry-instrumentation-flask 0.28b0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.