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.28b0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | a2c35ef33d97f176431d99daafc9bfef793b28c8074d00aee947f4e4b9aca858 |
|
MD5 | 5873956f331f7856c21a7b7d75e2b8c8 |
|
BLAKE2b-256 | 851329d77b017ce79c37c3cea09c3681a19113c7052681eec581ca618b637b86 |
Hashes for opentelemetry_instrumentation_falcon-0.28b0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 846336c86d74d4fdb0d25e69dd9c923f07be427527e8b3646400bfed3801067b |
|
MD5 | f05aff151d1a6c18d141d92f0fc0d953 |
|
BLAKE2b-256 | 428cc8c0faa21f2813fe0e750b319b3a3115c96ad4bc5dd117e9b330a54a624b |