Struct LogConfiguration

Struct Documentation

struct Microsoft::Applications::Telemetry::LogConfiguration

Public Members

bool enableLifecycleSession

[optional] Enable lifecycle session.

default will be false

bool multiTenantEnabled

[optional] Enable multiTenant default will be true

std::string eventCollectorUri

[optional] Url of the collector for sending events default will be used if not specified

std::string blobCollectorUri

[not implemented] Url of the collector for sending BLOB data default will be used if not specified

std::string cacheFilePath

[required] Full path and name of the disk file used to cache events on client side Specify one to avoid/reduce potential data loss by persisting event to file storage for them to be sent in next telemetry session.

unsigned int cacheFileSizeLimitInBytes

[optional] Size limit of the disk file used to cache events on client side.

Additional events might cause older events in the file cache to be dropped. This size limit should be larger than the cacheMemorySizeLimitInBytes below

unsigned int cacheMemorySizeLimitInBytes

[optional] Memory size limit that allows events to be cached in memory.

Additional events will cause older events to be flushed to disk file. Maximum supported in-ram queue size is 2MB.

unsigned int traceLevelMask

[optional] Debug trace module mask controls what modules may emit debug output.

default is 0 - monitor no modules

unsigned int minimumTraceLevel

[optional] Debug trace level mask controls global verbosity level.

default is ACTTraceLevel_Error

unsigned int sdkmode

Api to set SDK mode with Non UTC, UTC with common Schema or UTC with legacy Schema.

default is Non UTC

unsigned int maxTeardownUploadTimeInSec

[optional] Maximum amount of time (in seconds) allotted to upload in-ram and offline records on teardown.

If device is in a state where events are not allowed to be transmitted (offline, roaming, etc.), then the value is ignored.

default duration is 0

unsigned int maxPendingHTTPRequests

[optional] Maximum number of HTTP requests posted to HTTP stack.

This value controls how much RAM is allocated for pending HTTP requests.

Each request may consume up to ~1MB of RAM. On slow network connections

it may happen that there is a large number of requests pending.

default value is 4

unsigned int maxDBFlushQueues

[optional] Maximum number of DB flush back buffers / queues.

Each Flush() operation or overflow of in-ram to offline storage is handled

asynchronously by swapping in-ram queue to a back buffer and scheduling

asynchronous task that saves the buffer to offline storage.

Each queue consumes up to

cacheMemorySizeLimitInBytes

bytes.

Default value is 3 queues (back buffers)