Skip to main content

Falcon instrumentation for OpenTelemetry

Project description

pypi

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


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

File details

Details for the file opentelemetry_instrumentation_falcon-0.49b1.tar.gz.

File metadata

File hashes

Hashes for opentelemetry_instrumentation_falcon-0.49b1.tar.gz
Algorithm Hash digest
SHA256 b41cd978588ae8bd469ae8bd4abcd7169ec806e81ef0f23a80cd417f76c407b3
MD5 d7760d7784ed5738dc770036b4466d80
BLAKE2b-256 1aa91c170cf445382855ebd7ef5daca1f8373db37c3b0f5762c9232a02bb6f51

See more details on using hashes here.

Provenance

File details

Details for the file opentelemetry_instrumentation_falcon-0.49b1-py3-none-any.whl.

File metadata

File hashes

Hashes for opentelemetry_instrumentation_falcon-0.49b1-py3-none-any.whl
Algorithm Hash digest
SHA256 60a4baa0b8603742f52440aea2a7d90f2941eff0f31926f03a6bc49a95b82dc8
MD5 ccdccb7fba47a386853fb575d5b4fd6f
BLAKE2b-256 3b3b9d52c8905123f25ba2a36d01c4033bac2269008ed27d91d80912e73b4d4e

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page