Edge Data Store health

Edge Data Store (EDS) and its components produce health information to provide insight into their status, which is critical for monitoring data collection. When configured, EDS transfers health information to Open Message Format (OMF) endpoints, including the types and containers that represent available health information. To enable this functionality, configure one or more health endpoints.

EDS also produces diagnostic data. You can use diagnostic data to find more information about a particular component instance. Diagnostic data lives alongside the health data and you can egress it using a health endpoint and setting EnableDiagnostics to true. You can configure EnableDiagnostics in the system configuration. For more information on available adapter diagnostics data, see Diagnostics configuration.

EDS adapter health

The following health types and streams are created to reflect the health of EDS adapters.

Note: If a Health prefix is assigned in System_General's Health Prefix field (xref: GeneralConfiguration), all streams will be prefixed with {HealthPrefix}.

The EDS static type includes these properties and servers as a root AF element with the ID.

EDS adapter component health

The DataCollectorService static type includes the following properties, which are logged in a stream with the ID {machinename}.{EdgeDataStore}. The stream is linked to root AF element (Adapters).

Device status

The DeviceStatus dynamic type includes the following values, which are logged in a stream with the ID Adapters.{machinename}.{componentid}.DeviceStatus. The stream is linked to {machinename}.{componentid} static stream.

Next health message expected

The NextHealthMessageExpected dynamic type includes the following values, which are logged in a stream with the ID Adapters.{machinename}.{componentid}.NextHealthMessageExpected. The stream is linked to {machinename}.{componentid} static stream. Heart beat message is expected once a minute.

Storage health

The Storage Health static type includes the following properties, which are logged in a stream with the ID {machinename}.Storage. The stream is linked to Edge Data Store's service element {machinename}.EdgeDataStore.

Storage device status

The DeviceStatus dynamic type includes the following values, which are logged in a stream with the ID Storage.{machinename}.DeviceStatus. The stream is linked to {machinename}.Storage static stream.

Storage next health message expected

The NextHealthMessageExpected dynamic type includes the following values, which are logged in a stream with the ID Storage.{machinename}.NextHealthMessageExpected. The stream is linked to {machinename}.Storage static stream. Heart beat message is expected once a minute.