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.30b1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9e241338b293289af1d3e6018f1258d43049ba75bbe951e3e32b8d957c574b99 |
|
MD5 | fd09a95a3c66bfe1fbe038b72bd73457 |
|
BLAKE2b-256 | e16cb4876e6ce36a89fb7991182e8b1c96397e36ba732a40d662d74fe2a32736 |
Hashes for opentelemetry_instrumentation_falcon-0.30b1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 98f6d2178fff995c00a0c480decce45446b6835d7b352195864fd7a51d673f2f |
|
MD5 | dc5516e53cc21edc1a192ab745a11bda |
|
BLAKE2b-256 | d43a1266eb4474b903d5a0f88370d8ba309b98d461bf5f83da935060a5c22284 |