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

File metadata

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

File hashes

Hashes for opentelemetry-instrumentation-asgi-0.19b0.tar.gz
Algorithm Hash digest
SHA256 a152e2557c41b17da47d630214f3d15f974f3af68a03acbc2c55d114f9a77b45
MD5 aa711bb683fb4a918bf65ee606ddb481
BLAKE2b-256 a6e5cac06a9a6fcf2493fa9e68beb9d9cbc0dbe26a4f043dc88428f3781aa829

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for opentelemetry_instrumentation_asgi-0.19b0-py3-none-any.whl
Algorithm Hash digest
SHA256 75e20e35e95907462df239d92bec6cc40d610859156907502b0a191d92fc5c58
MD5 41189fe40c9d895b9259cbed7079ee69
BLAKE2b-256 766b6b59c761058a88cc55ecbfbe6471b5a11a14da5206553bc9e91b9684ca59

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