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

File metadata

  • Download URL: opentelemetry-instrumentation-asgi-0.15b0.tar.gz
  • Upload date:
  • Size: 4.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.6.1 requests/2.24.0 setuptools/50.3.2 requests-toolbelt/0.9.1 tqdm/4.51.0 CPython/3.7.9

File hashes

Hashes for opentelemetry-instrumentation-asgi-0.15b0.tar.gz
Algorithm Hash digest
SHA256 c22939fb1ff4af9933f3fb3b3e2842a831c37918d06962fad57a7869eecfa39f
MD5 02903ec37eb09a0c1c2181410606458d
BLAKE2b-256 019562232105258b301eb6c3e9851e89b6b14bbe91e58efe9791abc00ecf020a

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for opentelemetry_instrumentation_asgi-0.15b0-py3-none-any.whl
Algorithm Hash digest
SHA256 38358df1ac12d3fdc307bc97058cb68ae3d9b411d49a7121d6d578a8f168afa2
MD5 ebd7ea3101e8171e7fc5e53c75d48d36
BLAKE2b-256 5f6a92541548cd5f24038f95e2e1c48eca35bcd0fa9ce0c3c9d3fe2f98ab6d24

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