RTI Connext Traditional C++ API Version 7.2.0

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  NDDS_Config_LogMessage
 Log message. More...
 
class  NDDSConfigLoggerDevice
 <<interface>> Logging device interface. Use for user-defined logging devices. More...
 
class  NDDSConfigLogger
 <<interface>> The singleton type used to configure RTI Connext logging. More...
 

Enumerations

enum  NDDS_Config_LogVerbosity {
  NDDS_CONFIG_LOG_VERBOSITY_SILENT ,
  NDDS_CONFIG_LOG_VERBOSITY_ERROR ,
  NDDS_CONFIG_LOG_VERBOSITY_WARNING ,
  NDDS_CONFIG_LOG_VERBOSITY_STATUS_LOCAL ,
  NDDS_CONFIG_LOG_VERBOSITY_STATUS_REMOTE ,
  NDDS_CONFIG_LOG_VERBOSITY_STATUS_ALL
}
 The verbosities at which RTI Connext diagnostic information is logged. More...
 
enum  NDDS_Config_LogLevel {
  NDDS_CONFIG_LOG_LEVEL_FATAL_ERROR ,
  NDDS_CONFIG_LOG_LEVEL_ERROR ,
  NDDS_CONFIG_LOG_LEVEL_WARNING ,
  NDDS_CONFIG_LOG_LEVEL_STATUS_LOCAL ,
  NDDS_CONFIG_LOG_LEVEL_STATUS_REMOTE ,
  NDDS_CONFIG_LOG_LEVEL_DEBUG
}
 Level category assigned to RTI Connext log messages returned to an output device. More...
 
enum  NDDS_Config_SyslogLevel {
  NDDS_CONFIG_SYSLOG_LEVEL_EMERGENCY ,
  NDDS_CONFIG_SYSLOG_LEVEL_ALERT ,
  NDDS_CONFIG_SYSLOG_LEVEL_CRITICAL ,
  NDDS_CONFIG_SYSLOG_LEVEL_ERROR ,
  NDDS_CONFIG_SYSLOG_LEVEL_WARNING ,
  NDDS_CONFIG_SYSLOG_LEVEL_NOTICE ,
  NDDS_CONFIG_SYSLOG_LEVEL_INFORMATIONAL ,
  NDDS_CONFIG_SYSLOG_LEVEL_DEBUG
}
 Syslog level category assigned to RTI Connext log messages. More...
 
enum  NDDS_Config_LogCategory {
  NDDS_CONFIG_LOG_CATEGORY_PLATFORM ,
  NDDS_CONFIG_LOG_CATEGORY_COMMUNICATION ,
  NDDS_CONFIG_LOG_CATEGORY_DATABASE ,
  NDDS_CONFIG_LOG_CATEGORY_ENTITIES ,
  NDDS_CONFIG_LOG_CATEGORY_API ,
  NDDS_CONFIG_LOG_CATEGORY_DISCOVERY ,
  NDDS_CONFIG_LOG_CATEGORY_SECURITY ,
  NDDS_CONFIG_LOG_CATEGORY_ALL
}
 Categories of logged messages. More...
 
enum  NDDS_Config_LogPrintFormat {
}
 The format used to output RTI Connext diagnostic information. More...
 
enum  NDDS_Config_LogFacility {
  NDDS_CONFIG_LOG_FACILITY_USER ,
  NDDS_CONFIG_LOG_FACILITY_SECURITY ,
  NDDS_CONFIG_LOG_FACILITY_SERVICE ,
  NDDS_CONFIG_LOG_FACILITY_MIDDLEWARE
}
 A number that identifies the source of a log message. More...
 
enum  NDDS_Config_SyslogVerbosity {
  NDDS_CONFIG_SYSLOG_VERBOSITY_SILENT ,
  NDDS_CONFIG_SYSLOG_VERBOSITY_EMERGENCY ,
  NDDS_CONFIG_SYSLOG_VERBOSITY_ALERT ,
  NDDS_CONFIG_SYSLOG_VERBOSITY_CRITICAL ,
  NDDS_CONFIG_SYSLOG_VERBOSITY_ERROR ,
  NDDS_CONFIG_SYSLOG_VERBOSITY_WARNING ,
  NDDS_CONFIG_SYSLOG_VERBOSITY_NOTICE ,
  NDDS_CONFIG_SYSLOG_VERBOSITY_INFORMATIONAL ,
  NDDS_CONFIG_SYSLOG_VERBOSITY_DEBUG
}
 The Syslog verbosities at which RTI Connext diagnostic information is logged. More...
 

Detailed Description

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

Enumeration Type Documentation

◆ NDDS_Config_LogVerbosity

The verbosities at which RTI Connext diagnostic information is logged.

Enumerator
NDDS_CONFIG_LOG_VERBOSITY_SILENT 

No further output will be logged.

NDDS_CONFIG_LOG_VERBOSITY_ERROR 

