README.rst

OpenTelemetry CherryPy Tracing

This library builds on the OpenTelemetry WSGI middleware to track web requests in CherryPy applications.

Installation

pip install opentelemetry-instrumentation-cherrypy

Configuration

Exclude lists

To exclude certain URLs from being tracked, set the environment variable OTEL_PYTHON_CHERRYPY_EXCLUDED_URLS (or OTEL_PYTHON_EXCLUDED_URLS as fallback) with comma delimited regexes representing which URLs to exclude.

For example,

export OTEL_PYTHON_CHERRYPY_EXCLUDED_URLS="client/.*/info,healthcheck"

will exclude requests such as https://site/client/123/info and https://site/xyz/healthcheck.

References

• OpenTelemetry CherryPy Instrumentation
• OpenTelemetry Project
• OpenTelemetry Python Examples