|
GET/POST |
http://yourserver.com/services/system/metrics |
Cluster and node metrics are provided on the Server Status page in the Management Console, but can also be retrieved as a JSON block from the metrics API (which is where the page gets its data from).
Result
The JSON result is made up of a "cluster" object and a "nodes" array of objects which correspond to each of your nodes. Below you will find an example of a single-node cluster's metrics JSON response.
{
"cluster": {
"licenseStatus": {
"customer": "example",
"serverStatus": {
"type": "ElvisServerUltimate600"
}
},
"name": "ElvisDAM",
"nodesCount": 1,
"processing": {
"inProcessCountCluster": 0,
"processingHealth": "GREEN",
"queueSizePerPriority": {
"URGENT": 0,
"HIGH": 0,
"MEDIUM": 0,
"LOW": 0
},
"queueTotalSize": 0
},
"state": "UNINITIALIZED",
"storage": {
"sharedVolumeStatuses": [
{
"name": "/",
"totalSpace": "930.6 GB",
"freeSpace": "111.5 GB",
"usableSpace": "111.3 GB",
"healthReasons": {
"reasons": [],
"health": "GREEN"
}
}
]
},
"timeStarted": null,
"uptime": null
},
"nodes": [
{
"health": null,
"ip": "123.45.67.89",
"jobRunner": {
"scheduledJobs": {
"/folder_import": {
"pluginId": "/folder_import",
"activated": false,
"status": "Manual",
"totalExecutionCount": 0,
"failCount": 0,
"running": false,
"lastOutcomeOk": true
},
"/internal/version_cleanup": {
"pluginId": "/internal/version_cleanup",
"activated": true,
"status": "Scheduled",
"lastOutcome": "Executed successfully",
"totalExecutionCount": 91,
"failCount": 0,
"running": false,
"nextFireTime": 1555661760000,
"lastOutcomeOk": true
},
"/ww_enterprise_import": {
"pluginId": "/ww_enterprise_import",
"activated": false,
"status": "Scheduled",
"totalExecutionCount": 312,
"failCount": 15,
"running": false,
"nextFireTime": 1555658260000,
"lastOutcomeOk": true
}
}
},
"name": "ELVIS_example_node",
"processing": {
"inProcessCount": 0,
"inProcessRequests": [],
"processStatus": {
"runningProcesses": 0,
"heavyProcesses": 0,
"exclusiveHeavyProcesses": 0,
"processes": [],
"history": [
{
"id": "ATwMleC0aA98F_9luLeSPj",
"name": "Plugin /internal/version_cleanup",
"load": "NORMAL",
"user": "server",
"cancelable": false,
"state": "COMPLETED",
"progress": -1,
"total": -1,
"errorCount": -1,
"displayState": "COMPLETED, time spent: less than a second",
"estimateTimeRemaining": "done",
"done": true
},
{
"id": "ETGckyJaKtvANZZMmbp8w9",
"name": "RemoveVersionsByQuery",
"load": "NORMAL",
"user": "server",
"cancelable": false,
"state": "COMPLETED",
"progress": 0,
"total": 0,
"errorCount": -1,
"displayState": "COMPLETED, time spent: less than a second",
"estimateTimeRemaining": "done",
"done": true
},
{
"id": "3XiVM_EcqtrBCcOdKC_pd6",
"name": "Plugin /internal/version_cleanup",
"load": "NORMAL",
"user": "server",
"cancelable": false,
"state": "COMPLETED",
"progress": -1,
"total": -1,
"errorCount": -1,
"displayState": "COMPLETED, time spent: less than a second",
"estimateTimeRemaining": "done",
"done": true
},
{
"id": "9wHQ3pR74TUAfwxHZyA2nd",
"name": "RemoveVersionsByQuery",
"load": "NORMAL",
"user": "server",
"cancelable": false,
"state": "COMPLETED",
"progress": 0,
"total": 0,
"errorCount": -1,
"displayState": "COMPLETED, time spent: less than a second",
"estimateTimeRemaining": "done",
"done": true
},
{
"id": "1IaUfoa543F9l_NiVoLt3I",
"name": "Plugin /internal/version_cleanup",
"load": "NORMAL",
"user": "server",
"cancelable": false,
"state": "COMPLETED",
"progress": -1,
"total": -1,
"errorCount": -1,
"displayState": "COMPLETED, time spent: less than a second",
"estimateTimeRemaining": "done",
"done": true
},
{
"id": "7p0xFHHWKu9BLfQj4l4Vuq",
"name": "RemoveVersionsByQuery",
"load": "NORMAL",
"user": "server",
"cancelable": false,
"state": "COMPLETED",
"progress": 0,
"total": 0,
"errorCount": -1,
"displayState": "COMPLETED, time spent: less than a second",
"estimateTimeRemaining": "done",
"done": true
},
{
"id": "DK8V0su1atZB3TAfM1zMVe",
"name": "Plugin /internal/version_cleanup",
"load": "NORMAL",
"user": "server",
"cancelable": false,
"state": "COMPLETED",
"progress": -1,
"total": -1,
"errorCount": -1,
"displayState": "COMPLETED, time spent: less than a second",
"estimateTimeRemaining": "done",
"done": true
},
{
"id": "1jIv2qgd40F8KlvBwCTE31",
"name": "RemoveVersionsByQuery",
"load": "NORMAL",
"user": "server",
"cancelable": false,
"state": "COMPLETED",
"progress": 0,
"total": 0,
"errorCount": -1,
"displayState": "COMPLETED, time spent: less than a second",
"estimateTimeRemaining": "done",
"done": true
},
{
"id": "8vPnnFEVaJx9a2cHmRyOm1",
"name": "Plugin /internal/version_cleanup",
"load": "NORMAL",
"user": "server",
"cancelable": false,
"state": "COMPLETED",
"progress": -1,
"total": -1,
"errorCount": -1,
"displayState": "COMPLETED, time spent: less than a second",
"estimateTimeRemaining": "done",
"done": true
},
{
"id": "5NJwgo_L48MAwsWStuOiqZ",
"name": "RemoveVersionsByQuery",
"load": "NORMAL",
"user": "server",
"cancelable": false,
"state": "COMPLETED",
"progress": 0,
"total": 0,
"errorCount": -1,
"displayState": "COMPLETED, time spent: less than a second",
"estimateTimeRemaining": "done",
"done": true
},
{
"id": "5nwsljJ5aFMBYeceQG1ZmC",
"name": "Plugin /internal/version_cleanup",
"load": "NORMAL",
"user": "server",
"cancelable": false,
"state": "COMPLETED",
"progress": -1,
"total": -1,
"errorCount": -1,
"displayState": "COMPLETED, time spent: less than a second",
"estimateTimeRemaining": "done",
"done": true
},
{
"id": "Eox5gJO_a0S8V1qVXzuJ3k",
"name": "RemoveVersionsByQuery",
"load": "NORMAL",
"user": "server",
"cancelable": false,
"state": "COMPLETED",
"progress": 0,
"total": 0,
"errorCount": -1,
"displayState": "COMPLETED, time spent: less than a second",
"estimateTimeRemaining": "done",
"done": true
}
]
},
"processedRequests": [
"icon.jpg (createPreview, priority: HIGH) - 21f55c4a978eb5daa7beefdbb3570b06_createPreview_maxWidth_20_maxHeight_20_ppi_300_quality_100.jpg",
"icon.jpg (createThumbnailAndDefaultPreviews, priority: LOW) - 21f55c4a978eb5daa7beefdbb3570b06_createThumbnailAndDefaultPreviews",
"icon.jpg (extractMetadata, priority: URGENT) - f0be59f3fbdb8db6c8e298de0d42d2c9_extractMetadata"
]
},
"serverLoadStats": [
{
"minutePeakRate": 0,
"label": "Searches",
"lastHourTimeline": [
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0
],
"minuteRate": 0,
"lastHourAvgMinuteRate": 0
},
{
"minutePeakRate": 0,
"label": "Assets created",
"lastHourTimeline": [
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0
],
"minuteRate": 0,
"lastHourAvgMinuteRate": 0
},
{
"minutePeakRate": 0,
"label": "Metadata changes",
"lastHourTimeline": [
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0
],
"minuteRate": 0,
"lastHourAvgMinuteRate": 0
},
{
"minutePeakRate": 0,
"label": "Thumbnails downloaded",
"lastHourTimeline": [
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0
],
"minuteRate": 0,
"lastHourAvgMinuteRate": 0
},
{
"minutePeakRate": 0,
"label": "Previews downloaded",
"lastHourTimeline": [
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0
],
"minuteRate": 0,
"lastHourAvgMinuteRate": 0
},
{
"minutePeakRate": 0,
"label": "Originals downloaded",
"lastHourTimeline": [
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0
],
"minuteRate": 0,
"lastHourAvgMinuteRate": 0
}
],
"storage": {
"cacheStatistics": [
{
"name": "assetCache",
"averageGetTimeMillis": 0.0,
"cacheHitCount": 4340,
"cacheMissCount": 482,
"cacheMissCountExpired": 0,
"inMemorySize": 443,
"onDiskSize": 0,
"size": 443,
"putCount": 4099,
"updateCount": 3637,
"evictedCount": 0,
"expiredCount": 0
},
{
"name": "cdpOutputCache",
"averageGetTimeMillis": 0.0,
"cacheHitCount": 0,
"cacheMissCount": 0,
"cacheMissCountExpired": 0,
"inMemorySize": 0,
"onDiskSize": 0,
"size": 0,
"putCount": 0,
"updateCount": 0,
"evictedCount": 0,
"expiredCount": 0
},
{
"name": "dngCache",
"averageGetTimeMillis": 0.0,
"cacheHitCount": 0,
"cacheMissCount": 0,
"cacheMissCountExpired": 0,
"inMemorySize": 0,
"onDiskSize": 0,
"size": 0,
"putCount": 0,
"updateCount": 0,
"evictedCount": 0,
"expiredCount": 0
},
{
"name": "dngPreviewCache",
"averageGetTimeMillis": 0.0,
"cacheHitCount": 0,
"cacheMissCount": 0,
"cacheMissCountExpired": 0,
"inMemorySize": 0,
"onDiskSize": 0,
"size": 0,
"putCount": 0,
"updateCount": 0,
"evictedCount": 0,
"expiredCount": 0
},
{
"name": "icmlDocCache",
"averageGetTimeMillis": 0.0,
"cacheHitCount": 0,
"cacheMissCount": 0,
"cacheMissCountExpired": 0,
"inMemorySize": 0,
"onDiskSize": 0,
"size": 0,
"putCount": 0,
"updateCount": 0,
"evictedCount": 0,
"expiredCount": 0
},
{
"name": "incxDocCache",
"averageGetTimeMillis": 0.0,
"cacheHitCount": 0,
"cacheMissCount": 0,
"cacheMissCountExpired": 0,
"inMemorySize": 0,
"onDiskSize": 0,
"size": 0,
"putCount": 0,
"updateCount": 0,
"evictedCount": 0,
"expiredCount": 0
},
{
"name": "localFileCache",
"averageGetTimeMillis": 0.0,
"cacheHitCount": 0,
"cacheMissCount": 0,
"cacheMissCountExpired": 0,
"inMemorySize": 0,
"onDiskSize": 0,
"size": 0,
"putCount": 0,
"updateCount": 0,
"evictedCount": 0,
"expiredCount": 0
},
{
"name": "messageCache",
"averageGetTimeMillis": 0.0,
"cacheHitCount": 26,
"cacheMissCount": 2,
"cacheMissCountExpired": 0,
"inMemorySize": 2,
"onDiskSize": 2,
"size": 2,
"putCount": 28,
"updateCount": 26,
"evictedCount": 0,
"expiredCount": 0
},
{
"name": "pdfInfoCache",
"averageGetTimeMillis": 0.0,
"cacheHitCount": 0,
"cacheMissCount": 0,
"cacheMissCountExpired": 0,
"inMemorySize": 0,
"onDiskSize": 0,
"size": 0,
"putCount": 0,
"updateCount": 0,
"evictedCount": 0,
"expiredCount": 0
},
{
"name": "ruleCache",
"averageGetTimeMillis": 0.0,
"cacheHitCount": 0,
"cacheMissCount": 4,
"cacheMissCountExpired": 0,
"inMemorySize": 4,
"onDiskSize": 0,
"size": 4,
"putCount": 4,
"updateCount": 0,
"evictedCount": 0,
"expiredCount": 0
},
{
"name": "securityCache",
"averageGetTimeMillis": 0.0,
"cacheHitCount": 22285,
"cacheMissCount": 27,
"cacheMissCountExpired": 4,
"inMemorySize": 2,
"onDiskSize": 0,
"size": 2,
"putCount": 13,
"updateCount": 0,
"evictedCount": 0,
"expiredCount": 4
},
{
"name": "subscriptionPrice",
"averageGetTimeMillis": 0.0,
"cacheHitCount": 0,
"cacheMissCount": 0,
"cacheMissCountExpired": 0,
"inMemorySize": 0,
"onDiskSize": 0,
"size": 0,
"putCount": 0,
"updateCount": 0,
"evictedCount": 0,
"expiredCount": 0
},
{
"name": "subscriptionUsage",
"averageGetTimeMillis": 0.0,
"cacheHitCount": 0,
"cacheMissCount": 0,
"cacheMissCountExpired": 0,
"inMemorySize": 0,
"onDiskSize": 0,
"size": 0,
"putCount": 0,
"updateCount": 0,
"evictedCount": 0,
"expiredCount": 0
},
{
"name": "unoconvOutputCache",
"averageGetTimeMillis": 0.0,
"cacheHitCount": 0,
"cacheMissCount": 0,
"cacheMissCountExpired": 0,
"inMemorySize": 0,
"onDiskSize": 0,
"size": 0,
"putCount": 0,
"updateCount": 0,
"evictedCount": 0,
"expiredCount": 0
},
{
"name": "woodstockPermissions",
"averageGetTimeMillis": 0.0,
"cacheHitCount": 0,
"cacheMissCount": 0,
"cacheMissCountExpired": 0,
"inMemorySize": 0,
"onDiskSize": 0,
"size": 0,
"putCount": 0,
"updateCount": 0,
"evictedCount": 0,
"expiredCount": 0
},
{
"name": "wweaDocCache",
"averageGetTimeMillis": 0.0,
"cacheHitCount": 0,
"cacheMissCount": 0,
"cacheMissCountExpired": 0,
"inMemorySize": 0,
"onDiskSize": 0,
"size": 0,
"putCount": 0,
"updateCount": 0,
"evictedCount": 0,
"expiredCount": 0
},
{
"name": "wwrcOutputCache",
"averageGetTimeMillis": 0.0,
"cacheHitCount": 0,
"cacheMissCount": 0,
"cacheMissCountExpired": 0,
"inMemorySize": 0,
"onDiskSize": 0,
"size": 0,
"putCount": 0,
"updateCount": 0,
"evictedCount": 0,
"expiredCount": 0
},
{
"name": "xmlDocCache",
"averageGetTimeMillis": 0.0,
"cacheHitCount": 0,
"cacheMissCount": 0,
"cacheMissCountExpired": 0,
"inMemorySize": 0,
"onDiskSize": 0,
"size": 0,
"putCount": 0,
"updateCount": 0,
"evictedCount": 0,
"expiredCount": 0
},
{
"name": "xmpMetaCache",
"averageGetTimeMillis": 0.0,
"cacheHitCount": 0,
"cacheMissCount": 2,
"cacheMissCountExpired": 0,
"inMemorySize": 0,
"onDiskSize": 0,
"size": 0,
"putCount": 1,
"updateCount": 0,
"evictedCount": 0,
"expiredCount": 1
}
],
"volumeStatuses": [
{
"name": "/",
"totalSpace": "930.6 GB",
"freeSpace": "111.5 GB",
"usableSpace": "111.3 GB",
"healthReasons": {
"reasons": [],
"health": "GREEN"
}
}
]
},
"systemMetrics": {
"systemInfo": {
"uptime": "2 hours, 13 minutes and 30 seconds",
"timeStarted": "Thu, 18 Apr 2019 15:15:45",
"systemLoadAverage": "4.3",
"threadCount": 229,
"heapMemory": {
"init": "2 GB",
"used": "1.1 GB",
"committed": "2 GB",
"max": "2 GB"
},
"nonHeapMemory": {
"init": "2.4 MB",
"used": "346.1 MB",
"committed": "405 MB",
"max": "Undefined"
},
"threadPoolCount": {
"GenericExecutor": 9,
"jobExecutor": 4
}
},
"systemSummary": {
"uptime": "2 hours, 13 minutes and 30 seconds",
"timeStarted": "Thu, 18 Apr 2019 15:15:45",
"systemLoadAverage": "4.3"
}
},
"timeStarted": "Thu, 18 Apr 2019 15:15:45",
"version": "6.31.1.428"
}
]
}Document history
- 30 April 2019: Updated the example.
Comment
Do you have corrections or additional information about this article? Leave a comment! Do you have a question about what is described in this article? Please contact Support.
2 comments
Hi,
Provided sample output of /metrics differs from what 6.28-6.30 return. For examlpe, for these versions:
- 'state’ in ‘cluster’ section always contains “UNITIALAIZED”
- 'searchEngine' in ‘cluster’ doesn’t contain 'ESHealth'
-‘clusterLogs’ is missing
- ‘licenseStatus’ doesn’t contain ‘userStatuses'
Looks like the sample relates to Elvis 5.
Hi Sergey,
Upcoming 6.31 release will have a slightly different metrics output as well compared to previous versions.
I will make sure we gather a proper output example from this version and replace the current one (from 2014) displayed here.
Thank you for reaching out.
Regards,
Vincent
Please sign in to leave a comment.