The standard MagAOX log manager, used for both process logs and telemetry streams. More...

#include <logManager.hpp>

Inheritance diagram for MagAOX::logger::logManager< logFileT >:

Collaboration diagram for MagAOX::logger::logManager< logFileT >:

Public Member Functions
	logManager ()
	Default c'tor. More...

	~logManager ()
	Destructor. More...

int	writePause (const unsigned long &wp)
	Set a new value of writePause. More...

unsigned long	writePause ()
	Get the current value of writePause. More...

int	logLevel (logPrioT newLev)
	Set a new value of logLevel. More...

logPrioT	logLevel ()
	Get the current value of logLevel. More...

int	logThreadPrio (int newPrio)
	Set a new value of logThreadPrio. More...

int	logThreadPrio ()
	Get the current value of logThreadPrio. More...

bool	logThreadRunning ()
	Get status of the log thread running flag. More...

int	setupConfig (mx::appConfigurator &config)
	Setup an application configurator for the logger section. More...

int	loadConfig (mx::appConfigurator &config)
	Load the logger section from an application configurator. More...

int	logThreadStart ()
	Start the logger thread. More...

void	logThreadExec ()
	Execute the logger thread. More...

template<typename logT >
void	log (const typename logT::messageT &msg, logPrioT level=logPrio::LOG_DEFAULT)
	Make a log entry, including a message. More...

template<typename logT >
void	log (timespecX &ts, const typename logT::messageT &msg, logPrioT level=logPrio::LOG_DEFAULT)
	Make a log entry, including a message. More...

template<typename logT >
void	log (logPrioT level=logPrio::LOG_DEFAULT)
	Make a log entry with no message. More...

template<typename logT >
void	log (timespecX &ts, logPrioT level=logPrio::LOG_DEFAULT)
	Make a log entry with no message. More...

Static Public Member Functions
static void	_logThreadStart (logManager *l)
	Thread starter, called by logThreadStart on thread construction. Calls logThreadExec. More...

template<typename logT >
static int	createLog (bufferPtrT &logBuffer, const typename logT::messageT &msg, const logPrioT &level)
	Create a log formatted log entry, filling in a buffer. More...

template<typename logT >
static int	createLog (bufferPtrT &logBuffer, const timespecX &ts, const typename logT::messageT &msg, const logPrioT &level)
	Create a log formatted log entry, filling in a buffer. More...

Public Attributes
std::list< bufferPtrT >	m_logQueue
	Log entries are stored here, and writen to the file by the log thread. More...

std::thread	m_logThread
	A separate thread for actually writing to the file. More...

std::mutex	m_qMutex
	Mutex for accessing the m_logQueue. More...

bool	m_logShutdown {false}
	Flag to signal the log thread to shutdown. More...

unsigned long	m_writePause {MAGAOX_default_writePause}
	Time, in nanoseconds, to pause between successive batch writes to the file. Default is 1e9. Configure with logger.writePause. More...

logPrioT	m_logLevel {logPrio::LOG_INFO}
	The minimum log level to actually record. Logs with level below this are rejected. Default is INFO. Configure with logger.logLevel. More...

int	m_logThreadPrio {0}

bool	m_logThreadRunning {false}

Detailed Description

template<class logFileT>
struct MagAOX::logger::logManager< logFileT >

The standard MagAOX log manager, used for both process logs and telemetry streams.

Manages the formatting and queueing of the log entries.

A log entry is made using one of the standard log types. These are formatted into a binary stream and stored in a std::list. This occurs in the calling thread. The insertion into the list is mutex-ed, so it is safe to make logs from different threads concurrently.

Write-to-disk occurs in a separate thread, which is normally set to the lowest priority so as not to interfere with higher-priority tasks. The log thread cycles through pending log entries in the list, dispatching them to the logFile.

The template parameter logFileT is one of the logFile types, which is used to actually write to disk.

Example:

logManager<logFileRaw> log;
log.m_logThreadStart();
//do stuff
log<loop_closed>(); //An empty log, which is used to log discrete events.
//more stuff happens
log<text_log>("a log entry with a std::string message type");

Todo:: document all the requirements of logFileT

Template Parameters

logFileT a logFile type with a writeLog method.

Definition at line 68 of file logManager.hpp.

Constructor & Destructor Documentation

◆ logManager()

template<class logFileT >

MagAOX::logger::logManager< logFileT >::logManager ( )

Default c'tor.

Definition at line 225 of file logManager.hpp.

◆ ~logManager()

template<class logFileT >

MagAOX::logger::logManager< logFileT >::~logManager ( )

Destructor.

Definition at line 230 of file logManager.hpp.

Member Function Documentation

◆ _logThreadStart()

template<class logFileT >

void MagAOX::logger::logManager< logFileT >::_logThreadStart ( logManager< logFileT > * l )

static

Thread starter, called by logThreadStart on thread construction. Calls logThreadExec.

Parameters

[in] l a pointer to a logger instance (normally this)

Definition at line 351 of file logManager.hpp.

◆ createLog() [1/2]

template<class logFileT >

template<typename logT >

