MagAO-X
Operations Applications Utilities Source
Variables
flatlogs::logPrio Namespace Reference
The Logging System » The flatlogs log protocol » The flatlogs binary header definition » The log priorities

The log priority codes. These control if logs are stored on disk and how they are presented to users. More...

Variables

static constexpr logPrioT LOG_EMERGENCY = 0
 Normal operations of the entire system should be shut down immediately. More...
 
static constexpr logPrioT LOG_ALERT = 1
 This should only be used if some action is required by operators to keep the system safe. More...
 
static constexpr logPrioT LOG_CRITICAL = 2
 The process can not continue and will shut down (fatal) More...
 
static constexpr logPrioT LOG_ERROR = 3
 An error has occured which the software will attempt to correct. More...
 
static constexpr logPrioT LOG_WARNING = 4
 A condition has occurred which may become an error, but the process continues. More...
 
static constexpr logPrioT LOG_NOTICE = 5
 A normal but significant condition. More...
 
static constexpr logPrioT LOG_INFO = 6
 Informational. The info log level is the lowest level recorded during normal operations. More...
 
static constexpr logPrioT LOG_DEBUG = 7
 Used for debugging. More...
 
static constexpr logPrioT LOG_DEBUG2 = 8
 Used for debugging, providing a 2nd level. More...
 
static constexpr logPrioT LOG_DEFAULT = std::numeric_limits<logPrioT>::max() - 1
 Used to denote "use the default level for this log type". More...
 
static constexpr logPrioT LOG_UNKNOWN = std::numeric_limits<logPrioT>::max()
 Used to denote an unkown log type for internal error handling. More...
 

Detailed Description

The log priority codes. These control if logs are stored on disk and how they are presented to users.

This is a scoping namespace for log priority codes. We do not use the enum class feature since it does not have automatic integer conversion.

Variable Documentation

◆ LOG_ALERT

constexpr logPrioT flatlogs::logPrio::LOG_ALERT = 1
static

This should only be used if some action is required by operators to keep the system safe.

Definition at line 34 of file logPriority.hpp.

Referenced by flatlogs::logLevelFromString(), and flatlogs::priorityString().

◆ LOG_CRITICAL

constexpr logPrioT flatlogs::logPrio::LOG_CRITICAL = 2
static

The process can not continue and will shut down (fatal)

Definition at line 37 of file logPriority.hpp.

Referenced by MagAOX::app::MagAOXApp< _useINDI >::createINDIFIFOS(), MagAOX::app::MagAOXApp< _useINDI >::execute(), MagAOX::app::MagAOXApp< _useINDI >::lockPID(), flatlogs::logLevelFromString(), flatlogs::priorityString(), and MagAOX::app::MagAOXApp< _useINDI >::state().

◆ LOG_DEBUG

constexpr logPrioT flatlogs::logPrio::LOG_DEBUG = 7
static

Used for debugging.

Definition at line 52 of file logPriority.hpp.

Referenced by flatlogs::logLevelFromString(), flatlogs::priorityString(), and MagAOX::app::MagAOXApp< _useINDI >::setSigTermHandler().

◆ LOG_DEBUG2

constexpr logPrioT flatlogs::logPrio::LOG_DEBUG2 = 8
static

Used for debugging, providing a 2nd level.

Definition at line 55 of file logPriority.hpp.

Referenced by flatlogs::logLevelFromString(), and flatlogs::priorityString().

◆ LOG_DEFAULT

constexpr logPrioT flatlogs::logPrio::LOG_DEFAULT = std::numeric_limits<logPrioT>::max() - 1
static

Used to denote "use the default level for this log type".

Definition at line 58 of file logPriority.hpp.

Referenced by flatlogs::logHeader::createLog(), MagAOX::logger::logManager< logFileT >::loadConfig(), MagAOX::logger::logManager< logFileT >::log(), flatlogs::logLevelFromString(), and flatlogs::priorityString().

◆ LOG_EMERGENCY

constexpr logPrioT flatlogs::logPrio::LOG_EMERGENCY = 0
static

Normal operations of the entire system should be shut down immediately.

Definition at line 31 of file logPriority.hpp.

Referenced by flatlogs::logLevelFromString(), and flatlogs::priorityString().

◆ LOG_ERROR

constexpr logPrioT flatlogs::logPrio::LOG_ERROR = 3
static

An error has occured which the software will attempt to correct.

Definition at line 40 of file logPriority.hpp.

Referenced by flatlogs::logLevelFromString(), flatlogs::priorityString(), and MagAOX::app::MagAOXApp< _useINDI >::state().

◆ LOG_INFO

constexpr logPrioT flatlogs::logPrio::LOG_INFO = 6
static

Informational. The info log level is the lowest level recorded during normal operations.

Definition at line 49 of file logPriority.hpp.

Referenced by MagAOX::logger::logManager< logFileT >::loadConfig(), flatlogs::logLevelFromString(), MagAOX::app::MagAOXApp< _useINDI >::MagAOXApp(), flatlogs::priorityString(), and MagAOX::app::MagAOXApp< _useINDI >::state().

◆ LOG_NOTICE

constexpr logPrioT flatlogs::logPrio::LOG_NOTICE = 5
static

A normal but significant condition.

Definition at line 46 of file logPriority.hpp.

Referenced by flatlogs::logLevelFromString(), and flatlogs::priorityString().

◆ LOG_UNKNOWN

constexpr logPrioT flatlogs::logPrio::LOG_UNKNOWN = std::numeric_limits<logPrioT>::max()
static

Used to denote an unkown log type for internal error handling.

Definition at line 61 of file logPriority.hpp.

Referenced by MagAOX::logger::logManager< logFileT >::loadConfig(), and flatlogs::logLevelFromString().

◆ LOG_WARNING

constexpr logPrioT flatlogs::logPrio::LOG_WARNING = 4
static

A condition has occurred which may become an error, but the process continues.

Definition at line 43 of file logPriority.hpp.

Referenced by flatlogs::logLevelFromString(), MagAOX::app::MagAOXApp< _useINDI >::MagAOXApp(), and flatlogs::priorityString().