Skip to main content
Pre-release

This release is a pre-release and may not be stable for production use.

OpenTelemetry Flask Tracing

pypi

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.31b0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for opentelemetry-instrumentation-flask 0.31b0
File Size Uploaded Provenance Actions
opentelemetry-instrumentation-flask-0.31b0.tar.gz 14.2 kB Without provenance Details for opentelemetry-instrumentation-flask-0.31b0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for opentelemetry-instrumentation-flask 0.31b0
File Interpreter ABI Platform Actions
opentelemetry_instrumentation_flask-0.31b0-py3-none-any.whl Python 3 none any Details for opentelemetry_instrumentation_flask-0.31b0-py3-none-any.whl

Total release size: 27.0 kB

Release files / opentelemetry-instrumentation-flask-0.31b0.tar.gz

Download URL opentelemetry-instrumentation-flask-0.31b0.tar.gz
Size 14.2 kB
Tags Source
SHA-256 checksum
How to use checksums
e8391f16f13f87623c6001420b41895211a7481741dcf761b4b3211a12ba3d1f
BLAKE2b-256 checksum
How to use checksums
eef9e7e44245a0c128a3da3457bf1baa1d04d3007618bf4346017b22ca15c902
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.0 CPython/3.7.13

Release files / opentelemetry_instrumentation_flask-0.31b0-py3-none-any.whl

Download URL opentelemetry_instrumentation_flask-0.31b0-py3-none-any.whl
Size 12.9 kB
Tags Python 3
SHA-256 checksum
How to use checksums
38ac9a5fba274b64f4e502048aeb940689b65c89cb6f0d641f49860a2a5baa4b
BLAKE2b-256 checksum
How to use checksums
4a615f18834a34ca321c5972d6b9ced1dbfa4d861469f6d610d8c46cc0d3f36d
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.0 CPython/3.7.13

Security for opentelemetry-instrumentation-flask 0.31b0

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.

Release history Release notifications | RSS feed

This release
Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page