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.25b1.tar.gz.

File metadata

  • Download URL: opentelemetry-instrumentation-falcon-0.25b1.tar.gz
  • Upload date:
  • Size: 11.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.7.12

File hashes

Hashes for opentelemetry-instrumentation-falcon-0.25b1.tar.gz
Algorithm Hash digest
SHA256 4b0db0d13020c6a88cc636a595a624b575d4178181448d4062327cb1032b8154
MD5 481be62440bbb2177f738a7339ba80e0
BLAKE2b-256 6406799dbfde70d392cdc5b9280515ba02f824a0cb67699d2497bd2206ed769e

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for opentelemetry_instrumentation_falcon-0.25b1-py3-none-any.whl
Algorithm Hash digest
SHA256 4082331907134d3c0ccdfc527b638fce022126b7bba3835077ce1f64c7c97856
MD5 f48b972e164cf1746b74f89b773e81e7
BLAKE2b-256 1744bfabeaddfcf362c8aedeaccc0c40480ff8847a17ea66cba5ca63ff45f432

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