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.21b0.tar.gz.

File metadata

  • Download URL: opentelemetry-instrumentation-asgi-0.21b0.tar.gz
  • Upload date:
  • Size: 5.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.0.1 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.60.0 CPython/3.7.10

File hashes

Hashes for opentelemetry-instrumentation-asgi-0.21b0.tar.gz
Algorithm Hash digest
SHA256 fe3ba6b0891fdb575f4afc8dcc7c93cca2154fc64c64f89c9240aa84cd577fdd
MD5 ec64caf9eb46ff7c2ce0aa26fd0bff27
BLAKE2b-256 038468e300052d3e176d37b51d6ff8c8627d96a98c6d8845b176a55250057ed5

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for opentelemetry_instrumentation_asgi-0.21b0-py3-none-any.whl
Algorithm Hash digest
SHA256 d4a154d58a89a07024c4a5a62b69969a1844f8007bf336534d351c42fc0d08cb
MD5 7c1710d2f03e414f24e8ddb70eb18ae0
BLAKE2b-256 27641260310766a8d4d0def690d2e03d3c9a27ed049cd9abd66bd8bdeb674538

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