com.bugsnag.android

Class Client

java.lang.Object

com.bugsnag.android.Client

public class Client
extends java.lang.Object

A Bugsnag Client instance allows you to use Bugsnag in your Android app. Typically you'd instead use the static access provided in the Bugsnag class.

Example usage:

Client client = new Client(this, "your-api-key"); client.notify(new RuntimeException("something broke!"));

See Also:

Bugsnag

Constructor Summary

Constructors

Constructor and Description
Client(android.content.Context androidContext) Initialize a Bugsnag client
Client(android.content.Context androidContext, Configuration configuration) Initialize a Bugsnag client
Client(android.content.Context androidContext, java.lang.String apiKey) Initialize a Bugsnag client
Client(android.content.Context androidContext, java.lang.String apiKey, boolean enableExceptionHandler) Initialize a Bugsnag client

Method Summary

Modifier and Type	Method and Description
void	addToTab(java.lang.String tab, java.lang.String key, java.lang.Object value) Add diagnostic information to every error report.
void	beforeNotify(BeforeNotify beforeNotify) Add a "before notify" callback, to execute code before every report to Bugsnag.
void	clearBreadcrumbs() Clear any breadcrumbs that have been left so far.
void	clearTab(java.lang.String tabName) Remove a tab of app-wide diagnostic information
void	clearUser() Removes the current user data and sets it back to defaults
void	disableExceptionHandler() Disable automatic reporting of unhandled exceptions.
void	enableExceptionHandler() Enable automatic reporting of unhandled exceptions.
java.lang.String	getContext() Gets the context to be sent to Bugsnag.
MetaData	getMetaData() Get the global diagnostic information currently stored in MetaData.
void	leaveBreadcrumb(java.lang.String breadcrumb) Leave a "breadcrumb" log message, representing an action that occurred in your app, to aid with debugging.
void	leaveBreadcrumb(java.lang.String name, BreadcrumbType type, java.util.Map<java.lang.String,java.lang.String> metadata)
void	notify(java.lang.String name, java.lang.String message, java.lang.StackTraceElement[] stacktrace, Callback callback) Notify Bugsnag of an error
void	notify(java.lang.String name, java.lang.String message, java.lang.StackTraceElement[] stacktrace, Severity severity, MetaData metaData) Deprecated. Use notify(String,String,StackTraceElement[],Callback) to send and modify error reports
void	notify(java.lang.String name, java.lang.String message, java.lang.String context, java.lang.StackTraceElement[] stacktrace, Severity severity, MetaData metaData) Deprecated. Use notify(String,String,StackTraceElement[],Callback) to send and modify error reports
void	notify(java.lang.Throwable exception) Notify Bugsnag of a handled exception
void	notify(java.lang.Throwable exception, Callback callback) Notify Bugsnag of a handled exception
void	notify(java.lang.Throwable exception, MetaData metaData) Deprecated. Use notify(Throwable,Callback) to send and modify error reports
void	notify(java.lang.Throwable exception, Severity severity) Notify Bugsnag of a handled exception
void	notify(java.lang.Throwable exception, Severity severity, MetaData metaData) Deprecated. Use notify(Throwable,Callback) to send and modify error reports
void	notifyBlocking(java.lang.String name, java.lang.String message, java.lang.StackTraceElement[] stacktrace, Callback callback) Notify Bugsnag of an error
void	notifyBlocking(java.lang.String name, java.lang.String message, java.lang.StackTraceElement[] stacktrace, Severity severity, MetaData metaData) Deprecated. Use notifyBlocking(String,String,StackTraceElement[],Callback) to send and modify error reports
void	notifyBlocking(java.lang.String name, java.lang.String message, java.lang.String context, java.lang.StackTraceElement[] stacktrace, Severity severity, MetaData metaData) Deprecated. Use notifyBlocking(String,String,StackTraceElement[],Callback) to send and modify error reports
void	notifyBlocking(java.lang.Throwable exception) Notify Bugsnag of a handled exception
void	notifyBlocking(java.lang.Throwable exception, Callback callback) Notify Bugsnag of a handled exception
void	notifyBlocking(java.lang.Throwable exception, MetaData metaData) Deprecated. Use notify(Throwable,Callback) to send and modify error reports
void	notifyBlocking(java.lang.Throwable exception, Severity severity) Notify Bugsnag of a handled exception
void	notifyBlocking(java.lang.Throwable exception, Severity severity, MetaData metaData) Deprecated. Use notifyBlocking(Throwable,Callback) to send and modify error reports
void	setAppVersion(java.lang.String appVersion) Set the application version sent to Bugsnag.
void	setBuildUUID(java.lang.String buildUUID) Set the buildUUID to your own value.
void	setContext(java.lang.String context) Set the context sent to Bugsnag.
void	setEndpoint(java.lang.String endpoint) Set the endpoint to send data to.
void	setFilters(java.lang.String... filters) Set which keys should be filtered when sending metaData to Bugsnag.
void	setIgnoreClasses(java.lang.String... ignoreClasses) Set which exception classes should be ignored (not sent) by Bugsnag.
void	setMaxBreadcrumbs(int numBreadcrumbs) Set the maximum number of breadcrumbs to keep and sent to Bugsnag.
void	setMetaData(MetaData metaData) Set the global diagnostic information to be send with every error.
void	setNotifyReleaseStages(java.lang.String... notifyReleaseStages) Set for which releaseStages errors should be sent to Bugsnag.
void	setProjectPackages(java.lang.String... projectPackages) Set which packages should be considered part of your application.
void	setReleaseStage(java.lang.String releaseStage) Set the current "release stage" of your application.
void	setSendThreads(boolean sendThreads) Set whether to send thread-state with report.
void	setUser(java.lang.String id, java.lang.String email, java.lang.String name) Set details of the user currently using your application.
void	setUserEmail(java.lang.String email) Set the email address of the current user.
void	setUserId(java.lang.String id) Set a unique identifier for the user currently using your application.
void	setUserName(java.lang.String name) Set the name of the current user.

