Skip to content

docs(django): document ASGI extra#4686

Open
SyedAsadRazaDevops wants to merge 3 commits into
open-telemetry:mainfrom
SyedAsadRazaDevops:syedasadrazadevops/1051-django-asgi-docs
Open

docs(django): document ASGI extra#4686
SyedAsadRazaDevops wants to merge 3 commits into
open-telemetry:mainfrom
SyedAsadRazaDevops:syedasadrazadevops/1051-django-asgi-docs

Conversation

@SyedAsadRazaDevops

@SyedAsadRazaDevops SyedAsadRazaDevops commented Jun 11, 2026

Copy link
Copy Markdown

Description

Documents the optional ASGI extra for Django instrumentation so users running Django through ASGI know to install opentelemetry-instrumentation-django[asgi].

Fixes #1051

Type of change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update

How Has This Been Tested?

  • git diff --check
  • python -m py_compile instrumentation/opentelemetry-instrumentation-django/src/opentelemetry/instrumentation/django/__init__.py

Does This PR Require a Core Repo Change?

  • Yes. - Link to PR:
  • No.

Checklist:

See contributing.md for styleguide, changelog guidelines, and more.

  • Followed the style guidelines of this project
  • Changelogs have been updated: N/A, docs-only change
  • Unit tests have been added: N/A, docs-only change
  • Documentation has been updated

Assisted-by: OpenAI Codex
Comment on lines +28 to +36
Then instrument Django the same way as a WSGI application:

.. code:: python

from opentelemetry.instrumentation.django import DjangoInstrumentor

DjangoInstrumentor().instrument()


Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Then instrument Django the same way as a WSGI application:
.. code:: python
from opentelemetry.instrumentation.django import DjangoInstrumentor
DjangoInstrumentor().instrument()
Then instrument Django the same way as a WSGI application.

I think we can avoid adding the very same example of the previous chapter.

@xrmx xrmx moved this to Easy to review / merge / close in Python PR digest Jun 24, 2026
@xrmx xrmx added the Skip Changelog PRs that do not require a CHANGELOG.md entry label Jul 2, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Skip Changelog PRs that do not require a CHANGELOG.md entry

Projects

Status: Easy to review / merge / close

Development

Successfully merging this pull request may close these issues.

Document how to use Django with ASGI

4 participants