Batch

User Guide | Data Model

---

The Batch object encapsulates metadata about a set of queries and wraps an array of Metric entities.

Field Name	Type	Description
status	int	Status of the batch. Default statuses are: queued: initial status, any query has yet to be processed processing: at least one query is still being evaluated done: All queries finished successfully error: all queries finished, but at least one of them had an error
ttl	int	Time for the finished results to live after the entire batch is evaluated
createdDate	long	Timestamp at which the batch was created
ownerName	string	Principal owner of the batch
queries	object[]	The individuals queries of the batch. Contains: expression, result: metric entity after evaluation (uses the JSON schema of the Metric model) message: error message if the query failed.

Example: Batch Entity

{
  "status": "error",
  "ttl": 1800,
  "createdDate": 1469557798435,
  "ownerName": "a",
  "queries": [
    {
      "expression": "-1m:argus.jvm:thread.used:sum",
      "result": {
        "query": {
          "aggregator": "SUM",
          "metric": "thread.used",
          "tags": {},
          "endTimestamp": 1469557798595,
          "startTimestamp": 1469557738000,
          "scope": "argus.jvm"
        },
        "displayName": null,
        "units": "count",
        "metric": "thread.used",
        "datapoints": {
          "1469557740000": "42.0"
        },
        "scope": "argus.jvm",
        "namespace": null,
        "uid": "00033C0000010094840000040094060000080093EC",
        "tags": {}
      },
      "message": null
    },
    {
      "expression": "3h:argus.jvm:thread.used:sum",
      "result": null,
      "message": "com.salesforce.dva.argus.service.metric.ParseException: ... "
    }
  ]
}