Customizing error reports

Add diagnostic data to every error report, or conditionally adjust error reports.

Before notify callbacks

If you’d like to add diagnostic data to every error report, or adjust error reports conditionally, you can use a before notify callback, which will be run before each error report is sent:

Bugsnag.beforeNotify {
    it.addToTab("account", "name", "Acme Co.")
    it.addToTab("account", "paying_customer", true)

    // Return `false` if you'd like to stop this error being reported
    true
}

The callback gives you access to the error object, so you can inspect and modify the error report which is about to be sent to Bugsnag.

Disabling error reporting

If you wish to disable error reporting, you can return false within Bugsnag.beforeNotify. This would allow for users to opt out of sending error reports, for example:

Bugsnag.beforeNotify { false } // no error report will be sent

The error object

The following properties and methods are available on the Error object, the representation of error information available in before notify callbacks.

addToTab

Sets a piece of information to be displayed in the Bugsnag.com error page. The first argument is the tab name, the second argument is the key for the data, and the third argument is used as the value.

error.addToTab("user", "role", "Administrator")

getContext

Returns the context of the error. The context is a summary what what was occurring in the application at the time of the crash, if available, such as the visible activity.

getException

Returns the thrown Throwable.

getExceptionName

Returns the full name of the Throwable.

getMetaData

Returns the attached exception metadata, which can be modified to add or remove fields.

val metadata = error.metaData
metadata.clearTab("user")

getStackTrace

Returns the Throwable’s array of StackTraceElements.

getUser

Returns the User that has been associated with the Error report.

setContext

Sets the context of the error. The context is a summary what what was occurring in the application at the time of the crash, if available, such as the visible activity.

error.context = "Pause menu"

setGroupingHash

Sets the groupingHash used by Bugsnag.com to manually override the default grouping technique. This option is not recommended, and should be used carefully when used.

Any errors that are sent to Bugsnag, that have the same groupingHash will be grouped as one. As the name implies, this option accepts a hash of sorts.

// ... generate the hash
val groupingHash = "f8803769f3e293dfcabdb6dec5100b8c52c6ae6b"
error.setGroupingHash(groupingHash)

setSeverity

Overrides the severity of the error. Valid severities are error, warning and info.

error.severity = Severity.WARNING

setUser

Sets the user associated with the error report.

error.setUser("123", "user@example.com", "Bob Johnson")

Modifying the stack trace

It is possible to modify the stack trace that is associated with the error report in the following way:

Create a recursive function which loops copies each stack trace element and sets it back to the Throwable object. Any modifications to the stack trace can be done within this loop

private fun alterStacktrace(t: Throwable) {
    val trace = t.stackTrace

    val newTrace = trace.map {
        // YOUR CODE HERE
        StackTraceElement(
            it.className,
            it.methodName,
            it.fileName,
            it.lineNumber)
    }

    t.stackTrace = newTrace.toTypedArray()
    t.cause?.let { alterStacktrace(it) }
}

Then call this new function from the BeforeNotify function

alterStacktrace(it.exception)

Reporting StrictMode violations

If you have enabled StrictMode in your development builds with the penaltyDeath option, then Bugsnag will automatically detect StrictMode exceptions. Any reports for these errors will contain a human readable description of the policy violation (e.g. ActivityLeak) in their metadata.

If you have not already setup StrictMode, you can do so by entering the following code in your Application class. It is strongly recommended that you only enable StrictMode for non-release builds.

if (BuildConfig.DEBUG) {
    StrictMode.setThreadPolicy(StrictMode.ThreadPolicy.Builder()
                .detectDiskReads()
                .detectDiskWrites()
                .detectNetwork()
                .penaltyDeath()
                .build())

    StrictMode.setVmPolicy(StrictMode.VmPolicy.Builder()
            .detectLeakedSqlLiteObjects()
            .detectLeakedClosableObjects()
            .penaltyDeath()
            .build())
}