Package org.apache.hadoop.hbase.logging

Class HBaseTestAppender

java.lang.Object
org.apache.logging.log4j.core.AbstractLifeCycle
org.apache.logging.log4j.core.filter.AbstractFilterable
org.apache.logging.log4j.core.appender.AbstractAppender
org.apache.logging.log4j.core.appender.AbstractOutputStreamAppender<org.apache.logging.log4j.core.appender.OutputStreamManager>
org.apache.hadoop.hbase.logging.HBaseTestAppender
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="HBaseTest", category="Core", elementType="appender", printObject=true) public final class HBaseTestAppender extends org.apache.logging.log4j.core.appender.AbstractOutputStreamAppender<org.apache.logging.log4j.core.appender.OutputStreamManager>
Log4j2 appender to be used when running UTs.

The main point here is to limit the total output size to prevent eating all the space of our ci system when something wrong in our code.

See HBASE-26947 for more details.

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static class 
    HBaseTestAppender.Builder<B extends HBaseTestAppender.Builder<B>>
     
    private static class 
    HBaseTestAppender.FactoryData
    Data to pass to factory method.Unable to instantiate
    private static class 
    HBaseTestAppender.HBaseTestManagerFactory
    Factory to create the Appender.

    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
    private static final HBaseTestAppender.HBaseTestManagerFactory
    FACTORY
     
    private final long
    maxSize
     
    static final String
    PLUGIN_NAME
     
    private final AtomicLong
    size
     
    private final AtomicBoolean
    stop
     

    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
    Modifier
    Constructor
    Description
    private
    HBaseTestAppender(String name, org.apache.logging.log4j.core.Layout<? extends Serializable> layout, org.apache.logging.log4j.core.Filter filter, boolean ignoreExceptions, boolean immediateFlush, org.apache.logging.log4j.core.config.Property[] properties, org.apache.logging.log4j.core.appender.OutputStreamManager manager, long maxSize)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    append(org.apache.logging.log4j.core.LogEvent event)
     
    static <B extends HBaseTestAppender.Builder<B>>
    B
    newBuilder()
     

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

    directEncodeEvent, getImmediateFlush, getManager, start, stop, stop, writeByteArrayToManager

    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

    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, stop

  • Field Details

  • Constructor Details

    • HBaseTestAppender

      private HBaseTestAppender(String name, org.apache.logging.log4j.core.Layout<? extends Serializable> layout, org.apache.logging.log4j.core.Filter filter, boolean ignoreExceptions, boolean immediateFlush, org.apache.logging.log4j.core.config.Property[] properties, org.apache.logging.log4j.core.appender.OutputStreamManager manager, long maxSize)

  • Method Details

    • newBuilder

      @PluginBuilderFactory public static <B extends HBaseTestAppender.Builder<B>> B newBuilder()

    • append

      public void append(org.apache.logging.log4j.core.LogEvent event)
      Specified by:
      append in interface org.apache.logging.log4j.core.Appender
      Overrides:
      append in class org.apache.logging.log4j.core.appender.AbstractOutputStreamAppender<org.apache.logging.log4j.core.appender.OutputStreamManager>