| Name | opentelemetry-util-http JSON |
| Version |
0.45b0
JSON |
| download |
| home_page | None |
| Summary | Web util for OpenTelemetry |
| upload_time | 2024-03-28 19:31:41 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.8 |
| license | None |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
|
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/>`_
Raw data
{
"_id": null,
"home_page": null,
"name": "opentelemetry-util-http",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": null,
"author": null,
"author_email": "OpenTelemetry Authors <cncf-opentelemetry-contributors@lists.cncf.io>",
"download_url": "https://files.pythonhosted.org/packages/03/99/6784a4f7fea0d2ef818a9ccbd8ea43abc163ab6f95a13b1e27edce66dafe/opentelemetry_util_http-0.45b0.tar.gz",
"platform": null,
"description": "OpenTelemetry Util HTTP\n=======================\n\n|pypi|\n\n.. |pypi| image:: https://badge.fury.io/py/opentelemetry-util-http.svg\n :target: https://pypi.org/project/opentelemetry-util-http/\n\n\nThis library provides ASGI, WSGI middleware and other HTTP-related\nfunctionality that is common to instrumented web frameworks (such as Django,\nStarlette, FastAPI, etc.) to track requests timing through OpenTelemetry.\n\nInstallation\n------------\n\n::\n\n pip install opentelemetry-util-http\n\n\nUsage (Quart)\n-------------\n\n.. code-block:: python\n\n from quart import Quart\n from opentelemetry.instrumentation.asgi import OpenTelemetryMiddleware\n\n app = Quart(__name__)\n app.asgi_app = OpenTelemetryMiddleware(app.asgi_app)\n\n @app.route(\"/\")\n async def hello():\n return \"Hello!\"\n\n if __name__ == \"__main__\":\n app.run(debug=True)\n\n\nUsage (Django 3.0)\n------------------\n\nModify the application's ``asgi.py`` file as shown below.\n\n.. code-block:: python\n\n import os\n from django.core.asgi import get_asgi_application\n from opentelemetry.instrumentation.asgi import OpenTelemetryMiddleware\n\n os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'asgi_example.settings')\n\n application = get_asgi_application()\n application = OpenTelemetryMiddleware(application)\n\n\nUsage (Raw ASGI)\n----------------\n\n.. code-block:: python\n\n from opentelemetry.instrumentation.asgi import OpenTelemetryMiddleware\n\n app = ... # An ASGI application.\n app = OpenTelemetryMiddleware(app)\n\n\nReferences\n----------\n\n* `OpenTelemetry Project <https://opentelemetry.io/>`_\n",
"bugtrack_url": null,
"license": null,
"summary": "Web util for OpenTelemetry",
"version": "0.45b0",
"project_urls": {
"Homepage": "https://github.com/open-telemetry/opentelemetry-python-contrib/tree/main/util/opentelemetry-util-http"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "13e4f62b2b098481c093d87095454360ab2dce1bc967c6220096e3d10207045a",
"md5": "e51eacb89271ff90e62353905ddab56c",
"sha256": "6628868b501b3004e1860f976f410eeb3d3499e009719d818000f24ce17b6e33"
},
"downloads": -1,
"filename": "opentelemetry_util_http-0.45b0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "e51eacb89271ff90e62353905ddab56c",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 6921,
"upload_time": "2024-03-28T19:30:25",
"upload_time_iso_8601": "2024-03-28T19:30:25.353638Z",
"url": "https://files.pythonhosted.org/packages/13/e4/f62b2b098481c093d87095454360ab2dce1bc967c6220096e3d10207045a/opentelemetry_util_http-0.45b0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "03996784a4f7fea0d2ef818a9ccbd8ea43abc163ab6f95a13b1e27edce66dafe",
"md5": "f0dc3b50e15f3d761444ad5ade634bb9",
"sha256": "4ce08b6a7d52dd7c96b7705b5b4f06fdb6aa3eac1233b3b0bfef8a0cab9a92cd"
},
"downloads": -1,
"filename": "opentelemetry_util_http-0.45b0.tar.gz",
"has_sig": false,
"md5_digest": "f0dc3b50e15f3d761444ad5ade634bb9",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 7208,
"upload_time": "2024-03-28T19:31:41",
"upload_time_iso_8601": "2024-03-28T19:31:41.487183Z",
"url": "https://files.pythonhosted.org/packages/03/99/6784a4f7fea0d2ef818a9ccbd8ea43abc163ab6f95a13b1e27edce66dafe/opentelemetry_util_http-0.45b0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-28 19:31:41",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "open-telemetry",
"github_project": "opentelemetry-python-contrib",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"tox": true,
"lcname": "opentelemetry-util-http"
}
