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 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

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.23b0.tar.gz.

File metadata

  • Download URL: opentelemetry-instrumentation-falcon-0.23b0.tar.gz
  • Upload date:
  • Size: 11.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.6.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.61.2 CPython/3.7.11

File hashes

Hashes for opentelemetry-instrumentation-falcon-0.23b0.tar.gz
Algorithm Hash digest
SHA256 4dafdb4184a752e8d49e4785b95e8325f0754bb4470c381382128dae5de3e1c6
MD5 b3e5995606775202728954eda71f0017
BLAKE2b-256 9fc70ff53bde05249ac1310e2514ee96c57405a937047470b735307dc01b0742

See more details on using hashes here.

File details

Details for the file opentelemetry_instrumentation_falcon-0.23b0-py3-none-any.whl.

File metadata

File hashes

Hashes for opentelemetry_instrumentation_falcon-0.23b0-py3-none-any.whl
Algorithm Hash digest
SHA256 207d1c4481fb9e42ab14c0ddd5265bb35a131dd51d9c18100e6da1dbc85325b4
MD5 b8afb7062647948f13d056aad26b94b8
BLAKE2b-256 9ebe3ab29135149a4cfcfeb16f779209f36438109b26e6879b35f62e55b50482

See more details on using hashes here.

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