dashboard info

Displays a summary of information about the cluster.

Syntax

CLI 
maprcli dashboard info
        [ -cluster cluster name ]
        [ -zkconnect ZooKeeper Connect String: 'host:port,host:port,host:port,...' ]
        [ -version true|false. default: false ]
        [ -multi_cluster_info true|false. default: false ]
     -json
NOTE
The -json option is required.
REST
Request Type GET
Request URL 
http[s]://<host>:<port>/rest/dashboard/info[?<parameters>]

Parameters

Parameter

Description
cluster (Optional) The cluster on which to run the command. By default, the cluster is the one on which this command is run.
multi_cluster_info (Optional) Specifies whether to display cluster information from multiple clusters.

Values: true or false. Default: false.
version (Optional) Specifies whether to display ONLY the version of the HPE Ezmeral Data Fabric. Values: true or false. Default: false.
zkconnect (Optional) Common Parameters
json (Required) Formats the output.

Output

The following table summarizes information about the services, volumes, MapReduce applications, health, and utilization of the cluster.

Output Fields

Field

Description

timestamp

The time at which the dashboard info data is retrieved, expressed as a Unix epoch time.
timeofday The local time and date of the query.

status

The success status of the dashboard info command.

total

The number of clusters for which data is queried in the dashboard info command.

version

The data-fabric software version running on the cluster.

cluster

Determines the following information about the cluster:

  • name — the cluster name
  • secure — whether or not the cluster is secure. Value: true (if enabled) or false (if disabled)
  • dare — whether or not the cluster is enabled for data at rest encryption. Value: true (if enabled) or false (if disabled)
  • globalPolicyMaster — whether or not the cluster is the master cluster for Policy Based Security. Yes if true, and no if false. You can create security policies only from the master cluster.
  • ip — the IP address of the active CLDB
  • id — the cluster ID
  • nodesUsed — number of nodes in the cluster
  • totalNodesAllowed — number of allowed nodes

volumes

The number and size (in GiB) of volumes that are:

  • Mounted
  • Unmounted
mirrors Indicates whether this cluster is a mirror or is mirrored, and the details of the mirrors, if any.

utilization

The following summarizes utilization information:

  • CPU — utilization, total and active. CPU utilization % is calculated as (100% - idle%) on each node and then averaged across all nodes where hoststats is running.
  • Memory — total and active (in MiB).
  • Disk space — total and active (in GiB).
  • Compression — compressed and uncompressed data size
  • Tiering — following cluster-level tiering information:
    • — amount of user data stored in tiered volumes (in GiB). This amount is independent of storage system operations relative to compression, replication, or offloading to a warm (erasure-coded) or cold tier. See Understanding how physical, logicalUsed, ecOffloaded data usage is calculated for additional details.
    • replicatedLogicalUsed — amount of user data stored in tiered volumes (in GiB) multiplied by the configured replication factor for hot tier volume(s).

      This value is calculated as follows: logicalUsed by volume * number of replicas configured for the hot tier. This value does not change as file data is removed from the hot tier and erasure-coded to the warm tier.

    • replicatedTotalUsed — amount of user data (after compression, if any) and snapshot user data (after compression, if any) stored in tiered volumes (in GiB) multiplied by the configured replication factor(s) for the hot tier volume(s).

      This value is calculated as follows: (logical user data after compression used by volume + logical user data after compression in snapshots) * number of replicas configured for the hot tier . This value does not include EC-backend volumes and cache volumes since their replicatedTotalUsed is already accounted for by the front-end and parent volumes respectively.

    • metaDBUsedMB — disk space (in MiB) used by the metadata volume associated with the tier.
    • replicatedMetaDBUsedMB — disk space (in MiB) used by the metadata volume associated with the tier multiplied by the configured replication factor for the hot tier.
    • offloaded — total physical data (in GiB) offloaded to the cold tier.

      This value is calculated as follows: amount of data purged from the hot tier (HPE Ezmeral Data Fabric data-fabric cluster) + amount of data recalled to the hot tier (Data Fabric data-fabric cluster).

    • recalled — total physical data (in GiB) recalled from the cold tier.

      This value is calculated as follows: amount of data recalled to the hot tier (Data Fabric cluster) + total amount of disk space used by the cache volume.

    • cvTotalUsed — total disk space (in GiB) used by all the cache-volumes. At the volume level, for mirror volumes, this is the total size of the cache volume and its replicas.
    • replicatedCvTotalUsed — total disk space (in GiB) used by all the cache volumes and associated replicas.
    • — amount of logical user data (in GiB), after being reduced to account for compression, that has been written to the warm tier (erasure-coded).

      See Understanding how physical, logicalUsed, ecOffloaded data usage is calculated for additional details.

    • ecRecalled — total physical data (in GiB) recalled from the erasure-coded volume (warm-tier).

      This value is calculated as follows: amount of data recalled to the hot tier (Data Fabric cluster) + total amount of disk space used by the cache volume.

    • ecTotalUsed — physical storage used by the warm tier to store user data that is warm-tiered (erasure-coded).

      This value includes the disk space used by the parity fragments.
