系统成分信息收集功能说明

命令功能

使用命令通过终端工具进行系统迁移应用系统成分信息收集。

  • 支持扫描应用框架Spring（Boot/Spring Framework/Spring MVC）、MyBatis（iBatis/MyBatis/MyBatis Plus）、Tomcat、Redis的数据/配置，结果文件夹存放在报告生成目录的source目录下。
  • 用户可通过“sys-mig/resources/sysmig/compatibility_extend”目录下文件配置软件兼容性名单，在进行成分收集时，系统会读取用户配置的兼容性信息进行兼容性分析，具体请参见兼容性名单配置。

命令格式

参数说明

表1 参数说明

参数

参数选项

说明

-h/--help

-

获取帮助信息。

-c/--command

stmt/sbom/mvn_analyse

收集信息的模式。

  • stmt（默认）：收集台账信息，可生成CSV报告。
  • sbom：收集成分信息，可生成HTML或JSON报告，默认会扫描MySQL、Oracle、Redis、Nginx和Tomcat。
  • mvn_analyse：Maven工程源码迁移分析，可生成HTML报告。

-cf/--config

-

输入参数配置文件路径。支持通过配置文件方式输入参数，默认模板位置为“sys-mig/resources/sysmig_default.conf”，具体使用示例请参见配置文件使用示例。

-d/--directory

-

输入扫描文件目录，支持输入多个目录，多个目录间以空格分隔。

例如：/home/test1 /home/test2。

-o/--output

-

报告输出目录，默认为sys-mig二进制所在report目录。

例如：/home/report。

-f/--format

html/json

扫描报告的格式，默认为html。支持选择多个报告格式，多个报告格式以空格间隔。

  • html：生成HTML格式报告。
  • json：生成JSON格式报告。

-e/--exclude-fields

version/checkOutPath

表示需要隐藏的参数信息。支持同时选择，多个参数信息以空格间隔。

  • version：表示成分版本号。
  • checkOutPath：表示成分检出路径。

-l/--log-level

0/1/2/3
设置日志级别，默认为1。
  • 0：日志级别为DEBUG。
  • 1：日志级别为INFO。
  • 2：日志级别为WARNING。
  • 3：日志级别为ERROR。

-mn/--multi-node

all/ungrouped/groupName

远程扫描服务器的组名，仅支持Linux环境。配置文件为“sys-mig/nodes/nodes.conf”，具体格式请参见配置文件使用说明（-mn/--multi-node）。

说明：

所有组都放在all组下，未分组的服务器配置放在ungrouped组下。

-ec/--encipher

-

输入需要加密的文本。

-pid/--process_id

-

该参数仅适用于Java应用程序。动态扫描指定进程ID的Java应用程序，与-pname无对应关系，支持输入多个PID，多个PID以空格分隔。

-pname/--process_name

-

该参数仅适用于Java应用程序。动态扫描指定进程名称的Java应用程序，与-pid无对应关系，支持输入多个进程名称，多个进程名称以空格分隔。

-v/--version

-

展示程序版本信息，无需输入参数。

使用示例

配置文件使用说明（-mn/--multi-node）

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
[groupName]
host key=value
[groupName:vars]
ssh_port=
ssh_user=
ssh_pass=
soft_path=
scan_dir=
process_id=
process_name=
[groupName:children]
groupName
[groupName:host]
host
  • [groupName]：分组名称，由字母、数字组成。
  • host key=value：节点IP和参数值，多个参数以空格分隔，支持参数如下：
    • ssh_port：端口号，默认22。
    • ssh_user：用户名。
    • ssh_pass：通过devkit sys-mig -ec命令加密的用户密码。
    • soft_path：当目标服务器与本地服务器架构不一致时，需要指定当前服务器上，可适配目标服务器执行信息收集的软件包解压后目录。
    • scan_dir：目标服务器的扫描目录，多个请使用英文逗号分隔。
    • process_id：扫描目标服务器的Java应用程序进程ID，多个请使用英文逗号分隔。
    • process_name：扫描目标服务器的Java应用程序进程名，多个请使用英文逗号分隔。
  • [groupName:vars]：分组全局参数设置，格式为key=value，可被子分组继承。
  • [groupName:children]：子分组，指定父子关系。
  • [groupName:host]：指定分组中服务器的IP地址。

兼容性名单配置

用户可通过“sys-mig/resources/sysmig/compatibility_extend”目录下文件配置软件兼容性的可兼容替换以及黑白名单，支持名单如下：

系统内置的名单位于“sysmig/resources/sysmig/compatibility_builtin”目录下，用户配置的名单优先级大于系统内置的名单。对于JAVA应用，支持的名单优先级从高到低为：可替换名单、黑名单、白名单。

配置示例：

输出报告说明

表2 输出报告说明

报告类型

报告详细说明

json

汇总Java应用、中间件、OS、硬件等系统成分的相关元数据详细信息，如：成分名称、版本号、检出路径、兼容性等，以及成分之间的父子关系。

html

通过树形图的方式分别展示Java应用、中间件、数据库、OS等系统成分的关联关系，以及每个成分的基础信息，如：成分名称、版本号、检出路径、兼容性等。
父主题： 系统迁移应用信息收集