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.19b0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | e6b14f7614fab525b1e5f5cc2e625ddf70b64df1f03def300e7aeacc00cc0575 |
|
MD5 | 79ffa8c18db1a94265fc86f0827c75da |
|
BLAKE2b-256 | 1919ce462b2acadfd61900a28586f6dd312141c0cae472ff5afaba74b749cf16 |
Close
Hashes for opentelemetry_instrumentation_starlette-0.19b0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 62fc96b6b1ccd84569249f870049ee5e5cc67b40e9518fddf096f6c980ee1eb7 |
|
MD5 | 0e225a228933fc0a45c85e7a950e6b38 |
|
BLAKE2b-256 | 1ccaabe44f6d71fc9d19e91b49b2850045ea5c87afc789d8315e3f9b0adb6410 |