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.23b0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | f3d4ae619f4c4022ce0f339e3562ff2a9633b3cc149d0c525981c7027abb5a2a |
|
MD5 | 0881cef38b9956ff0cd3d0137ffec17e |
|
BLAKE2b-256 | 3122d0b95ca96d69cdc7097fd9c192e0cf098b47fd47c9cd08097b5a7f101471 |
Close
Hashes for opentelemetry_instrumentation_starlette-0.23b0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | ce8fc7cd8ae7600900f4fa58a98cdf00cd4e74aa3eebde34449da063760410e6 |
|
MD5 | 719edfdc348e5c676b1551872931cf4f |
|
BLAKE2b-256 | 71fbd3268c78ee5d065a750140309cc5168502e38cdd79b04a0719c03a2ec5f5 |