Log functions with different levels of verbosity. More...

Namespaces
	detail

Classes
class	LogStream

class	ConsoleLogHandler
	Print colored logs to the console. More...

class	CsvLogHandler

class	FileLogHandler

class	HeadFileLogHandler
	Log the first length lines to a file. . More...

class	TailFileLogHandler
	Keeps at most 2 MiB of logs. . More...

Typedefs
typedef detail::Category *	CategoryType
	Catergory Informations. More...

typedef unsigned int	SubscriberId
	Subscriber Identifier. More...

typedef boost::function7< void, const qi::LogLevel, const qi::os::timeval, const char , const char , const char , const char , int >	logFuncHandler
	Boost delegate to log function (verbosity lv, date of log, category, message, file, function, line). More...

typedef boost::function8< void, const qi::LogLevel, const qi::Clock::time_point, const qi::SystemClock::time_point, const char , const char , const char , const char , int >	Handler
	Boost delegate to log function (verbosity lv, dates of log, category, message, file, function, line). More...

Functions
bool	isVisible (CategoryType category, qi::LogLevel level)
	Check if the given combination of category and level is enable. More...

void	init (qi::LogLevel verb=qi::LogLevel_Info, qi::LogContext context=qi::LogContextAttr_ShortVerbosity\|qi::LogContextAttr_Tid\|qi::LogContextAttr_Category, bool synchronous=true)
	Initialization of the logging system (could be avoided) More...

void	destroy ()
	Stop and flush the logging system. More...

void	log (const qi::LogLevel verb, const char category, const char msg, const char file="", const char fct="", const int line=0)
	Log function. You should call qiLog* macros instead. More...

void	log (const qi::LogLevel verb, CategoryType category, const std::string &msg, const char file="", const char fct="", const int line=0)
	Log function. You should call qiLog* macros instead. More...

const char *	logLevelToString (const qi::LogLevel verb, bool verbose=true)
	Convert log verbosity to a readable string. More...

qi::LogLevel	stringToLogLevel (const char *verb)
	Convert string to log verbosity. More...

void	setLogLevel (const qi::LogLevel lv, SubscriberId sub=0)
	Set log Level. More...

qi::LogLevel	logLevel (SubscriberId sub=0)
	Get log verbosity. More...

std::vector< std::string >	categories ()
	Get the list of all categories. More...

CategoryType	addCategory (const std::string &name)
	Add/get a category. More...

void	enableCategory (const std::string &cat, SubscriberId sub=0)
	Set category to current verbosity level. Globbing is supported. More...

void	disableCategory (const std::string &cat, SubscriberId sub=0)
	Set category to silent log level. Globbing is supported. More...

bool	isVisible (const std::string &category, qi::LogLevel level)
	Check if the given combination of category and level is enable. More...

void	addFilters (const std::string &rules, SubscriberId sub=0)
	Parse and execute a set of verbosity rules. More...

void	addFilter (const std::string &cat, qi::LogLevel level, SubscriberId sub=0)
	Set per-subscriber category to level. Globbing is supported. More...

void	setContext (int ctx)
	Set log context verbosity. More...

int	context ()
	Get log context. More...

void	setColor (LogColor color)
	Set log color. More...

LogColor	color ()
	Get log color. More...

void	setSynchronousLog (bool sync)
	Enables or disables synchronous logs. More...

SubscriberId	addHandler (const std::string &name, qi::log::Handler fct, qi::LogLevel defaultLevel=LogLevel_Info)
	Add a log handler. More...

QI_API_DEPRECATED SubscriberId	addLogHandler (const std::string &name, qi::log::logFuncHandler fct, qi::LogLevel defaultLevel=LogLevel_Info)
	Add a log handler. More...

void	removeHandler (const std::string &name)
	Remove a log handler. More...

QI_API_DEPRECATED void	removeLogHandler (const std::string &name)
	Remove a log handler. More...

void	flush ()
	Flush asynchronous logs. More...

QI_API_DEPRECATED void	setVerbosity (SubscriberId sub, const qi::log::LogLevel lv)

