参数说明

表1 hpccollector命令参数说明
参数	参数选项	说明
-h，--help	-	帮助功能，提供参数和用法的简单说明。
-g，--g，--generate	-	生成多任务使用的taskfile模板，包含公共参数和每种任务类型。使用-g和-t/--task命令组合，可以生成制定任务类型的taskfile，如只需要生成statistics类型任务模板，输入命令如下：/INSTALL_PATH/hpccollector -g -t statistics
-t，--task	statistics meticulous	指定任务类型。 statistics对应Web界面分析对象为应用，分析模式为统计分析，即HPC应用性能通用采集分析。 meticulous对应Web界面分析对象为应用，分析模式精细化分析，即HPC应用精细化分析。
-tf，--task-file	-	指定多任务下发的taskfile文件，可先使用-g, --generate生成模板文件。
-mpirun，--mpirun-command	MPIRUN_COMMAND	mpirun路径，指定环境安装的mpirun路径，支持脚本封装。
-mpi-arg，--mpirun-argument	MPIRUN_ARG	mpirun参数，指定应用的参数，为防止参数解析冲突，请在参数两边添加引号" "，如果参数以"-"开头造成："expected one argument"报错，需要使用双层引号"' '"，或者在引号中参数前后添加空格，例： "'-host ip'"或 " -host ip "。
-sf，--shared-folder	SHARED_FOLDER	指定shared-folder路径（即共享目录）。
-app，--application	APPLICATION	指定应用路径，若-t参数选择参数statistics或meticulous，必须配置此参数。
-app-arg，--application-argument	APPLICATION_ARG	指定应用的参数，为防止参数解析冲突，请在参数两边添加引号“”，如果不含空格的单参数，参数需放入双层引号（"' '"）。
-script，--script-file	-	指定mpirun脚本路径。脚本中的mpirun命令执行行格式必须以"mpirun"或"mpirun绝对路径"开头，且mpirun命令行所在的行必须是命令的执行行。
-l，--profile-level	summary detail	指定采集模式，可选summary和detail模式，默认为summary模式。
-mo，--mo，--mpi-only	-	开启只采集mpi指标功能。对于混合应用时，指定此参数不会采集openmp指标，较少采集分析时间和数据量。
-ss，--ss，--sys-sampling	-	开启采集系统性能功能。
-cp，--cp，--critical-path	-	开启采集critical path功能。任务类型为statistics时可配置。
-pc，--pc，--pmu-collect	-	开启采集PMU事件。任务类型为meticulous时可配置。
-nt，--nt，--no-topn	-	关闭采集低效通讯TopN功能。任务类型为meticulous时可配置。
-ri，--rdma-interval	RDMA_INTERVAL	开启RDMA数据采集。
-ssi，--shared-storage-interval	SHARED_STORAGE_INTERVAL	开启共享存储（DPC和 NFS ）数据采集。
-st，--st，--subtask-time	-	开启显示子任务时间功能。采集分析过程中，显示更精细子任务时间统计。生成taskfile时默认打开。
-rf，--rank-fuzzy	RANK_FUZZY	指定模糊化倍率。热力图中，rank有很多情况，为更高效的分析显示数据，使用模糊化，200个rank，指定模糊化值为20，即将10个rank作为一个分组进行数据统计。
-d，--duration	DURATION_S	配置采样时长。默认为300秒，采集模式为summary时范围为1-1800秒，采集模式为detail时范围为1-600秒。采样时长并非任务时长，任务时长=准备时长+采样时长+分析时长+打包清理时长。
-D，--delay	DELAY_S	配置延迟采样时长。默认为0秒，任务类型为statistics时可配置，范围为0-900秒。
-u，--u，--unlimited	unlimited	开启不限制采样时长模式。当指定duration时，可以配置更大的采样时长；不指定时，采集直到应用运行结束。说明：随着时间变长，采集分析需要的内存、硬盘以及分析时间都会相应增加，请合理使用；不指定采样时间时，请确保应用能运行结束，不会将系统资源耗尽。
-v, --version	-	查看工具版本信息。

表2 hpcreport命令参数说明
参数	参数选项	说明
-h，--help	-	帮助功能，提供参数和用法的简单说明。
-r，--raw-collection-data-dir	RAW_DATA_DIR	设置原始采集数据路径。
-i，--input-file	RESULT_FILE	设置采集文件路径，格式为“tar文件绝对路径:任务名”；只输入tar文件绝对路径将展示可供report的所有子任名称。
子命令	summary perf-events parallel-regions hotspots mpi-wait issues	可同子命令一同使用查看详细内容，如：hpcreport summary -h。

表3 hpcmanager命令参数说明
参数	参数选项	说明
-h，--help	-	帮助功能，提供参数和用法的简单说明。
-q，--q，--query	-	查询历史任务信息。
-c，--c，--cancel	任务名	直接取消任务。作用同Ctrl+C组合键。
-a，--a，--abort	任务名	提前结束采集状态的任务，根据已有的采集数据进行数据分析。作用同Ctrl+Z组合键。

表4 hpcreport summary和issues子命令参数说明
参数	参数选项	说明
-h, --help	-	帮助功能，提供参数和用法的简单说明。
--top-rows	TOP_ROWS	展示Top table中的行数。
--show-long-names	-	展示节点完整名称。
--no-show-long-names	-	不展示节点完整名称。

表5 hpcreport perf-events、parallel-regions、hotspots、mpi-wait子命令参数说明
参数	参数选项	说明
-h, --help	-	帮助功能，提供参数和用法的简单说明。
-g，--group-by	rank,function,send-type,recv-type,mpi-comm,caller,send-size,recv-size	指定分组，可使用空格分割多个值。
-s，--sort-column	rank,function,send-type,recv-type,mpi-comm,caller,send-size,recv-size,mpi-wait-rate,mpi-imbalance-rate,mpi-transfer-rate,mpi-comm-p2p-wait-rate,mpi-comm-collective-wait-rate,mpi-sync-wait-rate,mpi-io-single-wait-rate,mpi-io-collective-wait-rate,mpi-avg-duration,mpi-avg-imbalance-duration,mpi-avg-transfer-duration,mpi-call-count,mpi-data-size	指定要排序的列。
-so，--sort-order	{asc,desc}	指定展示数据排序，正序或倒序。
--format	{txt,csv}	指定输出格式。
--csv-delimiter	{tab,comma,colon,semicolon}	指定csv的分隔符。
--csv, -csv	-	格式化为csv格式的数据。
--show-long-names	-	展示节点完整名称。
--no-show-long-names	-	不展示节点完整名称。

表6 check_latency_bandwidth命令参数说明
参数	参数选项	说明
-cf，--cmd-file	-	配置需运行的脚本文件（cmd-file）路径。
-l，--log	-	配置记录用户输入命令的文件的路径，不配置时默认为工具路径。
-h，--help	-	帮助功能，提供参数和用法的简单说明。

表7 hpcdld命令参数说明
参数	参数选项	说明
-h，--help	-	帮助功能，提供参数和用法的简单说明。
-mp，--mpirun-path	MPIRUN_PATH	配置需运行的mpirun路径。
-n，--ranks	PROCESS_NUMBERS	配置并行的进程数量。
-i，--master-ip	MASTER_IP	配置节点IP地址。
-sf， --shared-folder	SHARED_FOLDER	配置共享目录路径。
-host，--host	HOST_LIST	配置host列表。
-r，--raw-collection-data-dir	RAW_DATA_DIR	指定数据集合目录。

父主题： HPC命令行工具