Instalasi manual agen Python - Application Real-Time Monitoring Service

Topik ini menjelaskan cara menginstal agen Python secara manual. Setelah diinstal, ARMS akan memantau aplikasi Anda sehingga Anda dapat melihat topologinya, jejak (traces), analisis SQL, dan data pemantauan lainnya.

Catatan

Untuk aplikasi yang diterapkan di lingkungan Kubernetes, instalasi agen secara manual tidak disarankan. Sebagai gantinya, integrasikan dengan ARMS dengan menginstal sebuah komponen. Untuk instruksinya, lihat Instal agen Python pada Container Service for Kubernetes (ACK) dan Container Compute Service (ACS) menggunakan komponen ack-onepilot.
Jika Anda mengalami masalah saat menggunakan agen Python, lihat FAQ agen Python. Jika dokumentasi tersebut tidak menjawab pertanyaan Anda, hubungi kami melalui grup dukungan DingTalk (ID Grup: 159215000379).
Komponen aliyun-bootstrap secara default menginstal versi agen terbaru, sehingga Anda dapat mengakses fitur-fitur terbaru. Untuk menginstal versi tertentu, lihat bagian Cara menginstal agen untuk wilayah dan versi tertentu dalam FAQ agen Python.

Prasyarat

Pastikan lingkungan build Anda terhubung ke internet publik atau jaringan internal Alibaba Cloud. Security group untuk lingkungan tersebut harus mengizinkan lalu lintas TCP keluar (outbound) pada Port 80 dan 443.
Periksa versi Python dan framework Anda. Untuk persyaratan lengkapnya, lihat Komponen dan framework Python yang didukung untuk Application Monitoring ARMS.

Kompatibilitas framework Python

Tinjau persyaratan khusus framework berikut sebelum melanjutkan.

uvicorn

Jika aplikasi Anda dijalankan dengan uvicorn, pilih salah satu pendekatan berikut:

Pendekatan A: Impor agen dalam kode. Tambahkan pernyataan impor berikut di baris pertama file entri uvicorn Anda:

from aliyun.opentelemetry.instrumentation.auto_instrumentation import sitecustomize

Pendekatan B: Beralih ke gunicorn dengan awalan aliyun-instrument. Ganti perintah uvicorn Anda:

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

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

Catatan

Awalan aliyun-instrument menangani inisialisasi dan instrumentasi non-intrusif dari agen Python ARMS.

uWSGI

Jika aplikasi Anda dijalankan dengan uWSGI, lihat Instal agen Python untuk proyek Django atau Flask yang dijalankan dengan uWSGI.

gevent

Jika Anda menggunakan korutin gevent, atur variabel lingkungan GEVENT_ENABLE ke true.

Sebagai contoh, jika kode Anda berisi:

from gevent import monkey
monkey.patch_all()

Atur variabel lingkungan berikut dalam deployment Anda:

GEVENT_ENABLE=true

Langkah 1: Unduh installer aliyun-bootstrap

Unduh installer agen dari Python Package Index (PyPI).

pip3 install aliyun-bootstrap

Langkah 2: Konfigurasikan variabel lingkungan

Tambahkan secara manual variabel lingkungan berikut untuk aplikasi Python:

# Metode 1: Tambahkan variabel lingkungan untuk semua proses di shell saat ini
export ARMS_APP_NAME=xxx   # Nama aplikasi Anda.
export ARMS_REGION_ID=xxx   # ID wilayah untuk Akun Alibaba Cloud Anda.
export ARMS_LICENSE_KEY=xxx   # Kunci lisensi Anda.

# Metode 2: Tambahkan variabel lingkungan untuk satu proses saja
ARMS_APP_NAME=xxx ARMS_REGION_ID=xxx ARMS_LICENSE_KEY=xxx aliyun-instrument xxx.py

Anda dapat memperoleh kunci lisensi dengan memanggil operasi OpenAPI. Untuk informasi selengkapnya, lihat Daftar kunci lisensi.

(Opsional) Contoh instalasi Docker

Untuk lingkungan Docker, perbarui Dockerfile Anda berdasarkan contoh berikut.

# Tambahkan variabel lingkungan
ENV ARMS_APP_NAME={YourAppName}
ENV ARMS_REGION_ID={YourRegionId}
ENV ARMS_LICENSE_KEY={YourLicenseKey}
## Lingkungan asli

Langkah 3: Instal agen Python

Untuk mempercepat instalasi, kami menyarankan agar Anda terlebih dahulu mengonfigurasi repository image dengan menjalankan perintah berikut:
```
pip config set global.index-url https://mirrors.aliyun.com/pypi/simple/ && pip config set install.trusted-host mirrors.aliyun.com
```
Instal agen.
```
aliyun-bootstrap -a install
```
Catatan
Untuk menginstal versi tertentu dari agen Python, jalankan perintah berikut:
```
# Ganti ${version} dengan nomor versi target.
aliyun-bootstrap -a install -v ${version}
```
Untuk daftar semua versi agen Python yang telah dirilis, lihat Catatan rilis agen Python.

Langkah 4: Jalankan aplikasi

Jalankan dengan agen Python ARMS

aliyun-instrument python app.py

Verifikasi hasil

Integrasi berhasil jika, setelah sekitar satu menit, aplikasi Python Anda muncul di halaman Application Monitoring > Application List di Konsol ARMS dan melaporkan data.