io.sentry.logback

Class SentryAppender

java.lang.Object

ch.qos.logback.core.spi.ContextAwareBase

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

io.sentry.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.UnsynchronizedAppenderBase<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 ch.qos.logback.core.encoder.Encoder<ch.qos.logback.classic.spi.ILoggingEvent>	encoder Appender encoder.
static String	LOGBACK_MARKER Name of the Event.extra property containing Maker details.
protected ch.qos.logback.classic.Level	minLevel Deprecated. use logback filters.
static String	THREAD_NAME Name of the Event.extra property containing the Thread name.

Fields inherited from class ch.qos.logback.core.UnsynchronizedAppenderBase

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.

Method Summary

Modifier and Type	Method and Description
protected void	append(ch.qos.logback.classic.spi.ILoggingEvent iLoggingEvent)
protected EventBuilder	createEventBuilder(ch.qos.logback.classic.spi.ILoggingEvent iLoggingEvent) Builds an EventBuilder 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.
ch.qos.logback.core.encoder.Encoder<ch.qos.logback.classic.spi.ILoggingEvent>	getEncoder()
void	setEncoder(ch.qos.logback.core.encoder.Encoder<ch.qos.logback.classic.spi.ILoggingEvent> encoder) Set logback encoder.
void	setMinLevel(String minLevel) Deprecated. use logback filters.
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.UnsynchronizedAppenderBase

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

encoder

protected ch.qos.logback.core.encoder.Encoder<ch.qos.logback.classic.spi.ILoggingEvent> encoder

Appender encoder.

minLevel

@Deprecated
protected volatile ch.qos.logback.classic.Level minLevel

Deprecated. use logback filters.

If set, only events with level = minLevel and up will be recorded.

Constructor Detail

SentryAppender

public SentryAppender()

Creates an instance of SentryAppender.

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 sentry.

append

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

Specified by:

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

createEventBuilder

protected EventBuilder createEventBuilder(ch.qos.logback.classic.spi.ILoggingEvent iLoggingEvent)

Builds an EventBuilder based on the logging event.

Parameters:

iLoggingEvent - Log generated.

Returns:

EventBuilder 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

setMinLevel

@Deprecated
public void setMinLevel(String minLevel)

Deprecated. use logback filters.

Set minimum level to log.

Parameters:

minLevel - minimum level to log.

stop

public void stop()

Specified by:

stop in interface ch.qos.logback.core.spi.LifeCycle

Overrides:

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

getEncoder

public ch.qos.logback.core.encoder.Encoder<ch.qos.logback.classic.spi.ILoggingEvent> getEncoder()

setEncoder

public void setEncoder(ch.qos.logback.core.encoder.Encoder<ch.qos.logback.classic.spi.ILoggingEvent> encoder)

Set logback encoder.

Parameters:

encoder - logback encoder.