Static helpers to deal with loggers and their configurations. More...

#include <easylogging++.h>

Inheritance diagram for el::Loggers:

Collaboration diagram for el::Loggers:

Classes
class	ScopedAddFlag
	Adds flag and removes it when scope goes out. More...
class	ScopedRemoveFlag
	Removes flag and add it when scope goes out. More...

Static Public Member Functions
static bool	allowed (Level leve, const char *cat)
	Determines whether logging will occur at this level and category.
static Logger *	getLogger (const std::string &identity, bool registerIfNotAvailable=true)
	Gets existing or registers new logger.
static void	setDefaultLogBuilder (el::LogBuilderPtr &logBuilderPtr)
	Changes default log builder for future loggers.
template<typename T>
static bool	installLoggerRegistrationCallback (const std::string &id)
	Installs logger registration callback, this callback is triggered when new logger is registered.
template<typename T>
static void	uninstallLoggerRegistrationCallback (const std::string &id)
	Uninstalls log dispatch callback.
template<typename T>
static T *	loggerRegistrationCallback (const std::string &id)
static bool	unregisterLogger (const std::string &identity)
	Unregisters logger - use it only when you know what you are doing, you may unregister loggers initialized / used by third-party libs.
static bool	hasLogger (const std::string &identity)
	Whether or not logger with id is registered.
static Logger *	reconfigureLogger (Logger *logger, const Configurations &configurations)
	Reconfigures specified logger with new configurations.
static Logger *	reconfigureLogger (const std::string &identity, const Configurations &configurations)
	Reconfigures logger with new configurations after looking it up using identity.
static Logger *	reconfigureLogger (const std::string &identity, ConfigurationType configurationType, const std::string &value)
	Reconfigures logger's single configuration.
static void	reconfigureAllLoggers (const Configurations &configurations)
	Reconfigures all the existing loggers with new configurations.
static void	reconfigureAllLoggers (ConfigurationType configurationType, const std::string &value)
	Reconfigures single configuration for all the loggers.
static void	reconfigureAllLoggers (Level level, ConfigurationType configurationType, const std::string &value)
	Reconfigures single configuration for all the loggers for specified level.
static void	setDefaultConfigurations (const Configurations &configurations, bool reconfigureExistingLoggers=false)
	Sets default configurations. This configuration is used for future (and conditionally for existing) loggers.
static const Configurations *	defaultConfigurations (void)
	Returns current default.
static const base::LogStreamsReferenceMap *	logStreamsReference (void)
	Returns log stream reference pointer if needed by user.
static base::TypedConfigurations	defaultTypedConfigurations (void)
	Default typed configuration based on existing defaultConf.
static std::vector< std::string > *	populateAllLoggerIds (std::vector< std::string > *targetList)
	Populates all logger IDs in current repository.
static void	configureFromGlobal (const char *globalConfigurationFilePath)
	Sets configurations from global configuration file.
static bool	configureFromArg (const char *argKey)
	Configures loggers using command line arg. Ensure you have already set command line args,.
static void	flushAll (void)
	Flushes all loggers for all levels - Be careful if you dont know how many loggers are registered.
static void	addFlag (LoggingFlag flag)
	Adds logging flag used internally.
static void	removeFlag (LoggingFlag flag)
	Removes logging flag used internally.
static bool	hasFlag (LoggingFlag flag)
	Determines whether or not certain flag is active.
static void	setLoggingLevel (Level level)
	Sets hierarchy for logging. Needs to enable logging flag (HierarchicalLogging).
static void	setVerboseLevel (base::type::VerboseLevel level)
	Sets verbose level on the fly.
static base::type::VerboseLevel	verboseLevel (void)
	Gets current verbose level.
static void	setVModules (const char *modules)
	Sets vmodules as specified (on the fly).
static void	setCategories (const char *categories, bool clear=true)
	Sets categories as specified (on the fly).
static std::string	getCategories ()
	Gets current categories.
