omni::structuredlog::kEventsStateListSetting

Defined in omni/structuredlog/StructuredLogSettingsUtils.h

constexpr const char *omni::structuredlog::kEventsStateListSetting = "/structuredLog/state/events"

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

Each key under this setting will have a name that matches zero or event names. From a .schema file, this would match the “namespace” property plus one of the properties under `#/events/`. From a JSON schema file, this would match one of the event properties under `#/definitions/events/`. The key’s value is expected to be a boolean that indicates whether it is enabled upon registration.

The names of the keys under this path may either be an event’s full name or a wildcard string that matches to zero or more event names. In either version, the case of the non-wildcard portions of the key name is important. The wildcard characters ‘*’ (match to zero or more characters) and ‘?’ (match to exactly one character) may be used. This is only meant to be a simple wildcard filter, not a full regular expression.

For example, in a TOML file, these settings may be used to disable or enable multiple events:

[structuredLog.state.events]
"com.nvidia.omniverse.fancy_event" = false
"com.nvidia.carbonite.*" = false            # disable all 'com.nvidia.carbonite' events.

Note

The keys in this setting path are inherently unordered. If a set of dependent enable/disable settings is needed, the kEventsStateArraySetting setting path should be used instead. This other setting allows an array to be specified that preserves the order of keys. This is useful for doing things like disabling all events then only enabling a select few.