WoodWing Help Center

Elvis 5 API - Metrics

Elvis 5 API - Metrics

GET/POST

http://yourserver.com/services/system/metrics

Cluster and node metrics are provided on the admin page, but can also be retrieved as a JSON block from the metrics API (in fact, that is where the admin 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":{
    "clusterHealth":{
      "reasons":[

      ],
      "health":"GREEN"
    },
    "clusterLog":[
      {
        "message":"Starting coordinator state machine",
        "timestamp":"2014-12-10 10:44:24",
        "node":"Zeus"
      },
      {
        "message":"Elvis cluster waiting for minimal amount of nodes",
        "timestamp":"2014-12-10 10:44:25",
        "node":"cluster"
      },
      {
        "message":"Starting all nodes state machine",
        "timestamp":"2014-12-10 10:44:25",
        "node":"Zeus"
      },
      {
        "message":"Elvis node is initializing (joined cluster)",
        "timestamp":"2014-12-10 10:44:25",
        "node":"Zeus"
      },
      {
        "message":"Node allowed to join: NodeInfo[ name=Zeus, os=MacOSX, serverStatus=[threadCount = 209; heapMemory = [init = 4 GB; used = 583.7 MB; committed = 3.9 GB; max = 3.9 GB]; nonHeapMemory = [init = 2.4 MB; used = 190.6 MB; committed = 263.3 MB; max = -1 bytes]; threadPoolCount = {GenericExecutor=6, ImportExecutor=0, ProcessingRequestExecutor=0}], version=5.0.1.0, serverSummary=[uptime = 46 seconds; timeStarted = Wed, 10 Dec 2014 10:43:38; systemLoadAverage = 3.6], enabledSubSystems=[jobRunner, search, processing], subSystemStates={jobRunner=STOPPED, search=STOPPED, processing=STOPPED}, esDataNodeId=null, esDataNodePort=9300, uuid=0cfa2864-9561-4f64-b81f-6b7ad8011fe5 ]",
        "timestamp":"2014-12-10 10:44:25",
        "node":"cluster"
      },
      {
        "message":"Node joined cluster: NodeInfo[ name=Zeus, os=MacOSX, serverStatus=[threadCount = 209; heapMemory = [init = 4 GB; used = 583.7 MB; committed = 3.9 GB; max = 3.9 GB]; nonHeapMemory = [init = 2.4 MB; used = 190.6 MB; committed = 263.3 MB; max = -1 bytes]; threadPoolCount = {GenericExecutor=6, ImportExecutor=0, ProcessingRequestExecutor=0}], version=5.0.1.0, serverSummary=[uptime = 46 seconds; timeStarted = Wed, 10 Dec 2014 10:43:38; systemLoadAverage = 3.6], enabledSubSystems=[jobRunner, search, processing], subSystemStates={jobRunner=STOPPED, search=STOPPED, processing=STOPPED}, esDataNodeId=null, esDataNodePort=9300, uuid=0cfa2864-9561-4f64-b81f-6b7ad8011fe5 ]",
        "timestamp":"2014-12-10 10:44:25",
        "node":"cluster"
      },
      {
        "message":"Elvis node is initialized (Data node is ready)",
        "timestamp":"2014-12-10 10:44:30",
        "node":"Zeus"
      },
      {
        "message":"Node became Master: NodeInfo[ name=Zeus, os=MacOSX, serverStatus=[threadCount = 238; heapMemory = [init = 4 GB; used = 638.8 MB; committed = 3.9 GB; max = 3.9 GB]; nonHeapMemory = [init = 2.4 MB; used = 189.9 MB; committed = 264.4 MB; max = -1 bytes]; threadPoolCount = {GenericExecutor=9, ImportExecutor=0, ProcessingRequestExecutor=0}], version=5.0.1.0, serverSummary=[uptime = 52 seconds; timeStarted = Wed, 10 Dec 2014 10:43:38; systemLoadAverage = 3.7], enabledSubSystems=[jobRunner, search, processing], subSystemStates={jobRunner=STOPPED, search=RUNNING, processing=STOPPED}, esDataNodeId=sdwddmQ6Q4i-Y0p2wYJm_g, esDataNodePort=9300, uuid=0cfa2864-9561-4f64-b81f-6b7ad8011fe5 ]",
        "timestamp":"2014-12-10 10:44:33",
        "node":"cluster"
      },
      {
        "message":"Elvis cluster initializing",
        "timestamp":"2014-12-10 10:45:30",
        "node":"cluster"
      },
      {
        "message":"Initializing indices in Elastic Search",
        "timestamp":"2014-12-10 10:45:30",
        "node":"cluster"
      },
      {
        "message":"Indices initialized in Elastic Search",
        "timestamp":"2014-12-10 10:45:30",
        "node":"cluster"
      },
      {
        "message":"Elvis node is configured (cluster is initialized and config is synced)",
        "timestamp":"2014-12-10 10:45:32",
        "node":"Zeus"
      },
      {
        "message":"Elvis node is starting sub system(s) [jobRunner, processing]",
        "timestamp":"2014-12-10 10:45:32",
        "node":"Zeus"
      },
      {
        "message":"Elvis node started all sub systems",
        "timestamp":"2014-12-10 10:45:32",
        "node":"Zeus"
      },
      {
        "message":"Elvis node is running (cluster and subsystems are ready)",
        "timestamp":"2014-12-10 10:45:32",
        "node":"Zeus"
      }
    ],
    "licenseStatus":{
      "customer":"tlu",
      "serverStatus":{
        "type":"ElvisServerUltimate500"
      },
      "userStatuses":[
        {
          "type":"Pro",
          "registered":1,
          "inUse":1,
          "inUsePeak":1
        }
      ],
      "apiCalls":0
    },
    "name":"pantheon",
    "nodesCount":1,
    "processing":{
      "inProcessCountCluster":7,
      "notReadyCountCluster":9,
      "processingHealth":"GREEN",
      "queueSizePerPriority":{
        "URGENT":5,
        "HIGH":0,
        "MEDIUM":0,
        "LOW":17
      },
      "queueTotalSize":22,
      "queuedTop10":[
        {
          "fileName":"c6b1e6fedbff95ba65ba6fac6d98b5a5",
          "operation":"ExtractMetadataRequest",
          "priority":5.0,
          "duration":67
        },
        {
          "fileName":"bffef19a13a5473a9ef7f80d6df9fa26",
          "operation":"ThumbnailAndDefaultPreviewsRequest",
          "priority":1.0,
          "duration":53
        }
      ]
    },
    "searchEngine":{
      "ESHealth":"GREEN",
      "assetIndexSizeDocsNr":170,
      "assetIndexSizeMb":1,
      "relationIndexSizeDocsNr":3,
      "relationIndexSizeMb":0
    },
    "stackedGraph":{

    },
    "state":"GREEN",
    "storage":{
      "sharedVolumeStatuses":[
        {
          "name":"/",
          "totalSpace":"456.4 GB",
          "freeSpace":"87.1 GB",
          "usableSpace":"86.9 GB",
          "healthReasons":{
            "reasons":[

            ],
            "health":"GREEN"
          }
        }
      ]
    },
    "timeStarted":"Wed, 10 Dec 2014 10:45:30",
    "uptime":"5 minutes and 11 seconds"
  },
  "nodes":[
    {
      "bootstrapState":"RUNNING",
      "coordinatorState":"RUNNING",
      "health":{
        "reasons":[

        ],
        "health":"GREEN"
      },
      "ip":"172.20.16.60",
      "jobRunner":{
        "jobRunnerState":"RUNNING",
        "scheduledJobs":{
          "/folder_import":{
            "pluginId":"/folder_import",
            "activated":true,
            "status":"Scheduled",
            "lastOutcome":"Executed successfully",
            "totalExecutionCount":31,
            "failCount":0,
            "running":false,
            "nextFireTime":1418205050000
          },
          "/internal/backup":{
            "pluginId":"/internal/backup",
            "activated":true,
            "status":"Scheduled",
            "totalExecutionCount":0,
            "failCount":0,
            "running":false,
            "nextFireTime":1418263200000
          },
          "/schedule_plugins/metadata_import":{
            "pluginId":"/schedule_plugins/metadata_import",
            "activated":false,
            "status":"Manual",
            "totalExecutionCount":0,
            "failCount":0,
            "running":false
          },
          "/schedule_plugins/ww_enterprise_import":{
            "pluginId":"/schedule_plugins/ww_enterprise_import",
            "activated":false,
            "status":"Manual",
            "totalExecutionCount":0,
            "failCount":0,
            "running":false
          },
          "/internal/version_cleanup":{
            "pluginId":"/internal/version_cleanup",
            "activated":true,
            "status":"Scheduled",
            "lastOutcome":"Executed successfully",
            "totalExecutionCount":5,
            "failCount":0,
            "running":false,
            "nextFireTime":1418205060000
          },
          "/schedule_plugins/sce_import":{
            "pluginId":"/schedule_plugins/sce_import",
            "activated":false,
            "status":"Manual",
            "totalExecutionCount":0,
            "failCount":0,
            "running":false
          },
          "/schedule_plugins/move":{
            "pluginId":"/schedule_plugins/move",
            "activated":false,
            "status":"Manual",
            "totalExecutionCount":0,
            "failCount":0,
            "running":false
          },
          "/schedule_plugins/ftp_import":{
            "pluginId":"/schedule_plugins/ftp_import",
            "activated":false,
            "status":"Manual",
            "totalExecutionCount":0,
            "failCount":0,
            "running":false
          },
          "/schedule_plugins/cleanup":{
            "pluginId":"/schedule_plugins/cleanup",
            "activated":false,
            "status":"Manual",
            "totalExecutionCount":0,
            "failCount":0,
            "running":false
          }
        }
      },
      "name":"Zeus",
      "processing":{
        "processStatus":{
          "runningProcesses":1,
          "heavyProcesses":0,
          "exclusiveHeavyProcesses":0,
          "processes":[
            {
              "name":"RemoveVersionsByQuery",
              "load":"NORMAL",
              "user":"admin",
              "errorCount":-1,
              "displayState":"Completed, time spent: 67 milis"
            }
          ],
          "history":[
            {
              "name":"RemoveVersionsByQuery",
              "load":"NORMAL",
              "user":"admin",
              "errorCount":-1,
              "displayState":"Completed, time spent: 14 milis"
            },
            {
              "name":"RemoveVersionsByQuery",
              "load":"NORMAL",
              "user":"admin",
              "errorCount":-1,
              "displayState":"Completed, time spent: 11 milis"
            },
            {
              "name":"RemoveVersionsByQuery",
              "load":"NORMAL",
              "user":"admin",
              "errorCount":-1,
              "displayState":"Completed, time spent: 34 milis"
            },
            {
              "name":"RemoveVersionsByQuery",
              "load":"NORMAL",
              "user":"admin",
              "errorCount":-1,
              "displayState":"Completed, time spent: 5 milis"
            },
            {
              "name":"RemoveVersionsByQuery",
              "load":"NORMAL",
              "user":"admin",
              "errorCount":-1,
              "displayState":"Completed, time spent: 15 milis"
            },
            {
              "name":"RemoveVersionsByQuery",
              "load":"NORMAL",
              "user":"admin",
              "errorCount":-1,
              "displayState":"Completed, time spent: 27 milis"
            },
            {
              "name":"RemoveVersionsByQuery",
              "load":"NORMAL",
              "user":"admin",
              "errorCount":-1,
              "displayState":"Completed, time spent: 15 milis"
            },
            {
              "name":"RemoveVersionsByQuery",
              "load":"NORMAL",
              "user":"admin",
              "errorCount":-1,
              "displayState":"Completed, time spent: 17 milis"
            },
            {
              "name":"Plugin /folder_import",
              "load":"NORMAL",
              "user":"server",
              "errorCount":-1,
              "displayState":"Completed, time spent: 23 milis"
            },
            {
              "name":"Plugin /folder_import",
              "load":"NORMAL",
              "user":"server",
              "errorCount":-1,
              "displayState":"Completed, time spent: 21 milis"
            },
            {
              "name":"RemoveRelations",
              "load":"NORMAL",
              "user":"server",
              "errorCount":-1,
              "displayState":"Completed, time spent: 4 milis"
            },
            {
              "name":"RemoveRelations",
              "load":"NORMAL",
              "user":"server",
              "errorCount":-1,
              "displayState":"Completed, time spent: 5 milis"
            }
          ]
        },
        "processingState":"RUNNING"
      },
      "searchEngine":{
        "indexChangesPerMinute":{
          "indexCount":532,
          "deleteCount":146
        },
        "searchState":"RUNNING",
        "searchesPerMinute":{
          "queryCount":17820,
          "fetchCount":1284
        }
      },
      "serverLoadStats":[
        {
          "minutePeakRate":6,
          "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,
            3,
            6
          ],
          "minuteRate":5,
          "lastHourAvgMinuteRate":0
        },
        {
          "minutePeakRate":10,
          "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,
            10,
            4
          ],
          "minuteRate":12,
          "lastHourAvgMinuteRate":0
        },
        {
          "minutePeakRate":30,
          "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,
            30,
            13
          ],
          "minuteRate":31,
          "lastHourAvgMinuteRate":1
        },
        {
          "minutePeakRate":63,
          "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,
            50,
            63
          ],
          "minuteRate":57,
          "lastHourAvgMinuteRate":2
        },
        {
          "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
        }
      ],
      "state":"RUNNING",
      "storage":{
        "cacheStatistics":[
          {
            "name":"assetCache",
            "averageGetTimeMillis":0.006749740336090326,
            "cacheHitCount":1926,
            "cacheMissCount":157,
            "cacheMissCountExpired":0,
            "inMemorySize":112,
            "onDiskSize":0,
            "size":112,
            "putCount":112,
            "updateCount":509,
            "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":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":0,
            "cacheMissCountExpired":0,
            "inMemorySize":0,
            "onDiskSize":0,
            "size":0,
            "putCount":0,
            "updateCount":0,
            "evictedCount":0,
            "expiredCount":0
          },
          {
            "name":"securityCache",
            "averageGetTimeMillis":0.003066989593207836,
            "cacheHitCount":6195,
            "cacheMissCount":6,
            "cacheMissCountExpired":0,
            "inMemorySize":2,
            "onDiskSize":0,
            "size":2,
            "putCount":2,
            "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":"userAgentLookupCache",
            "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
          }
        ],
        "volumeStatuses":[
          {
            "name":"/",
            "totalSpace":"456.4 GB",
            "freeSpace":"87.1 GB",
            "usableSpace":"86.9 GB",
            "healthReasons":{
              "reasons":[

              ],
              "health":"GREEN"
            }
          }
        ]
      },
      "subsystems":[
        "jobRunner",
        "search",
        "processing"
      ],
      "systemMetrics":{
        "systemInfo":{
          "uptime":"7 minutes and 3 seconds",
          "timeStarted":"Wed, 10 Dec 2014 10:43:38",
          "systemLoadAverage":"3.9",
          "threadCount":293,
          "heapMemory":{
            "init":"4 GB",
            "used":"699.2 MB",
            "committed":"3.9 GB",
            "max":"3.9 GB"
          },
          "nonHeapMemory":{
            "init":"2.4 MB",
            "used":"246.1 MB",
            "committed":"320.4 MB",
            "max":"-1 bytes"
          },
          "threadPoolCount":{
            "GenericExecutor":9,
            "ImportExecutor":0,
            "ProcessingRequestExecutor":0,
            "jobExecutor":4
          }
        },
        "systemSummary":{
          "uptime":"7 minutes and 3 seconds",
          "timeStarted":"Wed, 10 Dec 2014 10:43:38",
          "systemLoadAverage":"3.9"
        }
      },
      "timeStarted":"Wed, 10 Dec 2014 10:43:38",
      "version":"5.0.1.0 dev"
    }
  ]
}
Was this article helpful?
0 out of 0 found this helpful / Created: / Updated:
Have more questions? Submit a request

0 Comments

Please sign in to leave a comment.