Instalar manualmente o agente Python - Application Real-Time Monitoring Service: Central de Documentação do Alibaba Cloud

Este tópico descreve como instalar manualmente o agente Python. Após a instalação, o ARMS monitora sua aplicação, permitindo que você visualize sua topologia, traces, análise de SQL e outros dados de monitoramento.

Nota

Para aplicações implantadas em um ambiente Kubernetes, não recomendamos a instalação manual do agente. Em vez disso, integre com o ARMS instalando um componente. Para obter instruções, consulte Instalar o agente Python no Container Service for Kubernetes (ACK) e no Container Compute Service (ACS) usando o componente ack-onepilot.
Caso encontre problemas ao usar o agente Python, consulte as Perguntas frequentes sobre o agente Python. Se a documentação não responder às suas dúvidas, entre em contato conosco no grupo de suporte do DingTalk (ID do grupo: 159215000379).
O componente aliyun-bootstrap instala a versão mais recente do agente por padrão, garantindo acesso aos recursos mais novos. Para instalar uma versão específica, consulte a seção Como instalar um agente para uma região e versão específicas nas Perguntas frequentes sobre o agente Python.

Pré-requisitos

Certifique-se de que seu ambiente de build esteja conectado à internet pública ou à rede interna da Alibaba Cloud. O grupo de segurança do ambiente deve permitir tráfego TCP de saída nas portas 80 e 443.
Verifique as versões do Python e do framework utilizados. Para consultar os requisitos, veja Componentes e frameworks Python suportados pelo ARMS Application Monitoring.

Compatibilidade de frameworks Python

Analise estes requisitos específicos de cada framework antes de prosseguir.

uvicorn

Se sua aplicação iniciar com uvicorn, escolha uma das seguintes abordagens:

Abordagem A: Importar o agente no código. Adicione esta instrução de importação na primeira linha do arquivo de entrada do uvicorn:

from aliyun.opentelemetry.instrumentation.auto_instrumentation import sitecustomize

**Abordagem B: Alternar para gunicorn com o prefixo aliyun-instrument.** Substitua seu comando 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

O prefixo aliyun-instrument gerencia a inicialização e a instrumentação não intrusiva do agente Python do ARMS.

uWSGI

Caso sua aplicação inicie com uWSGI, consulte Instalar o agente Python para um projeto Django ou Flask que inicia com uWSGI.

gevent

Ao utilizar corrotinas gevent, defina a variável de ambiente GEVENT_ENABLE como true.

Por exemplo, se o seu código contiver:

from gevent import monkey
monkey.patch_all()

Defina a seguinte variável de ambiente em sua implantação:

GEVENT_ENABLE=true

Etapa 1: Baixe o instalador aliyun-bootstrap

Baixe o instalador do agente no Python Package Index (PyPI).

pip3 install aliyun-bootstrap

Etapa 2: Configure variáveis de ambiente

Adicione manualmente as seguintes variáveis de ambiente para a aplicação 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

É possível obter a chave de licença chamando uma operação da OpenAPI. Para mais informações, consulte Listar chaves de licença.

(Opcional) Exemplo de instalação em Docker

Em ambientes Docker, atualize seu Dockerfile com base no exemplo a seguir.

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

Etapa 3: Instale o agente Python

Para acelerar a instalação, recomendamos configurar primeiro o repositório de imagens executando o seguinte comando:

pip config set global.index-url https://mirrors.aliyun.com/pypi/simple/ && pip config set install.trusted-host mirrors.aliyun.com

Instale o agente.
```
aliyun-bootstrap -a install
```
Nota
Para instalar uma versão específica do agente Python, execute o comando abaixo:
```
# Replace ${version} with the target version number.
aliyun-bootstrap -a install -v ${version}
```
Para visualizar a lista de todas as versões lançadas do agente Python, consulte as Notas de versão do agente Python.

Etapa 4: Iniciar a aplicação

Iniciar com o agente Python do ARMS

aliyun-instrument python app.py

Verifique os resultados

A integração será bem-sucedida se, após cerca de um minuto, sua aplicação Python aparecer na página Application Monitoring > Application List no console do ARMS e começar a reportar dados.