Methods inherited from class java.lang.Object

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

Constructor Detail

Client

public Client(android.content.Context androidContext)

Initialize a Bugsnag client

Parameters:

androidContext - an Android context, usually this

Client

public Client(android.content.Context androidContext,
              java.lang.String apiKey)

Initialize a Bugsnag client

Parameters:

androidContext - an Android context, usually this

apiKey - your Bugsnag API key from your Bugsnag dashboard

Client

public Client(android.content.Context androidContext,
              java.lang.String apiKey,
              boolean enableExceptionHandler)

Initialize a Bugsnag client

Parameters:

androidContext - an Android context, usually this

apiKey - your Bugsnag API key from your Bugsnag dashboard

enableExceptionHandler - should we automatically handle uncaught exceptions?

Client

public Client(android.content.Context androidContext,
              Configuration configuration)

Initialize a Bugsnag client

Parameters:

androidContext - an Android context, usually this

configuration - a configuration for the Client

Method Detail

setAppVersion

public void setAppVersion(java.lang.String appVersion)

Set the application version sent to Bugsnag. By default we'll pull this from your AndroidManifest.xml

Parameters:

appVersion - the app version to send

getContext

public java.lang.String getContext()

Gets the context to be sent to Bugsnag.

Returns:

Context

setContext

public void setContext(java.lang.String context)

Set the context sent to Bugsnag. By default we'll attempt to detect the name of the top-most activity at the time of a report, and use this as the context, but sometime this is not possible.

Parameters:

context - set what was happening at the time of a crash

setEndpoint

public void setEndpoint(java.lang.String endpoint)

Set the endpoint to send data to. By default we'll send reports to the standard https://notify.bugsnag.com endpoint, but you can override this if you are using Bugsnag Enterprise to point to your own Bugsnag endpoint.

