omni/structuredlog/IStructuredLog.h

↰ Parent directory: omni/structuredlog/

The core structured logging interface.

Source: omni/structuredlog/IStructuredLog.h

Included By

• omni/structuredlog/StructuredLogSettingsUtils.h: Utilities for the carb::settings::ISettings settings for structured logging.

• omni/core/Omni.h: Main header for the Omniverse core.

Namespaces

• omni: Main namespace for Omniverse.

• omni::structuredlog: Structured logging and Telemetry.

Classes

• omni::structuredlog::EventInfo: A descriptor for a single structured log event.

• omni::structuredlog::IStructuredLog: Main structured log interface.

• omni::structuredlog::IStructuredLog_abi: Main structured log interface.

Functions

• omniGetStructuredLogWithoutAcquire: Retrieves the module’s structured log object.

Defines

• OMNI_STRUCTURED_LOG: Common entry point for sending an event.

Typedefs

• omni::structuredlog::AllocFlags: Base type for flags to control how new events are allocated.

• omni::structuredlog::AllocHandle: Base type for the handle to an allocated block of memory returned from either the IStructuredLog::allocSchema() or IStructuredLog::allocEvent() functions.

• omni::structuredlog::EnableFlags: Base type for flags to control how events and schemas are enabled or disabled.

• omni::structuredlog::EventFlags: Base type for flags to control the behaviour of processing a single event.

• omni::structuredlog::ParserVersion: Base type for the version of the event payload parser to use.

• omni::structuredlog::SchemaFlags: Base type for flags to control the behaviour of the handling of a schema as a whole.

Variables

• omni::structuredlog::fAllocFlagOnlyQueue: Flag to indicate that the event should only be added to the queue on commit but that the consumer thread should not be started yet if it is not already running.

• omni::structuredlog::fEnableFlagAll: Flag to indicate that an enable state change should affect the entire system, not just one schema or event.

• omni::structuredlog::fEnableFlagOverrideEnableState: Flag to indicate that the enable state of each event in a schema should be overridden when the omni::structuredlog::fEnableFlagWholeSchema flag is also used.

• omni::structuredlog::fEnableFlagWholeSchema: Flag to indicate that a call to IStructuredLog::setEnabled() should affect the entire schema that the named event ID belongs to instead of just the event.

• omni::structuredlog::fEventFlagCriticalEvent: Flag to indicate that this event is critical to succeed and should potentially block the calling thread on IStructuredLog::allocEvent() calls if the event queue is full.

• omni::structuredlog::fEventFlagUseLocalLog: Use the log file specified by the owning event’s schema instead of the default log for the process.

• omni::structuredlog::fSchemaFlagKeepLogOpen: Flag to indicate that the log file should remain open between messages.

• omni::structuredlog::fSchemaFlagLogWithProcessId: Flag to indicate that the log file for this schema should include the process ID in the filename.

• omni::structuredlog::kMaxMessageLength: Approximate size of the maximum data payload in bytes that a message can contain that can be transmitted in a single message.

• omni::structuredlog::kMaxMessageLengthBase64: Approximate size of the maximum data payload in bytes that a message can contain that can be transmitted in a single message when the payload is encoded in Base64.

• omni::structuredlog::kNullTerminatedString: A special string length value to indicate that a string parameter to a generated event sending function is null terminated and should have its length calculated instead of passing in an explicit length.

• omni::structuredlog::kParserVersion: The current event payload parser version that will be used in the omni::structuredlog::IStructuredLog interface.

• omni::structuredlog::kStructuredLogPluginName: The expected base name for the structured log plugin.