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.26b1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 76e77e151ddb455f040f3ef21735935f48cdf45a34af7e95c5c3278754e95a5f |
|
MD5 | cb91d7c37fd4c9fa223ed4cfe5d31180 |
|
BLAKE2b-256 | d65769328496850a606a618fae940ad3f0975c1d09dea68e494b4a1c5d2fc0b5 |
Hashes for opentelemetry_instrumentation_falcon-0.26b1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3c03f591df0ec690508b4a7c3e19723943270180481f056dc773a21f0e97f68c |
|
MD5 | f78698def910cb10d09ea781f745999e |
|
BLAKE2b-256 | 09015c8c8a0bdbcbc031abbac2b6163fc313c9cfc8dcc5e09c502b358a8f02af |