com.bugsnag

Class BugsnagAppender

java.lang.Object

ch.qos.logback.core.spi.ContextAwareBase

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

com.bugsnag.BugsnagAppender

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 BugsnagAppender
extends ch.qos.logback.core.UnsynchronizedAppenderBase<ch.qos.logback.classic.spi.ILoggingEvent>

Sends events to Bugsnag using its Java client library.

Field Summary

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
BugsnagAppender() Default constructor used by Logback to create a Bugsnag appender that will create it's own client when required.
BugsnagAppender(Bugsnag bugsnag) Creates an appender from an existing Bugsnag client.

Method Summary

Modifier and Type	Method and Description
void	addCallback(Callback callback) Add a callback to execute code before/after every notification to Bugsnag.
protected void	append(ch.qos.logback.classic.spi.ILoggingEvent event)
Bugsnag	getClient()
void	setApiKey(java.lang.String apiKey) Internal use only Should only be used via the logback.xml file
void	setAppType(java.lang.String appType)
void	setAppVersion(java.lang.String appVersion)
void	setDelivery(Delivery delivery) Set the method of delivery for Bugsnag error report.
void	setEndpoint(java.lang.String endpoint) Internal use only Should only be used via the logback.xml file
void	setFilteredProperties(java.lang.String filters)
void	setFilteredProperty(java.lang.String filter)
void	setIgnoredClass(java.lang.String ignoredClass)
void	setIgnoredClasses(java.lang.String ignoredClasses)
void	setMetaData(LogbackMetaData metaData) Internal use only Should only be used via the logback.xml file
void	setNotifyReleaseStage(java.lang.String notifyReleaseStage)
void	setNotifyReleaseStages(java.lang.String notifyReleaseStages)
void	setProjectPackage(java.lang.String projectPackage)
void	setProjectPackages(java.lang.String projectPackages)
void	setProxy(ProxyConfiguration proxy)
void	setReleaseStage(java.lang.String releaseStage)
void	setSendThreads(boolean sendThreads)
void	setSessionDelivery(Delivery delivery) Set the method of delivery for Bugsnag sessions.
void	setTimeout(int timeout)
void	start()
void	stop()

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

addFilter, clearAllFilters, doAppend, getCopyOfAttachedFiltersList, getFilterChainDecision, getName, isStarted, setName, 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

Constructor Detail

BugsnagAppender

public BugsnagAppender(Bugsnag bugsnag)

Creates an appender from an existing Bugsnag client.

BugsnagAppender

public BugsnagAppender()

Default constructor used by Logback to create a Bugsnag appender that will create it's own client when required.

Method Detail

start

public void start()

Specified by:

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

Overrides:

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

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>

append

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

Specified by:

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

addCallback

public void addCallback(Callback callback)

Add a callback to execute code before/after every notification to Bugsnag.

You can use this to add or modify information attached to an error before it is sent to your dashboard. You can also stop any reports being sent to Bugsnag completely.

Parameters:

callback - a callback to run before sending errors to Bugsnag

See Also:

Callback

setDelivery

public void setDelivery(Delivery delivery)

Set the method of delivery for Bugsnag error report. By default we'll send reports asynchronously using a thread pool to https://notify.bugsnag.com, but you can override this to use a different sending technique or endpoint (for example, if you are using Bugsnag On-Premise).

Parameters:

delivery - the delivery mechanism to use

See Also:

Delivery

setSessionDelivery

public void setSessionDelivery(Delivery delivery)

Set the method of delivery for Bugsnag sessions. By default we'll send sessions asynchronously using a thread pool to https://sessions.bugsnag.com, but you can override this to use a different sending technique or endpoint (for example, if you are using Bugsnag On-Premise).

Parameters:

delivery - the delivery mechanism to use

See Also:

Delivery

setApiKey

public void setApiKey(java.lang.String apiKey)

Internal use only Should only be used via the logback.xml file

Parameters:

apiKey - The API key to use

setAppType

public void setAppType(java.lang.String appType)

See Also:

Bugsnag.setAppType(String)

setEndpoint

public void setEndpoint(java.lang.String endpoint)

Internal use only Should only be used via the logback.xml file

See Also:

Bugsnag.setEndpoints(String, String)

setFilteredProperty

public void setFilteredProperty(java.lang.String filter)

See Also:

Bugsnag.setFilters(String...)

setFilteredProperties

public void setFilteredProperties(java.lang.String filters)

See Also:

Bugsnag.setFilters(String...)

setIgnoredClass

public void setIgnoredClass(java.lang.String ignoredClass)

See Also:

Bugsnag.setIgnoreClasses(String...)

setIgnoredClasses

public void setIgnoredClasses(java.lang.String ignoredClasses)

See Also:

Bugsnag.setIgnoreClasses(String...)

setNotifyReleaseStage

public void setNotifyReleaseStage(java.lang.String notifyReleaseStage)

See Also:

Bugsnag.setNotifyReleaseStages(String...)

setNotifyReleaseStages

public void setNotifyReleaseStages(java.lang.String notifyReleaseStages)

See Also:

Bugsnag.setNotifyReleaseStages(String...)

setProjectPackage

public void setProjectPackage(java.lang.String projectPackage)

See Also:

Bugsnag.setProjectPackages(String...)

setProjectPackages

public void setProjectPackages(java.lang.String projectPackages)

See Also:

Bugsnag.setProjectPackages(String...)

setProxy

public void setProxy(ProxyConfiguration proxy)

See Also:

Bugsnag.setProxy(Proxy)

setReleaseStage

public void setReleaseStage(java.lang.String releaseStage)

See Also:

Bugsnag.setReleaseStage(String)

setSendThreads

public void setSendThreads(boolean sendThreads)

See Also:

Bugsnag.setSendThreads(boolean)

setTimeout

public void setTimeout(int timeout)

See Also:

Bugsnag.setTimeout(int)

setAppVersion

public void setAppVersion(java.lang.String appVersion)

See Also:

Bugsnag.setAppVersion(String)

setMetaData

public void setMetaData(LogbackMetaData metaData)

Internal use only Should only be used via the logback.xml file

Parameters:

metaData - Adds meta data to every report

getClient

public Bugsnag getClient()

Returns:

The Bugsnag instance