---
title: Using the Device Dashboard
slug: cloud/portal/capturing-small-peer-info
docTags: 
createdAt: 2023-11-20T15:19:33.953Z
---

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



# Viewing devices with Ditto SDK 4.8.0 and later

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`

:::CodeblockTabs
```swift
ditto.smallPeerInfo.isEnabled = false
```

```kotlin
ditto.smallPeerInfo.isEnabled = false
```

```javascript
ditto.smallPeerInfo.isEnabled = false
```

```java
ditto.smallPeerInfo.isEnabled = false
```

```csharp
ditto.SmallPeerInfo.IsEnabled = false;
```

```cpp
ditto.get_small_peer_info().set_enabled(false)
```

```rust
ditto.small_peer_info().set_enabled(false)
```

Dart(beta)

```dart
// Coming Soon
```
:::



# Viewing devices with Ditto SDK 4.4.0 - 4.7.x

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:

:::::WorkflowBlock
::::WorkflowBlockItem
 Set `smallPeerInfo.isEnabled` set to `true` :

:::CodeblockTabs
```swift
ditto.smallPeerInfo.isEnabled = true
```

```kotlin
ditto.smallPeerInfo.isEnabled = true
```

```javascript
ditto.smallPeerInfo.isEnabled = true
```

```java
ditto.smallPeerInfo.isEnabled = true
```

```csharp
ditto.SmallPeerInfo.IsEnabled = true;
```

```cpp
ditto.get_small_peer_info().set_enabled(true)
```

```rust
ditto.small_peer_info().set_enabled(true)
```

Dart(beta)

```dart
// Coming Soon
```
:::
::::

::::WorkflowBlockItem
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. 

:::CodeblockTabs
```swift
ditto.smallPeerInfo.syncScope = .bigPeerOnly
```

```kotlin
ditto.smallPeerInfo.syncScope = DittoSmallPeerInfoSyncScope.BigPeerOnly
```

```javascript
await ditto.smallPeerInfo.setSyncScope("BigPeerOnly")
```

```java
ditto.smallPeerInfo.syncScope = DittoSmallPeerInfoSyncScope.BigPeerOnly
```

```csharp
ditto.SmallPeerInfo.SyncScope  = DittoSmallPeerInfoSyncScope.BigPeerOnly
```

```cpp
ditto.get_small_peer_info().sync_scope(), SyncScope::BigPeerOnly
```

```rust
ditto.small_peer_info()..set_sync_scope(DittoSmallPeerInfoSyncScope::BigPeerOnly);
```

Dart(beta)

```dart
// Coming Soon
```
:::
::::
:::::



# Viewing devices with Ditto SDK 4.3.x and Earlier

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.



# Custom User Defined Device Name

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.

:::hint{type="info"}
This must be set before calling `startSync()` to take effect.
:::

:::CodeblockTabs
```swift
ditto.deviceName = "your device name"
```

```kotlin
ditto.deviceName = "your device name"
```

```javascript
ditto.deviceName = "your device name"
```

```java
ditto.deviceName = "your device name"
```

```csharp
ditto.DeviceName = "your device name";
```

```cpp
ditto.device_name = "your device name";
```

```rust
ditto.set_device_name("your device name");
```

Dart(beta)

```dart
// Coming Soon
```
:::



# Custom User Metadata

You can add custom device information into the device dashboard by setting the Small Peer Info `metadata` property on a device.

:::CodeblockTabs
```swift
var metadata: [String: String] = [
    "app_version": "1.0.0",
    "device_id": "abc123"
]

// Set the object directly
ditto.smallPeerInfo.setMetadata(metadata)

// or

// Convert dictionary to JSON string
if let jsonData = try? JSONSerialization.data(withJSONObject: metadata, options: []),
    let jsonString = String(data: jsonData, encoding: .utf8) {

    // Set with a JSON serialized payload
    ditto.smallPeerInfo.setMetadataJSONString(jsonString)
}
```

```kotlin
val metadata = mutableMapOf<String, String>(
    "app_version" to "1.0.0",
    "device_id" to "abc123"
)

// Set the object directly
ditto.smallPeerInfo.metadata = metadata

// or

val jsonMetadata = JSONObject(metadata)
val jsonString = jsonMetadata.toString()

// Set with a JSON serialized payload
ditto.smallPeerInfo.metadataJsonString = jsonString
```

```javascript
const metadata = {
  app_version: "1.0.0",
  device_id: "abc123"
}

// Set the object directly
ditto.smallPeerInfo.metadata = metadata

// or

const jsonString = JSON.stringify(metadata)

// Set with a JSON serialized payload
ditto.smallPeerInfo.metadataJSONString = jsonString
```

```java
Map<String, String> metadata = new HashMap<>();
metadata.put("app_version", "1.0.0");
metadata.put("device_id", "abc123");

// Set the object directly
ditto.smallPeerInfo.setMetadata(metadata);

// or

JSONObject jsonMetadata = new JSONObject(metadata);
String jsonString = jsonMetadata.toString();

// Set with a JSON serialized payload
ditto.smallPeerInfo.setMetadataJsonString(jsonString);
```

```csharp
Dictionary<string, string> metadata = new Dictionary<string, string>
{
    { "app_version", "1.0.0" },
    { "device_id", "abc123" }
};

// Set the object directly
ditto.SmallPeerInfo.Metadata = metadata;

// or

string jsonString = JsonConvert.SerializeObject(metadata);

// Set with a JSON serialized payload
ditto.SmallPeerInfo.MetadataJsonString = jsonString;
```

```cpp
std::map<std::string, std::string> metadata;
metadata["app_version"] = "1.0.0";
metadata["device_id"] = "abc123";

// Set the object directly
ditto.get_small_peer_info().set_metadata(metadata);

// or

nlohmann::json json_metadata(metadata);
std::string json_string = json_metadata.dump();

// Set with a json serilalized payload
ditto.get_small_peer_info().set_metadata_json_string(json_string)
```

```rust
use std::collections::HashMap;
use serde_json::json;

let mut metadata = HashMap::new();
metadata.insert("app_version".to_string(), "1.0.0".to_string());
metadata.insert("device_id".to_string(), "abc123".to_string());

// Set the object directly 
ditto.get_small_peer_info().set_metadata(metadata.clone());

// or

let json_metadata = json!(metadata);
let json_string = json_metadata.to_string();

// Set with a JSON serialized payload
ditto.get_small_peer_info().set_metadata_json_string(json_string);
```

Dart(beta)

```dart
// Coming Soon
```
:::