Report Structure

The monitoring report is a JSON document with the following overall structure:

{
  "items": [],
  "query": {
    "period": ["24h","30m","30s"]
  }
}

The report has two top-level properties:

items

An array containing the main body of the report.

query

Contains the parameters from the query that initiated the report. This information may be useful in the development of monitoring plug-ins.

The items array contains a list of entries, each containing information about some aspect of CUE Zipline operation during the requested period(s):

{
  "component": "...",
  "data": ...
}

Each entry has two properties:

component

The name of the CUE Zipline report section (often, but not always, the name of a component of the CUE Zipline system.

data

Information about this component. The structure of this property depends on the type of component. In most cases, the property is an array that can contain one report object for each requested time period. In some cases, however, (currently only for the state component) an array is not required, and data is a single object.