net.kencochrane.raven.log4j

Class SentryAppender

java.lang.Object

org.apache.log4j.AppenderSkeleton

net.kencochrane.raven.log4j.SentryAppender

All Implemented Interfaces:

org.apache.log4j.Appender, org.apache.log4j.spi.OptionHandler

public class SentryAppender
extends org.apache.log4j.AppenderSkeleton

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

Field Summary

Fields

Modifier and Type	Field and Description
protected String	dsn DSN property of the appender.
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.
static String	THREAD_NAME Name of the Event.extra property containing the Thread name.

Fields inherited from class org.apache.log4j.AppenderSkeleton

closed, errorHandler, headFilter, layout, name, tailFilter, threshold

Constructor Summary

Constructors

Constructor and Description
SentryAppender() Creates an instance of SentryAppender.
SentryAppender(Raven raven) Creates an instance of SentryAppender.
SentryAppender(Raven raven, boolean propagateClose) Creates an instance of SentryAppender.

Method Summary

Methods

Modifier and Type	Method and Description
void	activateOptions()
protected void	append(org.apache.log4j.spi.LoggingEvent loggingEvent)
protected static StackTraceElement	asStackTraceElement(org.apache.log4j.spi.LocationInfo location) Transforms the location info of a log into a stacktrace element (stackframe).
protected Event	buildEvent(org.apache.log4j.spi.LoggingEvent loggingEvent) Builds an Event based on the logging event.
void	close()
protected static Event.Level	formatLevel(org.apache.log4j.Level level) Transforms a Level into an Event.Level.
protected void	initRaven() Initialises the Raven instance.
boolean	requiresLayout()
void	setDsn(String dsn)
void	setRavenFactory(String ravenFactory)

Methods inherited from class org.apache.log4j.AppenderSkeleton

addFilter, clearFilters, doAppend, finalize, getErrorHandler, getFilter, getFirstFilter, getLayout, getName, getThreshold, isAsSevereAsThreshold, setErrorHandler, setLayout, setName, setThreshold

Methods inherited from class java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

LOG4J_NDC

public static final String LOG4J_NDC

Name of the Event.extra property containing NDC 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 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.

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

public SentryAppender(Raven raven,
              boolean propagateClose)

Creates an instance of SentryAppender.

Parameters:

raven - instance of Raven to use with this appender.

propagateClose - true if the Closeable.close() should be called when the appender is closed.

Method Detail

formatLevel

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

Transforms a Level into an Event.Level.

Parameters:

level - original level as defined in log4j.

Returns:

log level used within raven.

asStackTraceElement

protected static StackTraceElement asStackTraceElement(org.apache.log4j.spi.LocationInfo location)

Transforms the location info of a log into a stacktrace element (stackframe).

Parameters:

location - details on the location of the log.

Returns:

a stackframe.

activateOptions

public void activateOptions()

Specified by:

activateOptions in interface org.apache.log4j.spi.OptionHandler

Overrides:

activateOptions in class org.apache.log4j.AppenderSkeleton

initRaven

protected void initRaven()

Initialises the Raven instance.

append

protected void append(org.apache.log4j.spi.LoggingEvent loggingEvent)

Specified by:

append in class org.apache.log4j.AppenderSkeleton

buildEvent

protected Event buildEvent(org.apache.log4j.spi.LoggingEvent loggingEvent)

Builds an Event based on the logging event.

Parameters:

loggingEvent - Log generated.

Returns:

Event containing details provided by the logging system.

setDsn

public void setDsn(String dsn)

setRavenFactory

public void setRavenFactory(String ravenFactory)

close

public void close()

requiresLayout

public boolean requiresLayout()