Package org.apache.pulsar.log4j2.appender

Class PulsarAppender

  • 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="Pulsar",
        category="Core",
        elementType="appender",
        printObject=true)
public final class PulsarAppender
extends org.apache.logging.log4j.core.appender.AbstractAppender
    The PulsarAppender logs events to an Apache Pulsar topic.

    Each log event is sent as a Pulsar record.

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  PulsarAppender.Builder<B extends PulsarAppender.Builder<B>>
      Builds PulsarAppender instances.

      • 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

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void append​(org.apache.logging.log4j.core.LogEvent event)  
      static <B extends PulsarAppender.Builder<B>>
      B      		 newBuilder()
      Creates a builder for a PulsarAppender.
      void start()  
      boolean stop​(long timeout, java.util.concurrent.TimeUnit timeUnit)  
      java.lang.String toString()  

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

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

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

        addFilter, getFilter, getPropertyArray, hasFilter, isFiltered, removeFilter, 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, stop

    • Method Detail

      • newBuilder

        @PluginBuilderFactory
public static <B extends PulsarAppender.Builder<B>> B newBuilder()
        Creates a builder for a PulsarAppender.
        Returns:
        a builder for a PulsarAppender.

      • append

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

      • start

        public void start()
        Specified by:
        start in interface org.apache.logging.log4j.core.LifeCycle
        Overrides:
        start in class org.apache.logging.log4j.core.filter.AbstractFilterable

      • stop

        public boolean stop​(long timeout,
                    java.util.concurrent.TimeUnit timeUnit)
        Specified by:
        stop in interface org.apache.logging.log4j.core.LifeCycle2
        Overrides:
        stop in class org.apache.logging.log4j.core.filter.AbstractFilterable

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class org.apache.logging.log4j.core.appender.AbstractAppender