io.honeybadger.reporter

Class HoneybadgerReporter

java.lang.Object

io.honeybadger.reporter.HoneybadgerReporter

All Implemented Interfaces:

NoticeReporter

public class HoneybadgerReporter
extends Object
implements NoticeReporter

Reporter utility class that gives a simple interface for sending Java Throwable classes to the Honeybadger API.

Since:

1.0.0

Author:

page1, Elijah Zupancic

Constructor Summary

Constructors

Constructor and Description
HoneybadgerReporter()
HoneybadgerReporter(ConfigContext config)

Method Summary

Modifier and Type	Method and Description
protected Set<String>	aggregateTags(Iterable<String> tags) Processes an Iterable of Strings, discards invalid values and aggregates all values into an ordered set.
ConfigContext	getConfig()
NoticeReportResult	reportError(Throwable error) Send any Java Throwable to the Honeybadger error reporting interface.
NoticeReportResult	reportError(Throwable error, Object request) Send any Java Throwable to the Honeybadger error reporting interface.
NoticeReportResult	reportError(Throwable error, Object request, String message) Send any Java Throwable to the Honeybadger error reporting interface.
NoticeReportResult	reportError(Throwable error, Object request, String message, Iterable<String> tags) Send any Java Throwable to the Honeybadger error reporting interface with the associated tags.
NoticeReportResult	reportError(Throwable error, Object request, String message, Iterable<String> tags, String fingerprint) Send any Java Throwable to the Honeybadger error reporting interface.
protected org.apache.http.client.fluent.Response	sendToHoneybadger(String jsonError) Send an error encoded in JSON to the Honeybadger API.
protected void	setConfig(ConfigContext config)
protected NoticeReportResult	submitError(Throwable error, Request request, String message, Set<String> tags, String fingerprint)
protected boolean	supportsHttpServletRequest()
protected boolean	supportsPlayHttpRequest()

Methods inherited from class java.lang.Object

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

Constructor Detail

HoneybadgerReporter

public HoneybadgerReporter()

HoneybadgerReporter

public HoneybadgerReporter(ConfigContext config)

Method Detail

reportError

public NoticeReportResult reportError(Throwable error)

Send any Java Throwable to the Honeybadger error reporting interface.

Specified by:

reportError in interface NoticeReporter

Parameters:

error - error to report

Returns:

UUID of error created, if there was a problem null

reportError

public NoticeReportResult reportError(Throwable error,
                                      Object request)

Send any Java Throwable to the Honeybadger error reporting interface. Currently only HttpServletRequest objects are supported as request properties.

Specified by:

reportError in interface NoticeReporter

Parameters:

error - error to report

request - Object to parse for request properties

Returns:

UUID of error created, if there was a problem or ignored null

reportError

public NoticeReportResult reportError(Throwable error,
                                      Object request,
                                      String message)

Send any Java Throwable to the Honeybadger error reporting interface. Currently only HttpServletRequest objects are supported as request properties.

Specified by:

reportError in interface NoticeReporter

Parameters:

error - error to report

request - Object to parse for request properties

message - message to report instead of message associated with exception

Returns:

UUID of error created, if there was a problem or ignored null

reportError

public NoticeReportResult reportError(Throwable error,
                                      Object request,
                                      String message,
                                      Iterable<String> tags)

Description copied from interface: NoticeReporter

Send any Java Throwable to the Honeybadger error reporting interface with the associated tags.

Specified by:

reportError in interface NoticeReporter

Parameters:

error - error to report

request - Object to parse for request properties

message - message to report instead of message associated with exception

tags - tag values (duplicates will be removed)

Returns:

UUID of error created, if there was a problem or ignored null

reportError

public NoticeReportResult reportError(Throwable error,
                                      Object request,
                                      String message,
                                      Iterable<String> tags,
                                      String fingerprint)

Send any Java Throwable to the Honeybadger error reporting interface. Currently only HttpServletRequest objects are supported as request properties.

Specified by:

reportError in interface NoticeReporter

Parameters:

error - error to report

request - Object to parse for request properties

message - message to report instead of message associated with exception

fingerprint - custom fingerprint (used to group errors)

tags - tag values (duplicates will be removed)

Returns:

UUID of error created, if there was a problem or ignored null

getConfig

public ConfigContext getConfig()

Specified by:

getConfig in interface NoticeReporter

Returns:

The configuration used in the reporter

aggregateTags

protected Set<String> aggregateTags(Iterable<String> tags)

Processes an Iterable of Strings, discards invalid values and aggregates all values into an ordered set.

Parameters:

tags - tag values

Returns:

unique set of tags in the same order as input values

supportsHttpServletRequest

protected boolean supportsHttpServletRequest()

supportsPlayHttpRequest

protected boolean supportsPlayHttpRequest()

submitError

protected NoticeReportResult submitError(Throwable error,
                                         Request request,
                                         String message,
                                         Set<String> tags,
                                         String fingerprint)

sendToHoneybadger

protected org.apache.http.client.fluent.Response sendToHoneybadger(String jsonError)
                                                            throws IOException

Send an error encoded in JSON to the Honeybadger API.

Parameters:

jsonError - Error JSON payload

Returns:

Status code from the Honeybadger API

Throws:

IOException - thrown when a network exception was encountered

setConfig

protected void setConfig(ConfigContext config)