Summary
Get aggregate job metrics
Description
Search aggregate job metrics with options
Route
GET /workflow_engine/jobs/metrics
Roles
Parameters
Name | Type | Required | Description |
---|---|---|---|
queryOptions | object | yes | Search options for aggregation |
{ "queryOptions": { "order": 1, "sort": "workflow.name", "skip": 0, "limit": 50, "greaterThanEquals": 1617383798460, "greaterThanEqualsField": "metrics.startDate", "contains": "exampleName", "containsField": "workflow.name" } }
{ "type": "object", "properties": { "queryOptions": { "title": "queryOptions", "type": "object", "properties": { "order": { "$ref": "wfEngineCommon#/definitions/order" }, "sort": { "$ref": "wfEngineCommon#/definitions/sort" }, "skip": { "$ref": "wfEngineCommon#/definitions/skip" }, "limit": { "$ref": "wfEngineCommon#/definitions/limit" }, "greaterThanEquals": { "type": "integer", "description": "Date value to compare with greaterThanEqualsField, in time elapsed (milliseconds) since UNIX epoch.", "examples": [ 1617383798468, 1617383798460 ] }, "greaterThanEqualsField": { "type": "string", "description": "Date field to compare.", "examples": [ "metrics.startDate" ], "enum": [ "metrics.startDate" ] }, "contains": { "type": "string", "description": "String value to compare with containsField.", "examples": [ "exampleName" ] }, "containsField": { "type": "string", "description": "Field to compare with contains value.", "examples": [ "workflow.name" ], "enum": [ "workflow.name" ] } } } }, "required": [ "queryOptions" ], "additionalProperties": false }
Return
Name | Type | Description |
---|---|---|
metrics | object | - |
{ "results": [ { "_id": "5cb7b531d06cceb89fd21b1c", "app": "WorkflowBuilder", "name": "getTime", "taskType": "operation", "global": false, "metrics": [ { "startDate": "2018-08-02T15:56:12.912Z", "totalSuccesses": 10, "totalSuccessRunTime": 550, "totalErrorRunTime": 550, "totalErrors": 10, "totalFailureRunTime": 550, "totalFailures": 10, "slaTargetsMissed": 5 }, { "startDate": "2018-08-02T15:56:12.912Z", "totalSuccesses": 10, "totalSuccessRunTime": 200, "totalErrorRunTime": 550, "totalErrors": 5, "totalFailureRunTime": 550, "totalFailures": 10, "slaTargetsMissed": 10 }, { "startDate": "2018-08-02T15:56:12.912Z", "totalSuccesses": 10, "totalSuccessRunTime": 200, "totalErrorRunTime": 550, "totalErrors": 5, "totalFailureRunTime": 550, "totalFailures": 10, "slaTargetsMissed": 5 }, { "startDate": "2018-08-02T15:56:12.912Z", "totalSuccesses": 10, "totalSuccessRunTime": 200, "totalErrorRunTime": 200, "totalErrors": 10, "totalFailureRunTime": 550, "totalFailures": 10, "slaTargetsMissed": 5 }, { "startDate": "2018-08-02T15:56:12.912Z", "totalSuccesses": 5, "totalSuccessRunTime": 550, "totalErrorRunTime": 550, "totalErrors": 5, "totalFailureRunTime": 200, "totalFailures": 5, "slaTargetsMissed": 10 } ], "taskId": "cd34", "workflow": { "name": "exampleAutomationName" } }, { "_id": "5cb7b531d06cceb89fd21b1c", "app": "WorkflowBuilder", "name": "testTask", "taskType": "manual", "global": true, "metrics": [ { "startDate": "2018-08-02T15:56:12.912Z", "totalSuccesses": 10, "totalSuccessRunTime": 550, "totalErrorRunTime": 200, "totalErrors": 10, "totalFailureRunTime": 200, "totalFailures": 10, "slaTargetsMissed": 5 }, { "startDate": "2018-08-02T15:56:12.912Z", "totalSuccesses": 5, "totalSuccessRunTime": 550, "totalErrorRunTime": 550, "totalErrors": 5, "totalFailureRunTime": 200, "totalFailures": 10, "slaTargetsMissed": 5 }, { "startDate": "2018-08-02T15:56:12.912Z", "totalSuccesses": 10, "totalSuccessRunTime": 550, "totalErrorRunTime": 550, "totalErrors": 10, "totalFailureRunTime": 200, "totalFailures": 10, "slaTargetsMissed": 10 }, { "startDate": "2018-08-02T15:56:12.912Z", "totalSuccesses": 5, "totalSuccessRunTime": 200, "totalErrorRunTime": 200, "totalErrors": 10, "totalFailureRunTime": 200, "totalFailures": 5, "slaTargetsMissed": 10 } ], "taskId": "cd34", "workflow": { "name": "exampleAutomationName" } }, { "_id": "5cb7b531d06cceb89fd21b1c", "app": "WorkflowBuilder", "name": "getTime", "taskType": "manual", "global": false, "metrics": [ { "startDate": "2018-08-02T15:56:12.912Z", "totalSuccesses": 10, "totalSuccessRunTime": 200, "totalErrorRunTime": 200, "totalErrors": 5, "totalFailureRunTime": 550, "totalFailures": 5, "slaTargetsMissed": 10 }, { "startDate": "2018-08-02T15:56:12.912Z", "totalSuccesses": 5, "totalSuccessRunTime": 200, "totalErrorRunTime": 200, "totalErrors": 5, "totalFailureRunTime": 550, "totalFailures": 10, "slaTargetsMissed": 10 }, { "startDate": "2018-08-02T15:56:12.912Z", "totalSuccesses": 10, "totalSuccessRunTime": 200, "totalErrorRunTime": 200, "totalErrors": 10, "totalFailureRunTime": 550, "totalFailures": 5, "slaTargetsMissed": 5 }, { "startDate": "2018-08-02T15:56:12.912Z", "totalSuccesses": 10, "totalSuccessRunTime": 200, "totalErrorRunTime": 200, "totalErrors": 10, "totalFailureRunTime": 200, "totalFailures": 5, "slaTargetsMissed": 5 } ], "taskId": "12ab", "workflow": { "name": "exampleAutomationName" } }, { "_id": "4321abcdef694aa79dae47ad", "app": "WorkflowBuilder", "name": "getTime", "taskType": "manual", "global": true, "metrics": [ { "startDate": "2018-08-02T15:56:12.912Z", "totalSuccesses": 5, "totalSuccessRunTime": 200, "totalErrorRunTime": 550, "totalErrors": 5, "totalFailureRunTime": 550, "totalFailures": 5, "slaTargetsMissed": 10 } ], "taskId": "cd34", "workflow": { "name": "exampleAutomationName" } } ], "skip": 0, "limit": 50, "total": 100 }
{ "title": "metrics", "type": "object", "properties": { "results": { "type": "array", "items": { "$ref": "taskMetricsDocument" } }, "skip": { "$ref": "wfEngineCommon#/definitions/skip" }, "limit": { "$ref": "wfEngineCommon#/definitions/limit" }, "total": { "$ref": "wfEngineCommon#/definitions/total" } } }