omni::structuredlog::kEventsStateArraySetting

Defined in omni/structuredlog/StructuredLogSettingsUtils.h

constexpr const char *omni::structuredlog::kEventsStateArraySetting = "/structuredLog/eventStates"

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.

Each value in this array will have a name that matches zero or more event names. From a .schema file, this would match one of the property names under #/events/. From a JSON schema file, this would match one of the event object names in `#/definitions/events/`. The event name may be optionally prefixed by either ‘+’ or ‘-’ to enable or disable (respectively) matching event(s). Alternatively, the event’s name may be assigned a boolean value to indicate whether it is enabled or not. If neither a ‘+’/’-’ prefix nor a boolean assignment suffix is specified, ‘enabled’ is assumed.

The names in this array 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 array entry 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 schemas:

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

Note

that TOML does not allow static arrays such as above to be appended to with later lines. Attempting to do so will result in a parsing error.