Instrument Java apps for Error Reporting

You can send error reports to Error Reporting from Java applications by using the Error Reporting package for Java . Use the Error Reporting package for Java to create error groups for the following cases:

A log bucket that contains your log entries has customer-managed encryption keys (CMEK) .
The log bucket satisfies one of the following:
- The log bucket is stored in the same project where the log entries originated.
- The log entries were routed to a project, and then that project stored those log entries in a log bucket that it owns.
You want to report custom error events.

Error Reporting is integrated with some Google Cloud services, such as Cloud Functions and App Engine , Compute Engine , and Google Kubernetes Engine . Error Reporting displays the errors that are logged to Cloud Logging by applications running on those services. For more information, go to Running on Google Cloud on this page.

You can also send error data to Error Reporting using Logging . For information on the data formatting requirements, read Formatting error messages in Logging .

Before you begin

Sign in to your Google Cloud account. If you're new to Google Cloud, create an account to evaluate how our products perform in real-world scenarios. New customers also get $300 in free credits to run, test, and deploy workloads.

In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

Go to project selector

Verify that billing is enabled for your Google Cloud project .

Enable the Error Reporting API .

Enable the API

In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

Go to project selector

Verify that billing is enabled for your Google Cloud project .

Enable the Error Reporting API .

Enable the API

Install the client library

The Error Reporting package for Java lets you monitor and view errors reported by Java applications running nearly anywhere.

For more information on installation, read the documentation for the Error Reporting package for Java. You can also report issues using the issue tracker .

Configure the client library

You can customize the behavior of the Error Reporting package for Java. See the Java API reference documentation .

Run apps on Google Cloud

To create error groups by using projects.events.report , your service account requires the Error Reporting Writer role ( roles/errorreporting.writer ).

Some Google Cloud services automatically grant the Error Reporting Writer role ( roles/errorreporting.writer ) to the appropriate service account. However, you must grant this role to the appropriate service account for some services.

Cloud Run and Cloud Run functions

The default service account used by Cloud Run has the permissions of Error Reporting Writer role ( roles/errorreporting.writer ).

The Error Reporting package for Java can be used without needing to explicitly provide credentials.

Cloud Run is configured to use Error Reporting automatically. Unhandled JavaScript exceptions will appear in Logging and be processed by Error Reporting without needing to use the Error Reporting package for Java.

App Engine flexible environment

App Engine grants the Error Reporting Writer role ( roles/errorreporting.writer ) to your default service account automatically.

The Error Reporting package for Java can be used without needing to explicitly provide credentials.

Error Reporting is automatically enabled for App Engine flexible environment applications. No additional setup is required.

  @WebServlet 
 ( 
 name 
  
 = 
  
 "Error reporting" 
 , 
  
 value 
  
 = 
  
 "/error" 
 ) 
 public 
  
 class 
 ErrorReportingExample 
  
 extends 
  
 HttpServlet 
  
 { 
  
 private 
  
 Logger 
  
 logger 
  
 = 
  
 Logger 
 . 
 getLogger 
 ( 
 ErrorReportingExample 
 . 
 class 
 . 
 getName 
 ()); 
  
 @Override 
  
 public 
  
 void 
  
 doGet 
 ( 
 HttpServletRequest 
  
 req 
 , 
  
 HttpServletResponse 
  
 resp 
 ) 
  
 throws 
  
 IOException 
 , 
  
 ServletException 
  
 { 
  
 // errors logged to stderr / Cloud logging with exceptions are automatically reported. 
  
 logger 
 . 
 log 
 ( 
 Level 
 . 
 SEVERE 
 , 
  
 "exception using log framework" 
 , 
  
 new 
  
 IllegalArgumentException 
 ()); 
  
 // use the error-reporting client library only if you require logging custom error events. 
  
 logCustomErrorEvent 
 (); 
  
 // runtime exceptions are also automatically reported. 
  
 throw 
  
 new 
  
 RuntimeException 
 ( 
 "this is a runtime exception" 
 ); 
  
 } 
  
 private 
  
 void 
  
 logCustomErrorEvent 
 () 
  
 { 
  
 try 
  
 ( 
 ReportErrorsServiceClient 
  
 reportErrorsServiceClient 
  
 = 
  
 ReportErrorsServiceClient 
 . 
 create 
 ()) 
  
 { 
  
 // Custom error events require an error reporting location as well. 
  
 ErrorContext 
  
 errorContext 
  
 = 
  
 ErrorContext 
 . 
 newBuilder 
 () 
  
 . 
 setReportLocation 
 ( 
  
 SourceLocation 
 . 
 newBuilder 
 () 
  
 . 
 setFilePath 
 ( 
 "Test.java" 
 ) 
  
 . 
 setLineNumber 
 ( 
 10 
 ) 
  
 . 
 setFunctionName 
 ( 
 "myMethod" 
 ) 
  
 . 
 build 
 ()) 
  
 . 
 build 
 (); 
  
 // Report a custom error event 
  
 ReportedErrorEvent 
  
 customErrorEvent 
  
 = 
  
 ReportedErrorEvent 
 . 
 getDefaultInstance 
 () 
  
 . 
 toBuilder 
 () 
  
 . 
 setMessage 
 ( 
 "custom error event" 
 ) 
  
 . 
 setContext 
 ( 
 errorContext 
 ) 
  
 . 
 build 
 (); 
  
 // default project id 
  
 ProjectName 
  
 projectName 
  
 = 
  
 ProjectName 
 . 
 of 
 ( 
 ServiceOptions 
 . 
 getDefaultProjectId 
 ()); 
  
 reportErrorsServiceClient 
 . 
 reportErrorEvent 
 ( 
 projectName 
 , 
  
 customErrorEvent 
 ); 
  
 } 
  
 catch 
  
 ( 
 Exception 
  
 e 
 ) 
  
 { 
  
 logger 
 . 
 log 
 ( 
 Level 
 . 
 SEVERE 
 , 
  
 "Exception encountered logging custom event" 
 , 
  
 e 
 ); 
  
 } 
  
 } 
 }

