org.apache.logging.log4j.core.appender.mom.kafka

Class KafkaAppender

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.mom.kafka.KafkaAppender

All Implemented Interfaces:

Appender, Filterable, LifeCycle, LifeCycle2

@Plugin(name="Kafka",
        category="Core",
        elementType="appender",
        printObject=true)
public final class KafkaAppender
extends AbstractAppender

Sends log events to an Apache Kafka topic.

Nested Class Summary

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

AbstractAppender.Builder<B extends AbstractAppender.Builder<B>>

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

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

Methods

Modifier and Type	Method and Description
void	append(LogEvent event) Logs a LogEvent using whatever logic this Appender wishes to use.
static KafkaAppender	createAppender(Layout<? extends Serializable> layout, Filter filter, String name, boolean ignoreExceptions, String topic, Property[] properties, Configuration configuration)
void	start() Make the Filter available for use.
boolean	stop(long timeout, TimeUnit timeUnit) Cleanup the Filter.
String	toString()

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

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

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

addFilter, getFilter, hasFilter, isFiltered, removeFilter, stop

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

equalsImpl, getState, 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

createAppender

@PluginFactory
public static KafkaAppender createAppender(@PluginElement(value="Layout")
                                         Layout<? extends Serializable> layout,
                                         @PluginElement(value="Filter")
                                         Filter filter,
                                         @Required(message="No name provided for KafkaAppender")@PluginAttribute(value="name")
                                         String name,
                                         @PluginAttribute(value="ignoreExceptions",defaultBoolean=true)
                                         boolean ignoreExceptions,
                                         @Required(message="No topic provided for KafkaAppender")@PluginAttribute(value="topic")
                                         String topic,
                                         @PluginElement(value="Properties")
                                         Property[] properties,
                                         @PluginConfiguration
                                         Configuration configuration)

append

public void append(LogEvent event)

Description copied from interface: Appender

Logs a LogEvent using whatever logic this Appender wishes to use. It is typically recommended to use a bridge pattern not only for the benefits from decoupling an Appender from its implementation, but it is also handy for sharing resources which may require some form of locking.

Parameters:

event - The LogEvent.

start

public void start()

Description copied from class: AbstractFilterable

Make the Filter available for use.

Specified by:

start in interface LifeCycle

Overrides:

start in class AbstractFilterable

stop

public boolean stop(long timeout,
           TimeUnit timeUnit)

Description copied from class: AbstractFilterable

Cleanup the Filter.

Specified by:

stop in interface LifeCycle2

Overrides:

stop in class AbstractFilterable

Parameters:

timeout - the maximum time to wait

timeUnit - the time unit of the timeout argument

Returns:

true if the receiver was stopped cleanly and normally, false otherwise.

toString

public String toString()

Overrides:

toString in class AbstractAppender