為Python應用安裝探針後,ARMS即可開始監控Python應用,您可以查看應用拓撲、調用鏈路、SQL分析等一系列監控資料。本文介紹如何為Python應用手動安裝探針。
對於部署在Kubernetes環境的應用,不推薦手動安裝探針,建議通過安裝組件的方式接入ARMS。具體操作,請參見Container Service ACK 和容器計算服務 ACS 通過 ack-onepilot 組件安裝 Python 探針。
如果您在使用Python探針過程中有任何問題,可以查閱Python探針使用常見問題文檔,如果文檔無法解決您的疑問,歡迎通過DingTalk答疑群(群號:159215000379)與我們聯絡。
為了讓您可以及時使用到Python探針的最新能力,每次使用aliyun-bootstrap組件時都會預設安裝最新的探針版本,如果需要手動指定探針版本,可以參考Python探針使用常見問題文檔的如何安裝指定地區與版本的探針小節。
前提條件
確保您的編譯環境和公網或阿里雲內網連通,且編譯環境所在安全性群組已開放80、443的TCP出方向許可權。
檢查您的Python版本和架構版本。具體要求,請參見ARMS 應用監控支援的 Python 組件和架構。
注意事項
如果應用使用uvicorn啟動,請選擇以下一種方式進行配置。
方式一:在uvicorn的入口檔案處的第一行添加以下語句以引入Python探針。
from aliyun.opentelemetry.instrumentation.auto_instrumentation import sitecustomize方式二:使用gunicorn替換uvicorn,並在gunicorn命令前添加
aliyun-instrument首碼。例如:
uvicorn app:app --workers 4 --port=9090 --host 0.0.0.0修改為:
aliyun-instrument gunicorn -w 4 -k uvicorn.workers.UvicornWorker -b 0.0.0.0:8000 app:app說明aliyun-instrument指令負責ARMS Python探針初始化配置及無侵入埋點。
如果應用使用uWSGI啟動,請參考以下接入文檔進行接入:在使用uWSGI啟動Django或Flask專案時接入Python探針。
如果有使用gevent協程,則需要設定環境變數
GEVENT_ENABLE=true。例如程式中有使用:
from gevent import monkey monkey.patch_all()需要設定環境變數如下:
GEVENT_ENABLE=true
步驟一:下載探針安裝器 aliyun-bootstrap
從PyPI倉庫下載探針安裝器。
pip3 install aliyun-bootstrap步驟二:配置環境變數
您需要手動為Python應用添加以下環境變數:
# 方式一:為本SHELL中所有進程添加環境變數
export ARMS_APP_NAME=xxx # 應用程式名稱。
export ARMS_REGION_ID=xxx # 對應的阿里雲帳號的RegionID。
export ARMS_LICENSE_KEY=xxx # 阿里雲 LicenseKey。# 方式二:為某個進程單獨添加環境變數
ARMS_APP_NAME=xxx ARMS_REGION_ID=xxx ARMS_LICENSE_KEY=xxx aliyun-instrument xxx.py其中LicenseKey可以通過OpenAPI擷取,具體方法,參見DescribeTraceLicenseKey - 列出LicenseKey。
(可選)Docker環境安裝參考
對於Docker環境,可以參考以下Dockerfile樣本修改您的Dockerfile檔案。
# 添加環境變數
ENV ARMS_APP_NAME={AppName}
ENV ARMS_REGION_ID={regionId}
ENV ARMS_LICENSE_KEY={licenseKey}
## 原有環境步驟三:使用aliyun-bootstrap安裝Python探針
為了加快安裝,建議您使用如下命令先配置鏡像倉庫。
pip config set global.index-url https://mirrors.aliyun.com/pypi/simple/ && pip config set install.trusted-host mirrors.aliyun.com安裝探針。
aliyun-bootstrap -a install說明如需要指定安裝的Python探針版本,可通過以下命令安裝指定版本的探針:
# ${version}替換為實際的版本號碼 aliyun-bootstrap -a install -v ${version}請參考探針(Python Agent)版本說明查看所有發行的Python探針版本。
步驟四:啟動應用
通過ARMS Python探針啟動應用
aliyun-instrument python app.py結果驗證
約一分鐘後,若Python應用出現在ARMS控制台的頁面中且有資料上報,則說明接入成功。
