手动安装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_WORKSPACE=xxx   # 替换为当前Workspace名称。
export ARMS_REGION_ID=xxx   # 对应的阿里云账号的RegionID。
export ARMS_LICENSE_KEY=xxx   # 阿里云 LicenseKey。
export ARMS_IS_PUBLIC=True   ＃ 添加该环境变量表示使用公网访问。

# 方式二：为某个进程单独添加环境变量
ARMS_APP_NAME=xxx ARMS_WORKSPACE=xxx ARMS_REGION_ID=xxx ARMS_LICENSE_KEY=xxx ARMS_IS_PUBLIC=True aliyun-instrument xxx.py

其中LicenseKey可以通过OpenAPI获取，具体方法，参见DescribeTraceLicenseKey - 列出LicenseKey。

# 添加环境变量
ENV ARMS_APP_NAME={AppName}
ENV ARMS_REGION_ID={regionId}
ENV ARMS_LICENSE_KEY={licenseKey}
ENV ARMS_WORKSPACE={worksapce}

## 原有环境

步骤三：使用aliyun-bootstrap安装Python探针

1. 为了加快安装，建议您使用如下命令先配置镜像仓库。

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

2. 安装探针。

   aliyun-bootstrap -a install

   说明

   如需要指定安装的Python探针版本，可通过以下命令安装指定版本的探针：

   # ${version}替换为实际的版本号
   aliyun-bootstrap -a install -v ${version}

   请参考探针（Python Agent）版本说明查看所有已发布的Python探针版本。

步骤四：启动应用

aliyun-instrument python app.py

查看监控详情

1. 登录云监控2.0控制台，选择目标工作空间，在左侧导航栏选择应用中心 > 运维监控 > 应用监控。

2. 在应用列表页面可以看到已接入的应用，单击应用名称可以查看详细的应用监控数据。