Metadata-Version: 2.1
Name: opentelemetry-instrumentation-asgi
Version: 0.15b0
Summary: ASGI instrumentation for OpenTelemetry
Home-page: https://github.com/open-telemetry/opentelemetry-python/instrumentation/opentelemetry-instrumentation-asgi
Author: OpenTelemetry Authors
Author-email: cncf-opentelemetry-contributors@lists.cncf.io
License: Apache-2.0
Description: OpenTelemetry ASGI Instrumentation
        ==================================
        
        |pypi|
        
        .. |pypi| image:: https://badge.fury.io/py/opentelemetry-instrumentation-asgi.svg
           :target: https://pypi.org/project/opentelemetry-instrumentation-asgi/
        
        
        This library provides a ASGI middleware that can be used on any ASGI framework
        (such as Django, Starlette, FastAPI or Quart) to track requests timing through OpenTelemetry.
        
        Installation
        ------------
        
        ::
        
            pip install opentelemetry-instrumentation-asgi
        
        
        Usage (Quart)
        -------------
        
        .. code-block:: python
        
            from quart import Quart
            from opentelemetry.instrumentation.asgi import OpenTelemetryMiddleware
        
            app = Quart(__name__)
            app.asgi_app = OpenTelemetryMiddleware(app.asgi_app)
        
            @app.route("/")
            async def hello():
                return "Hello!"
        
            if __name__ == "__main__":
                app.run(debug=True)
        
        
        Usage (Django 3.0)
        ------------------
        
        Modify the application's ``asgi.py`` file as shown below.
        
        .. code-block:: python
        
            import os
            from django.core.asgi import get_asgi_application
            from opentelemetry.instrumentation.asgi import OpenTelemetryMiddleware
        
            os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'asgi_example.settings')
        
            application = get_asgi_application()
            application = OpenTelemetryMiddleware(application)
        
        
        Usage (Raw ASGI)
        ----------------
        
        .. code-block:: python
        
            from opentelemetry.instrumentation.asgi import OpenTelemetryMiddleware
        
            app = ...  # An ASGI application.
            app = OpenTelemetryMiddleware(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.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Requires-Python: >=3.5
Description-Content-Type: text/x-rst
Provides-Extra: test
