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 }
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 }
enum class	rti::config::LogFacility {   rti::config::LogFacility::user ,   rti::config::LogFacility::security_event ,   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

Syslog level category assigned to RTI Connext log messages. See Syslog Level and Verbosity Mapping, in the Core Libraries User's Manual, for more information.

Enumerator
emergency	System is unusable. Maps to rti::config::LogLevel_def::FATAL_ERROR.
alert	Should be corrected immediately. Maps to rti::config::LogLevel_def::EXCEPTION.
critical	Critical conditions. Maps to rti::config::LogLevel_def::EXCEPTION.
error	Error conditions. Maps to rti::config::LogLevel_def::EXCEPTION.
warning	May indicate that an error will occur if action is not taken. Maps to rti::config::LogLevel_def::WARNING.
notice	Events that are unusual, but not error conditions. Maps to rti::config::LogLevel_def::STATUS_LOCAL.
informational	Normal operational messages that require no action. Maps to rti::config::LogLevel_def::STATUS_LOCAL.
debug	Information useful to developers for debugging the application. Maps to rti::config::LogLevel_def::STATUS_ALL.

SyslogVerbosity

enum class rti::config::SyslogVerbosity

strong

The Syslog verbosities at which RTI Connext diagnostic information is logged. These Syslog verbosities are mapped to rti::config::Verbosity_def. See Syslog Level and Verbosity Mapping, in the Core Libraries User's Manual, for more information.

Enumerator
silent	No messages will be logged. (lowest verbosity) Equivalent to rti::config::Verbosity_def::silent.
emergency	Emergency, critical, alert, and error messages will be logged. This Syslog verbosity level is translated to rti::config::Verbosity_def::exception when interpreted by RTI Connext. (That's why this level actually logs more than just emergency messages.)
alert	Emergency, critical, and alert messages will be logged. This Syslog verbosity level is translated to rti::config::Verbosity_def::exception when interpreted by RTI Connext. (That's why this level actually logs more than just emergency, critical and alert messages.)
critical	Emergency, critical, alert, and error messages will be logged. This Syslog verbosity level is translated to rti::config::Verbosity_def::exception when interpreted by RTI Connext. (That's why this level actually logs more than just emergency and critical messages.)
error	Emergency, critical, alert, and error messages will be logged. This Syslog verbosity level is translated to rti::config::Verbosity_def::exception when interpreted by RTI Connext.
warning	Emergency, critical, alert, error, and warning messages will be logged. This Syslog verbosity level is translated to rti::config::Verbosity_def::warning when interpreted by RTI Connext.
notice	Emergency, critical, alert, error, warning, notice and informational messages will be logged. This Syslog verbosity level is translated to rti::config::Verbosity_def::status_remote when interpreted by RTI Connext. (That's why this level actually logs more than just emergency, critical, alert, error, warning and notice messages.)
informational	Emergency, critical, alert, error, warning, notice, and informational messages will be logged. This Syslog verbosity level is translated to rti::config::Verbosity_def::status_remote when interpreted by RTI Connext.
debug	All messages will be logged. This Syslog verbosity level is translated to rti::config::Verbosity_def::status_all when interpreted by RTI Connext.

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 APIs that log user messages in rti::config::Logger (e.g, rti::config::Logger::emergency). Numerical code: 1
security_event	A security-related message logged by the RTI Security Plugins Logging Plugin. Numerical code: 10
service	A log message produced by an Infrastructure Service, such as Routing Service. Infrastructure Services operate using the Core Libraries. The messages that the Core Libraries create are categorized under the MIDDLEWARE facility. Log messages that are directly generated by the Infrastructure Service itself are marked with the SERVICE facility. Numerical code: 22
middleware	A log message produced by RTI Connext Core Libraries. Numerical code: 23