opentelemetry-instrumentation-falcon 0.41b0
pip install opentelemetry-instrumentation-falcon==0.41b0
Released:
Falcon instrumentation for OpenTelemetry
Navigation
Unverified details
These details have not been verified by PyPIProject links
Meta
- License: Apache Software License
- Author: OpenTelemetry Authors
- Requires: Python >=3.7
Classifiers
- Development Status
- Intended Audience
- License
- Programming Language
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
Unverified details
These details have not been verified by PyPIProject links
Meta
- License: Apache Software License
- Author: OpenTelemetry Authors
- Requires: Python >=3.7
Classifiers
- Development Status
- Intended Audience
- License
- Programming Language
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
Uploaded
Python 3
File details
Details for the file opentelemetry_instrumentation_falcon-0.41b0.tar.gz
.
File metadata
- Download URL: opentelemetry_instrumentation_falcon-0.41b0.tar.gz
- Upload date:
- Size: 15.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.7.17
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | f1e480774f4882e325fda142c40f205b4ae792aad4c2f272d41d41ebfbdb7c1c |
|
MD5 | 643002aa55b3f0a38dbfaee7251afe77 |
|
BLAKE2b-256 | 8dbe758be16b0639f513bdf2e1f18a1c6db78ddd0dd6afed47dfaca39dc42389 |
File details
Details for the file opentelemetry_instrumentation_falcon-0.41b0-py3-none-any.whl
.
File metadata
- Download URL: opentelemetry_instrumentation_falcon-0.41b0-py3-none-any.whl
- Upload date:
- Size: 13.8 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.7.17
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | f5b800fe7ce71b933316c923db942429d22d2c7a508a22196c4dda96d39c8356 |
|
MD5 | 65bc9bdbad182177f534d5fd29283fe8 |
|
BLAKE2b-256 | b8a810ecc46af37533cf1b8bc434c9c4626312dc7651f3904cad6219b7c0e5f0 |