-
Notifications
You must be signed in to change notification settings - Fork 9
Home
The servicereport tool is a command-line tool that helps users to identify and fix the incorrect First Failure Data Capture (FFDC) configuration. The servicereport tool operates in two modes, validate and repair. The validate mode verifies the FFDC configuration and repair mode auto-fixes the incorrect FFDC configuration found by the validate mode. In the end, the tool prints a validation report on the console that indicates the status of all the FFDC configuration checks performed by the servicereport tool. See the example output given below.
$ sudo servicereport -v
servicereport 2.2.1
Daemon availability check PASS
irqbalance PASS
Kdump configuration check FAIL
Memory allocated for capture kernel PASS
Dump component in initial ramdisk PASS
Service status FAIL
Capture kernel load status FAIL
Kdump attributes in /etc/kdump.conf PASS
Kdump attributes in /etc/sysconfig/kdump PASS
kexec package PASS
Package availability check FAIL
irqbalance PASS
perf PASS
sos FAIL
The servicereport tool output is divided into multiple sections and each section represents a group of FFDC configuration checks. For example, in the above output, there are three sections Daemon availability check, kdump configuration check, and Package availability check. A section comprises of two elements that include section description with the overall section status and a list of FFDC configuration checks performed under that section. If the overall status of a section is PASS then the FFDC configuration checks performed under that section has correct configuration else section has at least one incorrect configuration. For instance, in the above example, the overall status of Package availability check is FAIL because the sos package was not installed in the system. Similarly, the Kdump configuration check section also has multiple incorrect configurations (like service not enabled and capture kernel load failed) that lead to overall section failure. A section/group in the servicereport tool is formally referred as a plugin and it is also our default terminology for the rest of the documentation.
As depicted in the above example running the servicereport tool in validate mode (or default mode) will only help you to identify the incorrect FFDC configuration. But in order to fix the incorrect FFDC configuration, one should run the servicereport tool in repair mode. repair mode basically collects all the incorrect FFDC configuration reported by validation mode and tries to fix them. In the end, repair mode updates the status of all the repaired configurations and prints the final report on the console. Visit the QuickStart page to see the ServiceReport tool in action.
Please make sure that you have python2 ( > 2.7.5) or python3 ( > 3.7.6) installed before proceeding with the servicereport tool installation.
$ git clone [email protected]:linux-ras/ServiceReport.git # clone the source code
$ cd ServiceReport
$ make build # Build the project
$ make install