Using the Device Dashboard
The Portal Device Dashboard provides insights into devices that have been deployed with an application embedded with the Ditto SDK. With the Device Dashboard, you can gather and store peer-to-peer sync and network details automatically rather than needing to continuously query Ditto for this data.
The Device Dashboard is powered by the Small Peer Info (smallPeerInfo) Ditto system collection and avaiable for Ditto SDK version 4.4.0 and later.
Once enabled, you can access the following details for each device using the portal:
- Mesh network connection status
- Timestamp when last seen by the Big Peer cloud deployment
- Names and unique identifiers
- Operating System (OS)
- Address peer key
- Latest device logs
- Custom user metadata
The Device Dashboard will automatically be populated with smallPeerInfo in the Ditto SDK 4.8.0 and later.
To opt out of having device data written and transmitted to the Portal, you must disable smallPeerInfo
In earlier versions of the Ditto SDK, the smallPeerInfo feature needs to be manually enabled to collect data. Enable smallPeerInfo before calling startSync() using the following steps:
Set smallPeerInfo.isEnabled set to true :
Set the sync scope to BigPeer Only which indicates that the data should be synced to the Cloud (BigPeer). Default is that the data is only captured locally.
The devices dashboard is only supported on devices with SDK version 4.4.0 and later. You must upgrate your application to a support version to take advantage of this feature capability.
For cross-platform development or when targeting iOS, if you want the ability to uniquely identify devices within Ditto, call the deviceName property on the ditto namespace and specify the desired name.
This must be set before calling startSync() to take effect.
You can add custom device information into the device dashboard by setting the Small Peer Info metadata property on a device.