Google Kubernetes Engine

To use Error Reporting with Google Kubernetes Engine, do the following:

Ensure that the service account to be used by your container has been granted the Error Reporting Writer role ( roles/errorreporting.writer ).

You can use either the Compute Engine default service account or a custom service account.

For information about granting roles, see Manage access to projects, folders, and organizations .
Create your cluster and grant the cluster the cloud-platform access scope .

For example, the following create command specifies the cloud-platform access scope and a service account:
```
gcloud container clusters create CLUSTER_NAME 
--service-account SERVICE_ACCT_NAME 
--scopes=cloud-platform
```

Compute Engine

To use Error Reporting with Compute Engine VM instances, do the following:

Ensure that the service account to be used by your VM instance has been granted the Error Reporting Writer role ( roles/errorreporting.writer ).

You can use either the Compute Engine default service account or a custom service account.

For information about granting roles, see Manage access to projects, folders, and organizations .
In the Google Cloud console, go to the VM instances page:

Go to VM instances

If you use the search bar to find this page, then select the result whose subheading is Compute Engine .
Select the VM instance that you want to receive the cloud-platform access scope .
Click Stop, and then click Edit.
In the Identity and API accesssection, select a service account that has the Error Reporting Writer role ( roles/errorreporting.writer ).
In the Access scopessection, select Allow full access to all Cloud APIs, and then save your changes.
Click Start/Resume.

Example

Exceptions logged using the Cloud Logging Logback Appender or java.util.logging Handler are automatically reported to the Error Reporting console.

