Python components and frameworks supported by ARMS Application Monitoring - Application Real-Time Monitoring Service

This topic lists the Python versions, third-party components, and frameworks supported by the Python agent.

Supported Python versions

Python version requirement: 3.8 ≤ Python ≤ 3.13

Supported Protobuf versions

The Python agent uses Protobuf to encode data during reporting, which might conflict with the Protobuf version used by your application. The Python agent currently supports the following range of Protobuf versions:

"protobuf>=3.20.0, < 6.0"

Supported OpenTelemetry API versions

The Python agent follows the OpenTelemetry API specification. However, different versions of the OpenTelemetry API may vary slightly. The Python agent currently supports the following OpenTelemetry API version range:

"opentelemetry-api <= 1.39.0"

Notes

If your application starts with uvicorn, choose one of the following configuration methods.
- Method 1: Add the following statement to the first line of the uvicorn entry file to import the Python agent.
```
from aliyun.opentelemetry.instrumentation.auto_instrumentation import sitecustomize
```
- Method 2: Replace uvicorn with gunicorn and add the aliyun-instrument prefix to the gunicorn command.
  Example:
```
uvicorn app:app --workers 4 --port=9090 --host 0.0.0.0
```
  Change the command to:
```
aliyun-instrument gunicorn -w 4 -k uvicorn.workers.UvicornWorker -b 0.0.0.0:8000 app:app
```
  Note
  The aliyun-instrument instruction handles the initialization and non-intrusive instrumentation of the ARMS Python agent.
If your application starts with uWSGI, see Install the Python agent for a Django or Flask project that starts with uWSGI.
If you use gevent coroutines, you must set the GEVENT_ENABLE=true environment variable.
For example, if your program contains the following code:
```
from gevent import monkey
monkey.patch_all()
```
You must set the environment variable as follows:
```
GEVENT_ENABLE=true
```

Database frameworks

Supported plugin versions

LLM (large language model) applications

Component	PyPI/GitHub repository URL	Minimum version	Later versions
OpenAI	https://pypi.org/project/openai/	v1.0.0	v2.14.0
Dashscope	https://pypi.org/project/dashscope/	v1.0.0	v1.2.1
Llama-index	https://pypi.org/project/llama-index/	v0.10.5	v0.10.43
Langchain	https://pypi.org/project/langchain/	v0.1.0	v0.3.27
Dify	https://github.com/langgenius/dify/	v0.12.8	v1.11.2
Dify Plugin	https://github.com/langgenius/dify/	No restriction	No restriction
MCP	https://pypi.org/project/mcp/	v1.3.0	v1.12.4
Google ADK	https://pypi.org/project/google-adk/	v1.2.1	v1.21.0
RagFlow	https://github.com/infiniflow/ragflow/	v0.14.0	v0.21.1
AgentScope	https://pypi.org/project/agentscope/	v1.0	v1.0.10
CrewAI	https://pypi.org/project/crewai/	v0.1.0	v1.7.2
LiteLLM	https://pypi.org/project/litellm/	v1.0.0	v1.79.0

LLM (large language model) services

Component	PyPI/GitHub repository URL	Earlier versions	Maximum version
vLLM V0	https://pypi.org/project/vllm/	v0.5.0	v0.8.4
vLLM V1	https://pypi.org/project/vllm/	V0.8.2	V0.10.0
SGLang	https://pypi.org/project/sglang/	v0.4.6	v0.4.9.post6

HTTP/RPC frameworks

Component	PyPI/GitHub repository URL	Minimum version	Maximum version
FastAPI	https://pypi.org/project/fastapi/	v0.58	No restriction
asgiref	https://pypi.org/project/asgiref/	v3.0	No restriction
aiohttp	https://pypi.org/project/aiohttp/	v3.0	No restriction
Django	https://pypi.org/project/Django/	v1.10	No restriction
WSGI	None	No restriction	No restriction
Flask	https://pypi.org/project/Flask/	v1.0	No restriction
Requests	https://pypi.org/project/requests/	v2.0	No restriction
gRPC	https://pypi.org/project/grpcio/	v1.42.0	No restriction
Jinja2	https://pypi.org/project/jinja2/	v2.7	< 4.0
Click	https://pypi.org/project/click/	v8.1.3	< 9.0.0
Tornado	https://pypi.org/project/tornado/	v5.1.1	No restriction
BlackSheep	https://pypi.org/project/blacksheep/	v1.2.0	No restriction

Vector databases

Component	PyPI/GitHub repository URL	Minimum version	Maximum version
milvus	https://pypi.org/project/milvus/	v2.4.1	No restriction

Database frameworks

Component	PyPI/GitHub repository URL	Minimum version	Maximum version
SQLAlchemy	https://pypi.org/project/sqlalchemy/	v1.0.0	< 2.1.0
AsyncPG	https://pypi.org/project/asyncpg/	v0.12.0	No restriction
aiopg	https://pypi.org/project/aiopg/	v0.13.0	< 2.0.0
PyMySQL	https://pypi.org/project/pymysql/	No specific version requirement	< 2
PyMSSQL	https://pypi.org/project/pymssql/	v2.1.5	< 3
psycopg	https://pypi.org/project/psycopg/	v3.1.0	No restriction
psycopg2	https://pypi.org/project/psycopg2/	v2.7.3.1	No restriction
MySQL	https://pypi.org/project/mysql-connector-python/	v8.0	< 10.0
MySQLClient	https://pypi.org/project/mysqlclient/	No specific version requirement	< 3
PyMongo	https://pypi.org/project/pymongo/	v3.1	< 5.0
TortoiseORM	https://pypi.org/project/tortoise-orm/	v0.17.0	No restriction
Pydantic	https://pypi.org/project/pydantic/	v1.10.2	No restriction
DBAPI	No specific dependency	No specific version requirement	No restriction
SQLite3	No specific dependency	No specific version requirement	No restriction

Cache plugins

Component	PyPI/GitHub repository URL	Minimum version	Maximum version
Redis	https://pypi.org/project/redis/	v2.6	No restriction
PyMemcache	https://pypi.org/project/pymemcache/	v1.3.5	< 5
Elasticsearch	https://pypi.org/project/elasticsearch/	v6.0	No restriction
Cassandra	https://pypi.org/project/cassandra-driver/	v3.25	No restriction
Scylla	https://pypi.org/project/scylla-driver/	v3.25	No restriction

Message queue plugins

Component	PyPI/GitHub repository URL	Minimum version	Later versions
Confluent Kafka	https://pypi.org/project/confluent-kafka/	v1.8.2	v2.7.0
Kafka Python	https://pypi.org/project/kafka-python/	No specific version requirement	No restriction
aiokafka	https://pypi.org/project/aiokafka/	No specific version requirement	No restriction
Pika	https://pypi.org/project/pika/	No specific version requirement	No restriction
aio-pika	https://pypi.org/project/aio-pika/	No specific version requirement	No restriction
Celery	https://pypi.org/project/celery/	v4.0	< 6.0
Remoulade	https://pypi.org/project/remoulade/	v0.50	No restriction

Other plugins

Component	PyPI/GitHub repository URL	Earlier versions	Maximum version
Threading	No specific dependency	No specific version requirement	No restriction
Logging	No specific dependency	No specific version requirement	No restriction
Loguru	https://pypi.org/project/loguru/	v0.5.0	v1.0
asyncio	No specific dependency	No specific version requirement	No restriction