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.39b0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 20863915fa2d7bb6d0f5970eaf85574e447df686ecc50dbe9a0989c745424f96 |
|
MD5 | 08fe76864e16574845fec1a1ec5525de |
|
BLAKE2b-256 | fb39f9d068aa2bec37f26e96c7bd64dd87cef8857b9e3f0372fc8cf5c176ec1f |
Hashes for opentelemetry_instrumentation_falcon-0.39b0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 90b61f87b60f66d335c3048c596ae0e144b507c5b963e81bf22ad45a136bdc3d |
|
MD5 | 38cc5e54966c5f645399d8c28ee9b8df |
|
BLAKE2b-256 | 39eed7a7213aa1d02eddf630a5b2b517fdd9203e41a7e906957c4cd2444492e1 |