IStructuredLogFromILog

class omni.structuredlog.IStructuredLogFromILog

Bases: _IStructuredLogFromILog

This interface controls the ability to send Carbonite and Omniverse logging through the structured log system. The output is equivalent to the standard logging output, except that it is in JSON, so it will be easier for programs to consume.

The default state of structured log logging is off, but it can be enabled by calling @ref omni::structuredlog::IStructuredLogFromILog::enableLogging() or setting ``/structuredLog/enableLogConsumer`` to true with ISettings.

Methods

`__init__`(args, *kwargs)	Overloaded function.
`disable_logging`(self)	Disables the structured log logger.
`enable_logging`(self)	Enable the structured log logger.

Attributes

logging_event_id

__init__(*args, **kwargs)

Overloaded function.

__init__(self: omni.structuredlog._structuredlog.IStructuredLogFromILog, arg0: omni.core._core.IObject) -> None
__init__(self: omni.structuredlog._structuredlog.IStructuredLogFromILog) -> None

disable_logging(self: omni.structuredlog._structuredlog._IStructuredLogFromILog) → None

Disables the structured log logger.

@remarks After this is called, log messages will no longer be sent as structured log: events to the structured log system’s log file.

enable_logging(self: omni.structuredlog._structuredlog._IStructuredLogFromILog) → None

Enable the structured log logger.

@remarks Enabling this will result in all Carbonite logging (e.g. CARB_LOG_*) and all: Omniverse logging (e.g. OMNI_LOG_*) going to the structured log log file. This may be useful if you want the logs to be consumed by some sort of log reader program. These log events will be sent to the default structured log system’s log file if there is one; they will otherwise go to a log file named “omni.structuredlog.logging-{version}”. These log events will not be sent to the collection servers.