Falcon instrumentation for OpenTelemetry
Project description
This library builds on the OpenTelemetry WSGI middleware to track web requests in Falcon applications.
Installation
pip install opentelemetry-instrumentation-falcon
Configuration
Exclude lists
To exclude certain URLs from being tracked, set the environment variable OTEL_PYTHON_FALCON_EXCLUDED_URLS (or OTEL_PYTHON_EXCLUDED_URLS as fallback) with comma delimited regexes representing which URLs to exclude.
For example,
export OTEL_PYTHON_FALCON_EXCLUDED_URLS="client/.*/info,healthcheck"
will exclude requests such as https://site/client/123/info and https://site/xyz/healthcheck.
Request attributes
To extract certain attributes from Falcon’s request object and use them as span attributes, set the environment variable OTEL_PYTHON_FALCON_TRACED_REQUEST_ATTRS to a comma delimited list of request attribute names.
For example,
export OTEL_PYTHON_FALCON_TRACED_REQUEST_ATTRS='query_string,uri_template'
will extract path_info and content_type attributes from every traced request and add them as span attritbues.
Falcon Request object reference: https://falcon.readthedocs.io/en/stable/api/request_and_response.html#id1
Request/Response hooks
The instrumentation supports specifying request and response hooks. These are functions that get called back by the instrumentation right after a Span is created for a request and right before the span is finished while processing a response. The hooks can be configured as follows:
def request_hook(span, req): pass def response_hook(span, req, resp): pass FalconInstrumentation().instrument(request_hook=request_hook, response_hook=response_hook)
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_falcon-0.45b0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9f2d8c2557dd1a11e6077d8435e5d169d0396360a22cb679e773a6576c0564ff |
|
MD5 | 3ec268b1adc5e70c849c5b19c7e03b93 |
|
BLAKE2b-256 | 2354b75b9c1e8b8dc2ca3234ed2aab2d5a9d0b6e060f12c93ec17eab0b2973b9 |
Hashes for opentelemetry_instrumentation_falcon-0.45b0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 03bf19a15293710ed39ef0052487c836e56608d2406770c40d270452d3a0bc90 |
|
MD5 | c26b58606f8ba5e51f711c8449192d88 |
|
BLAKE2b-256 | 4006b67e3865620fb42b5d13ae6f971edc8eeaf2fe26a3248b08550668ae498b |