為 Java 應用程式檢測錯誤報告

您可以使用 Java 適用的 Error Reporting 套件，從 Java 應用程式傳送錯誤報告至 Error Reporting。使用 Java 適用的 Error Reporting 套件，針對下列情況建立錯誤群組：

• 包含記錄項目的記錄值區具有客戶管理的加密金鑰 (CMEK)。
• 記錄檔值區符合下列其中一個條件：
  • 記錄值區會儲存在記錄項目來源的專案中。
  • 記錄項目會轉送至專案，然後該專案會將這些記錄項目儲存在專案擁有的記錄值區中。
• 您想回報自訂錯誤事件。

Error Reporting 已與部分 Google Cloud 服務整合，如 Cloud Functions、App Engine、Compute Engine 和 Google Kubernetes Engine。Error Reporting 能顯示在這些服務上執行的應用程式記錄到 Cloud Logging 的錯誤。詳情請參閱本頁面的「在 Google Cloud上執行」一節。

您也可以使用Logging，將錯誤資料傳送至 Error Reporting。如要瞭解資料格式要求，請參閱「在 Logging 中格式化錯誤訊息」。

事前準備

1. 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.

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

   Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

   Go to project selector

3. Make sure that billing is enabled for your Google Cloud project.

4. Enable the Error Reporting API .

   Enable the API

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

   Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

   Go to project selector

6. Make sure that billing is enabled for your Google Cloud project.

7. Enable the Error Reporting API .

   Enable the API

安裝用戶端程式庫

Java 適用的 Error Reporting 套件可讓您監控及查看在各處執行的 Java 應用程式回報的錯誤。

如要進一步瞭解安裝相關資訊，請參閱 Java 適用的 Error Reporting 套件的說明文件。您也可以使用問題追蹤工具回報問題。

設定用戶端程式庫

您可以自訂 Java 適用的 Error Reporting 套件行為。請參閱 Java API 參考說明文件。

在 Google Cloud上執行應用程式

如要使用 projects.events.report 建立錯誤群組，服務帳戶必須具備錯誤回報寫入者角色 (roles/errorreporting.writer)。

部分 Google Cloud 服務會自動將「Error Reporting Writer」角色 (roles/errorreporting.writer) 授予適當的服務帳戶。不過，您必須為部分服務將這個角色授予適當的服務帳戶。

Cloud Run 和 Cloud Run 函式

Cloud Run 使用的預設服務帳戶具有Error Reporting 寫入者角色 (roles/errorreporting.writer) 的權限。

不需要明確提供憑證，即可使用 Java 適用的 Error Reporting 套件。

Cloud Run 會設定為自動使用 Error Reporting。未處理的 JavaScript 例外狀況會出現在 Logging 之中並由 Error Reporting 處理，不需使用 Java 適用的 Error Reporting 套件。

注意： 如果記錄項目包含堆疊追蹤，且指定的記錄嚴重性為 ERROR 以上，則系統會自動處理記錄項目，而您不必使用 Java 適用的錯誤回報套件。

App Engine 彈性環境

App Engine 會自動將 Error Reporting 寫入者角色 (roles/errorreporting.writer) 授予預設服務帳戶。

不需要明確提供憑證，即可使用 Java 適用的 Error Reporting 套件。

系統會自動為 App Engine 彈性環境應用程式啟用 Error Reporting。您不需要另外進行設定。
注意： 寫入 stderr 的錯誤記錄項目會自動由錯誤報告處理，您無需直接使用 Java 適用的錯誤報告套件。
@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

如要搭配 Google Kubernetes Engine 使用錯誤回報功能，請按照下列步驟操作：

1. 請確認要由容器使用的服務帳戶已獲准使用 Error Reporting 寫入者角色 (roles/errorreporting.writer)。

   您可以使用 Compute Engine 預設服務帳戶或自訂服務帳戶。

   如要進一步瞭解如何授予角色，請參閱「管理專案、資料夾和機構的存取權」。

2. 建立叢集，並授予叢集 cloud-platform 存取權範圍。

   舉例來說，下列建立指令會指定 cloud-platform 存取範圍和服務帳戶：

   gcloud container clusters create CLUSTER_NAME --service-account  SERVICE_ACCT_NAME --scopes=cloud-platform
   

注意： 叢集建立完成後，您就無法變更其服務帳戶。

Compute Engine

如要搭配 Compute Engine VM 執行個體使用錯誤回報功能，請執行下列操作：

1. 請確認要由 VM 執行個體使用的服務帳戶已獲得 Error Reporting 寫入者角色 (roles/errorreporting.writer)。

   您可以使用 Compute Engine 預設服務帳戶或自訂服務帳戶。

   如要進一步瞭解如何授予角色，請參閱「管理專案、資料夾和機構的存取權」。

2. 前往 Google Cloud 控制台的「VM instances」(VM 執行個體) 頁面：

   前往「VM instances」(VM 執行個體) 頁面

   如果您是使用搜尋列尋找這個頁面，請選取子標題為「Compute Engine」的結果。

3. 選取要接收 cloud-platform 存取範圍 的 VM 執行個體。

4. 依序按一下「停止」和「編輯」。

5. 在「Identity and API access」(身分及 API 存取權) 區段中，選取具有「Error Reporting Writer」(錯誤回報寫入者) 角色 (roles/errorreporting.writer) 的服務帳戶。

6. 在「存取權範圍」部分，選取「允許所有 Cloud API 的完整存取權」，然後儲存變更。

7. 按一下「開始/繼續」。

範例

使用 Cloud Logging Logback 附加程式或 java.util.logging Handler記錄的例外狀況會自動回報至 Error Reporting 主控台。

下列範例說明如何使用 Java 用戶端程式庫回報自訂錯誤事件：

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);
    }
  }
}

請參閱 Java API 參考說明文件，進一步瞭解如何擷取及管理錯誤統計資料與個別事件的資料。

在本機開發環境中執行應用程式

如要在本機開發環境中使用 Java 適用的 Error Reporting 套件 (例如在自己的工作站上執行程式庫)，您必須為 Java 適用的 Error Reporting 套件提供本機應用程式預設憑證。詳情請參閱「向 Google 錯誤回報服務進行驗證」。

如要在本機開發環境中使用本頁面上的 Java 範例，請先安裝並初始化 gcloud CLI，然後使用您的使用者憑證設定應用程式預設憑證。

8. Install the Google Cloud CLI.

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

10. To initialize the gcloud CLI, run the following command:

    gcloud init

11. 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.

    Note: If the gcloud CLI prints a warning that your account doesn't have the serviceusage.services.use permission, then some gcloud CLI commands and client libraries might not work. Ask an administrator to grant you the Service Usage Consumer IAM role (roles/serviceusage.serviceUsageConsumer), then run the following command:

    gcloud auth application-default set-quota-project PROJECT_ID

    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.

詳情請參閱 Set up authentication for a local development environment。

查看錯誤報告

前往 Google Cloud 控制台的「Error Reporting」頁面：

前往「錯誤回報」

您也可以透過搜尋列找到這個頁面。

詳情請參閱查看錯誤一文。