Only error and fatal error messages will be logged.

An error indicates something wrong in the functioning of RTI Connext. The most common cause of errors is incorrect configuration.

NDDS_CONFIG_LOG_VERBOSITY_WARNING 

Both error and warning messages will be logged.

A warning indicates that RTI Connext is taking an action that may or may not be what you intended. Some configuration information is also logged at this verbosity to aid in debugging.

NDDS_CONFIG_LOG_VERBOSITY_STATUS_LOCAL 

Errors, warnings, and verbose information about the lifecycles of local RTI Connext objects will be logged.

NDDS_CONFIG_LOG_VERBOSITY_STATUS_REMOTE 

Errors, warnings, and verbose information about the lifecycles of remote RTI Connext objects will be logged.

NDDS_CONFIG_LOG_VERBOSITY_STATUS_ALL 

Errors, warnings, verbose information about the lifecycles of local and remote RTI Connext objects, and periodic information about RTI Connext threads will be logged.

◆ NDDS_Config_LogLevel

Level category assigned to RTI Connext log messages returned to an output device.

Enumerator
NDDS_CONFIG_LOG_LEVEL_FATAL_ERROR 

The message describes a fatal error.

A fatal error indicates an unrecoverable situation in the functioning of RTI Connext. Error messages with this log level usually indicate a violation of an internal invariant or a segfault, and may include the function call stack where the fatal error happened.

NDDS_CONFIG_LOG_LEVEL_ERROR 

The message describes an error.

An error indicates a non-fatal problem in the functioning of RTI Connext. Errors are usually recoverable and will not stop application execution, although they may prevent some features from working properly. The most common cause of non-fatal errors is incorrect configuration and incorrect arguments.

NDDS_CONFIG_LOG_LEVEL_WARNING 

The message describes a warning.

A warning indicates that RTI Connext is taking an action that may or may not be what you intended. Some configuration information is also logged at this verbosity to aid in debugging.

NDDS_CONFIG_LOG_LEVEL_STATUS_LOCAL 

The message contains information about the lifecycles of local RTI Connext objects will be logged.

NDDS_CONFIG_LOG_LEVEL_STATUS_REMOTE 

The message contains information about the lifecycles of remote RTI Connext objects will be logged.

NDDS_CONFIG_LOG_LEVEL_DEBUG 

The message contains debug information that might be relevant to your application.

◆ NDDS_Config_SyslogLevel

Syslog level category assigned to RTI Connext log messages.

Enumerator
NDDS_CONFIG_SYSLOG_LEVEL_EMERGENCY 

System is unusable.

Equivalent to NDDS_CONFIG_LOG_LEVEL_FATAL_ERROR.

NDDS_CONFIG_SYSLOG_LEVEL_ALERT 

Should be corrected immediately.

RTI Connext does not produce these messages.

NDDS_CONFIG_SYSLOG_LEVEL_CRITICAL 

Critical conditions.

RTI Connext does not produce these messages.

NDDS_CONFIG_SYSLOG_LEVEL_ERROR 

Error conditions.

Equivalent to NDDS_CONFIG_LOG_LEVEL_ERROR.

NDDS_CONFIG_SYSLOG_LEVEL_WARNING 

May indicate that an error will occur if action is not taken.

Equivalent to NDDS_CONFIG_LOG_LEVEL_WARNING.

NDDS_CONFIG_SYSLOG_LEVEL_NOTICE 

Events that are unusual, but not error conditions.

RTI Connext does not produce these messages.

NDDS_CONFIG_SYSLOG_LEVEL_INFORMATIONAL 

Normal operational messages that require no action.

Equivalent to NDDS_CONFIG_LOG_LEVEL_STATUS_LOCAL and NDDS_CONFIG_LOG_LEVEL_STATUS_REMOTE.

NDDS_CONFIG_SYSLOG_LEVEL_DEBUG 

Information useful to developers for debugging the application.

Equivalent to NDDS_CONFIG_LOG_LEVEL_DEBUG.

◆ NDDS_Config_LogCategory

Categories of logged messages.

The NDDSConfigLogger::get_verbosity_by_category and NDDSConfigLogger::set_verbosity_by_category can be used to specify different verbosities for different categories of messages.

Enumerator
NDDS_CONFIG_LOG_CATEGORY_PLATFORM 

Log messages pertaining to the underlying platform (hardware and OS) on which RTI Connext is running are in this category.

NDDS_CONFIG_LOG_CATEGORY_COMMUNICATION 

Log messages pertaining to data serialization and deserialization and network traffic are in this category.

NDDS_CONFIG_LOG_CATEGORY_DATABASE 

Log messages pertaining to the internal database in which RTI Connext objects are stored are in this category.

NDDS_CONFIG_LOG_CATEGORY_ENTITIES 

