Package org.alfresco.util.log.log4j2

Class Log4j2JmxLogAppender

java.lang.Object
org.apache.logging.log4j.core.AbstractLifeCycle
org.apache.logging.log4j.core.filter.AbstractFilterable
org.apache.logging.log4j.core.appender.AbstractAppender
org.alfresco.util.log.log4j2.Log4j2JmxLogAppender
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="Log4j2JmxLogAppender", category="Core", elementType="appender") public class Log4j2JmxLogAppender extends org.apache.logging.log4j.core.appender.AbstractAppender
A custom Log4J2 appender that pushes received log events to JMX.
Author:
Domenico Sibilio

  • 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, EMPTY_ARRAY

  • Constructor Summary

    Constructors
    Constructor
    Description
    Log4j2JmxLogAppender(String name, org.apache.logging.log4j.core.Filter filter, org.apache.logging.log4j.core.Layout<? extends Serializable> layout, String objectName, String serverSelection, boolean ignoreExceptions, org.apache.logging.log4j.core.config.Configuration configuration)
    The factory method within this class should be used instead.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    append(org.apache.logging.log4j.core.LogEvent event)
     
    static Log4j2JmxLogAppender
    createAppender(String name, org.apache.logging.log4j.core.Filter filter, org.apache.logging.log4j.core.Layout<? extends Serializable> layout, String objectName, String serverSelection, boolean ignoreExceptions, org.apache.logging.log4j.core.config.Configuration configuration)
    Factory method to create a Log4j2JmxLogAppender instance.
    jmxlogger.tools.JmxEventLogger
    getLogger()
     
    String
    getServerSelection()
     
    void
    setLogger(jmxlogger.tools.JmxEventLogger logger)
     

    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 Details

    • Log4j2JmxLogAppender

      public Log4j2JmxLogAppender(String name, org.apache.logging.log4j.core.Filter filter, org.apache.logging.log4j.core.Layout<? extends Serializable> layout, String objectName, String serverSelection, boolean ignoreExceptions, org.apache.logging.log4j.core.config.Configuration configuration)
      The factory method within this class should be used instead.
      Parameters:
      name - the name of the appender.
      filter - the filter to apply to incoming log events.
      layout - the layout to apply to the log message.
      objectName - the ObjectName for the underlying JMX bean.
      serverSelection - the MBean Server for the underlying JMX bean.
      ignoreExceptions - whether this appender should ignore exceptions or propagate them.
      configuration - the Log4j configuration.

  • Method Details

    • createAppender

      @PluginFactory public static Log4j2JmxLogAppender createAppender(@PluginAttribute("name") String name, @PluginElement("Filter") org.apache.logging.log4j.core.Filter filter, @PluginElement("Layout") org.apache.logging.log4j.core.Layout<? extends Serializable> layout, @PluginAttribute("ObjectName") String objectName, @PluginAttribute(value="serverSelection",defaultString="platform") String serverSelection, @PluginAttribute(value="ignoreExceptions",defaultBoolean=true) boolean ignoreExceptions, @PluginConfiguration org.apache.logging.log4j.core.config.Configuration configuration)
      Factory method to create a Log4j2JmxLogAppender instance.
      Parameters:
      name - the name of the appender.
      filter - the filter to apply to incoming log events.
      layout - the layout to apply to the log message.
      objectName - the ObjectName for the underlying JMX bean.
      serverSelection - the MBean Server for the underlying JMX bean.
      ignoreExceptions - whether this appender should ignore exceptions or propagate them.
      Returns:
      the newly built Log4j2JmxLogAppender instance.

    • append

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

    • getLogger

      public jmxlogger.tools.JmxEventLogger getLogger()

    • setLogger

      public void setLogger(jmxlogger.tools.JmxEventLogger logger)

    • getServerSelection

      public String getServerSelection()