alma.acs.logging.config

Class LogConfig

java.lang.Object

alma.acs.logging.config.LogConfig

public class LogConfig
extends java.lang.Object

Class that encapsulates all configuration sources (defaults, properties, CDB) for Java logging, and supports runtime updates of logging configuration based on these sources. This class can be used by a process such as the Java container or the manager, in order to configure all its loggers (e.g. container logger, component loggers, ORB logger).

Author:

hsommer

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	LogConfig.LockableUnnamedLogger

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	PROPERTYNAME_MIN_LOG_LEVEL
static java.lang.String	PROPERTYNAME_MIN_LOG_LEVEL_LOCAL
static java.lang.String	PROPERTYNAME_NAMED_LOGGER_LEVELS Using this property, we can configure named loggers for processes other than containers and manager, for which there is no logging configuration in the CDB.

Constructor Summary

Constructors

Constructor and Description
LogConfig()

Method Summary

Modifier and Type	Method and Description
void	addSubscriber(LogConfigSubscriber subscriber)
void	clearNamedLoggerConfig(java.lang.String loggerName) Clears log level settings for the given named logger, so that it uses default log levels.
java.lang.String	getCentralizedLogger()
AcsLogLevelDefinition	getDefaultMinLogLevel() Gets the log level for centralized logging for default loggers (those that don't have custom levels set).
AcsLogLevelDefinition	getDefaultMinLogLevelLocal() Gets the log level for stdout printing for default loggers (those that don't have custom levels set).
int	getDispatchPacketSize()
int	getFlushPeriodSeconds()
AcsLogLevelDefinition	getImmediateDispatchLevel()
java.util.Set<java.lang.String>	getLoggerNames() Gets the names of all known loggers, no matter if they use default or custom levels.
int	getMaxLogQueueSize()
int	getMaxLogsPerSecond()
LogConfig.LockableUnnamedLogger	getNamedLoggerConfig(java.lang.String loggerName) Gets the (log level) configuration data for a named logger.
boolean	hasCustomConfig(java.lang.String loggerName) Checks if there is a level configuration for this particular logger.
void	initialize(boolean cdbBeatsProperties) Initializes the values based on CDB settings, logging properties, etc.
boolean	isKnownLogger(java.lang.String loggerName) Checks if the given logger name is known, either for default or custom config.
protected void	log(java.util.logging.Level level, java.lang.String msg, java.lang.Throwable thr) Logs to the Logger given in setInternalLogger(Logger), or to System.out if no Logger has been provided.
void	removeSubscriber(LogConfigSubscriber subscriber)
boolean	renameNamedLoggerConfig(java.lang.String oldLoggerName, java.lang.String newLoggerName) Renaming of a logger can occur for example when an ORB logger undergoes a name change as soon as the process name is determined by the container logger.
void	setAndLockMinLogLevel(AcsLogLevelDefinition newLevel, java.lang.String loggerName) Locking a remote log level is currently needed only for the container to ensure that the ORB logger of the container in which the archive logger component runs is guaranteed to not produce any logs (which would lead to log record explosion through positive feedback).
void	setCDB(DALOperations cdb) Sets the reference to the CDB, which will then be used for configuration.
void	setCDBComponentPath(java.lang.String compLoggerName, java.lang.String path) Sets the path to the CDB's node that is parent of the <log:UnnamedLogger/> component logger node.
void	setCDBLoggingConfigPath(java.lang.String path) Sets the path to the CDB's node that is parent of the <LoggingConfig> node, such as a container or the manager node.
void	setDefaultMinLogLevel(AcsLogLevelDefinition newLevel) Sets the given log level for centralized logging of log records for all loggers that don't have a custom configuration.
void	setDefaultMinLogLevelLocal(AcsLogLevelDefinition newLevel) Sets the given log level for stdout printing of log records for all loggers that don't have a custom configuration.
void	setInternalLogger(java.util.logging.Logger logger) Sets the Logger to be used by this class and dependent classes for internal tracing.
void	setMaxLogsPerSecond(int maxLogsPerSecond) Limits the total number of logs emitted by the whole process, separately for local and remote logging.
void	setMinLogLevel(AcsLogLevelDefinition newLevel, java.lang.String loggerName)
void	setMinLogLevelLocal(AcsLogLevelDefinition newLevel, java.lang.String loggerName)
void	setNamedLoggerConfig(java.lang.String loggerName, LogConfig.LockableUnnamedLogger config) Sets the given log levels for the named logger and notifies all listeners.
void	setNamedLoggerConfig(java.lang.String loggerName, UnnamedLogger config) We keep this method next to setNamedLoggerConfig(String, alma.acs.logging.config.LogConfig.LockableUnnamedLogger) in order to keep the LockableUnnamedLogger confined to this class.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

PROPERTYNAME_MIN_LOG_LEVEL_LOCAL

public static final java.lang.String PROPERTYNAME_MIN_LOG_LEVEL_LOCAL

See Also:

Constant Field Values

PROPERTYNAME_MIN_LOG_LEVEL

public static final java.lang.String PROPERTYNAME_MIN_LOG_LEVEL

See Also:

Constant Field Values

PROPERTYNAME_NAMED_LOGGER_LEVELS

public static final java.lang.String PROPERTYNAME_NAMED_LOGGER_LEVELS

Using this property, we can configure named loggers for processes other than containers and manager, for which there is no logging configuration in the CDB. It is not expected to be used widely, which excuses the not so intuitive stuffing of data into a single property.

Example:

-DACS.log.minlevel.namedloggers="hibernateSQL@CDB-RDB=2,3:hibernate@CDB-RDB=5,5"

configures two loggers: "hibernateSQL@CDB-RDB" will use local log level 2 and remote level 3, while "hibernate@CDB-RDB" will use local and remote level 5.

See Also:

Constant Field Values

Constructor Detail

LogConfig

public LogConfig()

Method Detail

setCDB

public void setCDB(DALOperations cdb)

Sets the reference to the CDB, which will then be used for configuration. Before this method is called, default values are used instead of CDB values.

Note that the reference is only set, but the CDB is not read automatically; for this, call initialize(boolean).

Parameters:

cdb - a reference to the CDB. Will be ignored if == null.

setCDBLoggingConfigPath

public void setCDBLoggingConfigPath(java.lang.String path)

Sets the path to the CDB's node that is parent of the <LoggingConfig> node, such as a container or the manager node. This call does not access the CDB.

Parameters:

path - for example "MACI/Containers/frodoContainer"

setCDBComponentPath

public void setCDBComponentPath(java.lang.String compLoggerName,
                                java.lang.String path)

Sets the path to the CDB's node that is parent of the <log:UnnamedLogger/> component logger node. This call does not access the CDB.

Parameters:

compLoggerName - the component logger name, e.g. MOUNT1.

path - e.g. MACI/Components.

initialize

public void initialize(boolean cdbBeatsProperties)
                throws LogConfigException

Initializes the values based on CDB settings, logging properties, etc. All subscribing classes are notified of the new configuration, see LogConfigSubscriber.configureLogging(LogConfig).

This method can be called more than once: if some settings have changed, should be read in, and the logging classes should be notified of these changes. For example, the container could call this method when it gets notified that the logging configuration in the CDB has been changed at runtime.

Parameters:

cdbBeatsProperties - if true then the default logger level values from the CDB override the properties (env vars). True is foreseen for dynamic updates from the CDB, whereas for the initial configuration it should be a false.

Throws:

LogConfigException - if reading the configuration data failed and thus default values were used, or if there were problems during configuration even though some of the configuring went ok (best-effort approach).

getCentralizedLogger

public java.lang.String getCentralizedLogger()

getDispatchPacketSize

public int getDispatchPacketSize()

getImmediateDispatchLevel

public AcsLogLevelDefinition getImmediateDispatchLevel()

getFlushPeriodSeconds

public int getFlushPeriodSeconds()

getMaxLogQueueSize

public int getMaxLogQueueSize()

getMaxLogsPerSecond

public int getMaxLogsPerSecond()

setMaxLogsPerSecond

public void setMaxLogsPerSecond(int maxLogsPerSecond)

Limits the total number of logs emitted by the whole process, separately for local and remote logging.

Introduced with ACS 9.0 for only reading the log throttle configuration data, we add this setter method in preparation for future exposure in the LoggingConfigurable interface, and also for test setups.

getDefaultMinLogLevelLocal

public AcsLogLevelDefinition getDefaultMinLogLevelLocal()

Gets the log level for stdout printing for default loggers (those that don't have custom levels set).

setDefaultMinLogLevelLocal

public void setDefaultMinLogLevelLocal(AcsLogLevelDefinition newLevel)

Sets the given log level for stdout printing of log records for all loggers that don't have a custom configuration. All log config listeners.get notified of this change. The call is ignored for negative values of newLevel.

Parameters:

newLevel -

getDefaultMinLogLevel

public AcsLogLevelDefinition getDefaultMinLogLevel()

Gets the log level for centralized logging for default loggers (those that don't have custom levels set).

setDefaultMinLogLevel

public void setDefaultMinLogLevel(AcsLogLevelDefinition newLevel)

Sets the given log level for centralized logging of log records for all loggers that don't have a custom configuration. All log config listeners.get notified of this change. The call is ignored for negative values of newLevel.

Parameters:

newLevel -

getLoggerNames

public java.util.Set<java.lang.String> getLoggerNames()

Gets the names of all known loggers, no matter if they use default or custom levels.

The loggers are registered automatically by calls to getNamedLoggerConfig(String) and setNamedLoggerConfig(String, UnnamedLogger).

isKnownLogger

public boolean isKnownLogger(java.lang.String loggerName)

Checks if the given logger name is known, either for default or custom config.

The current LoggingConfigurable interface semantics don't allow configuration of a logger that does not yet exist. Therefore this method can be used to check first before calling getNamedLoggerConfig(String) or setNamedLoggerConfig(String, alma.acs.logging.config.LogConfig.LockableUnnamedLogger), which would automatically add a previously unknown logger.

Parameters:

loggerName -

Since:

ACS 7.0.2

hasCustomConfig

public boolean hasCustomConfig(java.lang.String loggerName)

Checks if there is a level configuration for this particular logger.

Parameters:

loggerName -

Returns:

false if the logger is not known or uses the default configuration

getNamedLoggerConfig

public LogConfig.LockableUnnamedLogger getNamedLoggerConfig(java.lang.String loggerName)

Gets the (log level) configuration data for a named logger. Resorts to the default configuration if a specialized configuration is not available.

Note that a copy of the config data is returned, so changes to it will not affect any other object's configuration.

A previously unknown logger gets registered by its name. If this is not intended, check first with isKnownLogger(String).

setNamedLoggerConfig

public void setNamedLoggerConfig(java.lang.String loggerName,
                                 LogConfig.LockableUnnamedLogger config)
                          throws AcsJIllegalArgumentEx

Sets the given log levels for the named logger and notifies all listeners. Ignores this call if any of the parameters are null.

A copy of the supplied config is made to isolate the stored data from later modifications.

If loggerName is previously unknown, then this logger is added automatically to the list of known loggers. If this is not intended, check first using isKnownLogger(String).

Throws:

AcsJIllegalArgumentEx - if the log level integers inside config are illegal.

setNamedLoggerConfig

public void setNamedLoggerConfig(java.lang.String loggerName,
                                 UnnamedLogger config)
                          throws AcsJIllegalArgumentEx

We keep this method next to setNamedLoggerConfig(String, alma.acs.logging.config.LogConfig.LockableUnnamedLogger) in order to keep the LockableUnnamedLogger confined to this class. It may be exposed later, and this method could then be removed.

Parameters:

loggerName -

config -

Throws:

AcsJIllegalArgumentEx

Since:

ACS 7.0

clearNamedLoggerConfig

public void clearNamedLoggerConfig(java.lang.String loggerName)

Clears log level settings for the given named logger, so that it uses default log levels. Notifies all listeners. Ignores this call if loggerName is null.

setMinLogLevelLocal

public void setMinLogLevelLocal(AcsLogLevelDefinition newLevel,
                                java.lang.String loggerName)

setMinLogLevel

public void setMinLogLevel(AcsLogLevelDefinition newLevel,
                           java.lang.String loggerName)

setAndLockMinLogLevel

public void setAndLockMinLogLevel(AcsLogLevelDefinition newLevel,
                                  java.lang.String loggerName)

Locking a remote log level is currently needed only for the container to ensure that the ORB logger of the container in which the archive logger component runs is guaranteed to not produce any logs (which would lead to log record explosion through positive feedback).

The more abstract concept of locking log levels was chosen to keep the special scenario described above out of the logging config code.

Parameters:

newLevel - small integer log level (IDL value wrapped by a Java enum)

loggerName -

renameNamedLoggerConfig

public boolean renameNamedLoggerConfig(java.lang.String oldLoggerName,
                                       java.lang.String newLoggerName)

Renaming of a logger can occur for example when an ORB logger undergoes a name change as soon as the process name is determined by the container logger.

Renaming is not a regular part of a logger's life though. By the time that tools can look at the list of loggers, no renaming should occur any more.

Parameters:

oldLoggerName -

newLoggerName -

Returns:

true if the logger config was renamed. False for bad or unmatching parameters which result in no change.

addSubscriber

public void addSubscriber(LogConfigSubscriber subscriber)

removeSubscriber

public void removeSubscriber(LogConfigSubscriber subscriber)

setInternalLogger

public void setInternalLogger(java.util.logging.Logger logger)

Sets the Logger to be used by this class and dependent classes for internal tracing.

Note that in the current design of ClientLogManager and LogConfig, the Logger can not be provided already in the constructor, because the Logger first must be configured, which in turn requires a LogConfig instance. That's why we have this setter method.

log

protected void log(java.util.logging.Level level,
                   java.lang.String msg,
                   java.lang.Throwable thr)

Logs to the Logger given in setInternalLogger(Logger), or to System.out if no Logger has been provided.