Monitoring IBM Storage Scale native REST API

You can monitor the health of IBM Storage Scale native REST API feature by using the traditional mmhealth command or the scalectl apihealth command.

Using mmhealth

The mmhealth command now supports the scalemgmt component, which tracks the health of the native REST API and raise health events for any issues. This scalemgmt component name is displayed in both the cluster and the node health view.

For more information, see mmhealth command.

Examples

  • The following example displays the cluster health status by using the mmhealth command:
    mmhealth cluster show
    A sample output as follows:
    Component           Total         Failed       Degraded        Healthy          Other
----------------------------------------------------------------------------------------------------------------
NODE                   10              0              0              9              1
GPFS                   10              0              0              9              1
NETWORK                10              0              0             10              0
FILESYSTEM              3              0              0              2              1
DISK                   22              0              0             22              0
CES                     6              0              0              6              0
CESCLUSTER              1              0              0              1              0
FILESYSMGR              2              0              0              2              0
GUI                     3              0              0              3              0
PERFMON                10              0              0             10              0
SCALEMGMT              10              0              0             10              0
THRESHOLD              10              0              0             10              0

Using scalectl apihealth

The scalectl apihealth command provides REST API–specific health status for native REST API processes. It is a subset of the mmhealth command and focuses only on API-related services.

Use API-health REST API or scalectl apihealth CLI to retrieve and display the current state of native REST API processes. These processes are part of the native REST API framework. Use the retrieve information to diagnose the running status in the event of cluster issues.

Each process can be in one of the following states:
  • Running
  • Shutdown
  • Error
If a process is in an Error state, additional details are available via API-health commands.

For more information, see scalectl apihealth command or API-health endpoints.

Examples

  1. The following example displays the health status by using the scalectl command:
    scalectl apihealth list

    A sample output as follows:

    
Node Number  Admin Node Name          IP Address   Service           Status   Message
=========================================================================================
  1            test-21.openstacklocal  10.0.100.01  HTTP gRPC Server  Running  healthy
                                                     REST Server       Running  healthy
                                                     UDS gRPC Server   Running  healthy
                                                     i/o gRPC Server   Running  healthy
  2            test-22.openstacklocal  10.0.100.02  HTTP gRPC Server  Running  healthy
                                                     REST Server       Running  healthy
                                                     UDS gRPC Server   Running  healthy
                                                     i/o gRPC Server   Running  healthy
  3            test-23.openstacklocal  10.0.100.03  HTTP gRPC Server  Running  healthy
                                                     REST Server       Running  healthy
                                                     UDS gRPC Server   Running  healthy
                                                     i/o gRPC Server   Running  healthy
  2. The following example displays the health status of the specified node by using the scalectl command:
    scalectl apihealth get test-21
    A sample output as follows:
    
Node Number  Admin Node Name          IP Address   Service           Status   Message
=========================================================================================
  1            test-21.openstacklocal  10.0.100.01  HTTP gRPC Server  Running  healthy
                                                     REST Server       Running  healthy
                                                     UDS gRPC Server   Running  healthy
                                                     i/o gRPC Server   Running  healthy