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

File metadata

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

File hashes

Hashes for opentelemetry-instrumentation-asgi-0.22b0.tar.gz
Algorithm Hash digest
SHA256 f6dc46b5daa4f95b9cbe9b1b241cd14fe673ef13d4abcb3493e8706b4e819478
MD5 b14fc129d92d49cfdf6ae9feaa0e93fa
BLAKE2b-256 071cedf34a150a5e6bff20387adece34e436f2f81146a92e30f7ef99c716fe3f

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for opentelemetry_instrumentation_asgi-0.22b0-py3-none-any.whl
Algorithm Hash digest
SHA256 17962937d3aee27fa348f8a52d4244465cd2540c2d43e0436293e0ce1327ab9c
MD5 1ba23d0702f1be176a08c47fb6689746
BLAKE2b-256 3db235732f8d4a17112b9d50685c71a891693996e1890a2cd00014dfd930257c

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