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.17b0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | e4bb5f020d856e18ac41559e272a6d29077f437da795e59133da09134b16323c |
|
MD5 | 9422cc9150882949b7f7e6615c2ffe4c |
|
BLAKE2b-256 | fb395f5c83c7f8f1754bd16cc359da8e363e477065596a5b8d4395c164aee552 |
Close
Hashes for opentelemetry_instrumentation_starlette-0.17b0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8a1d4f4b747775e51fc2efc2f9873c6ede921ffeb2d7a86e6080e7df7cabfb4b |
|
MD5 | 53bcc36cbcc62120ed1bb4aad914cbc7 |
|
BLAKE2b-256 | 90f8d9c2bbf80ab33b6008195a860acea96a3847f6c37abef275920385814984 |