4.2.0.0R6
Software Development Kit
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Modules
Trouble Log
#define TLOG(severity, formatText, argumentList...)
 Post a log entry. More...
 
#define TLOG_HEXDUMP(severity, data, length, baseOfData)
 Dump data in hex form to TLOG as one or more log entries. More...
 
enum  tlog_severity_level {
  TLOG_SEVERITY_LEVEL__EMERGENCY = 0, TLOG_SEVERITY_LEVEL__ALERT, TLOG_SEVERITY_LEVEL__CRITICAL, TLOG_SEVERITY_LEVEL__ERROR,
  TLOG_SEVERITY_LEVEL__WARNING, TLOG_SEVERITY_LEVEL__NOTICE, TLOG_SEVERITY_LEVEL__INFORMATIONAL, TLOG_SEVERITY_LEVEL__DEBUG
}
 Severity levels. More...
 

Detailed Description

Logs to a ring buffer in RAM, always on. Accessed by Line protocol "Trouble Log", CLI tlog command, or Web Manager "/tlog" URL.

Macro Definition Documentation

#define TLOG (   severity,
  formatText,
  argumentList... 
)
Value:
ltrx_tlog_do_not_call_directly( \
__FILE__, __LINE__, TLOG_FACILITY__USER, \
severity, formatText, ##argumentList \
)

Post a log entry.

Parameters
[in]severityServerity of type enum tlog_severity_level.
[in]formatTextText for log entry, use snprintf format.
[in]argumentListOptional arguments with types matching those defined in formatText.
#define TLOG_HEXDUMP (   severity,
  data,
  length,
  baseOfData 
)
Value:
ltrx_tlog_hex_dump_do_not_call_directly( \
__FILE__, __LINE__, TLOG_FACILITY__USER, \
severity, data, length, baseOfData \
)

Dump data in hex form to TLOG as one or more log entries.

Parameters
[in]severityServerity of type enum tlog_severity_level.
[in]dataStarting address of data to be logged.
[in]lengthLength in bytes of data to be logged.
[in]baseOfDataBase address of data, used for display of data offset.

Enumeration Type Documentation

Severity levels.

The severity levels are defined in accordance with RFC 3164.

Enumerator
TLOG_SEVERITY_LEVEL__EMERGENCY 

Emergency.

TLOG_SEVERITY_LEVEL__ALERT 

Alert.

TLOG_SEVERITY_LEVEL__CRITICAL 

Critical.

TLOG_SEVERITY_LEVEL__ERROR 

Error.

TLOG_SEVERITY_LEVEL__WARNING 

Warning.

TLOG_SEVERITY_LEVEL__NOTICE 

Notice.

TLOG_SEVERITY_LEVEL__INFORMATIONAL 

Informational.

TLOG_SEVERITY_LEVEL__DEBUG 

Debug.