anatomy_monitors.rst

Monitor Message Strand

The monitor_message_schema strand is values-based meaning the data that matches the strand is in JSON form. It is a json schema which describes a monitor message.

Monitors Strand

There are two kinds of monitoring data required from a digital twin.

Monitor data (output)

Values for health and progress monitoring of the twin, for example percentage progress, iteration number and status - perhaps even residuals graphs for a converging calculation. Broadly speaking, this should be user-facing information.

This kind of monitoring data can be in a suitable form for display on a dashboard

Log data (output)

Logged statements, typically in iostream form, produced by the twin (e.g. via python's logging module) must be capturable as an output for debugging and monitoring purposes. Broadly speaking, this should be developer-facing information.

Let's look at basic examples for twines containing each of these strands:

Monitors Strand

Monitor data (output)

{
  "monitor_message_schema": {
    "type": "object",
    "properties": {
      "my_property": {
      "type": "number"
      }
    },
    "required": ["my_property"]
  }
}

Log data (output)