Document how to use Django with ASGI

[owais]

ASGI support for Django was added in the PR #391 but we never documented the usage.

Users may have to install opentelemetry-instrumentation-django[asgi] in order to take advantage of asgi support. This should be documented at https://opentelemetry-python-contrib.readthedocs.io/en/latest/instrumentation/django/django.html

[rahuldimri]

@owais can I work on this ? Please assign this to me.

[rahuldimri]

Thanks for assigning this to me. I am new to OpenSource community. If you can help me initially that would be great.
Just wanted to know do you have any template for updating the document ?.

[lzchen]

You can make your doc addition to the docstrings of the django instrumentation. Your docs will be reflected in readthedocs if you do this. Follow the structuring and wording of the other types of configuration, I would name the header something like Asgi Configuration or something.

[Abhishek-569]

I want to work on this issue. Is there any example or use cases on what exactly ASGI support for Django help the users with in opentelemetry ?

[srikanthccv]

Your question is unclear; how are "use cases" relevant to this issue?

[Abhishek-569]

Sorry if my question was not clear before. I am asking like this below for example on this page for Django instrumentation we have to give one example or use case for the proper documentation of using Django with asgi. Please tell me if something is wrong with my proposal as this is my first issue on this project.

[srikanthccv]

EXCLUDE_URLS has examples since it's a configuration option. This issue is about documenting that Django instrumentation supports ASGI.

[Abhishek-569]

Okay. we should add this issue in this page, right?

[srikanthccv]

Yes, you need to update the docstrings, but this issue is already assigned. @rahuldimri please unassign yourself if you are not working on this.

[Abhishek-569]

Okay can tell me where I can learn more onHow to use Django with asgihelps in open-telemetry?

[baravkareknath]

Hi Abhishek-569 can you assign this documentation work to me if you are not working on the same.