Parameters:

endpoint - the custom endpoint to send report to

setBuildUUID

public void setBuildUUID(java.lang.String buildUUID)

Set the buildUUID to your own value. This is used to identify proguard mapping files in the case that you publish multiple different apps with the same appId and versionCode. The default value is read from the com.bugsnag.android.BUILD_UUID meta-data field in your app manifest.

Parameters:

buildUUID - the buildUUID.

setFilters

public void setFilters(java.lang.String... filters)

Set which keys should be filtered when sending metaData to Bugsnag. Use this when you want to ensure sensitive information, such as passwords or credit card information is stripped from metaData you send to Bugsnag. Any keys in metaData which contain these strings will be marked as [FILTERED] when send to Bugsnag.

For example:

client.setFilters("password", "credit_card");

Parameters:

filters - a list of keys to filter from metaData

setIgnoreClasses

public void setIgnoreClasses(java.lang.String... ignoreClasses)

Set which exception classes should be ignored (not sent) by Bugsnag.

For example:

client.setIgnoreClasses("java.lang.RuntimeException");

Parameters:

ignoreClasses - a list of exception classes to ignore

setNotifyReleaseStages

public void setNotifyReleaseStages(java.lang.String... notifyReleaseStages)

Set for which releaseStages errors should be sent to Bugsnag. Use this to stop errors from development builds being sent.

For example:

client.setNotifyReleaseStages("production");

Parameters:

notifyReleaseStages - a list of releaseStages to notify for

See Also:

setReleaseStage(java.lang.String)

setProjectPackages

public void setProjectPackages(java.lang.String... projectPackages)

Set which packages should be considered part of your application. Bugsnag uses this to help with error grouping, and stacktrace display.

For example:

client.setProjectPackages("com.example.myapp");

By default, we'll mark the current package name as part of you app.

Parameters:

projectPackages - a list of package names

setReleaseStage

public void setReleaseStage(java.lang.String releaseStage)

Set the current "release stage" of your application. By default, we'll set this to "development" for debug builds and "production" for non-debug builds.

Parameters:

releaseStage - the release stage of the app

See Also:

setNotifyReleaseStages(java.lang.String...)

setSendThreads

public void setSendThreads(boolean sendThreads)

Set whether to send thread-state with report. By default, this will be true.

Parameters:

sendThreads - should we send thread-state with report?

setUser

public void setUser(java.lang.String id,
                    java.lang.String email,
                    java.lang.String name)

Set details of the user currently using your application. You can search for this information in your Bugsnag dashboard.

For example:

client.setUser("12345", "james@example.com", "James Smith");

Parameters:

id - a unique identifier of the current user (defaults to a unique id)

email - the email address of the current user

name - the name of the current user

clearUser

public void clearUser()

Removes the current user data and sets it back to defaults

setUserId

public void setUserId(java.lang.String id)

Set a unique identifier for the user currently using your application. By default, this will be an automatically generated unique id You can search for this information in your Bugsnag dashboard.

Parameters:

id - a unique identifier of the current user

setUserEmail

public void setUserEmail(java.lang.String email)

Set the email address of the current user. You can search for this information in your Bugsnag dashboard.

Parameters:

email - the email address of the current user

setUserName

public void setUserName(java.lang.String name)

Set the name of the current user. You can search for this information in your Bugsnag dashboard.

Parameters:

name - the name of the current user

beforeNotify

public void beforeNotify(BeforeNotify beforeNotify)

Add a "before notify" callback, to execute code before every report 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 return false from any callback to halt execution.

For example:

client.beforeNotify(new BeforeNotify() { public boolean run(Error error) { error.setSeverity(Severity.INFO); return true; } })

Parameters:

beforeNotify - a callback to run before sending errors to Bugsnag

See Also:

BeforeNotify

notify

public void notify(java.lang.Throwable exception)

Notify Bugsnag of a handled exception