clusterReplication

The following cluster replication information:

  • bytesReceived
  • bytesSend
streamThroughput

The following stream throughput information:

  • bytesProduced
  • bytesConsumed
label_stats Information about the labels registered and assigned.

services

The number of active, stopped, failed, and total installed services on the cluster, for example:

  • API server
  • CLDB
  • Fileserver
  • File Migrate
  • ResourceManager
  • NodeManager
  • NFSv4
  • hoststats
  • MAST Gateway

Understanding how physical, logicalUsed, ecOffloaded data usage is calculated

Data usage calculations for physical, logicalUsed, and ecOffloaded can be calculated as shown in the following uncompressed and compressed scenarios.

Scenario:

There are two tiered volumes in a system (Vol3x and Vol6x), and:
  • Vol3x is 3x replicated in the hot tier that uses 10+2 erasure coding
  • Vol6x is 6x replicated in the hot tier that uses 4+2 erasure coding
If you write a 100GiB file uncompressed to each volume, for the two volumes:
logicalUsed = 200 100GiB+100GiB=200GiB
replicatedLogicalUsed = 900 3*100GiB + 6*100GiB = 900GiB
replicatedTotalUsed = 900

For 3x replicated volume: 3*(100/1)=300GiB

For 6x replicated volume: 6*(100/1)=600GiB
ecOffloaded = 0 Nothing is offloaded to the warm tier.
ecTotalUsed = 0 Nothing is offloaded to the warm tier.
If you offload both volumes to the warm tier:
logicalUsed = 200 200GiB
replicatedLogicalUsed = 900 Note that file data no longer resides on the hot tier, and physical disk space is not consumed. After it is offloaded, this number reflects the metadata of files that previously resided on the hot tier.
replicatedTotalUsed = 900 Note that file data no longer resides on the hot tier, and physical disk space is not consumed. After it is offloaded, this number reflects the metadata of files that previously resided on the hot tier.
ecOffloaded = 200 100GiB+100GiB=200GiB
ecTotalUsed = 270 [100GiB * (10+2)/10] + [100GiB * (4+2)/4] = 120GiB + 150GiB = 270GiB
If the 100GiB of logical data in Vol3x and Vol6x is compressed by a factor of 4:1 and writes a100GiB file to each volume:
logicalUsed = 200 100GiB+100GiB=200GiB
replicatedLogicalUsed = 900 (3*100GiB) + (6*100GiB)=900GiB
replicatedTotalUsed = 225

For 3x replicated volume: 3*(100/4)=75GiB

For 6x replicated volume: 6(100/4)=150GiB
ecOffloaded = 0 Nothing is offloaded to the warm tier.
ecTotalUsed = 0 Nothing is offloaded to the warm tier.
If you offload both volumes to the warm tier:
logicalUsed equals 200GiB
replicatedLogicalUsed = 900 Note that file data no longer resides on the hot tier, and physical disk space is not consumed. After it is offloaded, this number reflects the metadata of files that previously resided on the hot tier.
replicatedTotalUsed = 900 Note that file data no longer resides on the hot tier, and physical disk space is not consumed. After it is offloaded, this number reflects the metadata of files that previously resided on the hot tier.
ecOffloaded = 50 (100GiB+100GiB)/4=50GiB
ecTotalUsed = 68 (100GiB/4) * ((10+2)/10) + (100GiB/4) * ((4+2)/4) = 30GiB+37.5GiB = 67.5GiB

Examples

Display dashboard information:

CLI 
maprcli dashboard info -json
{
	 "timestamp":1599138960056,
        "timeofday":"2020-09-03 06:16:00.056 GMT-0700 AM",
        "status":"OK",
        "total":1,
        "data":[
                {
                        "version":"6.2.0.0.20200823204949.GA",
                        "cluster":{
                                "name":"my.cluster.com",
                                "secure":true,
                                "dare":false,
                                "globalPolicyMaster":true,
                                "ip":"10.163.167.212",
                                "id":"2812007637544940359",
                                "nodesUsed":1,
                                "totalNodesAllowed":-1
                        },
                        "volumes":{
                                "mounted":{
                                        "total":17,
                                        "size":6605
                                },
                                "unmounted":{
                                        "total":2,
                                        "size":1
                                }
                        },
                        "mirrors":{
                                "num jobs":0,
                                "active containers":0,
                                "resync containers":0,
                                "mirrored datasize mb":0,
                                "remaining datasize mb":0,
                                "completion pcnt":0
                        },
                        "utilization":{
                                "cpu":{
                                        "util":21,
                                        "total":8,
                                        "active":1
                                },
                                "memory":{
                                        "total":23911,
                                        "active":23075
                                },
                                "disk_space":{
                                        "total":287,
                                        "active":6
                                },
                                "compression":{
                                        "compressed":6,
                                        "uncompressed":6
                                },
                                "tiering":{
                                        "logicalUsed":0,
                                        "replicatedLogicalUsed":0,
                                        "replicatedTotalUsed":0,
                                        "metaDBUsedMB":0,
                                        "replicatedMetaDBUsedMB":0,
                                        "offloaded":0,
                                        "recalled":0,
                                        "cvTotalUsed":0,
                                        "replicatedCvTotalUsed":0,
                                        "ecOffloaded":0,
                                        "ecRecalled":0,
                                        "ecTotalUsed":0
                                }
                        },
                        "clusterReplication":{
                                "bytesReceived":0,
                                "bytesSend":0
                        },
                        "streamThroughput":{
                                "bytesProduced":46746456005,
                                "bytesConsumed":46748653475
                        },
                        "labels_stats":[
                                {
                                        "label":"ssd",
                                        "label_id":0,
                                        "total_size":294465,
                                        "used":7045,
                                        "num_sps":1,
                                        "num_volumes":19
                                },
                                {
                                        "label":"anywhere",
                                        "label_id":2147483647,
                                        "total_size":0,
                                        "used":0,
                                        "num_sps":0,
                                        "num_volumes":0
                                }
                        ],
                        "services":{
                                "hbaserest":{
                                        "active":1,
                                        "stopped":0,
                                        "failed":0,
                                        "total":1
                                },
                                "hbasethrift":{
                                        "active":1,
                                        "standby":0,
                                        "stopped":0,
                                        "failed":0,
                                        "total":1
                                },
                                "fileserver":{
                                        "active":1,
                                        "stopped":0,
                                        "failed":0,
                                        "total":1
                                },
                                "grafana":{
                                        "active":1,
                                        "stopped":0,
                                        "failed":0,
                                        "total":1
                                },
                                "cldb":{
                                        "active":1,
                                        "stopped":0,
                                        "failed":0,
                                        "total":1
                                },
                                "mastgateway":{
                                        "active":1,
                                        "stopped":0,
                                        "failed":0,
                                        "total":1
                                },
                                "opentsdb":{
                                        "active":1,
                                        "stopped":0,
                                        "failed":0,
                                        "total":1
                                },
                                "gateway":{
                                        "active":1,
                                        "stopped":0,
                                        "failed":0,
                                        "total":1
                                },
                                "hoststats":{
                                        "active":1,
                                        "stopped":0,
                                        "failed":0,
                                        "total":1
                                },
                                "collectd":{
                                        "active":1,
                                        "stopped":0,
                                        "failed":0,
                                        "total":1
                                },
                                "apiserver":{
                                        "active":1,
                                        "stopped":0,
                                        "failed":0,
                                        "total":1
                                }
                        }
                }
        ]
}
REST 
curl -u <username> -X GET https://server.sj.us:8443/rest/dashboard/info

View the master security policy cluster:

CLI 
maprcli dashboard info -json | grep globalPolicyMaster
   {
      "globalPolicyMaster":true
   }