Skip to main content

Class DataCollectionSettings

Settings containing data collection configuration.

public sealed class DataCollectionSettings : Settings<DataCollectionSettings, DataCollectionSettingsBuildTargetCollection>

Inheritance​

Inherited Members​

Fields​

DEFAULT_COLLECTION_ENABLED​

The default state of the master data collection switch.

public const bool DEFAULT_COLLECTION_ENABLED = true

Field Value​

bool

DEFAULT_DATA_COLLECTION_INTERVAL​

The default interval (in seconds) between data collection events. Controls how frequently data is timestamped and logged by the LogAnalysis.

public const float DEFAULT_DATA_COLLECTION_INTERVAL = 0.1

Field Value​

float

DEFAULT_MAX_CACHE_SIZE​

The default maximum size (in number of items) of the data cache before old data is written to a file. A larger value uses more memory but reduces the frequency of writes to disk.

public const int DEFAULT_MAX_CACHE_SIZE = 200

Field Value​

int

DEFAULT_MAX_RETRY_COUNT​

The default number of retry attempts for a failed request before giving up.

public const int DEFAULT_MAX_RETRY_COUNT = 5

Field Value​

int

DEFAULT_REQUEST_TIME​

The default time (in seconds) to wait before canceling a request if it doesn't complete. Used for setting the timeout for network requests.

public const int DEFAULT_REQUEST_TIME = 12

Field Value​

int

Properties​

CollectionEnabled​

Static convenience accessor for the master switch. Returns false when no settings instance exists for the active build target, so callers fail closed.

public static bool CollectionEnabled { get; }

Property Value​

bool

DataCollectionInterval​

Gets the interval (in seconds) for collecting data from the selected profile. This determines how often data is timestamped by the LogAnalysis.

public float DataCollectionInterval { get; }

Property Value​

float

IsDataCollectionEnabled​

Gets whether data collection is enabled for the selected profile of the active build target.

public bool IsDataCollectionEnabled { get; }

Property Value​

bool

MaxCacheSize​

Gets the maximum size of the data cache from the selected profile. This value controls how much data is kept in memory before being written to a cache file.

public int MaxCacheSize { get; }

Property Value​

int

MaxRetryCount​

Gets the maximum number of retry attempts for failed requests from the selected profile.

public int MaxRetryCount { get; }

Property Value​

int

Method​

Get the configured data collection method from the selected profile.

public RequestMethod Method { get; }

Property Value​

RequestMethod

RequestTimeout​

Gets the timeout (in seconds) for data upload requests from the selected profile. This is the time to wait before canceling a request if it has not completed.

public int RequestTimeout { get; }

Property Value​

int

SaveDirectory​

Gets the directory where data will be saved locally from the selected profile. If a path is provided, it resolves environment variables (e.g., %USERPROFILE%) within the path. If the path is empty, it defaults to Unity's persistent data path.

public string SaveDirectory { get; }

Property Value​

string

ServerAddress​

Gets the server address to which data will be uploaded from the selected profile.

public string ServerAddress { get; }

Property Value​

string

  • Fields
    • DEFAULT_COLLECTION_ENABLED
    • DEFAULT_DATA_COLLECTION_INTERVAL
    • DEFAULT_MAX_CACHE_SIZE
    • DEFAULT_MAX_RETRY_COUNT
    • DEFAULT_REQUEST_TIME
  • Properties
    • CollectionEnabled
    • DataCollectionInterval
    • IsDataCollectionEnabled
    • MaxCacheSize
    • MaxRetryCount
    • Method
    • RequestTimeout
    • SaveDirectory
    • ServerAddress