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.18b0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | ace3e5b5dc8a7ddcb366f07ad46c574b14c281e7352c8b0301b49091f337fd2b |
|
MD5 | b505796ecd34a88011c5899c691ac5c6 |
|
BLAKE2b-256 | 14fa19cf7101fc589aecb8ecc3dfb1f392f9423c6b2bded120ece8beac7f8c31 |
Close
Hashes for opentelemetry_instrumentation_starlette-0.18b0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | aa1d10cac1b95bcaaf0eb3cf98dec03f94eba5b0c644ebbbec82e10535d534e8 |
|
MD5 | bffc49811e4e19250ca3b19691bb373d |
|
BLAKE2b-256 | e0c813ff5cf105ad805593c688080754315862b7fc7f775385a1b5367f2946c3 |