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.20b0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 69d8630527df055b0a444dd41926dfb42fbd84ce246ef4660edee2a09d3cb235 |
|
MD5 | 11210f86d2bc55fe8ce9f188cdee7caa |
|
BLAKE2b-256 | b2079589300395bc242b2aeb5141f8b6ee4e603aed60347884cc0c2c35765337 |
Close
Hashes for opentelemetry_instrumentation_starlette-0.20b0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0502fe6db4f239827eb2945a106a7f06be8761a8cbca91046cc439f7dcd83787 |
|
MD5 | 04d0474b72f2a278d0e3578d244bdc11 |
|
BLAKE2b-256 | e9d64e3d09a7b88bfc71652e62cb2a93be8e205e41e511e0afd86519e79eae4b |