volume tierstats

Retrieves statistics on the offload and recall operation.

Permissions Required

The user running the command must have one of the following:

  • Full control (fc) on the cluster or volume
  • Volume edit permissions

Syntax

CLI
maprcli volume tierstats
            [ -cluster cluster_name ]
            -name <volume_name>
REST
Request Type GET
Request URL 
http[s]://<host>:<port>/rest/volume/tierstats?<parameters>

Parameters

Parameter

Description
cluster The name of the cluster on which to run the command.
name The name of the volume.

Output

The command returns the following:

offloadThroughput The amount of data (in MB) offloaded per second.
totalTierDataSize The total size of tiered data (in MB).
totalTierReclaimableSize The size of deleted data (in MB) that is under the compaction operation threshold.
recallThroughput The amount of data (in MB) recalled per second.

Example

Retrieve statistics for a volume specified by name:

# /opt/mapr/bin/maprcli volume tierstats -name sampleVol -json
{
	"timestamp":1520275614872,
	"timeofday":"2018-03-05 06:46:54.872 GMT+0000",
	"status":"OK",
	"total":1,
	"data":[
		{
			"totalTierDataSize":"404.323 MB",
			"offloadThroughput":"17.063 MB/s",
			"recallThroughput":"14.071 MB/s"
		}
	]
}
curl -X GET 'https://server.sj.us:8443/rest/volume/tierstats?name=sampleVol' --user <username>:<password>
{"timestamp":1520275614872,"timeofday":"2018-03-05 06:46:54.872 GMT+0000","status":"OK","total":1,"data":[{"totalTierDataSize":"404.323 MB","offloadThroughput":"17.063 MB/s","recallThroughput":"14.071 MB/s"}]}

Retrieve statistics for a volume after a compaction operation:

# maprcli volume tierstats -name test1 -json
{
    	"timestamp":1527048672887,
    	"timeofday":"2018-05-23 04:11:12.887 GMT+0000 AM",
    	"status":"OK",
    	"total":1,
    	"data":[
            	{
                    	"totalTierDataSize":"3001.926 MB",
                    	"totalTierReclaimableSize":"100 MB",
                    	"offloadThroughput":"31.064 MB/s"
            	}
    	]
}
curl -X GET 'https://server.sj.us:8443/rest/volume/tierstatus?name=test1' --user <username>:<password>
{"timestamp":1527048672887,"timeofday":"2018-05-23 04:11:12.887 GMT+0000 AM","status":"OK","total":1,"data":[{"totalTierDataSize":"3001.926 MB","totalTierReclaimableSize":"100 MB","offloadThroughput":"31.064 MB/s"}]}