QI_API_DEPRECATED void	setCategory (SubscriberId sub, const std::string &cat, qi::log::LogLevel level)

QI_API_DEPRECATED qi::LogLevel	verbosity (SubscriberId sub=0)

QI_API_DEPRECATED void	setVerbosity (const std::string &rules, SubscriberId sub=0)
	Parse and execute a set of verbosity rules. More...

QI_API_DEPRECATED void	setVerbosity (const qi::LogLevel lv, SubscriberId sub=0)
	Set log Level. More...

QI_API_DEPRECATED void	setCategory (const std::string &catName, qi::LogLevel level, SubscriberId sub=0)

Variables
QI_API_DEPRECATED typedef qi::LogLevel	LogLevel

QI_API_DEPRECATED typedef unsigned int	Subscriber

Detailed Description

Log functions with different levels of verbosity.

Typedef Documentation

typedef detail::Category * qi::log::CategoryType

Catergory Informations.

Definition at line 210 of file log.hxx.

typedef boost::function8<void, const qi::LogLevel, const qi::Clock::time_point, const qi::SystemClock::time_point, const char*, const char*, const char*, const char*, int> qi::log::Handler

Boost delegate to log function (verbosity lv, dates of log, category, message, file, function, line).

Definition at line 236 of file log.hpp.

typedef boost::function7<void, const qi::LogLevel, const qi::os::timeval, const char*, const char*, const char*, const char*, int> qi::log::logFuncHandler

Boost delegate to log function (verbosity lv, date of log, category, message, file, function, line).

Deprecated:: 1.24 use qi::log::Handler

Definition at line 223 of file log.hpp.

typedef unsigned int qi::log::SubscriberId

Subscriber Identifier.

Definition at line 204 of file log.hpp.

Function Documentation

CategoryType qi::log::addCategory ( const std::string & name )

Add/get a category.

Parameters

name	Category to add/get.

Returns: CategoryType structure.

void qi::log::addFilter	(	const std::string &	cat,
		qi::LogLevel	level,
		SubscriberId	sub = `0`
	)

Set per-subscriber category to level. Globbing is supported.

Parameters

cat	Category to set.
level	Level to set to the category.
sub	Log subscriber id.

* .. code-block:: cpp
*
*   addFilter("internal.*", silent);
*
* One can also set a filtering rule in QI_LOG_FILTERS environment variable.
* syntax is colon-separated list of rules of the form (+|-)CAT or CAT=level.
* For example, -internal.*:file=verbose
*
*

void qi::log::addFilters	(	const std::string &	rules,
		SubscriberId	sub = `0`
	)

Parse and execute a set of verbosity rules.

Parameters

rules

Colon separated of rules. Each rule can be:

(+)?CAT : enable category CAT
-CAT : disable category CAT
CAT=level : set category CAT to level

Each category can include a '*' for globbing. Can be set with env var QI_LOG_FILTERS. For instance 'qi.*=debug:-qi.foo:+qi.foo.bar' stands for "all qi.* logs in debug, remove all qi.foo logs except qi.foo.bar".

Parameters

sub	Log subscriber id.

SubscriberId qi::log::addHandler	(	const std::string &	name,
		qi::log::Handler	fct,
		qi::LogLevel	defaultLevel = `LogLevel_Info`
	)

Add a log handler.

Parameters

name	Name of the handler, useful to remove handler (prefer lowercase).
fct	Boost delegate to log handler function.
defaultLevel	default log verbosity.

Returns: New log subscriber id added.

QI_API_DEPRECATED SubscriberId qi::log::addLogHandler	(	const std::string &	name,
		qi::log::logFuncHandler	fct,
		qi::LogLevel	defaultLevel = `LogLevel_Info`
	)

Add a log handler.

Parameters

name	Name of the handler, useful to remove handler (prefer lowercase).
fct	Boost delegate to log handler function.
defaultLevel	default log verbosity.

Returns: New log subscriber id added.

Deprecated:: 1.24 use qi::log::addHandler

std::vector<std::string> qi::log::categories ( )

Get the list of all categories.

Returns: The list of existing categories

LogColor qi::log::color ( )

Get log color.

