dashboard info

Displays a summary of information about the cluster.

Syntax

CLI

/opt/mapr/bin/maprcli dashboard info
    [ -cluster <cluster name> ]
    [ -multi_cluster_info true|false]
    [ -version true|false ]
    [ -zkconnect <ZooKeeper connect string> ] 
    -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`	The cluster on which to run the command. By default, the cluster is the local cluster.
`multi_cluster_info`	Specifies whether to display cluster information from multiple clusters. Values: `true` or `false`. Default: `false`.
`version`	Specifies whether to display the version. Values: `true` or `false`. Default: `false`.
`zkconnect`	Common Parameters
`json`	Formats the output.

Output

A summary of 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 was 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 was 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 the cluster is secure or not. Value: `true` (if enabled) or `false` (if disabled) `dare` — whether the cluster is enabled for data at rest encryption or not. Value: `true` (if enabled) or `false` (if disabled) `globalPolicyMaster` — whether 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 GB) of volumes that are: Mounted Unmounted
utilization	The following 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 MB. Disk space — total and active in GB. Compression — compressed and uncompressed data size Tiering — following cluster level tiering information: `logicalUsed` — The total gigabytes of disk space used (before compression) for the tiered volumes in the cluster. This value does not include erasure-coded backend volumes and cache-volumes. `replicatedLogicalUsed` — The logical size in gigabytes, of disk used by the tiered volumes and all associated replicas. This value is calculated as follows: disk space (before compression) used by volume number of replicas. This value does not include erasure-coded backend volumes and cache-volumes. `replicatedTotalUsed` — The total space after compression (in GB) used by tiered volumes and associated snapshots and replicas. This value is calculated as follows: total space used by volume * number of replicas. 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` — The disk space (in MB) used by the metadata volume associated with the tier. `replicatedMetaDBUsedMB` — The disk space (in MB) used by the replicas of the metadata volume associated with the tier. `offloaded` — The total physical data (in GB) offloaded to the cold tier. This value is calculated as follows: amount of data purged from the hot tier (data-fabric cluster) + amount of data recalled to the hot tier (data-fabric cluster). `recalled` — The total physical data (in GB) 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` — The total disk space (in GB) 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` — The total disk space (in GB) used by all the cache-volumes and associated replicas. `ecOffloaded` — The total physical data (in GB) offloaded to the erasure-coded volume (warm tier). This value is calculated as follows: amount of data purged from the hot tier (data-fabric cluster) + amount of data recalled to the hot tier (data-fabric cluster). `ecRecalled` — The total physical data (in GB) 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` — The total space after compression (in GB) used by the erasure coded volumes. 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
yarn	The following mapreduce information: Running applications Queued applications Number of NodeManagers Total memory Total VCores Total disks Used memory Used VCores Used disks

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 mapr:mapr -X GET  -k "https://host:8443/rest/dashboard/info"
{"timestamp":1599139171576,"timeofday":"2020-09-03 06:19:31.576 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":6659},"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":30,"total":8,"active":2},"memory":{"total":23911,"active":23166},"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":46802771481,"bytesConsumed":46804959666},"labels_stats":[{"label":"ssd","label_id":0,"total_size":294465,"used":7098,"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}}}]}

View the master security policy cluster:

CLI

/opt/mapr/bin/maprcli dashboard info -json | grep globalPolicyMaster
   {
      "globalPolicyMaster":true
   }