Class GrowLog4j2Appender

java.lang.Object
org.apache.logging.log4j.core.AbstractLifeCycle
org.apache.logging.log4j.core.filter.AbstractFilterable
org.apache.logging.log4j.core.appender.AbstractAppender
codes.grow.packages.betterstack.logging.GrowLog4j2Appender
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="GrowLog", category="Core", elementType="appender", printObject=true) public final class GrowLog4j2Appender extends org.apache.logging.log4j.core.appender.AbstractAppender
Log4j 2 appender plugin (<GrowLog name="grow"/>) that forwards events to a LogClient (Log4j is an optional, provided dependency).

Appenders created from a configuration file use the client registered with setDefaultClient(codes.grow.packages.betterstack.logging.LogClient); create(java.lang.String, codes.grow.packages.betterstack.logging.LogClient) binds an explicit client. Context data (MDC) becomes attributes, together with logger.name, thread.name and exception.*.

  • 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
    Modifier and Type
    Field
    Description
    static final String
    Plugin element name in log4j2.xml.

    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
  • Method Summary

    Modifier and Type
    Method
    Description
    void
    append(org.apache.logging.log4j.core.LogEvent event)
     
    create(String name, LogClient client)
    Creates an appender bound to client (start it and add it to a configuration).
    createAppender(String name, org.apache.logging.log4j.core.Filter filter)
    Plugin factory used by configuration files.
    static void
    Sets the client used by appenders created from configuration files.
    static Severity
    severityOf(org.apache.logging.log4j.Level level)
    Maps a Log4j level to a severity.

    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
  • Field Details

  • Method Details

    • createAppender

      @PluginFactory public static GrowLog4j2Appender createAppender(@PluginAttribute("name") String name, @PluginElement("Filter") org.apache.logging.log4j.core.Filter filter)
      Plugin factory used by configuration files.
      Parameters:
      name - appender name
      filter - optional filter
      Returns:
      appender bound to the default client
    • create

      public static GrowLog4j2Appender create(String name, LogClient client)
      Creates an appender bound to client (start it and add it to a configuration).
      Parameters:
      name - appender name
      client - destination
      Returns:
      appender
    • setDefaultClient

      public static void setDefaultClient(LogClient client)
      Sets the client used by appenders created from configuration files.
      Parameters:
      client - destination or null
    • severityOf

      public static Severity severityOf(org.apache.logging.log4j.Level level)
      Maps a Log4j level to a severity.
      Parameters:
      level - level
      Returns:
      severity
    • append

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