int MagAOX::logger::logManager< logFileT >::createLog	(	bufferPtrT &	logBuffer,
		const typename logT::messageT &	msg,
		const logPrioT &	level
	)

static

Create a log formatted log entry, filling in a buffer.

This is where the timestamp of the log entry is set.

Template Parameters

logT	is a log entry type

Returns: 0 on success, -1 on error.

Parameters

[out]	logBuffer	a shared_ptr<logBuffer>, which will be allocated and populated with the log entry
[in]	msg	the message to log (could be of type emptyMessage)
[in]	level	the level (verbosity) of this log

Definition at line 450 of file logManager.hpp.

◆ createLog() [2/2]

template<class logFileT >

template<typename logT >

int MagAOX::logger::logManager< logFileT >::createLog	(	bufferPtrT &	logBuffer,
		const timespecX &	ts,
		const typename logT::messageT &	msg,
		const logPrioT &	level
	)

static

Create a log formatted log entry, filling in a buffer.

This version has the timestamp provided.

Template Parameters

logT	is a log entry type

Returns: 0 on success, -1 on error.

Parameters

[out]	logBuffer	a shared_ptr<logBuffer>, which will be allocated and populated with the log entry
[in]	ts	the timestamp of this log entry.
[in]	msg	the message to log (could be of type emptyMessage)
[in]	level	the level (verbosity) of this log

Definition at line 464 of file logManager.hpp.

◆ loadConfig()

template<class logFileT >

int MagAOX::logger::logManager< logFileT >::loadConfig ( mx::appConfigurator & config )

Load the logger section from an application configurator.

Parameters

[in] config an application configuration from which to load values

Definition at line 309 of file logManager.hpp.

Referenced by MagAOX::app::MagAOXApp< _useINDI >::loadBasicConfig().

◆ log() [1/4]

template<class logFileT >

template<typename logT >

void MagAOX::logger::logManager< logFileT >::log	(	const typename logT::messageT &	msg,
		logPrioT	level = `logPrio::LOG_DEFAULT`
	)

Make a log entry, including a message.

Template Parameters

logT	is a log entry type

Parameters

[in]	msg	the message to log
[in]	level	[optional] the log level. The default is used if not specified.

Definition at line 475 of file logManager.hpp.

Referenced by MagAOX::app::MagAOXApp< _useINDI >::log().

◆ log() [2/4]

template<class logFileT >

template<typename logT >

void MagAOX::logger::logManager< logFileT >::log	(	timespecX &	ts,
		const typename logT::messageT &	msg,
		logPrioT	level = `logPrio::LOG_DEFAULT`
	)

Make a log entry, including a message.

Template Parameters

logT	is a log entry type

Parameters

[in]	ts	the timestamp of the log entry
[in]	msg	the message to log
[in]	level	[optional] the log level. The default is used if not specified.

Definition at line 497 of file logManager.hpp.

◆ log() [3/4]

template<class logFileT >

template<typename logT >

void MagAOX::logger::logManager< logFileT >::log ( logPrioT level = logPrio::LOG_DEFAULT )

Make a log entry with no message.

Template Parameters

logT	is a log entry type

Parameters

[in] level [optional] the log level. The default is used if not specified.

Definition at line 519 of file logManager.hpp.

◆ log() [4/4]

template<class logFileT >

template<typename logT >

void MagAOX::logger::logManager< logFileT >::log	(	timespecX &	ts,
		logPrioT	level = `logPrio::LOG_DEFAULT`
	)

Make a log entry with no message.

Template Parameters

logT	is a log entry type

Parameters

[in]	ts	the timestamp of the log entry
[in]	level	[optional] the log level. The default is used if not specified.

Definition at line 526 of file logManager.hpp.

◆ logLevel() [1/2]

template<class logFileT >

int MagAOX::logger::logManager< logFileT >::logLevel ( logPrioT newLev )

Set a new value of logLevel.

Updates m_logLevel with new value. Will return an error and take no actions if the argument is outside the range of the logLevels enum.

Returns: 0 on success; -1 on error.

Parameters

[in] newLev the new value of logLevel

Definition at line 258 of file logManager.hpp.

◆ logLevel() [2/2]

template<class logFileT >

logPrioT MagAOX::logger::logManager< logFileT >::logLevel ( )

Get the current value of logLevel.

Returns: the value m_logLevel

Definition at line 268 of file logManager.hpp.

◆ logThreadExec()

template<class logFileT >

void MagAOX::logger::logManager< logFileT >::logThreadExec ( )

Execute the logger thread.

Definition at line 397 of file logManager.hpp.

Referenced by MagAOX::logger::logManager< logFileT >::_logThreadStart().

◆ logThreadPrio() [1/2]

template<class logFileT >

int MagAOX::logger::logManager< logFileT >::logThreadPrio ( int newPrio )

Set a new value of logThreadPrio.

Updates m_logThreadPrio with new value. If the argument is < 0, this sets m_logThreadPrio to 0. Will not set > 98, and returns -1 with no changes in this case.

Returns: 0 on success; -1 on error (> 98).

Parameters

[in] newPrio the new value of logThreadPrio

