Viewing device events
Device Management stores a log of all the important events in a device's lifetime, such as the device's first registration date and all firmware updates.
In Device Management Portal
In the portal, the Device events page lists all events in the past month on all devices sorted by time.
To view the events log for a specific device:
- Click the ID of the device you are interested in.
- Device details pane opens straight to the Event log tab.
- The log lists all events during the lifetime of the device.
The Message type field shows one of these values:
Value | Description |
---|---|
SUCCESS | The device reached the desired state. |
FAIL | The device did not reach the desired state. |
SKIPPED | The device is already at the desired state. |
INFO | Other information on the device, such as device state or lifecycle events. |
The Message field shows a text related to the event log code.
Using the API
To query the API:
curl -X GET https://api.us-east-1.mbedcloud.com/v3/device-events \
-H "Authorization: Bearer <access_key>"
Tip: You can limit your query to a specific device, or a group of devices, using device filters. The full list of query parameters is in the Device Directory API section.
When you query the API, the return for one event looks like:
{
"date_time":"2016-11-08T10:02:07.033000Z",
"device_id":"00000000000000000000000000000000",
"device_log_id":"00000000000000000000000000000000",
"event_type":"1",
"event_type_description":"FAIL",
"event_type_category":"FAIL_SERVICE"
"state_change":true,
"description":"Device update failed",
"changes":{
},
"data":{
"campaign_id":"00000000000000000000000000000000",
}
},
The full reply to this query has more than one event (remember that each event is marked by the date_time
field):
{
"object":"list",
"data":[
{
"date_time":"2016-11-08T10:02:07.033000Z",
"device_id":"00000000000000000000000000000000",
"device_log_id":"00000000000000000000000000000000",
"event_type":"1",
"event_type_description":"FAIL",
"event_type_category":"FAIL_SERVICE"
"state_change":true,
"description":"Device update failed",
"changes":{
},
"data":{
"campaign_id":"00000000000000000000000000000000",
}
},
{
"date_time":"2016-11-08T10:02:07.033000Z",
"device_id":"00000000000000000000000000000000",
"device_log_id":"00000000000000000000000000000001",
"event_type":"1",
"event_type_description":"FAIL",
"event_type_category":"FAIL_NETWORK"
"state_change":true,
"description":"Manifest network error, nonspecific network error",
"changes":{
},
"data":{
"campaign_id":"00000000000000000000000000000000",
}
}
],
"limit":50,
"after":null,
"order":"DESC",
"has_more":true
}
References: Event log codes
Service-generated events
Event log code | Portal text | Possible corrective action |
---|---|---|
SYS_100 | Service error: Device could not be reached. | |
SYS_101 | Service error: Device not registered, manifest not sent. | |
SYS_102 | Service error: Device Vendor ID does not match Manifest Vendor ID. | |
SYS_103 | Campaign was manually stopped. Device not updated. | |
SYS_104 | Campaign was manually stopped. Device may still update. | |
SYS_105 | Device deregistered. | |
SYS_106 | Device registered. | |
SYS_107 | Device bootstrapped. | |
SYS_108 | Device added to campaign. | |
SYS_109 | Device removed from campaign. | |
SYS_110 | Device already at desired state. | |
SYS_111 | Device failed to reach desired state. | |
SYS_112 | Device reached desired state. |
Client-generated events
This table presents events reported by the Update client in Device Management Client 4.8.0 and higher. For events reported the Update client in previous versions of Device Management Client, please see the documentation for the relevant client version.
Event log code | Portal text | Explanation | Possible corrective action |
---|---|---|---|
UPD2_OK_18 | Asset update successfully completed. | The firmware image has been updated successfully. | |
UPD4_FAIL_21 | FW payload URI in manifest is too long. | The URI in the manifest is invalid. | Check the URI in the manifest. |
UPD4_FAIL_22 | Failure to parse an update manifest. | The client cannot parse the manifest. | Check manifest generation. Check that the correct manifest was used in the campaign. |
UPD4_FAIL_23 | Signature verification failed. | The client cannot authenticate the manifest because the manifest signature the client calculated does not match the signature on the manifest. | Check that certificates were provisioned correctly. Make sure the manifest is signed using the correct private key. |
UPD4_FAIL_24 | Connection lost during download. | Network connection was lost during the download of the updated image. | Check the device's connectivity. |
UPD4_FAIL_25 | Payload format specified by manifest is unsupported. | The device does not support the payload format in the manifest. | Check the payload format of the manifest. |
UPD4_FAIL_26 | Payload authenticity check failed. | The hash of the payload in the manifest does not match the hash the client calculates for the downloaded image. | Manifest was edited or corrupted in transit. Retry. |
UPD4_FAIL_27 | FW candidate version is rejected (is older or equal to installed one). | You tried to update to a firmware version that is older than the one already on the device. | Check that the updated firmware version is newer than the existing one. |
UPD4_FAIL_28 | Manifest schema version unsupported (incompatible manifest-tool version). | The client does not support the schema of the received manifest. | Use a manifest schema that is compatible with the device. |
UPD4_FAIL_29 | Vendor data specified in the manifest is too big. | The custom vendor data size in the manifest is bigger than defined on the device. | Configure the device to work with a larger vendor data size or reduce your application vendor data size. |
UPD4_FAIL_30 | Manifest with wrong Vendor ID. | The Vendor ID in the received manifest does not match the Vendor ID stored on the device. | Check that the device was provisioned correctly. Check the manifest. |
UPD4_FAIL_31 | Manifest with wrong Class ID. | The Class ID in the received manifest does not match the Class ID stored on the device. | Check that the device was provisioned correctly. Check the manifest. |
UPD4_FAIL_32 | Installed FW digest differs from the one specified in the manifest (precursor). | Relevant for delta update only. The actual installed firmware digest is different from the digest specified in the manifest (precursor). | Recreate the delta patch. The image you provide in the --current-fw argument, when you create the delta patch, must be the same as the firmware installed on the device. |
UPD4_FAIL_33 | Insufficient storage on a device for saving update candidate. | Insufficient space on the device to store a payload of this size. | Check device storage. |
UPD4_FAIL_34 | Not enough RAM. | Insufficient space allocated for various Update client actions. | Check device RAM. |
UPD4_FAIL_35 | Storage write error. | Error during writing to non-volatile memory (NVM). | Check the device storage configuration. |
UPD4_FAIL_36 | Storage read error. | Error during reading from non-volatile memory (NVM). | Check the device storage configuration. |
UPD4_FAIL_37 | Application rejected install authorization request. | The device application rejected install authorization. | Check the device application code. |
UPD4_FAIL_38 | Application rejected download authorization request. | The device application rejected download authorization. | Check the device application code. |
UPD4_FAIL_39 | Component name in manifest targets unknown component. | The component name specified in the manifest doesn't match a component registered on the device. | Check the manifest or the device application code that registers the component. |
UPD4_FAIL_40 | Update failed at installation phase. | Either the installation of the component failed or the verification of the new image after the installation failed. | Check the installation or the verification callbacks. |
UPD4_FAIL_41 | Non-specific internal error. | Generic internal error. | Call FAE. |
UPD4_FAIL_42 | Non-specific internal error - delta engine. | Internal error of the delta engine. | Call FAE. |
UPD4_FAIL_43 | Non-specific internal error - crypto engine. | Internal error of the crypto engine. | Call FAE. |
UPD4_FAIL_44 | Expected asset is not found in NVM. | The update client requires an item that is missing from non-volatile memory (NVM). | Check that the device was provisioned correctly. |
UPD4_FAIL_45 | Multicast abort session. | Aborting the update process because of an unexpected multicast command sequence or border router request to abort. | Check for network problems. |
UPD4_FAIL_46 | Failure to parse a combined package. | The client cannot parse the combined package. | Check combined package generation. |
UPD4_FAIL_47 | Combined package with wrong number of images. | The number of images specified in the package descriptor doesn't match the number of images inside the package . | Combined package was edited or corrupted in transit. Retry. |
UPD4_FAIL_48 | Image name specified in the package is too long. | The name of at least one image in the package is longer than the name size defined on the device. | Configure the device to work with a longer name size or reduce the length of your combined image name. |
UPD4_FAIL_49 | Vendor data specified in the package descriptor is too long. | The vendor data related to at least one image in the package is longer than the vendor data size defined on the device. | Configure the device to work with a larger vendor data size or reduce the length of the vendor data string in the package descriptor file. |