msMonitor工具安装指南

软件包安装

推荐使用软件包安装，步骤如下：

1. 根据版本配套说明选择对应软件包并下载到Linux安装环境。

2. 校验包完整性。

   进入zip包所在目录，执行如下命令。

   sha256sum {name}.zip
   

   {name}为zip包名称。

   若回显呈现对应版本zip包一致的校验码，则表示下载了正确的性能工具zip安装包。示例如下：

   sha256sum aarch64_8.1.0.zip
   

3. 安装whl包。

   # 解压压缩包
   mkdir x86
   unzip x86_8.1.0.zip -d x86
   
   # 进入解压后的目录
   cd x86
   
   # 安装whl包，须选择与当前环境Python版本一致的whl包
   pip install msmonitor_plugin-{mindstudio_version}-cp{python_version}-cp{python_version}-linux_{system_architecture}.whl
   

4. 安装dynolog。

5. 有以下三种安装方式可供选择，根据用户服务器系统自行选择：

   • 方式一：使用deb软件包安装（适用于Debian/Ubuntu等系统）。

     dpkg -i --force-overwrite dynolog*.deb
     

   • 方式二：使用rpm软件包安装（适用于RedHat/Fedora/openSUSE等系统）。

     rpm -ivh dynolog-*.rpm --nodeps
     

   • 方式三：直接复制bin文件夹到系统中。

编译安装

clone代码

git clone https://gitcode.com/Ascend/msmonitor.git

安装依赖

dynolog的编译依赖如下，请确保已安装以下依赖，用户手动安装的第三方依赖由用户自行确保安全性，避免安装存在安全漏洞的版本。

Language	Toolchain
C++	gcc 8.5.0+
Rust	Rust >= 1.81

1. 安装rust

   curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
   source $HOME/.cargo/env
   

2. 安装ninja

   # debian
   sudo apt-get install -y cmake ninja-build
   
   # centos
   sudo yum install -y cmake ninja
   

3. 安装protobuf (tensorboard_logger第三方依赖，用于对接tensorboard展示)

   说明：要求protobuf版本为3.12或更高版本

   # debian
   sudo apt install -y protobuf-compiler libprotobuf-dev
   
   # centos
   sudo yum install -y protobuf protobuf-devel protobuf-compiler
   
   # Python
   pip install protobuf
   

4. （可选）安装openssl（RPC TLS认证）& 生成证书密钥

   说明：如果不需要使用TLS证书密钥加密，该步骤可跳过。

   # debian
   sudo apt-get install -y openssl
   
   # centos
   sudo yum install -y openssl
   

dyno CLI与dynolog daemon之间的RPC通信使用TLS证书密钥加密，在启动dyno和dynolog二进制时可以指定证书密钥存放的路径，路径下需要满足如下结构和名称。 用户应使用与自己需求相符的密钥生成和存储机制，并保证密钥安全性与机密性。当前仅支持RSA-SHA256和RSA-SHA512两种证书签名算法。

服务端证书目录结构：

server_certs
├── ca.crt (根证书，用于验证其他证书的合法性，必选)
├── server.crt (服务器端的证书，用于向客户端证明服务器身份，必选)
├── server.key (服务器端的私钥文件，与server.crt配对使用，支持加密，必选)
└── ca.crl (证书吊销列表，包含已被吊销的证书信息，可选)

客户端证书目录结构：

client_certs
├── ca.crt (根证书，用于验证其他证书的合法性，必选)
├── client.crt (客户端证书，用于向服务器证明客户端身份，必选)
├── client.key (客户端的私钥文件，与client.crt配对使用，支持加密，必选)
└── ca.crl (证书吊销列表，包含已被吊销的证书信息，可选)

编译

1. dynolog编译。

   默认编译生成dyno和dynolog二进制文件，-t参数可以支持将二进制文件打包成deb包或rpm包。

   # 编译dyno和dynolog二进制文件
   bash scripts/build.sh
   
   # 编译deb包, 当前支持amd64和aarch64平台, 默认为amd64, 编译aarch64平台需要修改third_party/dynolog/scripts/debian/control文件中的Architecture改为arm64
   bash scripts/build.sh -t deb
   
   # 编译rpm包, 当前只支持amd64平台
   bash scripts/build.sh -t rpm
   

2. msmonitor-plugin wheel包编译。

   msmonitor-plugin wheel包提供IPCMonitor，MsptiMonitor等公共能力，使用nputrace和npu-monitor功能前必须安装该wheel包，具体编译安装指导请参见msmonitor-plugin编译安装包指导。