Skip to main content

ASGI instrumentation for OpenTelemetry

Project description

pypi

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)

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.

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)

from opentelemetry.instrumentation.asgi import OpenTelemetryMiddleware

app = ...  # An ASGI application.
app = OpenTelemetryMiddleware(app)

References

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

Built Distribution

File details

Details for the file opentelemetry-instrumentation-asgi-0.17b0.tar.gz.

File metadata

  • Download URL: opentelemetry-instrumentation-asgi-0.17b0.tar.gz
  • Upload date:
  • Size: 5.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/51.3.3 requests-toolbelt/0.9.1 tqdm/4.56.0 CPython/3.7.9

File hashes

Hashes for opentelemetry-instrumentation-asgi-0.17b0.tar.gz
Algorithm Hash digest
SHA256 406b4e0ae4ba25958749a113cee3b16732f24e3cfac40b77ca72675bdd681a16
MD5 1ecfd533aa22669d5b2bd4d25b1298a8
BLAKE2b-256 10875dbbfd1b257f58cb873ae101079e28ec74d562f5316cfa35822255d2b032

See more details on using hashes here.

File details

Details for the file opentelemetry_instrumentation_asgi-0.17b0-py3-none-any.whl.

File metadata

File hashes

Hashes for opentelemetry_instrumentation_asgi-0.17b0-py3-none-any.whl
Algorithm Hash digest
SHA256 3062723284b19bf189d074f08c70e34595997f14a4325865bad9ed9920a3bd41
MD5 7b94df6ee64285cfe83768e7cc8f09e8
BLAKE2b-256 6ff1dc8663273a14a09a9a3ec027f1be41e50a21c152558d69c45db9e0a4aec3

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page