Logging

Configure how much debugging information is reported during runtime and where it is logged. More...

Modules
	Activity Context
	Add contextual information to log messages.

Classes
struct	rti::config::LogLevel_def
	The definition of the dds::core::safe_enum LogLevel;. More...
struct	rti::config::Verbosity_def
	The definition of the dds::core::safe_enum Verbosity. More...
struct	rti::config::LogCategory_def
	The definition of the dds::core::safe_enum LogCategory. More...
struct	rti::config::PrintFormat_def
	The definition of the dds::core::safe_enum PrintFormat. More...
struct	rti::config::LogMessage
	A log message, including the text and additional information. More...
class	rti::config::Logger
	The singleton type used to configure RTI Connext logging. More...
class	rti::config::ScopedLoggerVerbosity
	Changes the logger verbosity temporarily during the scope of a variable. More...

Typedefs
typedef dds::core::safe_enum< LogLevel_def >	rti::config::LogLevel
	The log level at which RTI Connext diagnostic information is logged. More...
typedef dds::core::safe_enum< Verbosity_def >	rti::config::Verbosity
	The verbosities at which RTI Connext diagnostic information is logged. More...
typedef dds::core::safe_enum< LogCategory_def >	rti::config::LogCategory
	Categories of logged messages. More...
typedef dds::core::safe_enum< PrintFormat_def >	rti::config::PrintFormat
	The format used to output RTI Connext diagnostic information. More...

Enumerations
enum class	rti::config::SyslogLevel {   rti::config::SyslogLevel::emergency ,   rti::config::SyslogLevel::alert ,   rti::config::SyslogLevel::critical ,   rti::config::SyslogLevel::error ,   rti::config::SyslogLevel::warning ,   rti::config::SyslogLevel::notice ,   rti::config::SyslogLevel::informational ,   rti::config::SyslogLevel::debug }
	The Syslog level at which RTI Connext diagnostic information is logged. More...
enum class	rti::config::SyslogVerbosity {   rti::config::SyslogVerbosity::silent ,   rti::config::SyslogVerbosity::emergency ,   rti::config::SyslogVerbosity::alert ,   rti::config::SyslogVerbosity::critical ,   rti::config::SyslogVerbosity::error ,   rti::config::SyslogVerbosity::warning ,   rti::config::SyslogVerbosity::notice ,   rti::config::SyslogVerbosity::informational ,   rti::config::SyslogVerbosity::debug }
	The Syslog verbosities at which RTI Connext diagnostic information is logged. More...
enum class	rti::config::LogFacility {   rti::config::LogFacility::user ,   rti::config::LogFacility::security ,   rti::config::LogFacility::service ,   rti::config::LogFacility::middleware }

Detailed Description

Configure how much debugging information is reported during runtime and where it is logged.

Typedef Documentation

LogLevel

typedef dds::core::safe_enum<LogLevel_def> rti::config::LogLevel

The log level at which RTI Connext diagnostic information is logged.

See also

LogLevel_def

Verbosity

typedef dds::core::safe_enum<Verbosity_def> rti::config::Verbosity

The verbosities at which RTI Connext diagnostic information is logged.

See also

Verbosity_def

LogCategory

typedef dds::core::safe_enum<LogCategory_def> rti::config::LogCategory

Categories of logged messages.

See also

LogCategory_def

PrintFormat

typedef dds::core::safe_enum<PrintFormat_def> rti::config::PrintFormat

The format used to output RTI Connext diagnostic information.

See also

PrintFormat_def

Enumeration Type Documentation

SyslogLevel

enum class rti::config::SyslogLevel

strong

The Syslog level at which RTI Connext diagnostic information is logged.

Enumerator
emergency	System is unusable. Equivalent to LogLevel::FATAL_ERROR.
alert	Should be corrected immediately. RTI Connext does not produce these messages.
critical	Critical conditions. RTI Connext does not produce these messages.
error	Error conditions. Equivalent to LogLevel::EXCEPTION.
warning	May indicate that an error will occur if action is not taken. Equivalent to LogLevel::WARNING.
notice	Events that are unusual, but not error conditions. RTI Connext does not produce these messages.
informational	Normal operational messages that require no action. Equivalent to LogLevel::LOCAL and LogLevel::REMOTE.
debug	Information useful to developers for debugging the application. Equivalent to LogLevel::DEBUG.

SyslogVerbosity

enum class rti::config::SyslogVerbosity

strong

The Syslog verbosities at which RTI Connext diagnostic information is logged.

Enumerator
silent	No output will be logged. Equivalent to rti::config::Verbosity_def::NDDS_CONFIG_LOG_VERBOSITY_SILENT.
emergency	Only fatal log messages will be logged. Only log messages with LogLevel equals to LogLevel::FATAL_ERROR will be part of this Syslog verbosity level.
alert	Only fatal log messages will be logged. Equivalent to rti::config::SyslogVerbosity::emergency.
critical	Only fatal log messages will be logged. Equivalent to rti::config::SyslogVerbosity::emergency.
error	Only error and fatal error messages will be logged. Only log messages with LogLevel equals to LogLevel::FATAL_ERROR or LogLevel::EXCEPTION will be part of this Syslog verbosity level.
warning	Fatal, error and warning messages will be logged. Only log messages with LogLevel equals to LogLevel::FATAL_ERROR, LogLevel::EXCEPTION or LogLevel::WARNING will be part of this Syslog verbosity level.
notice	Fatal, error and warning messages will be logged. Equivalent to rti::config::SyslogVerbosity::warning.
informational	Local, remote, fatal, error and warning messages will be logged. Only log messages with LogLevel equals to LogLevel::FATAL_ERROR, LogLevel::EXCEPTION, LogLevel::WARNING, LogLevel::LOCAL or LogLevel::REMOTE will be part of this Syslog verbosity level.
debug	All messages will be logged.

LogFacility

enum class rti::config::LogFacility

strong

A number that identifies the source of a log message.

In the Syslog Protocol, the Facility is a numerical code that represents the machine process that created a Syslog event. RTI Connext uses the facility to represent the source of a given log message.

Enumerator
user	A log message produced by the user's application.
security	A security-related message. A "security-related message" is a log message that meets any of the following: A security event logged with the RTI Security Plugins Logging Plugin. RTI TLS Support log messages related to OpenSSL.
service	A log message produced by an Infrastructure Service.
middleware	A log message produced by RTI Connext.