.. _Monitoring Cluster Status:

Monitoring Cluster Status
-------------------------

You can use the ``shaman top`` and ``shaman stat`` commands to monitor the overall status of a cluster and cluster resources. The ``shaman stat`` command shows a snapshot of the current cluster status and clustering resources while ``shaman top`` displays a dynamic real-time view of the cluster. The following shows an example output of the ``shaman stat`` command:

::

    # shaman stat
    Cluster 'vstor1'
    Nodes: 3
    Resources: 8

            NODE_IP          STATUS         RESOURCES
          M 10.30.24.176    Active          0 CT, 0 VM, 1 ISCSI
         *  10.30.25.33     Active          1 CT, 3 VM, 1 ISCSI
            10.30.26.26     Active          0 CT, 0 VM, 2 ISCSI

            CT ID    STATE     STATUS       OWNER_IP         PRIORITY
            101      stopped   Active       10.30.25.33      0

            VM NAME  STATE     STATUS       OWNER_IP        PRIORITY
            vm1      stopped   Active       10.30.25.33     0
            vm2      running   Active       10.30.25.33     0
            vm3      stopped   Active       10.30.25.33     0

            ISCSI ID                STATE    STATUS   OWNER_IP         PRIORITY
    iqn.2014-04.com.pstorage:ps1    running  Active   10.30.24.176     0
    iqn.2014-04.com.pstorage:ps2    running  Active   10.30.25.33      0
    iqn.2014-04.com.pstorage:ps3    running  Active   10.30.26.26      0

The table below explains all output fields:

+--------------------+--------------------------------------------------------+
| Field              | Description                                            |
+====================+========================================================+
| Cluster            | Name of the cluster.                                   |
|                    |                                                        |
|                    | The "M" next to the server denotes that the server is  |
|                    | the main server in the cluster (called the master      |
|                    | server), and the asterisk (\*) indicates the server    |
|                    | where the ``shaman stat`` command was executed.        |
+--------------------+--------------------------------------------------------+
| Nodes              | Number of servers with enabled HA support in the       |
|                    | cluster.                                               |
+--------------------+--------------------------------------------------------+
| Resources          | Number of resources ``shaman`` keeps control of.       |
+--------------------+--------------------------------------------------------+
| NODE_IP            | IP address assigned to the server.                     |
+--------------------+--------------------------------------------------------+
| STATUS             | Server status. It can be one of the following:         |
|                    |                                                        |
|                    | -  Active. The server is up and running and controlled |
|                    |    by ``shaman``.                                      |
|                    |                                                        |
|                    | -  Inactive. The server is up and running, but         |
|                    |    ``shaman`` does not control the server (e.g., the   |
|                    |    ``shamand`` service is stopped).                    |
+--------------------+--------------------------------------------------------+
| RESOURCES          | Resources hosted on the server.                        |
+--------------------+--------------------------------------------------------+
| CT ID              | Container ID.                                          |
+--------------------+--------------------------------------------------------+
| VM NAME            | Virtual machine name.                                  |
+--------------------+--------------------------------------------------------+
| ISCSI ID           | iSCSI target name.                                     |
+--------------------+--------------------------------------------------------+
| STATE              | Denotes whether the virtual machine/container is       |
|                    | running or stopped.                                    |
+--------------------+--------------------------------------------------------+
| STATUS             | HA status of the virtual machine, container, or iSCSI  |
|                    | target (as reported by ``shaman``). It can be one of   |
|                    | the following:                                         |
|                    |                                                        |
|                    | -  Active. Healthy virtual machines, containers, or    |
|                    |    iSCSI targets hosted in the cluster.                |
|                    |                                                        |
|                    | -  Broken. Virtual machines, containers, or iSCSI      |
|                    |    targets that could not be relocated from a failed   |
|                    |    server to a healthy one.                            |
|                    |                                                        |
|                    | -  Pool. Virtual machines, containers, or iSCSI        |
|                    |    targets waiting for relocation from a failed server |
|                    |    to a healthy one.                                   |
+--------------------+--------------------------------------------------------+
| OWNER_IP           | IP address of the server where the virtual machine,    |
|                    | container, or iSCSI target is hosted.                  |
+--------------------+--------------------------------------------------------+
| PRIORITY           | Current priority of the virtual machine/container. For |
|                    | details, see :ref:`Configuring HA Priority For         |
|                    | Virtual Machines And Containers`.                      |
+--------------------+--------------------------------------------------------+

The output of the ``shaman top`` command is similar to that of ``shaman stat``. Additionally, you can use keyboard keys to change the command output on the fly. The following keys are supported:

-  g: Group or ungroup resources by their status.

-  v: Show or hide additional information.

-  ENTER or SPACE: Update the screen.

-  q or Esc or CTRL-C: Quit.

-  h: Show the help screen.

