Health Monitoring Data Specification

The Health Monitor, if enabled, sends regular health status information for the producer component of Jade Event Streaming to a specified URL or to a broker management topic.

The consumer of the health status information can monitor the general health status of this component. If configured, the information is sent at regular intervals for the whole lifetime of the producer.

The "HealthMonitor" section provides configuration settings that enable you to run the Health Monitor for a producer.

The health monitoring data are sent as a JSON string described by the following schema.

{
    "$schema": "http://json-schema.org/draft-07/schema#",
    "type": "object",
    "properties":
    {
        "Producer":
        {
            "type": "string"
        },
        "TimeGenerated": 
        {
            "type": "string",
            "format": "date-time"
        },
        "ProducerStarted":
        {
            "type": "string",
            "format": "date-time"
        },
        "LastEventSent":
        {
            "type": "string",
            "format": "date-time"
        },
        "EventsSentToDeadLetter":
        {
            "type": "integer"
        },
        "ErrorsInPeriod":
        {
            "type": "integer"
        },
        "EventsInPeriod":
        {
            "type": "integer"
        }
    },
    "required":
    [
        "Producer",
        "TimeGenerated"
    ]
}

The properties in the health monitor data message are described in the following table.

Property	Description
Producer	Name given to a producer in the command line for that producer. If no value is specified, it has the value "DEFAULT".
TimeGenerated	Time the data message was created. This is a string in ISO-8601 format. The time is fully specified as local time (to milliseconds) with time zone offset; for example, "2025‑06‑19T14:03:28.194+12:00" for NZST. In versions of Windows before Windows 10 19H1 or Windows Server 2022: Time zone information is not available. In these Windows versions, the timestamp format looks like "2025-06-19T14:03:28.194" (which is the local time of the Event Producer). Azure Monitor cannot be used as a valid endpoint. This is because published timestamps are not generated in ISO‑8601 format, which prevents health records from being ingested by Azure Monitor.
ProducerStarted	Time the producer was last started. (Uses the same time format as TimeGenerated.)
LastEventSent	Time of the last health monitoring message for a period that contained any events.
EventsSentToDeadLetter	Number of events that have been sent to the FileReader section UndeliverableDirectory in the lifetime of this producer run. (It is not necessarily the same as the number of events in that directory.)
ErrorsInPeriod	Count of any errors that have occurred while sending events to the broker since the last health monitoring message. An error occurring does not necessarily indicate that an event was not eventually successfully sent; a send might be retried successfully.
EventsInPeriod	Count of event sends to all topics since the last health monitoring message. A single event sent to two topics would increment the count by two.

2025.0.01 and higher