Definition at line 274 of file logManager.hpp.

◆ logThreadPrio() [2/2]

template<class logFileT >

int MagAOX::logger::logManager< logFileT >::logThreadPrio ( )

Get the current value of logThreadPrio.

Returns: the value m_logThreadPrio

Definition at line 284 of file logManager.hpp.

◆ logThreadRunning()

template<class logFileT >

bool MagAOX::logger::logManager< logFileT >::logThreadRunning ( )

Get status of the log thread running flag.

Returns: the current value of m_logThreadRunning

Definition at line 290 of file logManager.hpp.

Referenced by MagAOX::app::MagAOXApp< _useINDI >::execute().

◆ logThreadStart()

template<class logFileT >

int MagAOX::logger::logManager< logFileT >::logThreadStart ( )

Start the logger thread.

Definition at line 357 of file logManager.hpp.

Referenced by MagAOX::app::MagAOXApp< _useINDI >::execute().

◆ setupConfig()

template<class logFileT >

int MagAOX::logger::logManager< logFileT >::setupConfig ( mx::appConfigurator & config )

Setup an application configurator for the logger section.

Parameters

[in] config an application configuration to setup

Definition at line 296 of file logManager.hpp.

Referenced by MagAOX::app::MagAOXApp< _useINDI >::setupBasicConfig().

◆ writePause() [1/2]

template<class logFileT >

int MagAOX::logger::logManager< logFileT >::writePause ( const unsigned long & wp )

Set a new value of writePause.

Updates m_writePause with new value.

Returns: 0 on success; -1 on error (if wp == 0).

Parameters

[in] wp the new value of writePause

Definition at line 242 of file logManager.hpp.

◆ writePause() [2/2]

template<class logFileT >

unsigned long MagAOX::logger::logManager< logFileT >::writePause ( )

Get the current value of writePause.

Returns: the value m_writePause.

Definition at line 252 of file logManager.hpp.

Member Data Documentation

◆ m_logLevel

template<class logFileT >

logPrioT MagAOX::logger::logManager< logFileT >::m_logLevel {logPrio::LOG_INFO}

The minimum log level to actually record. Logs with level below this are rejected. Default is INFO. Configure with logger.logLevel.

Definition at line 81 of file logManager.hpp.

◆ m_logQueue

template<class logFileT >

std::list<bufferPtrT> MagAOX::logger::logManager< logFileT >::m_logQueue

Log entries are stored here, and writen to the file by the log thread.

Todo:: Make these protected members, with appropriate access methods

Definition at line 72 of file logManager.hpp.

◆ m_logShutdown

template<class logFileT >

bool MagAOX::logger::logManager< logFileT >::m_logShutdown {false}

Flag to signal the log thread to shutdown.

Definition at line 77 of file logManager.hpp.

◆ m_logThread

template<class logFileT >

std::thread MagAOX::logger::logManager< logFileT >::m_logThread

A separate thread for actually writing to the file.

Definition at line 74 of file logManager.hpp.

◆ m_logThreadPrio

template<class logFileT >

int MagAOX::logger::logManager< logFileT >::m_logThreadPrio {0}

Definition at line 83 of file logManager.hpp.

◆ m_logThreadRunning

template<class logFileT >

bool MagAOX::logger::logManager< logFileT >::m_logThreadRunning {false}

Definition at line 85 of file logManager.hpp.

◆ m_qMutex

template<class logFileT >

std::mutex MagAOX::logger::logManager< logFileT >::m_qMutex

Mutex for accessing the m_logQueue.

Definition at line 75 of file logManager.hpp.

◆ m_writePause

template<class logFileT >

unsigned long MagAOX::logger::logManager< logFileT >::m_writePause {MAGAOX_default_writePause}

Time, in nanoseconds, to pause between successive batch writes to the file. Default is 1e9. Configure with logger.writePause.

Definition at line 79 of file logManager.hpp.

The documentation for this struct was generated from the following file:

/home/jrmales/Source/MagAOX/libMagAOX/logger/logManager.hpp

Public Member Functions

Static Public Member Functions

Public Attributes

Detailed Description

template<class logFileT> struct MagAOX::logger::logManager< logFileT >

Constructor & Destructor Documentation

◆ logManager()

◆ ~logManager()

Member Function Documentation

◆ _logThreadStart()

◆ createLog() [1/2]

◆ createLog() [2/2]

◆ loadConfig()

◆ log() [1/4]

◆ log() [2/4]

◆ log() [3/4]

◆ log() [4/4]

◆ logLevel() [1/2]

◆ logLevel() [2/2]

◆ logThreadExec()

◆ logThreadPrio() [1/2]

◆ logThreadPrio() [2/2]

◆ logThreadRunning()

◆ logThreadStart()

◆ setupConfig()

◆ writePause() [1/2]

◆ writePause() [2/2]

Member Data Documentation

◆ m_logLevel

◆ m_logQueue

◆ m_logShutdown

◆ m_logThread

◆ m_logThreadPrio

◆ m_logThreadRunning

◆ m_qMutex

◆ m_writePause

template<class logFileT>
struct MagAOX::logger::logManager< logFileT >