Skip to main content
Pre-release

This release is a pre-release and may not be stable for production use.

OpenTelemetry Starlette Instrumentation

pypi

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

Metadata

Release files for opentelemetry-instrumentation-starlette 0.22b0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for opentelemetry-instrumentation-starlette 0.22b0
File Size Uploaded Provenance Actions
opentelemetry-instrumentation-starlette-0.22b0.tar.gz 4.4 kB Without provenance Details for opentelemetry-instrumentation-starlette-0.22b0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for opentelemetry-instrumentation-starlette 0.22b0
File Interpreter ABI Platform Actions
opentelemetry_instrumentation_starlette-0.22b0-py3-none-any.whl Python 3 none any Details for opentelemetry_instrumentation_starlette-0.22b0-py3-none-any.whl

Total release size: 9.7 kB

Release files / opentelemetry-instrumentation-starlette-0.22b0.tar.gz

Download URL opentelemetry-instrumentation-starlette-0.22b0.tar.gz
Size 4.4 kB
Tags Source
SHA-256 checksum
How to use checksums
97fa4786295862bc415079d17bbe432878a3839f6d1581b10b74aa1bad00cc15
BLAKE2b-256 checksum
How to use checksums
ab1d9b36dad0725a6bd785f7bbd343005e0455709da2f30665fbbdd164ed760f
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.4.1 importlib_metadata/4.4.0 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.61.0 CPython/3.7.10

Release files / opentelemetry_instrumentation_starlette-0.22b0-py3-none-any.whl

Download URL opentelemetry_instrumentation_starlette-0.22b0-py3-none-any.whl
Size 5.4 kB
Tags Python 3
SHA-256 checksum
How to use checksums
56ce85c673de0b84996169c02376373d6f166d0279c1cbdbe924d667eb397d3b
BLAKE2b-256 checksum
How to use checksums
f63f7d70ba928e3daa0ed98949cb4c1c69dfcaa67ff07588f9b58842b77e8018
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.4.1 importlib_metadata/4.4.0 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.61.0 CPython/3.7.10

Security for opentelemetry-instrumentation-starlette 0.22b0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release
Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page