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

File metadata

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

File hashes

Hashes for opentelemetry-instrumentation-asgi-0.24b0.tar.gz
Algorithm Hash digest
SHA256 062f82483be392e64f6344758c7641ca4364b7e4d391a902a0a9b22b177bb61c
MD5 04fa60b288f2842cc98c51ca21900088
BLAKE2b-256 ca6a4cb0abd417e0f382a3eb3379d72a804d85b703845e6a3cc09b4fffc928b4

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for opentelemetry_instrumentation_asgi-0.24b0-py3-none-any.whl
Algorithm Hash digest
SHA256 490052903d25f45a98d573966bea734b19ddfc38a5e6fb0585df35fff3bcdf8f
MD5 a007e0d5908d64ceac2d0fcd7719d4f3
BLAKE2b-256 b0a6ca6bbfba7b12eb84057b72e1ae9c6efbbcd5049c10619738fb36a953eb97

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