Returns: Returns LogColor enum.

int qi::log::context ( )

Get log context.

Returns: Returns the level of context verbosity.

void qi::log::destroy ( )

Stop and flush the logging system.

* Should be called in the main of program using atexit. For example:
*
* .. code-block:: cpp
*
*     atexit(qi::log::destroy)
*
* This is useful only for asynchronous log.
*

void qi::log::disableCategory	(	const std::string &	cat,
		SubscriberId	sub = `0`
	)

Set category to silent log level. Globbing is supported.

Parameters

cat	Category to set to silence level.
sub	Log subscriber id.

void qi::log::enableCategory	(	const std::string &	cat,
		SubscriberId	sub = `0`
	)

Set category to current verbosity level. Globbing is supported.

Parameters

cat	Category to set to current verbosity level.
sub	Log subscriber id.

void qi::log::flush ( )

Flush asynchronous logs.

void qi::log::init	(	qi::LogLevel	verb = `qi::LogLevel_Info`,
		qi::LogContext	context = `qi::LogContextAttr_ShortVerbosity\|qi::LogContextAttr_Tid\|qi::LogContextAttr_Category`,
		bool	synchronous = `true`
	)

Initialization of the logging system (could be avoided)

Parameters

verb	Log verbosity
context	Display Context
synchronous	Synchronous log

bool qi::log::isVisible	(	CategoryType	category,
		qi::LogLevel	level
	)

inline

Check if the given combination of category and level is enable.

Parameters

category	Category to check.
level	Level associate to category.

Returns: true if given combination of category and level is enabled.

Definition at line 205 of file log.hxx.

bool qi::log::isVisible	(	const std::string &	category,
		qi::LogLevel	level
	)

Check if the given combination of category and level is enable.

Parameters

category	Category to check.
level	Level associate to category.

Returns: true if given combination of category and level is enabled.

void qi::log::log	(	const qi::LogLevel	verb,
		const char *	category,
		const char *	msg,
		const char *	file = `""`,
		const char *	fct = `""`,
		const int	line = `0`
	)

Log function. You should call qiLog* macros instead.

Parameters

verb	The verbosity of the message.
category	Log category (for filtering in the future).
msg	Log message.
file	Filename from which this function was called (ex: FILE).
fct	Function name from which this function was called (ex: FUNCTION).
line	Line from which this function was called (ex: LINE).

void qi::log::log	(	const qi::LogLevel	verb,
		CategoryType	category,
		const std::string &	msg,
		const char *	file = `""`,
		const char *	fct = `""`,
		const int	line = `0`
	)

Log function. You should call qiLog* macros instead.

Parameters

verb	The verbosity of the message.
category	Log category (for filtering in the future).
msg	Log message.
file	Filename from which this function was called (ex: FILE).
fct	Function name from which this function was called (ex: FUNCTION).
line	Line from which this function was called (ex: LINE).

qi::LogLevel qi::log::logLevel ( SubscriberId sub = 0 )

Get log verbosity.

Parameters

sub	Log subscriber id.

Returns: Maximal verbosity displayed.

const char* qi::log::logLevelToString	(	const qi::LogLevel	verb,
		bool	verbose = `true`
	)

Convert log verbosity to a readable string.

Parameters

verb	Verbosity value.
verbose	Enable verbose conversion.

Returns: Returns a string matching the log level verbosity.

void qi::log::removeHandler ( const std::string & name )

Remove a log handler.

Parameters

name	Name of the handler.

QI_API_DEPRECATED void qi::log::removeLogHandler ( const std::string & name )

Remove a log handler.

Parameters

name	Name of the handler.

Deprecated:: 1.24 use qi::log::removeHandler

QI_API_DEPRECATED void qi::log::setCategory	(	SubscriberId	sub,
		const std::string &	cat,
		qi::log::LogLevel	level
	)

inline

Deprecated:: since 1.22. Use qi::log::addFilter(const std::string&, qi::LogLevel, SubscriberId)

Definition at line 511 of file log.hpp.

QI_API_DEPRECATED void qi::log::setCategory	(	const std::string &	catName,
		qi::LogLevel	level,
		SubscriberId	sub = `0`
	)

