libsc  2.8.7
The SC library provides support for parallel scientific applications.
All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Modules Pages
Macros
Log Priorities

The log level is a number designating the priority of a log action. More...

Collaboration diagram for Log Priorities:

Macros

#define SC_LP_DEFAULT   (-1)
 Selects the SC default threshold.
 
#define SC_LP_ALWAYS   0
 Log absolutely everything.
 
#define SC_LP_TRACE   1
 Prefix file and line number.
 
#define SC_LP_DEBUG   2
 Any information on the internal state.
 
#define SC_LP_VERBOSE   3
 Information on conditions, decisions.
 
#define SC_LP_INFO   4
 Most relevant things a function is doing.
 
#define SC_LP_STATISTICS   5
 Important for consistency/performance.
 
#define SC_LP_PRODUCTION   6
 A few lines at most for a major api function.
 
#define SC_LP_ESSENTIAL   7
 Log a few lines max (version info) per program.
 
#define SC_LP_ERROR   8
 Log errors only. More...
 
#define SC_LP_SILENT   9
 Never log anything. More...
 

Detailed Description

The log level is a number designating the priority of a log action.

Log levels serve both to indicate the priority of a message and as a filter passed to functions to determine which priorities to log.

The priorities SC_LP_TRACE to SC_LP_VERBOSE may be used profusely and are appropriate when all parallel processes contribute low-priority, informative log messages.

SC_LP_INFO and above should not clutter the output of large parallel runs. SC_LP_STATISTICS is suggested for important measurements. SC_LP_PRODUCTION is meant for rudimentary information on the program flow.

SC_LP_ESSENTIAL can be used for one-time messages, say at program startup to communicate program version or licence information.

SC_LP_ERROR shall never be used during clean operation. Thus, it can be used to indicate abnormal behavior of the program and will not disturb the silent appearance of a clean run. Recommended for those who generally prefer to see absolutely no output from the libraries they use.

Macro Definition Documentation

◆ SC_LP_ERROR

#define SC_LP_ERROR   8

Log errors only.

This is suggested over SC_LP_SILENT.

◆ SC_LP_SILENT

#define SC_LP_SILENT   9

Never log anything.

Instead suggesting SC_LP_ERROR.