IBM Support

五分钟学会使用 IBM Application Runtime Expert for i —— 读懂 ARE 报告

Technical Blog Post


Abstract

五分钟学会使用 IBM Application Runtime Expert for i —— 读懂 ARE 报告

Body

背景

 

IBM Application Runtime Expert for i Core(亦称 ARE Core)是 ARE 组件之一,用于使用模板(模板由 Deployment Template Editor 创建)对目标系统执行验证。当 ARE 完成对某个系统的验证,将产生三种内容及格式不尽相同的报告。本文将着力帮助ARE的用户理解这三种由 ARE Core 产生的系统验证报告,以期取得更好的使用效果。

 

有两种使用模板(template)验证系统的途径:

1. 使用 ARE 控制台(Console)的 Web 用户界面

2. 在 QShell 环境下使用脚本(script)

 

以上两个方法最终都能输出相同的三种验证报告。如果使用控制台的 web 用户界面验证目标系统,这将使验证报告非常易于阅读。如果使用QShell 脚本验证目标系统,所产生的报告文件名将依当时指定的 runARE.sh脚本所使用的参数决定。重要的是明白每个文件属于哪种报告类型。那么,让我们通过以下示例来说明:

/QIBM/ProdData/OS/OSGi/healthcheck/bin/runARE.sh –template myTemplate1.jar –outFile report.out  

 

根据 -outFile 参数的值,会产生并输出如下报告文件:

  •  report.out ——详细报告
  •  report.out summary.txt ——汇总报告
  •  report.out.xml —— XML 格式报告

注意,如果在-outFile 的参数值中只给定了文件名,那么报告将输出到当前的工作目录中。如果是指定一个绝对路径和文件名,那么报告将输出到所指定的绝对路径中。

 

关于每种报告的详细介绍我们将在本文的后续段落进行讨论,不过,在此之前,我们首先需要讲解“问题严重级别(Problem Severity)”这一概念,以及 ARE Core 所产生的报告是如何反映问题严重级的。

 

问题严重级别(Problem Severity Level )

 

ARE 会给每个验证过的项目标注一个恰当的问题严重级别。问题本身联连同问题的严重级别会被一同写入 ARE 报告中。所发现的问题可能通过以下三种不同的问题严重级别加以标注:

  •  Error (高严重性问题)
  •  Warning
  •  Info (最低严重性问题)

在汇总和详细报告中,问题严重级别会作为每项验证结果信息的开头输出显示。比如:

Error! This is a problem reported at the error severity level 

Warning: This is a problem reported at the warning severity level

Info: This is a problem reported at the info severity level

由于问题严重级别被放在每一项的检查结果的最前面,因此我们很容易区分检查结果正常的项目和那些被检出错误的项目。

 

汇总报告(Summary Report)

 

汇总报告采用纯文本格式文件保存(.txt),它只包含系统验证期间所发现问题的汇总信息。

在实践中,用户可以首先关注这个报告的内容,其中总是提及最要紧的问题。

 

由于报告内容是结构化的,如果报告中再给出一定的上下文,那么我们就能轻而易举地读懂报告。考虑到这一点,在汇总报告中所列出的每个问题之前,都会有几段状态信息。为了便于形象地解释状态信息和问题描述本身让我们来看下面这个例子。假定一个汇总报告中记录有如下访问权限错误:

 

Running plugin Authority Verifier

> Processing XML rule file (xml/Auth_Collection1.xml) for object authority

o Checking authority for /QIBM/ProdData/OS/OSGi/apps

- OK: Authorization list set to *NONE for /QIBM/ProdData/OS/OSGi/apps

ERROR! User *PUBLIC data authorities to object /QIBM/ProdData/OS/OSGi/apps is

not what we expect

Details: Expected: *RX Actual: *EXCLUDE

> Finished processing object authority

> Total number of object authority items checked: 1286

 

在这个例子中,蓝色文字是所检出问题的描述信息;正如你所见,在汇总报告中不仅包含问题描述,在它前面还会输出相关的状态信息,最后,在这个插件结束检查时,报告的最后一行对所检查项目的总数量进行了汇总。

 