Parameters:

exception - the exception to send to Bugsnag

notifyBlocking

public void notifyBlocking(java.lang.Throwable exception)

Notify Bugsnag of a handled exception

Parameters:

exception - the exception to send to Bugsnag

notify

public void notify(java.lang.Throwable exception,
                   Callback callback)

Notify Bugsnag of a handled exception

Parameters:

exception - the exception to send to Bugsnag

callback - callback invoked on the generated error report for additional modification

notifyBlocking

public void notifyBlocking(java.lang.Throwable exception,
                           Callback callback)

Notify Bugsnag of a handled exception

Parameters:

exception - the exception to send to Bugsnag

callback - callback invoked on the generated error report for additional modification

notify

public void notify(java.lang.String name,
                   java.lang.String message,
                   java.lang.StackTraceElement[] stacktrace,
                   Callback callback)

Notify Bugsnag of an error

Parameters:

name - the error name or class

message - the error message

context - the error context

stacktrace - the stackframes associated with the error

callback - callback invoked on the generated error report for additional modification

notifyBlocking

public void notifyBlocking(java.lang.String name,
                           java.lang.String message,
                           java.lang.StackTraceElement[] stacktrace,
                           Callback callback)

Notify Bugsnag of an error

Parameters:

name - the error name or class

message - the error message

context - the error context

stacktrace - the stackframes associated with the error

callback - callback invoked on the generated error report for additional modification

notify

public void notify(java.lang.Throwable exception,
                   Severity severity)

Notify Bugsnag of a handled exception

Parameters:

exception - the exception to send to Bugsnag

severity - the severity of the error, one of Severity.ERROR, Severity.WARNING or Severity.INFO

notifyBlocking

public void notifyBlocking(java.lang.Throwable exception,
                           Severity severity)

Notify Bugsnag of a handled exception

Parameters:

exception - the exception to send to Bugsnag

severity - the severity of the error, one of Severity.ERROR, Severity.WARNING or Severity.INFO

addToTab

public void addToTab(java.lang.String tab,
                     java.lang.String key,
                     java.lang.Object value)

Add diagnostic information to every error report. Diagnostic information is collected in "tabs" on your dashboard.

For example:

client.addToTab("account", "name", "Acme Co."); client.addToTab("account", "payingCustomer", true);

Parameters:

tab - the dashboard tab to add diagnostic data to

key - the name of the diagnostic information

value - the contents of the diagnostic information

clearTab

public void clearTab(java.lang.String tabName)

Remove a tab of app-wide diagnostic information

Parameters:

tabName - the dashboard tab to remove diagnostic data from

getMetaData

public MetaData getMetaData()

Get the global diagnostic information currently stored in MetaData.

See Also:

MetaData

setMetaData

public void setMetaData(MetaData metaData)

Set the global diagnostic information to be send with every error.

See Also:

MetaData

leaveBreadcrumb

public void leaveBreadcrumb(java.lang.String breadcrumb)

Leave a "breadcrumb" log message, representing an action that occurred in your app, to aid with debugging.

Parameters:

breadcrumb - the log message to leave (max 140 chars)

leaveBreadcrumb

public void leaveBreadcrumb(java.lang.String name,
                            BreadcrumbType type,
                            java.util.Map<java.lang.String,java.lang.String> metadata)

setMaxBreadcrumbs

public void setMaxBreadcrumbs(int numBreadcrumbs)

Set the maximum number of breadcrumbs to keep and sent to Bugsnag. By default, we'll keep and send the 20 most recent breadcrumb log messages.

Parameters:

numBreadcrumbs - number of breadcrumb log messages to send

clearBreadcrumbs

public void clearBreadcrumbs()

Clear any breadcrumbs that have been left so far.

enableExceptionHandler

public void enableExceptionHandler()

Enable automatic reporting of unhandled exceptions. By default, this is automatically enabled in the constructor.

disableExceptionHandler

public void disableExceptionHandler()

