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

File metadata

  • Download URL: opentelemetry-instrumentation-falcon-0.16b0.tar.gz
  • Upload date:
  • Size: 10.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.6.1 requests/2.25.0 setuptools/50.3.2 requests-toolbelt/0.9.1 tqdm/4.53.0 CPython/3.7.9

File hashes

Hashes for opentelemetry-instrumentation-falcon-0.16b0.tar.gz
Algorithm Hash digest
SHA256 a565af4c6ff37e42385fe0ffbd2bf3da855d4072925c46b588683e520332dbfc
MD5 3edbdba65138845081a4230414510b01
BLAKE2b-256 df6ce84912bc68e255df12be997bcbfaa5e6e3430a8a72b6b183e6d5480f8680

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for opentelemetry_instrumentation_falcon-0.16b0-py3-none-any.whl
Algorithm Hash digest
SHA256 9c6aba90424afde91cc7f6706ff7ec860a450312560bf3e7e8c1a47cb70a7aba
MD5 eb59240df00133094e8abca1b33c9100
BLAKE2b-256 a29b639c2ea5db676d67660cf3e6c13fe8b78a81da87ad6faa293ae40c9617b1

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