com.getsentry.raven.log4j2

Class SentryAppender

java.lang.Object

org.apache.logging.log4j.core.AbstractLifeCycle

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

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

com.getsentry.raven.log4j2.SentryAppender

All Implemented Interfaces:

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

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

Appender for log4j2 in charge of sending the logged events to a Sentry server.

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 and Description
static String	APPENDER_NAME Default name for the appender.
protected String	dsn DSN property of the appender.
protected String	environment Identifies the environment the application is running in.
protected Set<String>	extraTags Set of tags to look for in the Thread Context Map.
static String	LOG4J_MARKER Name of the Event.extra property containing Marker details.
static String	LOG4J_NDC Name of the Event.extra property containing NDC details.
protected Raven	raven Current instance of Raven.
protected String	ravenFactory Name of the RavenFactory being used.
protected String	release Identifies the version of the application.
protected String	serverName Server name to be sent to sentry.
protected Map<String,String>	tags Additional tags to be sent to sentry.
static String	THREAD_NAME Name of the Event.extra property containing the Thread name.

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

Constructor Summary

Constructors

Modifier	Constructor and Description
	SentryAppender() Creates an instance of SentryAppender.
	SentryAppender(Raven raven) Creates an instance of SentryAppender.
protected	SentryAppender(String name, org.apache.logging.log4j.core.Filter filter) Creates an instance of SentryAppender.

Method Summary

Methods

Modifier and Type	Method and Description
void	append(org.apache.logging.log4j.core.LogEvent logEvent)
protected Event	buildEvent(org.apache.logging.log4j.core.LogEvent event) Builds an Event based on the logging event.
static SentryAppender	createAppender(String name, String dsn, String ravenFactory, String release, String environment, String serverName, String tags, String extraTags, org.apache.logging.log4j.core.Filter filter) Create a Sentry Appender.
protected static Event.Level	formatLevel(org.apache.logging.log4j.Level level) Transforms a Level into an Event.Level.
protected static List<String>	formatMessageParameters(Object[] parameters) Extracts message parameters into a List of Strings.
protected void	initRaven() Initialises the Raven instance.
void	setDsn(String dsn)
void	setEnvironment(String environment)
void	setExtraTags(String extraTags) Set the mapped extras that will be used to search the Thread Context Map and upgrade key pair to a tag sent along with the events.
void	setRavenFactory(String ravenFactory)
void	setRelease(String release)
void	setServerName(String serverName)
void	setTags(String tags) Set the tags that should be sent along with the events.
void	stop()

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

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

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

addFilter, getFilter, 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

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

Field Detail

APPENDER_NAME

public static final String APPENDER_NAME

Default name for the appender.

See Also:

Constant Field Values

LOG4J_NDC

public static final String LOG4J_NDC

Name of the Event.extra property containing NDC details.

See Also:

Constant Field Values

LOG4J_MARKER

public static final String LOG4J_MARKER

Name of the Event.extra property containing Marker details.

See Also:

Constant Field Values

THREAD_NAME

public static final String THREAD_NAME

Name of the Event.extra property containing the Thread name.

See Also:

Constant Field Values

raven

protected volatile Raven raven

Current instance of Raven.

See Also:

initRaven()

dsn

protected String dsn

DSN property of the appender.

Might be null in which case the DSN should be detected automatically.

ravenFactory

protected String ravenFactory

Name of the RavenFactory being used.

Might be null in which case the factory should be defined automatically.

release

protected String release

Identifies the version of the application.

Might be null in which case the release information will not be sent with the event.

environment

protected String environment

Identifies the environment the application is running in.

Might be null in which case the environment information will not be sent with the event.

serverName

protected String serverName

Server name to be sent to sentry.

Might be null in which case the hostname is found via a reverse DNS lookup.

tags

protected Map<String,String> tags

Additional tags to be sent to sentry.

Might be empty in which case no tags are sent.

extraTags

protected Set<String> extraTags

Set of tags to look for in the Thread Context Map. These will be added as tags to be sent to Sentry.

Might be empty in which case no mapped tags are set.

Constructor Detail

SentryAppender

public SentryAppender()

Creates an instance of SentryAppender.

SentryAppender

public SentryAppender(Raven raven)

Creates an instance of SentryAppender.

Parameters:

raven - instance of Raven to use with this appender.

SentryAppender

protected SentryAppender(String name,
              org.apache.logging.log4j.core.Filter filter)

Creates an instance of SentryAppender.

Parameters:

name - The Appender name.

filter - The Filter to associate with the Appender.

Method Detail

createAppender

@PluginFactory
public static SentryAppender createAppender(@PluginAttribute(value="name")
                                          String name,
                                          @PluginAttribute(value="dsn")
                                          String dsn,
                                          @PluginAttribute(value="ravenFactory")
                                          String ravenFactory,
                                          @PluginAttribute(value="release")
                                          String release,
                                          @PluginAttribute(value="environment")
                                          String environment,
                                          @PluginAttribute(value="serverName")
                                          String serverName,
                                          @PluginAttribute(value="tags")
                                          String tags,
                                          @PluginAttribute(value="extraTags")
                                          String extraTags,
                                          @PluginElement(value="filters")
                                          org.apache.logging.log4j.core.Filter filter)

Create a Sentry Appender.

Parameters:

name - The name of the Appender.

dsn - Data Source Name to access the Sentry server.

ravenFactory - Name of the factory to use to build the Raven instance.

release - Release to be sent to Sentry.

environment - Environment to be sent to Sentry.

serverName - serverName to be sent to Sentry.

tags - Tags to add to each event.

extraTags - Tags to search through the Thread Context Map.

filter - The filter, if any, to use.

Returns:

The SentryAppender.

formatLevel

protected static Event.Level formatLevel(org.apache.logging.log4j.Level level)

Transforms a Level into an Event.Level.

Parameters:

level - original level as defined in log4j2.

Returns:

log level used within raven.

formatMessageParameters

protected static List<String> formatMessageParameters(Object[] parameters)

Extracts message parameters into a List of Strings.

null parameters are kept as null.

Parameters:

parameters - parameters provided to the logging system.

Returns:

the parameters formatted as Strings in a List.

append

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

The raven instance is set in this method instead of AbstractFilterable.start() in order to avoid substitute loggers being generated during the instantiation of Raven.

Parameters:

logEvent - The LogEvent.

initRaven

protected void initRaven()

Initialises the Raven instance.

buildEvent

protected Event buildEvent(org.apache.logging.log4j.core.LogEvent event)

Builds an Event based on the logging event.

Parameters:

event - Log generated.

Returns:

Event containing details provided by the logging system.

setDsn

public void setDsn(String dsn)

setRavenFactory

public void setRavenFactory(String ravenFactory)

setRelease

public void setRelease(String release)

setEnvironment

public void setEnvironment(String environment)

setServerName

public void setServerName(String serverName)

setTags

public void setTags(String tags)

Set the tags that should be sent along with the events.

Parameters:

tags - A String of tags. key/values are separated by colon(:) and tags are separated by commas(,).

setExtraTags

public void setExtraTags(String extraTags)

Set the mapped extras that will be used to search the Thread Context Map and upgrade key pair to a tag sent along with the events.

Parameters:

extraTags - A String of extraTags. extraTags are separated by commas(,).

stop

public void stop()

Specified by:

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

Overrides:

stop in class org.apache.logging.log4j.core.AbstractLifeCycle