DittoSDK.DittoSmallPeerInfo Class Reference

The entrypoint for small peer user info collection. More...

Properties
bool	IsEnabled [get, set]
Dictionary< string, object >	Metadata [get, set]
	Gets or sets the metadata as free-form, user-provided Dictionary which is serialized into JSON and is inserted into the small peer info system doc at each collection interval. The Dictionary has no schema except for the following constraints:
string	MetadataJsonString [get, set]
	Gets or sets the metadata as free-form, user-provided JSON string into the small peer info system doc at each collection interval. The JSON string provided has the following constraints:

Detailed Description

The entrypoint for small peer user info collection.

Property Documentation

IsEnabled

bool DittoSDK.DittoSmallPeerInfo.IsEnabled

getset

Gets or sets a value indicating whether small peer info collection is currently enabled. Defaults to true.

Small peer info consists of information scraped into a system collection at a repeated interval and synced to the Big Peer for device dashboard and debugging purposes.

Note: whether the background ingestion process is enabled or not is a separate decision to whether this information is allowed to sync to other peers (including the big peer). This is controlled by Sync Scopes, settable via DQL ALTER SYSTEM.

Metadata

Dictionary<string, object> DittoSDK.DittoSmallPeerInfo.Metadata

getset

Gets or sets the metadata as free-form, user-provided Dictionary which is serialized into JSON and is inserted into the small peer info system doc at each collection interval. The Dictionary has no schema except for the following constraints:

1. All contained values must be JSON serializable.
2. The size of the Dictionary serialized as JSON may not exceed 128 KB.
3. The Dictionary may only be nested up to 64 levels deep.

Exceptions

DittoValidationException

Can throw a DittoStoreException. For more granular exception handling check its subtypes: DittoDepthLimitExceededValidationException DittoSizeLimitExceededValidationException DittoNotADictionaryValidationException

MetadataJsonString

string DittoSDK.DittoSmallPeerInfo.MetadataJsonString

getset

Gets or sets the metadata as free-form, user-provided JSON string into the small peer info system doc at each collection interval. The JSON string provided has the following constraints:

1. All contained values must be JSON serializable.
2. The size of the Dictionary serialized as JSON may not exceed 128 KB.
3. The JSON may only be nested up to 64 levels deep.

Exceptions

DittoValidationException

Can throw a DittoStoreException. For more granular exception handling check its subtypes: DittoDepthLimitExceededValidationException DittoSizeLimitExceededValidationException DittoNotADictionaryValidationException