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.24b0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0cdb081bba37793d608fac0a1869b643c1817094c0170d85812ef3b66361cacb |
|
MD5 | 8bc2ed7c16d59493b8771975bed3b05e |
|
BLAKE2b-256 | 7a5871fa84b97cc4331e2ca3d08a825ff265733ab5fadd0eb1d5dbdbf6ff76ef |
Close
Hashes for opentelemetry_instrumentation_starlette-0.24b0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 41ff306666461f347fc93cdf31bf6057b07350c49124bec821297673c8c8b6f9 |
|
MD5 | 24769f0ea526b48af9c8525ba4a858ac |
|
BLAKE2b-256 | 9a837a6be64f32c29fd21b77d2720ab5e6cde860b832fb55103c510571532bfa |