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

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.33b0
File Size Uploaded Provenance Actions
opentelemetry-instrumentation-flask-0.33b0.tar.gz 15.4 kB Without provenance Details for opentelemetry-instrumentation-flask-0.33b0.tar.gz

Built distribution (wheel)

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

Total release size: 28.7 kB

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

Download URL opentelemetry-instrumentation-flask-0.33b0.tar.gz
Size 15.4 kB
Tags Source
SHA-256 checksum
How to use checksums
cb5674325a14aa5ddc83fa91aaa23a3dcb1b16353a5c948505a57f639f16e3a5
BLAKE2b-256 checksum
How to use checksums
971152ba5186a8a735434083a1dd49ee17e7032efe4889d48e0be650b6b73025
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.1 CPython/3.7.13

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

Download URL opentelemetry_instrumentation_flask-0.33b0-py3-none-any.whl
Size 13.3 kB
Tags Python 3
SHA-256 checksum
How to use checksums
41dc69d8b705d79895e1dd0c974ca9c5f8f9f43cd0b845b133bf972e545bb76e
BLAKE2b-256 checksum
How to use checksums
02da8d6915366a85cb549d332fe656323a3ba303d6a9fe9a952bce71d242c2d3
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.1 CPython/3.7.13

Security for opentelemetry-instrumentation-flask 0.33b0

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