Log messages pertaining to local and remote entities, and to a subset of the discovery process, are in this category. (To see all discovery-related messages, use the DISCOVERY category.)

NDDS_CONFIG_LOG_CATEGORY_API 

Log messages pertaining to the API layer of RTI Connext (such as method argument validation) are in this category.

NDDS_CONFIG_LOG_CATEGORY_DISCOVERY 

Log messages pertaining to discovery are in this category.

NDDS_CONFIG_LOG_CATEGORY_SECURITY 

Log messages pertaining to Security Plugins are in this category.

NDDS_CONFIG_LOG_CATEGORY_ALL 

Log messages pertaining to all categories in RTI Connext.

◆ NDDS_Config_LogPrintFormat

The format used to output RTI Connext diagnostic information.

Enumerator
NDDS_CONFIG_LOG_PRINT_FORMAT_DEFAULT 

(default) Print message, method name, log level, Activity Context (what was happening when the event occurred), and logging category.

NDDS_CONFIG_LOG_PRINT_FORMAT_TIMESTAMPED 

Print message, method name, log level, Activity Context, logging category, and timestamp.

NDDS_CONFIG_LOG_PRINT_FORMAT_VERBOSE 

Print message with all available context information (includes thread identifier, message location).

NDDS_CONFIG_LOG_PRINT_FORMAT_VERBOSE_TIMESTAMPED 

Print message with all available context information, and timestamp.

NDDS_CONFIG_LOG_PRINT_FORMAT_DEBUG 

Print a set of fields (including message number and backtrace information) that may be useful for internal debugging.

NDDS_CONFIG_LOG_PRINT_FORMAT_MINIMAL 

Print only message number and message location.

NDDS_CONFIG_LOG_PRINT_FORMAT_MAXIMAL 

Print all available fields.

◆ NDDS_Config_LogFacility

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
NDDS_CONFIG_LOG_FACILITY_USER 

A log message produced by the user's application.

NDDS_CONFIG_LOG_FACILITY_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.
NDDS_CONFIG_LOG_FACILITY_SERVICE 

A log message produced by an Infrastructure Service.

NDDS_CONFIG_LOG_FACILITY_MIDDLEWARE 

A log message produced by RTI Connext.

◆ NDDS_Config_SyslogVerbosity

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

Enumerator
NDDS_CONFIG_SYSLOG_VERBOSITY_SILENT 

No output will be logged.

Equivalent to NDDS_CONFIG_LOG_VERBOSITY_SILENT.

NDDS_CONFIG_SYSLOG_VERBOSITY_EMERGENCY 

Only fatal log messages will be logged.

Only log messages with NDDS_Config_LogLevel equals to NDDS_CONFIG_LOG_LEVEL_FATAL_ERROR will be part of this Syslog verbosity level.

NDDS_CONFIG_SYSLOG_VERBOSITY_ALERT 

Only fatal log messages will be logged.

Equivalent to NDDS_CONFIG_SYSLOG_VERBOSITY_EMERGENCY.

NDDS_CONFIG_SYSLOG_VERBOSITY_CRITICAL 

Only fatal log messages will be logged.

Equivalent to NDDS_CONFIG_SYSLOG_VERBOSITY_EMERGENCY.

NDDS_CONFIG_SYSLOG_VERBOSITY_ERROR 

Only error and fatal error messages will be logged.

Only log messages with NDDS_Config_LogLevel equals to NDDS_CONFIG_LOG_LEVEL_FATAL_ERROR or NDDS_CONFIG_LOG_LEVEL_ERROR will be part of this Syslog verbosity level.

NDDS_CONFIG_SYSLOG_VERBOSITY_WARNING 

Fatal, error and warning messages will be logged.

Only log messages with NDDS_Config_LogLevel equals to NDDS_CONFIG_LOG_LEVEL_FATAL_ERROR, NDDS_CONFIG_LOG_LEVEL_ERROR or NDDS_CONFIG_LOG_LEVEL_WARNING will be part of this Syslog verbosity level.

NDDS_CONFIG_SYSLOG_VERBOSITY_NOTICE 

Fatal, error and warning messages will be logged.

Equivalent to NDDS_CONFIG_SYSLOG_VERBOSITY_WARNING.

NDDS_CONFIG_SYSLOG_VERBOSITY_INFORMATIONAL 

Local, remote, fatal, error and warning messages will be logged.

Only log messages with NDDS_Config_LogLevel equals to NDDS_CONFIG_LOG_LEVEL_FATAL_ERROR, NDDS_CONFIG_LOG_LEVEL_ERROR, NDDS_CONFIG_LOG_LEVEL_WARNING, NDDS_CONFIG_LOG_LEVEL_STATUS_LOCAL or NDDS_CONFIG_LOG_LEVEL_STATUS_REMOTE will be part of this Syslog verbosity level.

NDDS_CONFIG_SYSLOG_VERBOSITY_DEBUG 

All messages will be logged.