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.36b0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | dbba84f514197e786804cc563a943325564e0bf52a59a5ca5a7e4756d1ce9f22 |
|
MD5 | 90c892af6b843392853646fb21a9929c |
|
BLAKE2b-256 | 60308382742dce0d586734382f36a80e31c68f9e4fc43b5b3c8d0d0bd9a16644 |
Hashes for opentelemetry_instrumentation_falcon-0.36b0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 77cc32a55736395dd94124400f2cd6486fc4abcf07776993f6ce455ec104e341 |
|
MD5 | eb11dcdd8c9387d6f29b26c46ec0c154 |
|
BLAKE2b-256 | 01ce57eb2ed375a8efad45a7faa3924c2a0fe922a06551052ce668c5f615ca73 |