Files
opentelemetry-python-contrib/instrumentation
Sri Kaaviya 3fcabc3f41 asyncio: fix environment variables not appearing in docs (#4261)
* asyncio: fix environment variables not in docs

Fix the docstrings in environment_variables.py so they are correctly
picked up by Sphinx autodoc for Read the Docs.

Previously the docstrings were placed above the variable assignments,
which Sphinx cannot parse. Moved them below and added the
required '.. envvar::' directives, consistent with how other
packages (e.g. opentelemetry-instrumentation) document their
environment variables.

Fixes #4256

* Fix typo from 'determines' to 'determine'

* Apply suggestion from @xrmx

* asyncio: move environment_variables docs to __init__ module docstring for sphinx

* asyncio: keep envvar docs in environment_variables.py with module-level docstring

---------

Co-authored-by: Riccardo Magliocchetti <riccardo.magliocchetti@gmail.com>
2026-03-02 08:47:10 +00:00
..

Instrumentation Supported Packages Metrics support Semconv status
opentelemetry-instrumentation-aio-pika aio_pika >= 7.2.0, < 10.0.0 No development
opentelemetry-instrumentation-aiohttp-client aiohttp ~= 3.0 Yes migration
opentelemetry-instrumentation-aiohttp-server aiohttp ~= 3.0 Yes migration
opentelemetry-instrumentation-aiokafka aiokafka >= 0.8, < 1.0 No development
opentelemetry-instrumentation-aiopg aiopg >= 0.13.0, < 2.0.0 No development
opentelemetry-instrumentation-asgi asgiref ~= 3.0 Yes migration
opentelemetry-instrumentation-asyncclick asyncclick ~= 8.0 No development
opentelemetry-instrumentation-asyncio asyncio No development
opentelemetry-instrumentation-asyncpg asyncpg >= 0.12.0 No development
opentelemetry-instrumentation-aws-lambda aws_lambda No development
opentelemetry-instrumentation-boto boto~=2.0 No development
opentelemetry-instrumentation-boto3sqs boto3 ~= 1.0 No development
opentelemetry-instrumentation-botocore botocore ~= 1.0 No development
opentelemetry-instrumentation-cassandra cassandra-driver ~= 3.25,scylla-driver ~= 3.25 No development
opentelemetry-instrumentation-celery celery >= 4.0, < 6.0 No development
opentelemetry-instrumentation-click click >= 8.1.3, < 9.0.0 No development
opentelemetry-instrumentation-confluent-kafka confluent-kafka >= 1.8.2, <= 2.13.0 No development
opentelemetry-instrumentation-dbapi dbapi No development
opentelemetry-instrumentation-django django >= 2.0 Yes development
opentelemetry-instrumentation-elasticsearch elasticsearch >= 6.0 No development
opentelemetry-instrumentation-falcon falcon >= 1.4.1, < 5.0.0 Yes migration
opentelemetry-instrumentation-fastapi fastapi ~= 0.92 Yes migration
opentelemetry-instrumentation-flask flask >= 1.0 Yes migration
opentelemetry-instrumentation-grpc grpcio >= 1.42.0 No development
opentelemetry-instrumentation-httpx httpx >= 0.18.0 Yes migration
opentelemetry-instrumentation-jinja2 jinja2 >= 2.7, < 4.0 No development
opentelemetry-instrumentation-kafka-python kafka-python >= 2.0, < 3.0,kafka-python-ng >= 2.0, < 3.0 No development
opentelemetry-instrumentation-logging logging No development
opentelemetry-instrumentation-mysql mysql-connector-python >= 8.0, < 10.0 No development
opentelemetry-instrumentation-mysqlclient mysqlclient < 3 No development
opentelemetry-instrumentation-pika pika >= 0.12.0 No development
opentelemetry-instrumentation-psycopg psycopg >= 3.1.0 No development
opentelemetry-instrumentation-psycopg2 psycopg2 >= 2.7.3.1,psycopg2-binary >= 2.7.3.1 No development
opentelemetry-instrumentation-pymemcache pymemcache >= 1.3.5, < 5 No development
opentelemetry-instrumentation-pymongo pymongo >= 3.1, < 5.0 No development
opentelemetry-instrumentation-pymssql pymssql >= 2.1.5, < 3 No development
opentelemetry-instrumentation-pymysql PyMySQL < 2 No development
opentelemetry-instrumentation-pyramid pyramid >= 1.7 Yes migration
opentelemetry-instrumentation-redis redis >= 2.6 No development
opentelemetry-instrumentation-remoulade remoulade >= 0.50 No development
opentelemetry-instrumentation-requests requests ~= 2.0 Yes migration
opentelemetry-instrumentation-sqlalchemy sqlalchemy >= 1.0.0, < 2.1.0 Yes development
opentelemetry-instrumentation-sqlite3 sqlite3 No development
opentelemetry-instrumentation-starlette starlette >= 0.13 Yes development
opentelemetry-instrumentation-system-metrics psutil >= 5 No development
opentelemetry-instrumentation-threading threading No development
opentelemetry-instrumentation-tornado tornado >= 5.1.1 Yes migration
opentelemetry-instrumentation-tortoiseorm tortoise-orm >= 0.17.0 No development
opentelemetry-instrumentation-urllib urllib Yes migration
opentelemetry-instrumentation-urllib3 urllib3 >= 1.0.0, < 3.0.0 Yes migration
opentelemetry-instrumentation-wsgi wsgi Yes migration