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

File metadata

  • Download URL: opentelemetry-instrumentation-asgi-0.13b0.tar.gz
  • Upload date:
  • Size: 4.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/50.3.0 requests-toolbelt/0.9.1 tqdm/4.49.0 CPython/3.7.9

File hashes

Hashes for opentelemetry-instrumentation-asgi-0.13b0.tar.gz
Algorithm Hash digest
SHA256 cc8354ea04cbe8fa68ae6fcd08becfec7b7d9ac20cf828f5c2199af2e69b05c5
MD5 832fafa65082b4bb45381db533d5c781
BLAKE2b-256 a30c322b301c26e60f0b258eefae148e464237849d64eecb6eed91c61d203dfd

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for opentelemetry_instrumentation_asgi-0.13b0-py3-none-any.whl
Algorithm Hash digest
SHA256 109960ed8fb5d10e90c8b212b5c95bc8e17bbce41fd3872b5813d782cd44f49c
MD5 e5b0b64a523029f5b0629c33db8be3d4
BLAKE2b-256 9be2793b8c83c1dd1f2af64647a511abaf52ce3f092294971e2d12e54f2034ae

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