94 lines
2.5 KiB
Plaintext
94 lines
2.5 KiB
Plaintext
|
Metadata-Version: 2.4
|
||
|
|
Name: opentelemetry-util-http
|
||
|
|
Version: 0.60b1
|
||
|
|
Summary: Web util for OpenTelemetry
|
||
|
|
Project-URL: Homepage, https://github.com/open-telemetry/opentelemetry-python-contrib/tree/main/util/opentelemetry-util-http
|
||
|
|
Project-URL: Repository, https://github.com/open-telemetry/opentelemetry-python-contrib
|
||
|
|
Author-email: OpenTelemetry Authors <cncf-opentelemetry-contributors@lists.cncf.io>
|
||
|
|
License-Expression: Apache-2.0
|
||
|
|
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.9
|
||
|
|
Classifier: Programming Language :: Python :: 3.10
|
||
|
|
Classifier: Programming Language :: Python :: 3.11
|
||
|
|
Classifier: Programming Language :: Python :: 3.12
|
||
|
|
Classifier: Programming Language :: Python :: 3.13
|
||
|
|
Requires-Python: >=3.9
|
||
|
|
Description-Content-Type: text/x-rst
|
||
|
|
|
||
|
|
OpenTelemetry Util HTTP
|
||
|
|
=======================
|
||
|
|
|
||
|
|
|pypi|
|
||
|
|
|
||
|
|
.. |pypi| image:: https://badge.fury.io/py/opentelemetry-util-http.svg
|
||
|
|
:target: https://pypi.org/project/opentelemetry-util-http/
|
||
|
|
|
||
|
|
|
||
|
|
This library provides ASGI, WSGI middleware and other HTTP-related
|
||
|
|
functionality that is common to instrumented web frameworks (such as Django,
|
||
|
|
Starlette, FastAPI, etc.) to track requests timing through OpenTelemetry.
|
||
|
|
|
||
|
|
Installation
|
||
|
|
------------
|
||
|
|
|
||
|
|
::
|
||
|
|
|
||
|
|
pip install opentelemetry-util-http
|
||
|
|
|
||
|
|
|
||
|
|
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/>`_
|