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

File metadata

  • Download URL: opentelemetry-instrumentation-asgi-0.23b0.tar.gz
  • Upload date:
  • Size: 5.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.6.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.61.2 CPython/3.7.11

File hashes

Hashes for opentelemetry-instrumentation-asgi-0.23b0.tar.gz
Algorithm Hash digest
SHA256 8ede3e1333a18d75367a0c478d32164b15aaf1faeadbf763abdc494a7b93b8e8
MD5 6548a7ba11024a207287f25554fbd28b
BLAKE2b-256 20dbdaca4592a047b210b7521cdf528fdc3f20c1f506f6ccafadc242c584886c

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for opentelemetry_instrumentation_asgi-0.23b0-py3-none-any.whl
Algorithm Hash digest
SHA256 1ff44632b240d72b8e3fb5e057c682c3d2ee4d08cc6c63c9ab3061c88a5a0ebd
MD5 841c941d944258684ede815dca240304
BLAKE2b-256 228e284f7e367f2aad85b1c71ac022e35e84d9e04ce9dc06b5007b92f593dcf7

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