Logging - Platform#

otLogRegion#

otLogRegion

Represents log regions.

The support for log region is removed and instead each core module can define its own name to appended to the logs. However, the otLogRegion enumeration is still defined as before to help with platforms which we may be using it in their otPlatLog() implementation. The OT core will always emit all logs with OT_LOG_REGION_CORE.

otLogLevel#

typedef int otLogLevel

Represents the log level.

otLogRegion#

typedef enum otLogRegion otLogRegion

Represents log regions.

The support for log region is removed and instead each core module can define its own name to appended to the logs. However, the otLogRegion enumeration is still defined as before to help with platforms which we may be using it in their otPlatLog() implementation. The OT core will always emit all logs with OT_LOG_REGION_CORE.

otPlatLog#

void otPlatLog (otLogLevel aLogLevel, otLogRegion aLogRegion, const char * aFormat, ... )

Outputs logs.

This platform API is used to output logs when the configuration OPENTHREAD_CONFIG_LOG_INSTANCE_AWARE_API_ENABLE is disabled. When the configuration is enabled, otPlatLogOutput() is used instead.

Note that the support for log region is removed. The OT core will always emit all logs with OT_LOG_REGION_CORE as aLogRegion.

otPlatLogOutput#

void otPlatLogOutput (otInstance * aInstance, otLogLevel aLogLevel, const char * aLogLine)

Outputs a log line.

This platform API is an alternative to otPlatLog() and is used when the configuration OPENTHREAD_CONFIG_LOG_INSTANCE_AWARE_API_ENABLE is enabled.

Unlike otPlatLog(), this API also provides a pointer to the OpenThread instance (otInstance*) from which the log is generated. This is particularly helpful in a multi-instance setup to distinguish logs from different instances. Additionally, it provides the log line as a fully formatted null-terminated string instead of a format string and variable arguments.

otPlatLogHandleLevelChanged#

void otPlatLogHandleLevelChanged (otLogLevel aLogLevel)

Handles OpenThread log level changes.

This platform function is optional. An empty weak implementation is provided by OpenThread core.

This platform function is called whenever the OpenThread log level changes:

• In a single-instance configuration, this is called when the log level changes.

• In a multi-instance configuration, this is called when the global log level changes.

Note

• Only applicable when OPENTHREAD_CONFIG_LOG_LEVEL_DYNAMIC_ENABLE=1.

otPlatLogHandleLogLevelChanged#

void otPlatLogHandleLogLevelChanged (otInstance * aInstance, otLogLevel aLogLevel)

Handles OpenThread instance-specific log level changes.

This platform function is optional. An empty weak implementation is provided by OpenThread core.

This platform function is called whenever the instance-specific log level changes:

• In a single-instance configuration, this is called along with otPlatLogHandleLevelChanged().

• In a multi-instance configuration, if OPENTHREAD_CONFIG_LOG_INSTANCE_AWARE_API_ENABLE is used, this is called when the instance-specific log level changes.