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.
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 MapR 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)
  • 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 (MapR cluster) + amount of data recalled to the hot tier (MapR 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 (MapR 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 (MapR cluster) + amount of data recalled to the hot tier (MapR 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 (MapR 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

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

Sample Output

# /opt/mapr/bin/maprcli dashboard info -json
{
	"timestamp":1555484566822,
	"timeofday":"2019-04-17 12:02:46.822 GMT-0700 AM",
	"status":"OK",
	"total":1,
	"data":[
		{
			"version":"6.1.9.20190416114817.GA",
			"cluster":{
				"name":"myCluster",
				"secure":true,
				"dare":true,
                           
				"ip":"10.10.82.29",
				"id":"677116233136630791",
				"nodesUsed":1,
				"totalNodesAllowed":-1
			},
			"volumes":{
				"mounted":{
					"total":17,
					"size":0
				},
				"unmounted":{
					"total":1,
					"size":1
				}
			},
			"utilization":{
				"cpu":{
					"util":20,
					"total":8,
					"active":1
				},
				"memory":{
					"total":23947,
					"active":10587
				},
				"disk_space":{
					"total":272,
					"active":0
				},
				"compression":{
					"compressed":0,
					"uncompressed":0
				},
				"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":0,
				"bytesConsumed":0
			},
			"services":{
				"fileserver":{
					"active":1,
					"stopped":0,
					"failed":0,
					"total":1
				},
				"resourcemanager":{
					"active":1,
					"standby":0,
					"stopped":0,
					"failed":0,
					"total":1
				},
				"filemigrate":{
					"active":0,
					"standby":0,
					"stopped":0,
					"failed":1,
					"total":1
				},
				"cldb":{
					"active":1,
					"stopped":0,
					"failed":0,
					"total":1
				},
				"nfs4":{
					"active":1,
					"stopped":0,
					"failed":0,
					"total":1
				},
				"mastgateway":{
					"active":1,
					"stopped":0,
					"failed":0,
					"total":1
				},
				"nodemanager":{
					"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
				},
				"apiserver":{
					"active":1,
					"stopped":0,
					"failed":0,
					"total":1
				}
			},
			"yarn":{
				"running_applications":0,
				"queued_applications":0,
				"num_node_managers":1,
				"total_memory_mb":5120,
				"total_vcores":4,
				"total_disks":3,
				"used_memory_mb":0,
				"used_vcores":0,
				"used_disks":0
			}
		}
	]
}

Examples

Display dashboard information:

CLI
# maprcli dashboard info -json
{
	"timestamp":1555484566822,
	"timeofday":"2019-04-17 12:02:46.822 GMT-0700 AM",
	"status":"OK",
	"total":1,
	"data":[
		{
			"version":"6.1.9.20190416114817.GA",
			"cluster":{
				"name":"myCluster",
				"secure":true,
				"dare":true,
			    
				"ip":"10.10.82.29",
				"id":"677116233136630791",
				"nodesUsed":1,
				"totalNodesAllowed":-1
			},
			"volumes":{
				"mounted":{
					"total":17,
					"size":0
				},
				"unmounted":{
					"total":1,
					"size":1
				}
			},
			"utilization":{
				"cpu":{
					"util":20,
					"total":8,
					"active":1
				},
				"memory":{
					"total":23947,
					"active":10587
				},
				"disk_space":{
					"total":272,
					"active":0
				},
				"compression":{
					"compressed":0,
					"uncompressed":0
				},
				"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":0,
				"bytesConsumed":0
			},
			"services":{
				"fileserver":{
					"active":1,
					"stopped":0,
					"failed":0,
					"total":1
				},
				"resourcemanager":{
					"active":1,
					"standby":0,
					"stopped":0,
					"failed":0,
					"total":1
				},
				"filemigrate":{
					"active":0,
					"standby":0,
					"stopped":0,
					"failed":1,
					"total":1
				},
				"cldb":{
					"active":1,
					"stopped":0,
					"failed":0,
					"total":1
				},
				"nfs4":{
					"active":1,
					"stopped":0,
					"failed":0,
					"total":1
				},
				"mastgateway":{
					"active":1,
					"stopped":0,
					"failed":0,
					"total":1
				},
				"nodemanager":{
					"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
				},
				"apiserver":{
					"active":1,
					"stopped":0,
					"failed":0,
					"total":1
				}
			},
			"yarn":{
				"running_applications":0,
				"queued_applications":0,
				"num_node_managers":1,
				"total_memory_mb":5120,
				"total_vcores":4,
				"total_disks":3,
				"used_memory_mb":0,
				"used_vcores":0,
				"used_disks":0
			}
		}
	]
}
REST
curl -u mapr:mapr -X GET  -k "https://host:8443/rest/dashboard/info"
{"timestamp":1555491565658,"timeofday":"2019-04-17 01:59:25.658 GMT-0700 AM","status":"OK","total":1,"data":[{"version":"6.1.9.20190416114817.GA","cluster":{"name":"myCluster","secure":true,"dare":true,"globalPolicyMaster":true,"ip":"10.10.82.29","id":"677116233136630791","nodesUsed":1,"totalNodesAllowed":-1},"volumes":{"mounted":{"total":17,"size":1},"unmounted":{"total":1,"size":1}},"utilization":{"cpu":{"util":1,"total":8,"active":0},"memory":{"total":23947,"active":10582},"disk_space":{"total":272,"active":0},"compression":{"compressed":0,"uncompressed":0},"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":0,"bytesConsumed":0},"services":{}}]}