Manually install the Python agent - Application Real-Time Monitoring Service

Este tema describe cómo instalar manualmente el agente de Python. Una vez instalado, ARMS monitorea su aplicación y le permite consultar su topología, trazas, análisis de SQL y otros datos de monitoreo.

Nota

Para aplicaciones desplegadas en un entorno de Kubernetes, no se recomienda la instalación manual del agente. En su lugar, integre ARMS mediante la instalación de un componente. Para obtener instrucciones, consulte Install the Python agent on Container Service for Kubernetes (ACK) and Container Compute Service (ACS) by using the ack-onepilot component.
Si encuentra algún problema al usar el agente de Python, consulte Python agent FAQ. Si la documentación no resuelve sus dudas, contáctenos en el grupo de soporte de DingTalk (ID de grupo: 159215000379).
El componente aliyun-bootstrap instala la versión más reciente del agente de forma predeterminada, lo que proporciona acceso a las funciones más nuevas. Para instalar una versión específica, consulte la sección Cómo instalar un agente para una región y versión específicas en Python agent FAQ.

Requisitos previos

Asegúrese de que su entorno de compilación esté conectado a Internet o a la red interna de Alibaba Cloud. El security group del entorno debe permitir el tráfico TCP saliente por los puertos 80 y 443.
Compruebe sus versiones de Python y del framework. Para conocer los requisitos, consulte Supported Python components and frameworks for ARMS Application Monitoring.

Compatibilidad con frameworks de Python

Revise estos requisitos específicos del framework antes de continuar.

uvicorn

Si su aplicación se inicia con uvicorn, elija uno de los siguientes métodos:

Método A: Importar el agente en el código. Agregue esta sentencia de importación en la primera línea de su archivo de entrada de uvicorn:

from aliyun.opentelemetry.instrumentation.auto_instrumentation import sitecustomize

**Método B: Cambiar a gunicorn con el prefijo aliyun-instrument.** Reemplace su comando de uvicorn:

# 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

Nota

El prefijo aliyun-instrument gestiona la inicialización y la instrumentación no intrusiva del agente de Python de ARMS.

uWSGI

Si su aplicación se inicia con uWSGI, consulte Install the Python agent for a Django or Flask project that starts with uWSGI.

gevent

Si utiliza corrutinas de gevent, establezca la variable de entorno GEVENT_ENABLE en true.

Por ejemplo, si su código contiene:

from gevent import monkey
monkey.patch_all()

Establezca la siguiente variable de entorno en su despliegue:

GEVENT_ENABLE=true

Paso 1: Descargar el instalador aliyun-bootstrap

Descargue el instalador del agente desde Python Package Index (PyPI).

pip3 install aliyun-bootstrap

Paso 2: Configurar variables de entorno

Agregue manualmente las siguientes variables de entorno para la aplicación de Python:

# Method 1: Add environment variables for all processes in the current shell
export ARMS_APP_NAME=xxx   # The name of your application.
export ARMS_REGION_ID=xxx   # The region ID for your Alibaba Cloud account.
export ARMS_LICENSE_KEY=xxx   # Your license key.

# Method 2: Add environment variables for a single process
ARMS_APP_NAME=xxx ARMS_REGION_ID=xxx ARMS_LICENSE_KEY=xxx aliyun-instrument xxx.py

Puede obtener la clave de licencia mediante una operación de OpenAPI. Para obtener más información, consulte List license keys.

(Opcional) Ejemplo de instalación en Docker

Para entornos de Docker, actualice su Dockerfile basándose en el siguiente ejemplo.

# Add environment variables
ENV ARMS_APP_NAME={YourAppName}
ENV ARMS_REGION_ID={YourRegionId}
ENV ARMS_LICENSE_KEY={YourLicenseKey}
## Original environment

Paso 3: Instalar el agente de Python

Para acelerar la instalación, se recomienda configurar primero el repositorio de imágenes mediante la ejecución del siguiente comando:
```
pip config set global.index-url https://mirrors.aliyun.com/pypi/simple/ && pip config set install.trusted-host mirrors.aliyun.com
```
Instale el agente.
```
aliyun-bootstrap -a install
```
Nota
Para instalar una versión específica del agente de Python, ejecute el siguiente comando:
```
# Replace ${version} with the target version number.
aliyun-bootstrap -a install -v ${version}
```
Para consultar la lista de todas las versiones publicadas del agente de Python, consulte Release notes for the Python agent.

Paso 4: Iniciar la aplicación

Inicio con el agente de Python de ARMS

aliyun-instrument python app.py

Comprobar los resultados

La integración se considera exitosa si, después de aproximadamente un minuto, su aplicación de Python aparece en la página Application Monitoring > Application List de la consola de ARMS y reporta datos.