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.25b2.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2c635255844ca9be617a7c2119e3a6460e1c2de1573e67e289164880222b6cc6 |
|
MD5 | 115450128f9febfac2649d226e96f7b1 |
|
BLAKE2b-256 | f9e77c1e1cb71c145a98b7a9361bf0d64522ab382ce5ef716bd11476eff27b01 |
Close
Hashes for opentelemetry_instrumentation_starlette-0.25b2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4ee1f923aeea34da5484d01f87d6d84a2167d554d762e437883156ade3799b06 |
|
MD5 | f802193fda02c0289d1edf9a14b90397 |
|
BLAKE2b-256 | 408704d14cfcffa9cd55ba22170788f58dbc82c540f2f6b89d75dfed4dcae2eb |