Preparing and downloading health check reports
Health check reports provide information about the health status of the available nodes in your HCP cluster.
You can prepare and download health check reports using either the HCP System Management Console or the HCP management API.
Using the System Management Console to prepare and download health check reports
Before you begin
You can create health check reports on HCP nodes in a cluster that are running and available.
Procedure
In the top-level menu of the System Management Console, select .
The Health Check Reports page is displayed.(Conditional) If you recently prepared health check reports for download and the Download Health Check Reports button is enabled, you can download the reports if desired. Then click Cancel to reinitialize the Prepare Reports for Download pane.
In the Prepare Reports for Download pane:
In the Start Date and End Date fields, enter or select a date range for the reports.
The default values for these fields is the current day.(Optional) Enter a comment to include in the manifest.csv file that is included in the reports download archive.
Click Prepare Health Check Reports.
The HCP system runs a health diagnostic tool on the available system nodes. The tool runs various signatures to collect system health information. You do not need to remain on the Health Check Reports page while the report preparation is in progress.After the health diagnostic tool finishes and the reports are prepared, status messages are displayed in the General Node Preparation Status pane in the Status column associated with each node, the checkboxes associated with each node for which the reports were successfully prepared are selected, and the Download Health Check Reports button is enabled.
Complete one of these actions:
To download an archive that contains health check reports for all selected nodes, click Download Health Check Reports.
To download an archive that contains a subset of the prepared reports, select only the checkboxes associated with the nodes for which you want to download reports. Then click Download Health Check Reports.
Save the file.
Next steps
Health check reports archive contents
The HCP health check reports .zip archive contains the following contents:
- A manifest.csv file, which contains the optional comment that you might have added when you prepared the health check reports
- A separate .tar archive for each available node in the cluster
Within each node-specific .tar archive:
- In the /var/ris/retired folder, the health check reports .tar files corresponding to the date range you specified when you prepared the health check reports
- In the /var/ris/logs/HealthCheckReport folder, the latest run of the health check report at the time you prepared the reports for the specified date range
Health check report signatures
When you prepare health check reports, the HCP system runs a health diagnostic tool on the available nodes in the cluster. This tool runs various signatures to collect information about the health of the HCP nodes.
Signatures are JSON files containing different shell commands that gather configuration information and collect data on potential issues related to the health of a node. Signatures are classified into components and types (info and issue).
Components include items such as replication, admin, or JVM. Info signatures collect node configuration information such as memory configuration, HCP version, hot fixes, and other HCP configurations. Issue signatures report if a node either is experiencing a certain issue or is at risk of experiencing an issue, such as server issues, object issues, repeated node restarts, or other general issues.
The following sample health check report signature provides information about specific disk errors on an HCP system. The output format is a JSON file.
{
"name": "DiskErrors",
"description": "Get the disk errors",
"issueId": "N/A",
"component": "Operating System",
"executionTime": 15,
"modifiedDate": "July 28, 2020 5:57:26 PM",
"product": "Hitachi Content Platform",
"signatureType": "GeneralIssue",
"hcpVersion": "9.2.0",
"signatureStatus": "NotMatched",
"runMode": "online",
"steps": [
{
"stepId": "1",
"command": "cat /var/log/messages | grep -iE \u0027(error|scsi|unexpected|failure|conflict)\u0027 ",
"expectedOutputCommand": "if [[ $(grep -i [A-Z] \"%s\" | wc -l) -gt 0 ]]; then echo true; fi",
"logTrace": "",
"signatureMatched": false,
"executionTime": 15,
"timedOut": false,
"stepExecutionFailure": "No Error",
"timeOutMillis": 10000
}
]
}