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.25b0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 99991d989b11f1115f45325f3a0ac160fc29ee87fb92ed77a4b57ce7c3015228 |
|
MD5 | 710a5569ba9eebcb549772ba3c11b298 |
|
BLAKE2b-256 | ea4ceb64be36d7d281b929e89203f3af8a347415477a142c9803964634c0da95 |
Close
Hashes for opentelemetry_instrumentation_starlette-0.25b0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | ef71d42ea2f5cfe9c73d801c7fd53c470856bc2f8eb653d905c37b05e9e748a6 |
|
MD5 | c4beef52aaf2c5936896ea5da4056b61 |
|
BLAKE2b-256 | 85f7ed5c963d483170ee0e749301fe64d2946802f751628b7d31aaf1fb8f81e8 |