omni::structuredlog

namespace structuredlog

Structured logging and Telemetry.

Classes

• omni::structuredlog::Allocator: A memory allocator interface, which can be overwritten with your custom allocator.

• omni::structuredlog::BasicStringView: An extension of carb::cpp::basic_string_view that can handle nullptr and std::basic_string as inputs.

• omni::structuredlog::BinaryBlobSizeCalculator: A helper class to calculate the required size of a binary blob.

• omni::structuredlog::BlobReader: A class to read binary blobs produced by the BlobWriter .

• omni::structuredlog::BlobWriter: A class to build a binary blob.

• omni::structuredlog::BlockAllocator: An implementation of Allocator which will just allocate from a preallocated block of memory and never deallocate memory until the full preallocated block is freed.

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

• omni::structuredlog::IStructuredLogControl: Structured log state control interface.

• omni::structuredlog::IStructuredLogControl_abi: Structured log state control interface.

• omni::structuredlog::IStructuredLogExtraFields: Interface to manage extra CloudEvent fields to be included in each emitted message.

• omni::structuredlog::IStructuredLogExtraFields_abi: Interface to manage extra CloudEvent fields to be included in each emitted message.

• omni::structuredlog::IStructuredLogFromILog: This interface controls the ability to send Carbonite and Omniverse logging through the structured log system.

• omni::structuredlog::IStructuredLogFromILog_abi: This interface controls the ability to send Carbonite and Omniverse logging through the structured log system.

• omni::structuredlog::IStructuredLogSettings: Structured log settings interface.

• omni::structuredlog::IStructuredLogSettings2: Interface for the second version of the IStructuredLogSettings interface.

• omni::structuredlog::IStructuredLogSettings2_abi: Interface for the second version of the IStructuredLogSettings interface.

• omni::structuredlog::IStructuredLogSettings_abi: Structured log settings interface.

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

• omni::structuredlog::JsonBuilder: A class to build JSON trees using JsonNode structs.

• omni::structuredlog::JsonConsumer: An interface for consuming the output JSON from the JsonSerializer .

• omni::structuredlog::JsonLengthCounter: An implementation of JsonConsumer that just counts the length of the output string.

• omni::structuredlog::JsonPrinter: An implementation of JsonConsumer that just prints to a fixed string.

• omni::structuredlog::JsonSerializer: A utility that allows you to easily encode JSON data.

• omni::structuredlog::JsonTreeSizeCalculator: Class for determining the allocation size required to build a JSON tree in a single block of memory.

• omni::structuredlog::TempJsonNode: A temporary JsonNode object that will be cleaned up at the end of a scope.

Enumerations

• omni::structuredlog::IdMode: Names to control how the next event identifier is generated after each event message.

• omni::structuredlog::IdType: Names to control what type of event identifiers will be used for each message.

• omni::structuredlog::JsonTreeCompareFuzz: Options to do a less of a strict comparison when comparing trees.

• omni::structuredlog::NodeType: The data type contained within a JsonNode .

• omni::structuredlog::SchemaResult: Possible results from registering a new schema.

Functions

• omni::structuredlog::addModulesSchemas: A function that registers all schemas within a module.

• omni::structuredlog::clearJsonTree: Free any memory allocated to a JsonNode and clear it out to an empty node.

• omni::structuredlog::compareJsonTrees: Perform a deep comparison of two nodes.

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

• omni::structuredlog::getSchemaResultName: Retrieves a string containing the name of a SchemaResult value.

• omni::structuredlog::ignoreJsonTreeSerializerValidationError: Default value for the onValidationError template parameter.

• omni::structuredlog::serializeArray: Serialize an array type from a JSON tree.

• omni::structuredlog::serializeEnum

• omni::structuredlog::serializeJsonTree: Serialize JSON using a JsonNode as the schema and a binary blob to read data.

• omni::structuredlog::serializeJsonTree: Serialize JSON using a JsonNode as the schema and a binary blob to read data.

• omni::structuredlog::serializeScalar: Serialize a scalar type from a JSON tree.

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

Namespaces

• omni::structuredlog::@253: Anonymous namespace for a helper function.

• omni::structuredlog::@266: Anonymous namespace for a helper function.

Structs

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

• omni::structuredlog::JsonNode: A node in a JSON structure.

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 behavior of processing a single event.

• omni::structuredlog::EventId: Base type for a unique ID of a registered event.

• omni::structuredlog::ExtraFieldFlags: Base type for flags that control how extra field flags are specified or retrieved in omni::structuredlog::IStructuredLogExtraFields::getExtraCloudEventField() and omni::structuredlog::IStructuredLogExtraFields::setExtraCloudEventField().

