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

File metadata

  • Download URL: opentelemetry-instrumentation-asgi-0.18b0.tar.gz
  • Upload date:
  • Size: 5.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/53.0.0 requests-toolbelt/0.9.1 tqdm/4.56.2 CPython/3.7.9

File hashes

Hashes for opentelemetry-instrumentation-asgi-0.18b0.tar.gz
Algorithm Hash digest
SHA256 d5b0fef09a56ace1643e535f09ce5e5f69d9ef2721e2f29c20066bc13a1c03ce
MD5 7a8e6adee5f7e54755fa4cded87f9c68
BLAKE2b-256 dc3e39ec9a0d7fc6c788ecd9f8d885462cef3e53eb84f2a5ea066af1ae5228b2

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for opentelemetry_instrumentation_asgi-0.18b0-py3-none-any.whl
Algorithm Hash digest
SHA256 79748a6a4185c7e9879d8af2dbea884e083bebd4ff1625ea7e2849a711c9464e
MD5 11392294128177032a9f5e9e30ba341e
BLAKE2b-256 dca0112a89e111aa2ecd1f3ffefd835afb8a58470d3fa07ac75da5b4ce1de3b8

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