Metadata-Version: 2.1
Name: opentelemetry-instrumentation-starlette
Version: 0.19b0
Summary: OpenTelemetry Starlette Instrumentation
Home-page: https://github.com/open-telemetry/opentelemetry-python-contrib/tree/main/instrumentation/opentelemetry-instrumentation-starlette
Author: OpenTelemetry Authors
Author-email: cncf-opentelemetry-contributors@lists.cncf.io
License: Apache-2.0
Description: OpenTelemetry Starlette Instrumentation
        =======================================
        
        |pypi|
        
        .. |pypi| image:: https://badge.fury.io/py/opentelemetry-instrumentation-starlette.svg
           :target: https://pypi.org/project/opentelemetry-instrumentation-starlette/
        
        
        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
        -----
        
        .. code-block:: python
        
            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
        ----------
        
        * `OpenTelemetry Project <https://opentelemetry.io/>`_
        
Platform: any
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Requires-Python: >=3.6
Description-Content-Type: text/x-rst
Provides-Extra: test
