Skip to content

Open Edge Device Kit – Open Edge Device Kit Status Messages

This section describes the monitoring topics published by the Open Edge Device Kit. Modules running on devices must subscribe to these topics.

Connection Status

Topic agentruntime/monitoring/diagnostic/connection
Description States if the Open Edge Device Kit has established a connection to Insights Hub. Possible values for the status are limited to 0 to 2, which are associated with the status "Connected To Cloud", "No Connection To Proxy", "No Connection To Cloud".
Quality of Service 0
Retained TRUE

Sample Body:

{
  "value": 0,
  "state": "Connected To Cloud"
}

Onboarding Status

Topic agentruntime/monitoring/diagnostic/onboarding
Description States the onboarding status of the agent. Possible values for the status are limited to 0 to 4, which are associated with the status "Not Onboarded", "Onboarded", "Onboarding In Progress", "Onboarding Failed", "Offboarded".
Quality of Service 0
Retained TRUE

Sample Body:

{
  "value": 1,
  "state": "Onboarded"
}

Buffer Status

Topic agentruntime/monitoring/diagnostic/buffer
Description States if the agent has enough space left in its buffer for storing data that cannot be uploaded immediately. If the buffer is full, it can lead to data loss if the connection to the server is not reestablished. Possible values for the status are 0 and 1, which are associated with the status "Buffer OK", "Buffer Overrun".
Quality of Service 0
Retained TRUE

Sample Body:

{
  "value": 0,
  "state": "Buffer OK"
}

Data Source Status

Topic agentruntime/monitoring/diagnostic/data
Description States if all data sources from which the agent reads data are available and running. Using this message the Open Edge Device Kit helps to exchange diagnostic information between different modules on the device. Possible values for the status are 0 and 1, which are associated with the status "Connection", "No Connection".
Quality of Service 0
Retained TRUE

Sample Body:

{
  "value": 0,
  "state": "Connection"
}

Clock Skew Status

Topic agentruntime/monitoring/clockskew
Description States the time difference in seconds between device time and Insights Hub time. This value can be positive or negative and must be added to update the system time to Insights Hub time.
The Open Edge Device Kit receives the Insights Hub time during the hourly token renewal process and uses it to calculate the time difference.
Quality of Service 1
Retained TRUE

Sample Body:

{
  "diff": -2234
}

Initialization Result

Topic agentruntime/monitoring/opresult/init
Description States whether initialization of the Open Edge Device Kit was successful. Possible values for the status are 0 and 1, which are associated with the status "Init Successful", "{Reason for failure}". The {Reason for failure} contains a description about the problem, if the initialization was unsuccessful.
Quality of Service 1
Retained TRUE

Sample Body:

{
  "value": 0,
  "status": "Init Successful"
}

Stopping Result

Topic agentruntime/monitoring/opresult/stop
Description States that the Open Edge Device Kit has stopped its operations successfully and can now be killed safely. The Open Edge Device kit publishes this message within 30 seconds after receiving the stop command via agentruntime/controlling/command/stop. If the message does not appear, an error occurred and the Open Edge Device Kit process must be killed.
Quality of Service 1
Retained TRUE

Sample Body:

{
  "value": 0,
  "status": "Stopped"
}
Last update: April 13, 2023

Except where otherwise noted, content on this site is licensed under the Development License Agreement.