static void	clearVModules (void)
	Clears vmodules.
static void	clearCategories (void)
	Clears categories.
static void	setFilenameCommonPrefix (const std::string &prefix)
	Sets filename common prefix.
static const std::string &	getFilenameCommonPrefix ()
	Gets filename common prefix.

Detailed Description

Static helpers to deal with loggers and their configurations.

Member Function Documentation

◆ addFlag()

void el::Loggers::addFlag ( LoggingFlag flag )

inlinestatic

Adds logging flag used internally.

◆ allowed()

bool el::Loggers::allowed	(	Level	leve,
		const char *	cat )

static

Determines whether logging will occur at this level and category.

◆ clearCategories()

void el::Loggers::clearCategories ( void )

static

Clears categories.

◆ clearVModules()

void el::Loggers::clearVModules ( void )

static

Clears vmodules.

◆ configureFromArg()

bool el::Loggers::configureFromArg ( const char * argKey )

static

Configures loggers using command line arg. Ensure you have already set command line args,.

Returns: False if invalid argument or argument with no value provided, true if attempted to configure logger. If true is returned that does not mean it has been configured successfully, it only means that it has attempeted to configure logger using configuration file provided in argument

◆ configureFromGlobal()

void el::Loggers::configureFromGlobal ( const char * globalConfigurationFilePath )

static

Sets configurations from global configuration file.

◆ defaultConfigurations()

const Configurations * el::Loggers::defaultConfigurations ( void )

static

Returns current default.

◆ defaultTypedConfigurations()

base::TypedConfigurations el::Loggers::defaultTypedConfigurations ( void )

static

Default typed configuration based on existing defaultConf.

◆ flushAll()

void el::Loggers::flushAll ( void )

static

Flushes all loggers for all levels - Be careful if you dont know how many loggers are registered.

◆ getCategories()

std::string el::Loggers::getCategories ( )

static

Gets current categories.

◆ getFilenameCommonPrefix()

const std::string & el::Loggers::getFilenameCommonPrefix ( )

static

Gets filename common prefix.

◆ getLogger()

Logger * el::Loggers::getLogger	(	const std::string &	identity,
		bool	registerIfNotAvailable = true )

static

Gets existing or registers new logger.

◆ hasFlag()

bool el::Loggers::hasFlag ( LoggingFlag flag )

inlinestatic

Determines whether or not certain flag is active.

◆ hasLogger()

bool el::Loggers::hasLogger ( const std::string & identity )

static

Whether or not logger with id is registered.

◆ installLoggerRegistrationCallback()

template<typename T>

bool el::Loggers::installLoggerRegistrationCallback ( const std::string & id )

inlinestatic

Installs logger registration callback, this callback is triggered when new logger is registered.

◆ loggerRegistrationCallback()

template<typename T>

T * el::Loggers::loggerRegistrationCallback ( const std::string & id )

inlinestatic

◆ logStreamsReference()

const base::LogStreamsReferenceMap * el::Loggers::logStreamsReference ( void )

static

Returns log stream reference pointer if needed by user.

◆ populateAllLoggerIds()

std::vector< std::string > * el::Loggers::populateAllLoggerIds ( std::vector< std::string > * targetList )

static

Populates all logger IDs in current repository.

Parameters

[out] targetList List of fill up.

◆ reconfigureAllLoggers() [1/3]

void el::Loggers::reconfigureAllLoggers	(	ConfigurationType	configurationType,
		const std::string &	value )

inlinestatic

Reconfigures single configuration for all the loggers.

◆ reconfigureAllLoggers() [2/3]

void el::Loggers::reconfigureAllLoggers ( const Configurations & configurations )

static

Reconfigures all the existing loggers with new configurations.

◆ reconfigureAllLoggers() [3/3]

void el::Loggers::reconfigureAllLoggers	(	Level	level,
		ConfigurationType	configurationType,
		const std::string &	value )

static

Reconfigures single configuration for all the loggers for specified level.