• omni::structuredlog::OnBlobWriterValidationErrorFunc: The prototype of the function to call when a validation error occurs.

• omni::structuredlog::OnValidationErrorFunc: The prototype of the function to call when a validation error occurs.

• omni::structuredlog::OutputFlags: Base type for the ouptut flags for the structured logging system.

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

• omni::structuredlog::PrivacyLoadFlags: Base type for the flags for that can be passed in the flags parameter to the omni::structuredlog::IStructuredLogSettings::loadPrivacySettingsFromFile() function.

• omni::structuredlog::SchemaAddFn: Registration function to install a schema with the structured logging system.

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

• omni::structuredlog::SessionId: Base type for a session ID.

• omni::structuredlog::StringView: String view for char strings.

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 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::fEventFlagOutputToStderr: Flag to indicate that this event should be output to the stderr file.

• omni::structuredlog::fEventFlagOutputToStdout: Flag to indicate that this event should be output to the stdout file.

• omni::structuredlog::fEventFlagSkipLog: Flag to indicate that this event should not be output to the schema's specified log file.

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

• omni::structuredlog::fExtraFieldFlagNone: Value to indicate that no special flags are being specified.

• omni::structuredlog::fOutputFlagEmitCloudHeartbeat: Flag to indicate that the cloud heartbeat events should be emitted as well as the normal heartbeat events.

• omni::structuredlog::fOutputFlagNone: Special flag value to indicate that no output flags are being specified.

• omni::structuredlog::fOutputFlagPayloadOnly: Flag to indicate that only emit the payload portion of each message as the full output instead of including the CloudEvents wrapper as well.

• omni::structuredlog::fOutputFlagSkipLogHeaders: Flag to indicate that no header should be written out to log files created by the structured logging system.

• omni::structuredlog::fPrivacyLoadFlagResetSettings: Flag to indicate that the privacy settings keys that the privacy settings that could affect user privacy functionality should be explicitly reset to their default values before loading the new privacy file.

• 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::kAllSchemas: A special value to indicate that an operation should affect all registered schemas.

• omni::structuredlog::kAnonymousUserIdModeSetting: The setting path that will indicate which type of anonymous user ID will be used in cases where no user ID is provided in the privacy.toml file or the privacy.toml file is missing.

• omni::structuredlog::kBadEventId: A special value to indicate a bad event identifier.

• omni::structuredlog::kBlobReaderNoValidate

• omni::structuredlog::kBlobReaderValidate

• omni::structuredlog::kBlobWriterNoValidate

• omni::structuredlog::kBlobWriterValidate

• omni::structuredlog::kDefaultAnonymousUserIdModeSetting: The default mode for how a random user ID is chosen.

• omni::structuredlog::kDefaultEmitCloudHeartbeat: The default state for whether the cloud heartbeat events will be emitted.

• omni::structuredlog::kDefaultEmitPayloadOnlySettings: The default state for whether the CloudEvents wrapper will be output with each message.

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

• omni::structuredlog::kDefaultHeartbeatPeriod: The default minimum time between heartbeat events in seconds.

• 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::kDefaultLogPathEvent: A special name to request the log file path for the default log (if set).

• omni::structuredlog::kDefaultLogPathName: A special name for the default log output path.

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

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

• omni::structuredlog::kDefaultNeedLogHeaders: The default state for whether headers will be added to each written log file.

• omni::structuredlog::kEmitCloudHeartbeatSetting: The setting path that will indicate whether the cloud heartbeat events will be enabled.

• omni::structuredlog::kEmitPayloadOnlySettings: The setting path that will indicate whether the CloudEvents wrapper should be added to the payload of each emitted event.

• 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::kExtraFieldsSettingBranch: The settings branch that will be expected to contain zero or more key/value pairs for extra fields to be added to each output message.

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

• omni::structuredlog::kHeartbeatDisabled: Special value to indicate that the heartbeat event should be disabled.

• omni::structuredlog::kHeartbeatPeriodSetting: The setting path that will contain the minimum number of seconds between heartbeat events A heartbeat event is one that is sent periodically to help calculate session lengths even if the expected 'exit' or 'crash' process lifetime events are missing.

• omni::structuredlog::kLogDirectory: Specifies the directory that log files should be written 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::kMaxEventQueueSize: The maximum allowed event queue size in bytes.

• 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::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::kNeedLogHeadersSetting: The setting path that will indicate whether headers will be added to each log file that is written to disk.

• 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 IStructuredLog interface.

• omni::structuredlog::kPrivacyFileSetting: The setting path for the privacy settings file to load.

• 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.

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