The following sample demonstrates using the Java client library to report a custom error event:

  import 
  
 com.google.cloud. ServiceOptions 
 
 ; 
 import 
  
 com.google.devtools.clouderrorreporting.v1beta1. ProjectName 
 
 ; 
 import 
  
 com.google.devtools.clouderrorreporting.v1beta1.ReportErrorsServiceClient 
 ; 
 import 
  
 com.google.devtools.clouderrorreporting.v1beta1.ReportedErrorEvent 
 ; 
 import 
  
 java.io.IOException 
 ; 
 import 
  
 java.io.PrintWriter 
 ; 
 import 
  
 java.io.StringWriter 
 ; 
 /** 
 * Snippet demonstrates using the Error Reporting API to report an exception. 
 * <p> 
 * When the workload runs on App Engine, GKE, Cloud Functions or another managed environment, 
 * printing the exception's stack trace to stderr will automatically report the error 
 * to Error Reporting. 
 */ 
 public 
  
 class 
 QuickStart 
  
 { 
  
 static 
  
  String 
 
  
 projectId 
 ; 
  
 public 
  
 static 
  
 void 
  
 main 
 ( 
  String 
 
 [] 
  
 args 
 ) 
  
 throws 
  
 Exception 
  
 { 
  
 // Set your Google Cloud Platform project ID via environment or explicitly 
  
 projectId 
  
 = 
  
  ServiceOptions 
 
 . 
 getDefaultProjectId 
 (); 
  
 if 
  
 ( 
 args 
 . 
 length 
 > 
 0 
 ) 
  
 { 
  
 projectId 
  
 = 
  
 args 
 [ 
 0 
 ] 
 ; 
  
 } 
  
 else 
  
 { 
  
  String 
 
  
 value 
  
 = 
  
 System 
 . 
 getenv 
 ( 
 "GOOGLE_CLOUD_PROJECT" 
 ); 
  
 if 
  
 ( 
 value 
  
 != 
  
 null 
 && 
 value 
 . 
 isEmpty 
 ()) 
  
 { 
  
 projectId 
  
 = 
  
 value 
 ; 
  
 } 
  
 } 
  
 try 
  
 { 
  
 throw 
  
 new 
  
 Exception 
 ( 
 "Something went wrong" 
 ); 
  
 } 
  
 catch 
  
 ( 
 Exception 
  
 ex 
 ) 
  
 { 
  
 reportError 
 ( 
 ex 
 ); 
  
 } 
  
 } 
  
 /** 
 * Sends formatted error report to Google Cloud including the error context. 
 * 
 * @param ex Exception containing the error and the context. 
 * @throws IOException if fails to communicate with Google Cloud 
 */ 
  
 private 
  
 static 
  
 void 
  
 reportError 
 ( 
 Exception 
  
 ex 
 ) 
  
 throws 
  
 IOException 
  
 { 
  
 try 
  
 ( 
 ReportErrorsServiceClient 
  
 serviceClient 
  
 = 
  
 ReportErrorsServiceClient 
 . 
 create 
 ()) 
  
 { 
  
 StringWriter 
  
 sw 
  
 = 
  
 new 
  
 StringWriter 
 (); 
  
 PrintWriter 
  
 pw 
  
 = 
  
 new 
  
 PrintWriter 
 ( 
 sw 
 ); 
  
 ex 
 . 
 printStackTrace 
 ( 
 pw 
 ); 
  
 ReportedErrorEvent 
  
 errorEvent 
  
 = 
  
 ReportedErrorEvent 
 . 
 getDefaultInstance 
 () 
  
 . 
 toBuilder 
 () 
  
 . 
 setMessage 
 ( 
 sw 
 . 
 toString 
 ()) 
  
 . 
 build 
 (); 
  
 // If you need to report an error asynchronously, use reportErrorEventCallable() 
  
 // method 
  
 serviceClient 
 . 
 reportErrorEvent 
 ( 
  ProjectName 
 
 . 
 of 
 ( 
 projectId 
 ), 
  
 errorEvent 
 ); 
  
 } 
  
 } 
 }

See the Java API Reference Documentation on how to retrieve and manage error statistics as well as data for individual events.

Run apps in a local development environment

To use the Error Reporting package for Java in a local development environment, such as running the library on your own workstation, you must provide your Error Reporting package for Java with the local application default credentials. For more information, see Authenticate to Error Reporting .

To use the Java samples on this page in a local development environment, install and initialize the gcloud CLI, and then set up Application Default Credentials with your user credentials.

Install the Google Cloud CLI.

If you're using an external identity provider (IdP), you must first sign in to the gcloud CLI with your federated identity .

If you're using a local shell, then create local authentication credentials for your user account:

gcloud  
auth  
application-default  
login

You don't need to do this if you're using Cloud Shell.

If an authentication error is returned, and you are using an external identity provider (IdP), confirm that you have signed in to the gcloud CLI with your federated identity .

For more information, see Set up authentication for a local development environment .

The projects.events.report method also supports API keys. If you want to use API keys for authentication, you do not need to set up a local Application Default Credentials file. For more information, see Create an API key in the Google Cloud authentication documentation.

Viewing error reports

In the Google Cloud console, go to the Error Reporting page:

Go to Error Reporting

You can also find this page by using the search bar.

For more information, see Viewing Errors .

Instrument Java apps for Error Reporting Stay organized with collections Save and categorize content based on your preferences.

Before you begin

Install the client library

Configure the client library

Run apps on Google Cloud

Cloud Run and Cloud Run functions

App Engine flexible environment

Google Kubernetes Engine

Compute Engine

Example

Run apps in a local development environment

Viewing error reports

Instrument Java apps for Error Reporting