---
title: 参数说明
description: "日志相关参数说明参见表1。日志参数（如配置的文件名、参数等）仅支持大小写字母、数字和特殊字符（-._,/=）的组合。基于安全性考虑，表1涉及的路径需要所在组织的安全要求。"
url: https://www.hiascend.com/document/detail/zh/mindcluster/latest/toolbox/toolboxug/toolboxug_0034.html
sourcePath: /source/zh/mindcluster/2610/toolbox/toolboxug/toolboxug_0034.html
indexId: 9cdc7a4c1d9d32fef052749c3a7fdc6e3c9ebde9059c53ebbb582536c8fe58ee65
---
# 参数说明

日志相关参数说明参见表1。日志参数（如配置的文件名、参数等）仅支持大小写字母、数字和特殊字符（-._,/=）的组合。基于安全性考虑，表1涉及的路径需要所在组织的安全要求。

如需了解Ascend DMI的更多信息，执行命令ascend-dmi -h查看。


**表1 参数说明**

| 参数 | 说明 | 是否必选 |
| --- | --- | --- |
| [\-h, \-\-help] | 查看ascend\-log\-collect.sh脚本帮助信息。 | 是 |
| [\-v, \-\-version] | 查看ascend\-log\-collect.sh脚本版本信息。 | 是 |
| \-\-output\-file=<FILENAME> | 指定收集日志的输出路径和输出文件的名称，文件的扩展名建议为.tar.gz。不指定“\-\-output\-file”参数时，默认在当前路径生成名称为ascend\-report\-<hostname>\-<YYYYMMDDhhmmss>.tar.gz的文件。只指定输出文件的名称，不指定输出路径时，默认在当前路径生成指定名称的文件。收集日志的输出路径请勿含有大量其他文件。 | 否 |
| \-\-safe | 调用Ascend DMI工具执行设备健康状态检查，此时不会执行功耗测试。 此选项默认开启。 | 否 |
| \-\-extra | 调用Ascend DMI工具执行全部检查项的检查，仅当\-\-modules取值为ascend或不指定\-\-modules时，\-\-extra参数才生效。此时执行功耗测试，会引起AI core占用率增加和芯片温度升高，收集结束后恢复正常。 说明： 同时指定\-\-safe和\-\-extra参数，则后一个参数生效。如ascend\-log\-collect.sh \-\-extra \-\-safe，则\-\-safe参数生效，\-\-extra参数不生效。 | 否 |
| \-\-modules=<MODULE>[,<MODULE>]… | 指定信息收集的模块，多个模块之间用逗号分隔。可选的模块有：system、ascend、mindx、all。指定模块与收集文件的对应关系请参见表2。 指定\-\-modules=all时，上述可选模块均进行收集。 | 否 |
| \-\-ascend\-path=<PATH> | 指定已安装的昇腾软件路径，收集安装软件的版本信息，默认为“/usr/local/Ascend”。 | 否 |
| \-\-user=<USERNAME> | 指定收集CANN日志的用户。该参数仅支持root用户使用，且不支持在Atlas 200 AI加速模块（RC场景）上使用。 此参数与“\-\-user\-log”互斥，不可同时使用。“\-\-user”和“\-\-user\-log”都不指定时，默认收集当前用户的用户态日志，路径为“$HOME/ascend/log”和“/var/log/ascend\_seclog”。 说明： “\-\-user”和“\-\-user\-log”，推荐使用“\-\-user”。 | 否 |
| \-\-user\-log=<USERLOG> | 指定收集CANN日志的目录位置。该参数仅支持root用户使用，且不支持在Atlas 200 AI加速模块（RC场景）和Atlas 200I SoC A1 核心板上使用。 此参数与“\-\-user”互斥，不可同时使用。“\-\-user”和“\-\-user\-log”都不指定时，默认收集当前用户的用户态日志，路径为“$HOME/ascend/log”和“/var/log/ascend\_seclog”。 说明： “\-\-user”和“\-\-user\-log”，推荐使用“\-\-user”。 | 否 |
| \-\-sdk\-log\-path=<PATH> | 指定收集SDK日志的目录，请用户输入生成的SDK日志的实际存放路径。 建议指定为需要收集日志所在的最小目录，否则指定目录过大，将会收集该目录下的所有可读文件，包含很多冗余信息。 | 否 |
| \-\-mindie\-log\-path=<MINDIELOGPATH> | 用于指定MindIE日志路径，收集MindIE日志。默认/var/log/ascend\_log/app\_log/mindie。 | 否 |
| [\-q, \-\-quiet] | 指定该参数，将不再进行防呆提示，用户将默认允许该操作。只有收集ascend模块日志，且指定了\-\-extra参数时，\-q参数才生效。 说明： 若不指定该参数，将进行防呆提示，用户需要输入Y或N（y或n）确认是否进行操作。 | 否 |


**表2 模块与文件对应关系**

| modules | 收集的文件 | 备注 |
| --- | --- | --- |
| system | system\-report.log.gz。 | \- |
| ascend | ascend\-report.log.gz、npu\_log\_collect\_YYYYMMDDhhmmss.tar.gz、ascend\_user\_log.tar.gz、device\_log.tar.gz、ascend\_user\_install\_log.tar.gz、YYYY\-MM\-DD\-HH\-MM\-SS文件夹。 | 昇腾软件日志存在，才会收集并生成ascend\_user\_log.tar.gz。 Device的系统级日志存在，才会收集并生成YYYY\-MM\-DD\-HH\-MM\-SS文件夹。 |
| mindx | alog.tar.gz、plog.tar.gz、mindx\_sdk\_info\_\*.tar.gz。 | 边缘设备的日志存在，才会收集并生成alog.tar.gz、plog.tar.gz；指定了需要收集的SDK日志的路径，才会收集并生成mindx\_sdk\_info\_\*.tar.gz。 |


#### 使用示例

- ascend-log-collect.sh -h（查看帮助信息）
- ascend-log-collect.sh --version（查看版本信息）
- ascend-log-collect.sh（以默认模式执行）
- ascend-log-collect.sh --safe（以safe模式执行）
- ascend-log-collect.sh --extra（以extra模式执行）
- ascend-log-collect.sh --output-file=./result.tar.gz（指定输出文件执行）

- (--modules=ascend)：ascend-log-collect.sh --modules=ascend（只收集昇腾NPU健康信息、昇腾软件日志、device的系统级日志和昇腾NPU日志）
- ascend-log-collect.sh --user=HwHiAiUser（指定收集CANN日志的用户）
- ascend-log-collect.sh--user-log=/root/ascend/log（指定收集CANN日志的目录）
- ascend-log-collect.sh--sdk-log-path=/home/ascend/mxVision-{version}/logs（指定收集SDK日志的目录）
- ascend-log-collect.sh --mindie-log-path=/var/log/ascend_log/app_log/mindie（指定收集MindIE日志路径）
