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.37b0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | e638834799eee37a440d0fffbd8219f89e62b1c1d0b29c65c652bf02d84d1354 |
|
MD5 | cbc23291343a45708990c6784a42c74c |
|
BLAKE2b-256 | b389b2934a1b1aff5877ffd05ed69b58bf34d3571166108c56b90da2d85528b0 |
Hashes for opentelemetry_instrumentation_falcon-0.37b0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | b3f98d455bdc8b75c4abf44e0d4638977cddf8e92d313c38eb8901d46a596273 |
|
MD5 | f446a63a6022dfb4157dc670206270fd |
|
BLAKE2b-256 | e86f6750cceed9a828bf1ded05dfa9415ee243b787fdd012f6d5110d9e6e9113 |