Disable automatic reporting of unhandled exceptions.

notify

public void notify(java.lang.Throwable exception,
                   MetaData metaData)

Deprecated. Use notify(Throwable,Callback) to send and modify error reports

Notify Bugsnag of a handled exception

Parameters:

exception - the exception to send to Bugsnag

metaData - additional information to send with the exception

notifyBlocking

public void notifyBlocking(java.lang.Throwable exception,
                           MetaData metaData)

Deprecated. Use notify(Throwable,Callback) to send and modify error reports

Notify Bugsnag of a handled exception

Parameters:

exception - the exception to send to Bugsnag

metaData - additional information to send with the exception

notify

@Deprecated
public void notify(java.lang.Throwable exception,
                               Severity severity,
                               MetaData metaData)

Deprecated. Use notify(Throwable,Callback) to send and modify error reports

Notify Bugsnag of a handled exception

Parameters:

exception - the exception to send to Bugsnag

severity - the severity of the error, one of Severity.ERROR, Severity.WARNING or Severity.INFO

metaData - additional information to send with the exception

notifyBlocking

@Deprecated
public void notifyBlocking(java.lang.Throwable exception,
                                       Severity severity,
                                       MetaData metaData)

Deprecated. Use notifyBlocking(Throwable,Callback) to send and modify error reports

Notify Bugsnag of a handled exception

Parameters:

exception - the exception to send to Bugsnag

severity - the severity of the error, one of Severity.ERROR, Severity.WARNING or Severity.INFO

metaData - additional information to send with the exception

notify

@Deprecated
public void notify(java.lang.String name,
                               java.lang.String message,
                               java.lang.StackTraceElement[] stacktrace,
                               Severity severity,
                               MetaData metaData)

Deprecated. Use notify(String,String,StackTraceElement[],Callback) to send and modify error reports

Notify Bugsnag of an error

Parameters:

name - the error name or class

message - the error message

stacktrace - the stackframes associated with the error

severity - the severity of the error, one of Severity.ERROR, Severity.WARNING or Severity.INFO

metaData - additional information to send with the exception

notifyBlocking

@Deprecated
public void notifyBlocking(java.lang.String name,
                                       java.lang.String message,
                                       java.lang.StackTraceElement[] stacktrace,
                                       Severity severity,
                                       MetaData metaData)

Deprecated. Use notifyBlocking(String,String,StackTraceElement[],Callback) to send and modify error reports

Notify Bugsnag of an error

Parameters:

name - the error name or class

message - the error message

stacktrace - the stackframes associated with the error

severity - the severity of the error, one of Severity.ERROR, Severity.WARNING or Severity.INFO

metaData - additional information to send with the exception

notify

@Deprecated
public void notify(java.lang.String name,
                               java.lang.String message,
                               java.lang.String context,
                               java.lang.StackTraceElement[] stacktrace,
                               Severity severity,
                               MetaData metaData)

Deprecated. Use notify(String,String,StackTraceElement[],Callback) to send and modify error reports

Notify Bugsnag of an error

Parameters:

name - the error name or class

message - the error message

context - the error context

stacktrace - the stackframes associated with the error

severity - the severity of the error, one of Severity.ERROR, Severity.WARNING or Severity.INFO

metaData - additional information to send with the exception

notifyBlocking

@Deprecated
public void notifyBlocking(java.lang.String name,
                                       java.lang.String message,
                                       java.lang.String context,
                                       java.lang.StackTraceElement[] stacktrace,
                                       Severity severity,
                                       MetaData metaData)

Deprecated. Use notifyBlocking(String,String,StackTraceElement[],Callback) to send and modify error reports

Notify Bugsnag of an error

Parameters:

name - the error name or class

message - the error message

context - the error context

stacktrace - the stackframes associated with the error

severity - the severity of the error, one of Severity.ERROR, Severity.WARNING or Severity.INFO

metaData - additional information to send with the exception