The BugSnag SDK automatically captures a variety of data to help you debug your errors. You may wish to avoid capturing some types of data, particularly if there are privacy implications for your users.
Information about the application can be useful to identify if an error occurs in certain versions.
| Data | Default value | Preventing collection |
|---|---|---|
| App version | The application version, which can be set with App Version. Defaults to null. |
Modify getApp() in an OnErrorCallback |
| Release stage | The release stage of the application, which defaults to production. |
Modify getApp() in an OnErrorCallback or set via Release Stage |
Information about the device can be useful to identify if an error is only occurring on some devices.
| Data | Default value | Preventing collection |
|---|---|---|
| Hostname | The name of the localhost, given by the COMPUTERNAME environment variable on Windows, HOSTNAME on Unix, or InetAddress.getLocalHost().getHostName() if none of the above are available. |
Modify getDevice() in an OnErrorCallback |
| Locale | The default locale for this JVM instance (Locale.getDefault().toString()) |
Modify getDevice() in an OnErrorCallback |
| OS architecture | The value of the os.arch system property |
Modify getDevice() in an OnErrorCallback |
| OS name | The value of the os.name system property |
Modify getDevice() in an OnErrorCallback |
| OS version | The value of the os.version system property |
Modify getDevice() in an OnErrorCallback |
| Runtime name | The value of the java.runtime.name system property |
Modify getDevice() in an OnErrorCallback |
| Runtime version | The value of the java.runtime.version system property |
Modify getDevice() in an OnErrorCallback |
| Spring version | The version of the Spring framework being used by the application, if using bugsnag-spring | Not possible (automatically detected) |
| Spring Boot version | The version of Spring Boot being used by the application, if using bugsnag-spring and Spring Boot | Not possible (automatically detected) |
Details about the request can be helpful to reproduce errors.
Request information is automatically recorded for applications which use the Java Servlet API (including Spring MVC applications).
| Data | Default value | Preventing collection |
|---|---|---|
| URL | The URL of the current HTTP request | Call event.clearMetadata("request") in an OnErrorCallback |
| HTTP method | The HTTP method of the current request (GET, POST, etc.) | Call event.clearMetadata("request") in an OnErrorCallback |
| Parameters | The query parameters and form data of the current HTTP request | Call event.clearMetadata("request") in an OnErrorCallback |
| Client IP | The IP address used to originate the current HTTP request | Call event.clearMetadata("request") in an OnErrorCallback |
| Headers | A map of HTTP headers from the current HTTP request | Call event.clearMetadata("request") in an OnErrorCallback |
| Referer | The HTTP referer header | Call event.clearMetadata("request") in an OnErrorCallback |
Modifying error information may affect error grouping.
| Data | Default value | Preventing collection |
|---|---|---|
| Context | Set as the request method and URI for the current HTTP request if using the Servlet API. Defaults to null otherwise. |
Call event.setContext("value") in an OnErrorCallback |
| Error class | The fully-qualified class name of the exception that occurred | Call event.setExceptionName("value") in an OnErrorCallback |
| Error message | The message string from the exception that occurred | Not possible (taken from the exception) |
| Stacktrace | A stacktrace showing the file, method, and line number where the error occurred in the source code | Not currently modifiable |
| Severity | The severity of the error (ERROR, WARNING, or INFO). Defaults to ERROR for unhandled exceptions and WARNING for handled exceptions reported via notify() |
Call event.setSeverity(Severity) in an OnErrorCallback |