org.graylog2.log4j2

Class GelfAppender

java.lang.Object

org.apache.logging.log4j.core.AbstractLifeCycle

org.apache.logging.log4j.core.filter.AbstractFilterable

org.apache.logging.log4j.core.appender.AbstractAppender

org.graylog2.log4j2.GelfAppender

All Implemented Interfaces:

Serializable, org.apache.logging.log4j.core.Appender, org.apache.logging.log4j.core.filter.Filterable, org.apache.logging.log4j.core.LifeCycle

@Plugin(name="GELF",
        category="Core",
        elementType="appender",
        printObject=true)
public class GelfAppender
extends org.apache.logging.log4j.core.appender.AbstractAppender

See Also:

Serialized Form

Nested Class Summary

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

LOGGER

Constructor Summary

Constructors

Modifier

Constructor and Description

protected

GelfAppender(String name, org.apache.logging.log4j.core.Layout<? extends Serializable> layout, org.apache.logging.log4j.core.Filter filter, boolean ignoreExceptions, org.graylog2.gelfclient.GelfConfiguration gelfConfiguration, String hostName, boolean includeSource, boolean includeThreadContext, boolean includeStackTrace, org.apache.logging.log4j.core.util.KeyValuePair[] additionalFields, boolean includeExceptionCause)

Method Summary

Modifier and Type	Method and Description
void	append(org.apache.logging.log4j.core.LogEvent event)
static GelfAppender	createGelfAppender(org.apache.logging.log4j.core.Filter filter, org.apache.logging.log4j.core.Layout<? extends Serializable> layout, org.apache.logging.log4j.core.util.KeyValuePair[] additionalFields, String name, Boolean ignoreExceptions, String server, Integer port, String protocol, String hostName, Integer queueSize, Integer connectTimeout, Integer reconnectDelay, Integer sendBufferSize, Boolean tcpNoDelay, Boolean tcpKeepAlive, Boolean includeSource, Boolean includeThreadContext, Boolean includeStackTrace, Boolean includeExceptionCause, Boolean tlsEnabled, Boolean tlsEnableCertificateVerification, String tlsTrustCertChainFilename) Factory method for creating a GelfTransport provider within the plugin manager.
protected String	getSimpleStacktraceAsString(Throwable thrown)
protected void	setClient(org.graylog2.gelfclient.transport.GelfTransport client)
void	start()
void	stop()
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

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

equalsImpl, getState, hashCodeImpl, initialize, isInitialized, isStarted, isStarting, isStopped, isStopping, setStarted, setStarting, setState, setStopped, setStopping

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

Constructor Detail

GelfAppender

protected GelfAppender(String name,
                       org.apache.logging.log4j.core.Layout<? extends Serializable> layout,
                       org.apache.logging.log4j.core.Filter filter,
                       boolean ignoreExceptions,
                       org.graylog2.gelfclient.GelfConfiguration gelfConfiguration,
                       String hostName,
                       boolean includeSource,
                       boolean includeThreadContext,
                       boolean includeStackTrace,
                       org.apache.logging.log4j.core.util.KeyValuePair[] additionalFields,
                       boolean includeExceptionCause)

Method Detail

append

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

getSimpleStacktraceAsString

protected String getSimpleStacktraceAsString(Throwable thrown)

setClient

protected void setClient(org.graylog2.gelfclient.transport.GelfTransport client)

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 void stop()

Specified by:

stop in interface org.apache.logging.log4j.core.LifeCycle

Overrides:

stop in class org.apache.logging.log4j.core.filter.AbstractFilterable

toString

public String toString()

Overrides:

toString in class org.apache.logging.log4j.core.appender.AbstractAppender

createGelfAppender