注意,汇总报告并不包含完整的验证结果,它仅仅报告所发现的问题,有些你同样感兴趣的的信息并不在此报告中列出。例如,PTF 插件检查的安装在目标系统上的所有 Group PTF 级别。这样的信息显然不属于“问题”, 因此也不会包含在汇总报告中。不过详细报告会包含这类信息。

 

详细报告(Detailed Report)

 

详细报告对验证期间产生的检查结果及其状态信息都逐一列出,它被保存在纯文本格式文件中。也就是说,这个报告中会包含对每一项的完整验证记录,及验证结果,即使没有发现错误。正因为这个报告包含如此详尽的信息,如果验证的项目非常多,那么文件的体量将会变得很大。这将给想要查看报告,从中寻找有价值信息的人们带来挑战。因此,我们在这里列出了几个节约查找时间的窍门:

 

Q:如何从详细报告中快速找到ARE检查出的问题?

A:最简便的方法是通过在报告中搜索问题严重级别相关的文本。如果你还记得我们前面提到的问题严重级别(Problem Severity Level), 根据要查看的严重级别不同,可以搜索以下三个字符串之一来定位:

ERROR!

Warning:

Info:

Q:如何找到特定插件的验证结果,比如PTF级别的验证结果,或是对系统值(system value)的验证结果?

A:应用程序和系统属性(权限,PTF 级别,系统值,User ID)都是由插件执行验证的。每个插件负责验证不同类型的属性;因此,PTF 级别有PTF插件验证, System Values 插件负责验证系统值,等等。每个插件在详细报告中都有一段标志验证开始的文本。因此要查看特定验证类型的结果可以通过搜索如下标志性文字开始:

Running plugin 

这段文本标识在每个插件执行验证的开始都会出现。

 

XML 格式报告

 

XML 报告可以看作是采用 XML 格式保存的详细报告(detailed report),它对验证期间发现的每个问题描述、状态信息予以列出。这个报告中会包含对每一检查项的完整验证记录,及验证结果,也包括没有发现错误条目信息。

除此之外,XML 报告还包含其他类型报告所不具备的信息:它包含如何修复问题的相关描述信息。

有关 ARE 如何修复所检出的问题我们另有专文加以讨论,这里不予赘述。您可以参阅产品官方网站上的“How To Automatically Fix Detected Problems”这篇文章。

http://www.ibm.com/systems/power/software/i/are/documentation.html

 

实际上主要是 ARE Core 在使用XML 报告所包含的修复信息作为自动修复检出问题的指南。如果你使用 ARE Console 修复所检出的问题,那么Console 使用 XML 报告对用户来说是透明的。不过,如果您使用的是 areFix.sh 这样的 QShell 脚本修复所发现的问题,你需要手动指定 XML 文件名及其路径作为该脚本的输入参数。

 

有关使用 areFix.sh 脚本的信息,请参阅产品官方网站上的“Script Interface to ARE”一文: http://www.ibm.com/systems/power/software/i/are/documentation.html

 

欢迎访问 IBM Application Runtime Expert for i 的官方站点了解更多信息:

http://www-03.ibm.com/systems/power/software/i/are/index.html

如您对本产品有任何问题或者希望和开发者及现有用户进行讨论,敬请访问我们的中文群组:

https://www.ibm.com/developerworks/mydeveloperworks/groups/service/html/communityview?communityUuid=49fb04be-7e65-4f89-9692-ff67b90a4f98

 

作者

焦焕文,jiaohw@cn.ibm.com,IBM中国系统与技术中心,负责 IBM Application Runtime Expert for i 的产品研发工作。

张煜晗,zhyhzhyh@cn.ibm.com,IBM中国系统与技术中心,负责 IBM Application Runtime Expert for i 的产品研发工作。

王南,wangnan@cn.ibm.com,IBM中国系统与技术中心,负责 IBM Application Runtime Expert for i 的产品研发工作。

 

了解更多关于 IBM i 的信息,请关注 IBM i 新浪官方微博@IBMiChina

[{"Business Unit":{"code":"BU009","label":"Systems - Cognitive"},"Product":{"code":"SWG60","label":"IBM i"},"Component":"","Platform":[{"code":"PF025","label":"Platform Independent"}],"Version":"","Edition":""}]

UID

ibm11144864