com.getsentry.raven.logback

Class SentryAppender

java.lang.Object

ch.qos.logback.core.spi.ContextAwareBase

ch.qos.logback.core.AppenderBase<ch.qos.logback.classic.spi.ILoggingEvent>

com.getsentry.raven.logback.SentryAppender

All Implemented Interfaces:

ch.qos.logback.core.Appender<ch.qos.logback.classic.spi.ILoggingEvent>, ch.qos.logback.core.spi.ContextAware, ch.qos.logback.core.spi.FilterAttachable<ch.qos.logback.classic.spi.ILoggingEvent>, ch.qos.logback.core.spi.LifeCycle

public class SentryAppender
extends ch.qos.logback.core.AppenderBase<ch.qos.logback.classic.spi.ILoggingEvent>

Appender for logback 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.
protected String	environment Identifies the environment the application is running in.
protected Set<String>	extraTags Extras to use as tags.
static String	LOGBACK_MARKER Name of the Event.extra property containing Maker details.
protected ch.qos.logback.classic.Level	minLevel If set, only events with level = minLevel and up will be recorded.
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 ch.qos.logback.core.AppenderBase

name, started

Fields inherited from class ch.qos.logback.core.spi.ContextAwareBase

context

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
protected void	append(ch.qos.logback.classic.spi.ILoggingEvent iLoggingEvent)
protected Event	buildEvent(ch.qos.logback.classic.spi.ILoggingEvent iLoggingEvent) Builds an Event based on the logging event.
protected SentryException	createSentryExceptionFrom(ch.qos.logback.classic.spi.IThrowableProxy throwableProxy, StackTraceInterface stackTrace) Given a IThrowableProxy and a StackTraceInterface return a SentryException to be reported to Sentry.
protected Deque<SentryException>	extractExceptionQueue(ch.qos.logback.classic.spi.ILoggingEvent iLoggingEvent) Creates a sequence of SentryExceptions given a particular ILoggingEvent.
protected String[]	extractPackageSimpleClassName(String canonicalClassName) Given a String representing a classname, return Strings representing the package name and the class name individually.
protected static Event.Level	formatLevel(ch.qos.logback.classic.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 MDC and upgrade key pair to a tag sent along with the events.
void	setMinLevel(String minLevel)
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()
protected StackTraceElement[]	toStackTraceElements(ch.qos.logback.classic.spi.IThrowableProxy throwableProxy) Given a IThrowableProxy return an array of StackTraceElements associated with the underlying Throwable.

Methods inherited from class ch.qos.logback.core.AppenderBase

addFilter, clearAllFilters, doAppend, getCopyOfAttachedFiltersList, getFilterChainDecision, getName, isStarted, setName, start, toString

Methods inherited from class ch.qos.logback.core.spi.ContextAwareBase

addError, addError, addInfo, addInfo, addStatus, addWarn, addWarn, getContext, getDeclaredOrigin, getStatusManager, setContext

Methods inherited from class java.lang.Object

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

Methods inherited from interface ch.qos.logback.core.spi.ContextAware

addError, addError, addInfo, addInfo, addStatus, addWarn, addWarn, getContext, setContext

Field Detail

LOGBACK_MARKER

public static final String LOGBACK_MARKER

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

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.

minLevel

protected ch.qos.logback.classic.Level minLevel

If set, only events with level = minLevel and up will be recorded. (This configuration parameter is deprecated in favor of using Logback Filters.)

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

Extras to use as tags.

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.

Method Detail

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.

formatLevel

protected static Event.Level formatLevel(ch.qos.logback.classic.Level level)

Transforms a Level into an Event.Level.

Parameters:

level - original level as defined in logback.

Returns:

log level used within raven.

append

protected void append(ch.qos.logback.classic.spi.ILoggingEvent iLoggingEvent)

The raven instance is started in this method instead of AppenderBase.start() in order to avoid substitute loggers being generated during the instantiation of Raven.
More on www.slf4j.org/codes.html#substituteLogger

Specified by:

append in class ch.qos.logback.core.AppenderBase<ch.qos.logback.classic.spi.ILoggingEvent>

initRaven

protected void initRaven()

Initialises the Raven instance.

buildEvent

protected Event buildEvent(ch.qos.logback.classic.spi.ILoggingEvent iLoggingEvent)

Builds an Event based on the logging event.

Parameters:

iLoggingEvent - Log generated.

Returns:

Event containing details provided by the logging system.

extractExceptionQueue

protected Deque<SentryException> extractExceptionQueue(ch.qos.logback.classic.spi.ILoggingEvent iLoggingEvent)

Creates a sequence of SentryExceptions given a particular ILoggingEvent.

Parameters:

iLoggingEvent - Information detailing a particular logging event

Returns:

A Deque of SentryExceptions detailing the exception chain

createSentryExceptionFrom

protected SentryException createSentryExceptionFrom(ch.qos.logback.classic.spi.IThrowableProxy throwableProxy,
                                                    StackTraceInterface stackTrace)

Given a IThrowableProxy and a StackTraceInterface return a SentryException to be reported to Sentry.

Parameters:

throwableProxy - Information detailing a Throwable

stackTrace - The stacktrace associated with the Throwable.

Returns:

A SentryException object ready to be sent to Sentry.

extractPackageSimpleClassName

protected String[] extractPackageSimpleClassName(String canonicalClassName)

Given a String representing a classname, return Strings representing the package name and the class name individually.

Parameters:

canonicalClassName - A dotted-notation string representing a class name (eg. "java.util.Date")

Returns:

An array of Strings. The first of which is the package name. The second is the class name.

toStackTraceElements

protected StackTraceElement[] toStackTraceElements(ch.qos.logback.classic.spi.IThrowableProxy throwableProxy)

Given a IThrowableProxy return an array of StackTraceElements associated with the underlying Throwable.

Parameters:

throwableProxy - Information detailing a Throwable.

Returns:

The StackTraceElements associated w/the underlying Throwable

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)

setMinLevel

public void setMinLevel(String minLevel)

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 MDC 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 ch.qos.logback.core.spi.LifeCycle

Overrides:

stop in class ch.qos.logback.core.AppenderBase<ch.qos.logback.classic.spi.ILoggingEvent>