com.jamonapi.log4j

Class JAMonAppender

java.lang.Object

org.apache.logging.log4j.core.AbstractLifeCycle

org.apache.logging.log4j.core.filter.AbstractFilterable

org.apache.logging.log4j.core.appender.AbstractAppender

com.jamonapi.log4j.JAMonAppender

All Implemented Interfaces:

org.apache.logging.log4j.core.Appender, org.apache.logging.log4j.core.filter.Filterable, org.apache.logging.log4j.core.impl.LocationAware, org.apache.logging.log4j.core.LifeCycle, org.apache.logging.log4j.core.LifeCycle2

@Plugin(name="JamonAppender",
        category="Core",
        elementType="appender",
        printObject=true)
public class JAMonAppender
extends org.apache.logging.log4j.core.appender.AbstractAppender

Implementaton of a log4j Appender that allows you to summarize log4j stats via jamon and view the tail of the log in realtime in a jamon web page. Click here for more info on how to use the JAMonAppender.

Since:

2.82

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.logging.log4j.core.appender.AbstractAppender

org.apache.logging.log4j.core.appender.AbstractAppender.Builder<B extends org.apache.logging.log4j.core.appender.AbstractAppender.Builder<B>>

Nested classes/interfaces inherited from interface org.apache.logging.log4j.core.LifeCycle

org.apache.logging.log4j.core.LifeCycle.State

Field Summary

Fields inherited from class org.apache.logging.log4j.core.AbstractLifeCycle

DEFAULT_STOP_TIMEOUT, DEFAULT_STOP_TIMEUNIT, LOGGER

Fields inherited from interface org.apache.logging.log4j.core.Appender

ELEMENT_TYPE

Constructor Summary

Constructors

Constructor and Description
JAMonAppender(String name, org.apache.logging.log4j.core.Filter filter, org.apache.logging.log4j.core.Layout<? extends Serializable> layout, boolean ignoreExceptions, int bufferSize, boolean enableLevelMonitoring, boolean generalize, String levelListenerType) This constructor is called automatically by log4j/sl4j

Method Summary

Modifier and Type	Method and Description
void	append(org.apache.logging.log4j.core.LogEvent event) If the appender is enabled then start and stop a JAMon entry.
static JAMonAppender	createAppender(String name, boolean ignoreExceptions, org.apache.logging.log4j.core.Layout layout, org.apache.logging.log4j.core.Filter filter, int bufferSize, boolean enableLevelMonitoring, boolean generalize, String levelListenerType) Called automatically by log4j/sl4j.
protected String	generalize(String detailedMessage) generalize the passed in String if a Genaralizer is set
boolean	getEnableLevelMonitoring() Returns whether or not LevelMonitoring is enabled or not.
boolean	getGeneralize() Return whether or not generalization will occur
int	getListenerBufferSize()
String	getUnits()
boolean	hasGeneralizer() Indicates whether or not a Generalizer has been set
void	setEnableDefaultGeneralizer(boolean enableDefaultGeneralizer) Enable the use of the DefaultGeneralizer.
void	setEnableLevelMonitoring(boolean enableLevelMonitoring) Specifies whether or not there will be a JAMon record for each log4j Level (DEBUG/WARN/...), and another one that corresponds to all calls to log4j logging methods.
void	setEnableListeners(String level) Note this is primarily used by the log4j configurator.
void	setGeneralize(boolean generalize) Indicate whether or not a jamon record should be created from the passed in message.
void	setGeneralizerClass(Generalizer generalizer) Default generalizer based on com.jamonapi.utils.SQLDeArger.
void	setGeneralizerDynamic(String generalizerClassStr) Pass in a string class name and this generalizer will be constructed an used.
void	setListenerBufferSize(int bufferSize) For defaultBufferSize to take hold it must be called before the first call to setDefaultListeners.
void	setUnits(String units)

Methods inherited from class org.apache.logging.log4j.core.appender.AbstractAppender

error, error, error, getHandler, getLayout, getName, ignoreExceptions, parseInt, requiresLocation, setHandler, toSerializable, toString

Methods inherited from class org.apache.logging.log4j.core.filter.AbstractFilterable

addFilter, getFilter, getPropertyArray, hasFilter, isFiltered, removeFilter, start, stop, stop

Methods inherited from class org.apache.logging.log4j.core.AbstractLifeCycle

equalsImpl, getState, getStatusLogger, hashCodeImpl, initialize, isInitialized, isStarted, isStarting, isStopped, isStopping, setStarted, setStarting, setState, setStopped, setStopping, stop, stop

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.logging.log4j.core.LifeCycle

getState, initialize, isStarted, isStopped, start, stop

Constructor Detail

JAMonAppender

public JAMonAppender(String name,
                     org.apache.logging.log4j.core.Filter filter,
                     org.apache.logging.log4j.core.Layout<? extends Serializable> layout,
                     boolean ignoreExceptions,
                     int bufferSize,
                     boolean enableLevelMonitoring,
                     boolean generalize,
                     String levelListenerType)

This constructor is called automatically by log4j/sl4j