@PluginFactory
public static GelfAppender createGelfAppender(@PluginElement(value="Filter")
                                                             org.apache.logging.log4j.core.Filter filter,
                                                             @PluginElement(value="Layout")
                                                             org.apache.logging.log4j.core.Layout<? extends Serializable> layout,
                                                             @PluginElement(value="AdditionalFields")
                                                             org.apache.logging.log4j.core.util.KeyValuePair[] additionalFields,
                                                             @PluginAttribute(value="name")
                                                             String name,
                                                             @PluginAttribute(value="ignoreExceptions",defaultBoolean=true)
                                                             Boolean ignoreExceptions,
                                                             @PluginAttribute(value="server",defaultString="localhost")
                                                             String server,
                                                             @PluginAttribute(value="port",defaultInt=12201)
                                                             Integer port,
                                                             @PluginAttribute(value="protocol",defaultString="UDP")
                                                             String protocol,
                                                             @PluginAttribute(value="hostName")
                                                             String hostName,
                                                             @PluginAttribute(value="queueSize",defaultInt=512)
                                                             Integer queueSize,
                                                             @PluginAttribute(value="connectTimeout",defaultInt=1000)
                                                             Integer connectTimeout,
                                                             @PluginAttribute(value="reconnectDelay",defaultInt=500)
                                                             Integer reconnectDelay,
                                                             @PluginAttribute(value="sendBufferSize",defaultInt=-1)
                                                             Integer sendBufferSize,
                                                             @PluginAttribute(value="tcpNoDelay",defaultBoolean=false)
                                                             Boolean tcpNoDelay,
                                                             @PluginAttribute(value="tcpKeepAlive",defaultBoolean=false)
                                                             Boolean tcpKeepAlive,
                                                             @PluginAttribute(value="includeSource",defaultBoolean=true)
                                                             Boolean includeSource,
                                                             @PluginAttribute(value="includeThreadContext",defaultBoolean=true)
                                                             Boolean includeThreadContext,
                                                             @PluginAttribute(value="includeStackTrace",defaultBoolean=true)
                                                             Boolean includeStackTrace,
                                                             @PluginAttribute(value="includeExceptionCause",defaultBoolean=false)
                                                             Boolean includeExceptionCause,
                                                             @PluginAttribute(value="tlsEnabled",defaultBoolean=false)
                                                             Boolean tlsEnabled,
                                                             @PluginAttribute(value="tlsEnableCertificateVerification",defaultBoolean=true)
                                                             Boolean tlsEnableCertificateVerification,
                                                             @PluginAttribute(value="tlsTrustCertChainFilename")
                                                             String tlsTrustCertChainFilename)

Factory method for creating a GelfTransport provider within the plugin manager.

Parameters:

name - The name of the Appender.

filter - A Filter to determine if the event should be handled by this Appender.

layout - The Layout to use to format the LogEvent defaults to "%m%n".

ignoreExceptions - The default is true, causing exceptions encountered while appending events to be internally logged and then ignored. When set to false exceptions will be propagated to the caller, instead. Must be set to false when wrapping this Appender in a FailoverAppender.

server - The server name of the GELF server, defaults to localhost.

port - The port the GELF server is listening on, defaults to 12201.

hostName - The host name of the machine generating the logs, defaults to local host name or localhost if it couldn't be detected.

protocol - The transport protocol to use, defaults to UDP.

tlsEnabled - Whether TLS should be enabled, defaults to false.

tlsEnableCertificateVerification - Whether TLS certificate chain should be checked, defaults to true.

tlsTrustCertChainFilename - A X.509 certificate chain file in PEM format for certificate verification, defaults to null

queueSize - The size of the internally used queue, defaults to 512.

connectTimeout - The connection timeout for TCP connections in milliseconds, defaults to 1000.

reconnectDelay - The time to wait between reconnects in milliseconds, defaults to 500.

sendBufferSize - The size of the socket send buffer in bytes, defaults to -1 (deactivate).

tcpNoDelay - Whether Nagle's algorithm should be used for TCP connections, defaults to false.

tcpKeepAlive - Whether to try keeping alive TCP connections, defaults to false.

includeSource - Whether the source of the log message should be included, defaults to true.

includeThreadContext - Whether the contents of the ThreadContext should be included, defaults to true.

includeStackTrace - Whether a full stack trace should be included, defaults to true.

includeExceptionCause - Whether the included stack trace should contain causing exceptions, defaults to false.

additionalFields - Additional static key=value pairs that will be added to every log message.

Returns:

a new GELF provider