RTI Connext Micro  Version
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups
Configuring and Interpreting RTI Connext Micro Logging


 DDS C. ModuleID = 7.
 Real-time Efficient Data Structures and Algorithms. ModuleID = 1.
 OS API. ModuleID = 0.
 Database. ModuleID = 2.
 RT. ModuleID = 3.
 Network I/O. ModuleID = 4.
 Real-Time Publish-Subscribe. ModuleID = 6.
 Reader History. ModuleID = 8.
 Writer History. ModuleID = 9.
 DPSE. ModuleID = 10.
 DPDE. ModuleID = 11.

Detailed Description

Objectives of this user guide:

RTI Connext Micro maintains a log of events occuring in an RTI Connext Micro application. Information of each event is formatted into a log entry, and each entry can be stored in a buffer, stringified into a displayable log message, and/or redirected to a user-defined log handler.

Initializing Logging

To enable RTI Connext Micro log functionality, initialize it (OSAPI_Log_initialize) with an input property that configures the following:

Managing the Log Buffer

The RTI Connext Micro log stores new log entries in a log buffer.

Once the buffer is full, it will not store new entries but will still display and redirect them to the user-defined log handler.

The log buffer can be cleared at anytime with a call to OSAPI_Log_clear.

Log Message Kinds

Each log entry is classified as one of the following kinds:

Interpreting Log Messages and Error Codes

A log entry in RTI Connext Micro has a defined format.

Each entry contains a header with the following information:

The module ID and error code together uniquely identify a log message within RTI Connext Micro.

RTI Connext Micro can be configured to provide additional details per log message:

When an event is logged, by default it is printed as a message to standard output. An example informative entry looks like this:

  [1379134571.591696998] INFO:ModuleID=6,Errcode=44,X=1,E=0,STATUS=f0000000

A log message will need to be interpreted by the user when:

A description of an error code printed in a log message can be determined by following these steps:

Setting the User Log Handler

A user can install a log handler function to process each new log entry. The handler must conform to the definition OSAPI_LogHandler_T, and it is set by OSAPI_Log_set_log_handler().

When called, the handler has parameters containing the raw log entry and detailed log information (e.g. error code, module, file and function names, line number).

The log handler is called for every new log entry, even when the log buffer is full. An expected use case is redirecting log entries to another logger, such as one native to a particular platform.

RTI Connext Micro Version Copyright © Thu Nov 20 2014 Real-Time Innovations, Inc