Parameters:

name -

filter -

layout -

ignoreExceptions -

bufferSize -

enableLevelMonitoring -

generalize -

levelListenerType -

Method Detail

createAppender

@PluginFactory
public static JAMonAppender createAppender(@PluginAttribute(value="name")
                                                          String name,
                                                          @PluginAttribute(value="ignoreExceptions")
                                                          boolean ignoreExceptions,
                                                          @PluginElement(value="Layout")
                                                          org.apache.logging.log4j.core.Layout layout,
                                                          @PluginElement(value="Filters")
                                                          org.apache.logging.log4j.core.Filter filter,
                                                          @PluginAttribute(value="bufferSize",defaultInt=100)
                                                          int bufferSize,
                                                          @PluginAttribute(value="enableLevelMonitoring",defaultBoolean=true)
                                                          boolean enableLevelMonitoring,
                                                          @PluginAttribute(value="generalize",defaultBoolean=false)
                                                          boolean generalize,
                                                          @PluginAttribute(value="enableListeners",defaultString="NONE")
                                                          String levelListenerType)

Called automatically by log4j/sl4j. If values aren't provided defaults are used.

Parameters:

name -

ignoreExceptions -

layout -

filter -

bufferSize -

enableLevelMonitoring -

generalize -

levelListenerType -

Returns:

append

public void append(org.apache.logging.log4j.core.LogEvent event)

If the appender is enabled then start and stop a JAMon entry. Depending on how this object is configured it may also put details into a JAMonBufferLister and generalize the logging message (logger.error(message) etc) and put it in jamon too. By default it will only do jamon records for each of the log4j Levels.

Parameters:

event -

getUnits

public String getUnits()

Returns:

Returns the units. By default this is 'log4j' though it can be changed. This is used as part of the jamon key.

setUnits

public void setUnits(String units)

Parameters:

units - The units to set.

setEnableLevelMonitoring

public void setEnableLevelMonitoring(boolean enableLevelMonitoring)

Specifies whether or not there will be a JAMon record for each log4j Level (DEBUG/WARN/...), and another one that corresponds to all calls to log4j logging methods. It is identified by the label TOTAL. By default this is enabled.

getEnableLevelMonitoring

public boolean getEnableLevelMonitoring()

Returns whether or not LevelMonitoring is enabled or not.

setEnableListeners

public void setEnableListeners(String level)

Note this is primarily used by the log4j configurator. Valid values are the various log4j levels:

• TRACE/DEBUG/ERROR/WARN/INFO/ERROR, as well as...
• TOTAL (A listener that gets called for all levels),
• BASIC (same as calling TOTAL/ERROR/FATAL),
• ALL (same as calling TRACE/DEBUG/ERROR/WARN/INFO/ERROR/FATAL/TOTAL).
• NONE (Nothing will be tracked).

Note: Values are not case sensitive.

Parameters:

level -

setListenerBufferSize

public void setListenerBufferSize(int bufferSize)

For defaultBufferSize to take hold it must be called before the first call to setDefaultListeners. By default the buffer size is 100.

Parameters:

bufferSize -

getListenerBufferSize

public int getListenerBufferSize()

setGeneralize

public void setGeneralize(boolean generalize)

Indicate whether or not a jamon record should be created from the passed in message. Note you can use the DefaultGeneralizer, your own Generalizer. It is very important that you ensure the String returned by the generalizer is unique enough that JAMon doesn't grow unbounded. For example by choosing to use no Generalizer you must pass in a relatively unique log4j string.

Parameters:

generalize -

getGeneralize

public boolean getGeneralize()

Return whether or not generalization will occur

generalize

protected String generalize(String detailedMessage)

generalize the passed in String if a Genaralizer is set

setEnableDefaultGeneralizer

public void setEnableDefaultGeneralizer(boolean enableDefaultGeneralizer)

Enable the use of the DefaultGeneralizer. As a side effect setGeneralize(true) is called telling this class to generalize.

Parameters:

enableDefaultGeneralizer -

hasGeneralizer

public boolean hasGeneralizer()

Indicates whether or not a Generalizer has been set

setGeneralizerClass

public void setGeneralizerClass(Generalizer generalizer)

Default generalizer based on com.jamonapi.utils.SQLDeArger. It generalizes by replacing numbers and strings in single or double quotes with '?'. i.e. select * from table where name = 'steve' and id=50 becomes select * from table where name = ? and id=?. Developers can provide their own Generalizer if this is not the desired behaviour. Although the example uses a query the code works equally well with any String. The generalizer is used to create a record appropriate for jamon from a detail String that goes to log4j.

setGeneralizerDynamic

public void setGeneralizerDynamic(String generalizerClassStr)
                           throws InstantiationException,
                                  IllegalAccessException,
                                  ClassNotFoundException

Pass in a string class name and this generalizer will be constructed an used. For example com.jamonapi.utils.DefaultGeneralizer could be passed in

Parameters:

generalizerClassStr -

Throws:

InstantiationException

IllegalAccessException

ClassNotFoundException