org.openmrs.logging

Class OpenmrsLoggingUtil

java.lang.Object

org.openmrs.logging.OpenmrsLoggingUtil

public final class OpenmrsLoggingUtil
extends Object

Utility methods related to logging. In general, module-level code should likely only call getMemoryAppender() and getOpenmrsLogLocation(), however, the methods to update loggers are also exposed if necessary.

Since:

2.4.4, 2.5.1, 2.6.0

Method Summary

Modifier and Type	Method and Description
static void	applyLogLevel(String logClass, String logLevel) Set the log4j log level for class logClass to logLevel.
static void	applyLogLevels() Sets the org.openmrs Log4J logger's level if global property log.level.openmrs ( OpenmrsConstants.GLOBAL_PROPERTY_LOG_LEVEL ) exists.
static MemoryAppender	getMemoryAppender() Gets the in-memory log appender.
static String	getOpenmrsLogLocation() Returns the location of the OpenMRS log file.
static void	reloadLoggingConfiguration() Reloads the logging configuration

Methods inherited from class java.lang.Object

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

Method Detail

getMemoryAppender

@Logging(ignore=true)
public static MemoryAppender getMemoryAppender()

Gets the in-memory log appender. This method needed to be added as it is much more difficult to get a specific appender in the Log4J2 architecture. This method is called in places where we need to display logging message.

Since:

2.4.4, 2.5.1, 2.6.0

getOpenmrsLogLocation

public static String getOpenmrsLogLocation()

Returns the location of the OpenMRS log file.

Warning: the result of this call can return null if either the file appender uses a name other than OpenmrsConstants.LOG_OPENMRS_FILE_APPENDER or if the appender with that name is not one of the default log4j2 file appending types.

Returns:

the path to the OpenMRS log file

applyLogLevels

@Logging(ignore=true)
public static void applyLogLevels()

Sets the org.openmrs Log4J logger's level if global property log.level.openmrs ( OpenmrsConstants.GLOBAL_PROPERTY_LOG_LEVEL ) exists. Valid values for global property are trace, debug, info, warn, error or fatal.

applyLogLevel

public static void applyLogLevel(String logClass,
                                 String logLevel)

Set the log4j log level for class logClass to logLevel.

Parameters:

logClass - optional string giving the class level to change. Defaults to OpenmrsConstants.LOG_CLASS_DEFAULT . Should be something like org.openmrs.___

logLevel - one of OpenmrsConstants.LOG_LEVEL_* constants

reloadLoggingConfiguration

public static void reloadLoggingConfiguration()

Reloads the logging configuration