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.33b0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | b54ffa2f028d55f71e959070ae71f341d97f26f2c7bdf68e9d31b53b6f8cfb04 |
|
MD5 | 23e08c6d54d40aa133354a57c7b3f83e |
|
BLAKE2b-256 | 39c64ac394abcdfa6ab595e3430a8dfa38836f8011ea3bb0317548ab1b2b8cb4 |
Hashes for opentelemetry_instrumentation_falcon-0.33b0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | a4269d1824a4e4d4b896b90ac4348ba75a7c7c68d9f0fe8bad5dc644d9bbbad4 |
|
MD5 | ce27bb413ca036843c3578e390f4f631 |
|
BLAKE2b-256 | 1d998f3869815979dd7253c51d171089992e27d0ef7cf9233c023ebf2d12c6e0 |