Skip to main content
Outside service Partner
Hitachi Vantara Knowledge

Preparing and downloading the health check report


The HCP health check report provides you with information regarding the health status of the nodes in your HCP system. One of the ways that you can prepare and download the health check report is by using the HCP System Management Console. The health check report can be prepared only on nodes that are up and available.

The health check report output format is a JSON file and can be downloaded at any time after the health check report has been successfully prepared.

To prepare and download the health check report using the System Management Console:

1.In the top-level menu of the HCP System Management Console, select Monitoring Health Check Report.

The Health Check Report page displays a list of available nodes under General Node Preparation Status.

2.Under General Node Preparation Status, using the checkboxes in the right column of the table, select the nodes that you want HCP to use for the health check report.

3.Click on Prepare Health Check Report.

When you click on Prepare Health Check Report, the HCP system runs a health diagnostic tool on the nodes that you have selected. This diagnostic tool executes various signatures to collect information on the health of HCP nodes in the system. For more information on signatures, see About signatures in JSON.

After the HCP system has finished running the health diagnostic tool on the nodes, the collected data is saved at a designated location in the output format of a JSON file, which can be downloaded at any time.

4.Click on Download Health Check Report to download the HCP health check report JSON file.

For examples of signatures in HCP health check report JSON files, see Examples of signatures in the health check report.

You can also use the HCP management API to prepare, cancel, download, and check the status of a health check report. For more information on using these functions with the management API, see Health check report resources and its corresponding data types.

© 2015, 2019 Hitachi Vantara Corporation. All rights reserved.

About signatures in JSON


On the MonitoringHealth Check Report page of the HCP System Management Console, you can select nodes that you want to include in the health check report. When you click on Prepare Health Check Report, the HCP system runs a health diagnostic tool on the nodes that you have selected. For more information on these steps, see Preparing and downloading the health check report.

This health diagnostic tool executes various signatures to collect information on the health of HCP nodes in the system. Signatures are JSON files containing different shell commands that can be run on nodes in an HCP system. These signatures can be used to gather configuration information about a node and to collect data on potential issues regarding the health of a node.

Signatures can be classified into components and types. Some examples of components are replication, admin, or JVM. Types can be further classified into info and issue. Info signatures collect information regarding the configuration of nodes, such as memory configuration, version of HCP, hot fixes, and other HCP configurations. Issue signatures report if a node is either experiencing a certain issue or is at risk of experiencing that issue, such as server issues, object issues, nodes restarting repeatedly, and other general issues.

After the signatures have been executed on the selected nodes, the health check report is saved at a designated location in the output format of a JSON file, which can be downloaded at any time.

For examples of signatures in HCP health check report JSON files, see Examples of signatures in the health check report.

© 2015, 2019 Hitachi Vantara Corporation. All rights reserved.

Examples of signatures in the health check report


The following sections contain examples of the signatures in HCP health check report files. The output format of these files is JSON.

© 2015, 2019 Hitachi Vantara Corporation. All rights reserved.

Example 1: Signature for node restarts during a health check


Here is a sample HCP health check report signature that reports of a node restarting repeatedly during a health check. The output format is a JSON file.

Sample signature in JSON

{
    "name" : "Node Rolls during Health Check",
    "description" : "This can be caused due to the connectivity issue between HCP nodes and NTP server",
    "jiraId" : "NONE",
    "component" : "JVM",
    "steps" : [
        {
            "stepId" : "1",
            "commandType" : "shell",
            "command" : "find . -name \"*jvm*\" -print -exec grep \"RuntimeException\" {} \\;",
            "expectedOutputCommand" : "if wc -l) -gt 0 ; then echo true; fi"
        },
            {
            "stepId" : "2",
            "commandType" : "shell",
            "command" : "find . -name \"*jvm*\" -print -exec grep \"HealthConnectionErrorHandler\" {} \\;"
            "expectedOutputCommand" : "if wc -l) -gt 0 ; then echo true; fi"
        }
    ]
}

© 2015, 2019 Hitachi Vantara Corporation. All rights reserved.

Example 2: Signature for replication details


Here is a sample HCP health check report signature that provides information regarding replication details. In this example, the signature status is reported as not matched. The output format is a JSON file.

Sample signature in JSON

{
    "name" : "ReplicationDetails",
    "description" : "System replication details",
    "issueId" : "N/A",
    "component" : "Replication",
    "modifiedDate" : May 30, 2018 7:07:51 PM",
    "product" : "Hitachi Content Platform",
    "signatureType" : "INFO",
    "supportedVersions" : [
        {
            "supportedVersion" : "8.1.0"
        }
    ],
    "signatureStatus" : "NotMatched",
    "steps" : [
        {
            "stepId" : "1",
            "commandType" : "Admin",
            "command" : "admin jvm replication list --all",
            "expectedOutputCommand" : "if wc -l) -gt 0 ; then echo true; fi",
            "logTrace" : "{\n}",
            "signatureMatched" : false,
            "truncatedLogTrace" : "Truncated the LogTrace Output, please run the command manually to get the full log trace",
            "executionTime" : 12,
            "timedOut" : false,
            "stepExecutionFailure" : "No Error",
            "timeOutDuration" : 10
        }
    ]
}

© 2015, 2019 Hitachi Vantara Corporation. All rights reserved.

Example 3: Signature for system status


Here is a sample HCP health check report signature that provides information regarding the status of a system. In this example, the signature status is reported as passed. The output format is a JSON file.

Sample signature in JSON

{
    "name" : "JVMStatus",
    "description" : "JVM status",
    "issueId" : "N/A",
    "component" : "Admin",
    "modifiedDate" : May 31, 2018 7:07:51 PM",
    "product" : "Hitachi Content Platform",
    "signatureType" : "INFO",
    "supportedVersions" : [
        {
            "supportedVersion" : "8.1.0"
        }
    ],
    "signatureStatus" : "Passed",
    "steps" : [
        {
            "stepId" : "1",
            "commandType" : "Admin",
            "command" : "admin jvm status",
            "expectedOutputCommand" : "if wc -l) -gt 0 ; then echo true; fi",
            "logTrace" : "system log trace",
            "signatureMatched" : true,
            "truncatedLogTrace" : "Truncated the LogTrace Output, please run the command manually to get the full log trace",
            "executionTime" : 236,
            "timedOut" : false,
            "stepExecutionFailure" : "No Error",
            "timeOutDuration" : 10
        }
    ]
}

© 2015, 2019 Hitachi Vantara Corporation. All rights reserved.