omni/structuredlog/StructuredLogSettingsUtils.h

↰ Parent directory: omni/structuredlog/

Utilities for the carb::settings::ISettings settings for structured logging.

Source: omni/structuredlog/StructuredLogSettingsUtils.h

Included By

• carb/StartupUtils.h: Contains carb::startupFramework and carb::shutdownFramework. Consider using OMNI_CORE_INIT, which invokes these methods for you in a safe manner.

Namespaces

• omni: Main namespace for Omniverse.

• omni::structuredlog: Structured logging and Telemetry.

Functions

• omni::structuredlog::configureStructuredLogging: Checks the settings registry for structured log settings and makes them active.

• omni::structuredlog::setStructuredLogLoggingEnabled: Enables or disables the structured logging log message redirection.

Variables

• omni::structuredlog::kDefaultEventQueueSize: The default value for the event queue size in bytes.

• omni::structuredlog::kDefaultIdMode: The default mode for generating event IDs.

• omni::structuredlog::kDefaultIdType: The default type of event ID to generate.

• omni::structuredlog::kDefaultLogNameSetting: The default log name to use.

• omni::structuredlog::kDefaultLogRetentionCount: The default log retention setting.

• omni::structuredlog::kDefaultLogSizeLimit: Constants for default and minimum values for various settings.

• omni::structuredlog::kEnableLogConsumerSetting: The setting path for the log consumer toggle.

• omni::structuredlog::kEventIdModeSetting: The setting path for the event identifier mode.

• omni::structuredlog::kEventIdTypeSetting: The setting path for the event identifier data type.

• omni::structuredlog::kEventQueueSizeSetting: The setting path for the size of the event queue buffer in kilobytes.

• omni::structuredlog::kEventsStateArraySetting: The setting path to an array that will contain zero or more values that will be used to disable or enable events when they are first registered.

• omni::structuredlog::kEventsStateListSetting: The setting path that will contain zero or more keys that will be used to disable events when they are first registered.

• omni::structuredlog::kGlobalEnableSetting: Names for various settings that can be used to override some of the default settings.

• omni::structuredlog::kLogDirectory: The directory where the logs will be sent to.

• omni::structuredlog::kLogRetentionCountSetting: The setting path for the log retention count.

• omni::structuredlog::kLogSizeLimitSetting: The setting path for the log size limit in megabytes.

• omni::structuredlog::kMinEventQueueSize: The minimum allowed event queue size in bytes.

• omni::structuredlog::kMinLogRetentionCount: The minimum allowed log retention setting.

• omni::structuredlog::kMinLogSizeLimit: The minimum value that can be set for the log size limit in bytes.

• omni::structuredlog::kSchemasStateArraySetting: The setting path to an array that will contain zero or more values that will be used to disable or enable schemas when they are first registered.

• omni::structuredlog::kSchemasStateListSetting: The setting path that will contain zero or more keys that will be used to disable schemas when they are first registered.