omni::structuredlog::kEmitPayloadOnlySettings

Defined in omni/structuredlog/StructuredLogSettingsUtils.h

constexpr const char *omni::structuredlog::kEmitPayloadOnlySettings = "/structuredLog/emitPayloadOnly"

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

By default, each event will be emitted as a CloudEvent compliant JSON object. If this setting is enabled, the CloudEvent wrapper will be skipped and only the schema’s defined payload for the event will be emitted. The main payload will be emitted as the top level object in the JSON output when this setting is enabled.

Note that when this setting is used, the output will be incompatible with the telemetry transmitter and the rest of the Omniverse telemetry toolchain. If a host app decides to use this feature, they will be responsible for including all the relevant information that would normally be part of the CloudEvents header. This includes fields such as the user ID, event type, event schema, event ID, etc. This setting defaults to false.