{ "definitions": {}, "$schema": "http://json-schema.org/draft-07/schema#", "$id": "taskMetricsDocument", "type": "object", "title": "Default metrics schema", "properties": { "_id": { "$ref": "wfEngineCommon#/definitions/mongoObjectId" }, "app": { "$id": "#/properties/app", "type": "string", "title": "The associated app for this task", "examples": [ "WorkflowBuilder" ] }, "name": { "$id": "#/properties/name", "type": "string", "title": "The name of the task", "examples": [ "getTime", "testTask" ] }, "taskType": { "$id": "#/properties/taskType", "type": "string", "title": "The type of the task", "enum": [ "automatic", "manual", "operation" ] }, "global": { "$id": "#/properties/global", "type": "boolean", "title": "Global task", "description": "Global designating if metric is global across automations or per-automation.", "examples": [ true, false ] }, "taskId": { "$ref": "wfEngineCommon#/definitions/workflowTaskId" }, "workflow": { "$id": "#/properties/workflow", "type": "object", "title": "Automation the job was started on.", "properties": { "name": { "$id": "#/properties/workflow/properties/name", "type": "string", "title": "Name of the automation the job was started on", "examples": [ "exampleAutomationName" ] } } }, "metrics": { "$id": "#/properties/metrics", "type": "array", "title": "Weekly aggregate metrics", "description": "Aggregate job metrics collected on a weekly basis", "items": { "type": "object", "properties": { "startDate": { "$id": "#/properties/metrics/properties/startDate", "type": "string", "title": "Start DateTime of metric collection", "description": "Metrics are collected on a weekly interval, starting at startDate.", "examples": [ "2018-08-02T15:56:12.912Z" ] }, "totalSuccesses": { "$id": "#/properties/metrics/properties/totalSuccesses", "type": "integer", "title": "Total successes for a task", "description": "Total number of tasks that ended in status success for the week starting at startDate.", "minimum": 0, "examples": [ 5, 10 ] }, "totalSuccessRunTime": { "$id": "#/properties/metrics/properties/totalSuccessRunTime", "type": "integer", "title": "Total successes run time for a task", "description": "Total run time (milliseconds) for tasks that ended in status success for the week starting at startDate.", "minimum": 0, "examples": [ 550, 200 ] }, "totalErrors": { "$id": "#/properties/metrics/properties/totalErrors", "type": "integer", "title": "Total errors for a task", "description": "Total number of tasks that ended in status error for the week starting at startDate.", "minimum": 0, "examples": [ 5, 10 ] }, "totalErrorRunTime": { "$id": "#/properties/metrics/properties/totalErrorRunTime", "type": "integer", "title": "Total error run time for a task", "description": "Total run time (milliseconds) for tasks that ended in status error for the week starting at startDate.", "minimum": 0, "examples": [ 550, 200 ] }, "totalFailures": { "$id": "#/properties/metrics/properties/totalFailures", "type": "integer", "title": "Total failures for a task", "description": "Total number of tasks that ended in status failure for the week starting at startDate.", "minimum": 0, "examples": [ 5, 10 ] }, "totalFailureRunTime": { "$id": "#/properties/metrics/properties/totalFailureRunTime", "type": "integer", "title": "Total failure run time for a task", "description": "Total run time (milliseconds) for tasks that ended in status failure for the week starting at startDate.", "minimum": 0, "examples": [ 550, 200 ] }, "slaTargetsMissed": { "$id": "#/properties/metrics/properties/slaTargetsMissed", "type": "integer", "title": "Sla targets missed for a manual task", "description": "Total number of sla targets that were missed for a manual task for the week starting at startDate.", "minimum": 0, "examples": [ 5, 10 ] } }, "required": [ "startDate", "totalSuccesses", "totalSuccessRunTime", "totalErrorRunTime", "totalErrors", "totalFailureRunTime", "totalFailures" ] } } }, "required": [ "_id", "app", "name", "type", "taskType", "global", "metrics" ] }
2022.1