◆ reconfigureLogger() [1/3]

Logger * el::Loggers::reconfigureLogger	(	const std::string &	identity,
		ConfigurationType	configurationType,
		const std::string &	value )

static

Reconfigures logger's single configuration.

◆ reconfigureLogger() [2/3]

Logger * el::Loggers::reconfigureLogger	(	const std::string &	identity,
		const Configurations &	configurations )

static

Reconfigures logger with new configurations after looking it up using identity.

◆ reconfigureLogger() [3/3]

Logger * el::Loggers::reconfigureLogger	(	Logger *	logger,
		const Configurations &	configurations )

static

Reconfigures specified logger with new configurations.

◆ removeFlag()

void el::Loggers::removeFlag ( LoggingFlag flag )

inlinestatic

Removes logging flag used internally.

◆ setCategories()

void el::Loggers::setCategories	(	const char *	categories,
		bool	clear = true )

static

Sets categories as specified (on the fly).

◆ setDefaultConfigurations()

void el::Loggers::setDefaultConfigurations	(	const Configurations &	configurations,
		bool	reconfigureExistingLoggers = false )

static

Sets default configurations. This configuration is used for future (and conditionally for existing) loggers.

◆ setDefaultLogBuilder()

void el::Loggers::setDefaultLogBuilder ( el::LogBuilderPtr & logBuilderPtr )

static

Changes default log builder for future loggers.

◆ setFilenameCommonPrefix()

void el::Loggers::setFilenameCommonPrefix ( const std::string & prefix )

static

Sets filename common prefix.

◆ setLoggingLevel()

void el::Loggers::setLoggingLevel ( Level level )

inlinestatic

Sets hierarchy for logging. Needs to enable logging flag (HierarchicalLogging).

◆ setVerboseLevel()

void el::Loggers::setVerboseLevel ( base::type::VerboseLevel level )

static

Sets verbose level on the fly.

◆ setVModules()

void el::Loggers::setVModules ( const char * modules )

static

Sets vmodules as specified (on the fly).

◆ uninstallLoggerRegistrationCallback()

template<typename T>

void el::Loggers::uninstallLoggerRegistrationCallback ( const std::string & id )

inlinestatic

Uninstalls log dispatch callback.

◆ unregisterLogger()

bool el::Loggers::unregisterLogger ( const std::string & identity )

static

Unregisters logger - use it only when you know what you are doing, you may unregister loggers initialized / used by third-party libs.

◆ verboseLevel()

base::type::VerboseLevel el::Loggers::verboseLevel ( void )

static

Gets current verbose level.

The documentation for this class was generated from the following files:

external/easylogging++/easylogging++.h
external/easylogging++/easylogging++.cc

Classes

Static Public Member Functions

Detailed Description

Member Function Documentation

◆ addFlag()

◆ allowed()

◆ clearCategories()

◆ clearVModules()

◆ configureFromArg()

◆ configureFromGlobal()

◆ defaultConfigurations()

◆ defaultTypedConfigurations()

◆ flushAll()

◆ getCategories()

◆ getFilenameCommonPrefix()

◆ getLogger()

◆ hasFlag()

◆ hasLogger()

◆ installLoggerRegistrationCallback()

◆ loggerRegistrationCallback()

◆ logStreamsReference()

◆ populateAllLoggerIds()

◆ reconfigureAllLoggers() [1/3]

◆ reconfigureAllLoggers() [2/3]

◆ reconfigureAllLoggers() [3/3]

◆ reconfigureLogger() [1/3]

◆ reconfigureLogger() [2/3]

◆ reconfigureLogger() [3/3]

◆ removeFlag()

◆ setCategories()

◆ setDefaultConfigurations()

◆ setDefaultLogBuilder()

◆ setFilenameCommonPrefix()

◆ setLoggingLevel()

◆ setVerboseLevel()

◆ setVModules()

◆ uninstallLoggerRegistrationCallback()

◆ unregisterLogger()

◆ verboseLevel()