OpenTelemetry Starlette Instrumentation
Project description
This library provides automatic and manual instrumentation of Starlette web frameworks, instrumenting http requests served by applications utilizing the framework.
auto-instrumentation using the opentelemetry-instrumentation package is also supported.
Installation
pip install opentelemetry-instrumentation-starlette
Configuration
Exclude lists
To exclude certain URLs from being tracked, set the environment variable OTEL_PYTHON_STARLETTE_EXCLUDED_URLS with comma delimited regexes representing which URLs to exclude.
For example,
export OTEL_PYTHON_STARLETTE_EXCLUDED_URLS="client/.*/info,healthcheck"
will exclude requests such as https://site/client/123/info and https://site/xyz/healthcheck.
Usage
from opentelemetry.instrumentation.starlette import StarletteInstrumentor
from starlette import applications
from starlette.responses import PlainTextResponse
from starlette.routing import Route
def home(request):
return PlainTextResponse("hi")
app = applications.Starlette(
routes=[Route("/foobar", home)]
)
StarletteInstrumentor.instrument_app(app)
References
Project details
Release history Release notifications | RSS feed
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
Close
Hashes for opentelemetry-instrumentation-starlette-0.22b0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 97fa4786295862bc415079d17bbe432878a3839f6d1581b10b74aa1bad00cc15 |
|
MD5 | 26aacc1f8ac9b6cc2c29784941fe651b |
|
BLAKE2b-256 | ab1d9b36dad0725a6bd785f7bbd343005e0455709da2f30665fbbdd164ed760f |
Close
Hashes for opentelemetry_instrumentation_starlette-0.22b0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 56ce85c673de0b84996169c02376373d6f166d0279c1cbdbe924d667eb397d3b |
|
MD5 | 946ad7077ed53e9bc8658324e811c0cf |
|
BLAKE2b-256 | f63f7d70ba928e3daa0ed98949cb4c1c69dfcaa67ff07588f9b58842b77e8018 |