Deprecated:: since 2.2 Use qi::log::addFilter instead.

void qi::log::setColor ( LogColor color )

Set log color.

Parameters

color Log color value.

void qi::log::setContext ( int ctx )

Set log context verbosity.

Show context logs, it's a bit field (add the values below).

Parameters

ctx	Value to set context.

Context values possible:

1 : Verbosity
2 : ShortVerbosity
4 : Date
8 : ThreadId
16 : Category
32 : File
64 : Function
128: EndOfLine some useful values for context are:
26 : (verb+threadId+cat)
30 : (verb+threadId+date+cat)
126: (verb+threadId+date+cat+file+fun)
254: (verb+threadId+date+cat+file+fun+eol)

Can be set with env var QI_LOG_CONTEXT

void qi::log::setLogLevel	(	const qi::LogLevel	lv,
		SubscriberId	sub = `0`
	)

Set log Level.

Parameters

lv	Default verbosity level shown in the logs.
sub	Log subscriber id.

Levels set by this function is a default value, overriden by all addFilter() and addFilters() calls.

Change the log minimum level: [0-6] (default:4):

0: silent
1: fatal
2: error
3: warning
4: info
5: verbose
6: debug

Can be set with env var QI_LOG_LEVEL.

If you don't want any log use silent mode.

void qi::log::setSynchronousLog ( bool sync )

Enables or disables synchronous logs.

Parameters

sync	Value to set or unset synchronous.

When setting to async, this function must be called after main has started.

QI_API_DEPRECATED void qi::log::setVerbosity	(	SubscriberId	sub,
		const qi::log::LogLevel	lv
	)

inline

Deprecated:: since 1.22. Use qi::log::setLogLevel(const qi::LogLevel, SubscriberId)

Definition at line 509 of file log.hpp.

QI_API_DEPRECATED void qi::log::setVerbosity	(	const std::string &	rules,
		SubscriberId	sub = `0`
	)

Parse and execute a set of verbosity rules.

Parameters

rules

Colon separated of rules. Each rule can be:

(+)?CAT : enable category CAT
-CAT : disable category CAT
CAT=level : set category CAT to level

Each category can include a '*' for globbing. Can be set with env var QI_LOG_FILTERS. For instance 'qi.*=debug:-qi.foo:+qi.foo.bar' stands for "all qi.* logs in debug, remove all qi.foo logs except qi.foo.bar".

Parameters

sub	Log subscriber id.

Deprecated:: since 2.2 Use qi::log::addFilters instead.

QI_API_DEPRECATED void qi::log::setVerbosity	(	const qi::LogLevel	lv,
		SubscriberId	sub = `0`
	)

Set log Level.

Parameters

lv	Default verbosity level shown in the logs.
sub	Log subscriber id.

Levels set by this function is a default value, overriden by all addFilter() and addFilters() calls.

Change the log minimum level: [0-6] (default:4):

0: silent
1: fatal
2: error
3: warning
4: info
5: verbose
6: debug

Can be set with env var QI_LOG_LEVEL.

If you don't want any log use silent mode.

Deprecated:: since 2.2 Use qi::log::setLogLevel instead.

qi::LogLevel qi::log::stringToLogLevel ( const char * verb )

Convert string to log verbosity.

Parameters

verb	debug, verbose, info, warning, error, fatal, silent

Returns: Log level verbosity

QI_API_DEPRECATED qi::LogLevel qi::log::verbosity ( SubscriberId sub = 0 )

Deprecated:: since 2.2. Use qi::log::logLevel instead.

Variable Documentation

QI_API_DEPRECATED typedef qi::LogLevel qi::log::LogLevel

Deprecated:: 1.22 Use qi::LogLevel

Definition at line 194 of file log.hpp.

QI_API_DEPRECATED typedef unsigned int qi::log::Subscriber

Deprecated:: 1.22 Use qi::log::SubscriberId

Definition at line 208 of file log.hpp.

Namespaces

Classes

Typedefs

Functions

Variables

Detailed Description

Typedef Documentation

Function Documentation

Variable Documentation