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.21b0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | b1493bfb3b83ddd7ac1424eb393029700f32c85dbd7f88f8c29c852184aa0aa4 |
|
MD5 | 3358afa0b16dc8b229b63763e226d510 |
|
BLAKE2b-256 | 9ac58188a45c70d8c84348a224181569e2db5251d837755f8f0ed1f7e6bb7398 |
Close
Hashes for opentelemetry_instrumentation_starlette-0.21b0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | c86eb93bee228171e9f56d9b6d9464171ccbd027902da0e721443dd4754e6f85 |
|
MD5 | d526a713df8337b279773761882a1e5e |
|
BLAKE2b-256 | d116779e30c16ced5860d9341d7fb004b280bc303a902f7b2ebd6b219304bf32 |