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

Protobuf

The Python agent uses Protobuf to encode data during reporting. If your application also uses Protobuf, make sure the versions are compatible:

protobuf>=3.20.0, < 7.0

OpenTelemetry API

The Python agent follows the OpenTelemetry API specification. Supported version range:

opentelemetry-api <= 1.39.0

uvicorn

If your application starts with uvicorn, use one of the following methods to initialize the ARMS Python agent.

Method 1: Import the agent in the entry file

Add this import as the first line of your uvicorn entry file:

from aliyun.opentelemetry.instrumentation.auto_instrumentation import sitecustomize

Method 2: Switch to gunicorn with the aliyun-instrument prefix

Replace uvicorn with gunicorn and prepend aliyun-instrument to the startup command.

Before:

uvicorn app:app --workers 4 --port=9090 --host 0.0.0.0

After:

aliyun-instrument gunicorn -w 4 -k uvicorn.workers.UvicornWorker -b 0.0.0.0:8000 app:app

The aliyun-instrument command handles initialization and non-intrusive instrumentation of the ARMS Python agent.

uWSGI

If your application starts with uWSGI, see Install the Python agent for a Django or Flask project that starts with uWSGI.

gevent

If your application uses gevent coroutines, set the GEVENT_ENABLE=true environment variable.

For example, if your code includes:

from gevent import monkey
monkey.patch_all()

Set the environment variable:

GEVENT_ENABLE=true

Large language model (LLM) applications

LLM services

HTTP and RPC frameworks

Vector databases

Memory frameworks

Database frameworks

Caches and search engines

Message queues

Logging and async