对 Java 应用进行插桩处理以进行 Error Reporting

您可以通过 Java 将错误报告发送到 Error Reporting 如何使用 Google Cloud 中的 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，您的服务账号需要 Error Reporting 写入者角色 (roles/errorreporting.writer)。

某些 Google Cloud 服务会自动 Error Reporting Writer 角色 (roles/errorreporting.writer) 服务账号。但是，您必须将此角色授予相应的服务 使用部分服务

App Engine 柔性环境

App Engine 会将 Error Reporting Writer 角色 (roles/errorreporting.writer) 您的默认服务账号

无需明确提供凭据即可使用 Java 版 Error Reporting 软件包。

系统会自动为 App Engine 柔性环境应用启用 Error Reporting。 无需进行额外设置。

注意 ：写入 stderr 的错误日志条目由 而不必使用 Error Reporting 软件包。

@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

如需将 Error Reporting 与 Google Kubernetes Engine 搭配使用， 执行以下操作：

1. 确保容器要使用的服务账号已 授予了 Error Reporting 写入者角色 (roles/errorreporting.writer)。

   您可以使用 Compute Engine 默认服务账号 或自定义服务账号

   如需了解如何授予角色，请参阅 管理对项目、文件夹和组织的访问权限。

2. 创建集群并向该集群授予 cloud-platform 访问权限范围。

   例如，以下 create 命令指定了 cloud-platform 访问权限范围和服务账号：

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

。

注意 ：创建集群后，您将无法更改其服务账号。

Compute Engine

如需将 Error Reporting 与 Compute Engine 虚拟机实例搭配使用，请执行以下操作： 执行以下操作：

1. 确保已为您的虚拟机实例使用服务账号 授予了 Error Reporting 写入者角色 (roles/errorreporting.writer)。

   您可以使用 Compute Engine 默认服务账号 或自定义服务账号

   如需了解如何授予角色，请参阅 管理对项目、文件夹和组织的访问权限。

2. 在 Google Cloud 控制台中，转到虚拟机实例页面：

   前往虚拟机实例

   如果您使用搜索栏查找此页面，请选择子标题为 Compute Engine 的结果。

3. 选择要接收 cloud-platform 访问权限范围。

4. 点击停止，然后点击修改。

5. 在身份和 API 访问权限部分，选择服务账号 具有 Error Reporting Writer 角色 (roles/errorreporting.writer)。

6. 在访问权限范围部分中， 选择允许所有 Cloud API 的全面访问权限，然后保存更改。

7. 点击启动/恢复。

Cloud Functions

Cloud Run 函数可 Error Reporting Writer 角色 (roles/errorreporting.writer) 您的默认服务账号

无需明确提供凭据即可使用 Java 版 Error Reporting 软件包。

Cloud Run 函数已配置为使用 Error Reporting 。未处理 JavaScript 异常将出现在 Logging 中，并由 而不必使用 Java 版 Error Reporting 程序包。

注意 ：如果日志条目包含堆栈轨迹和 它们要么不指定日志严重性，要么指定不小于 ERROR 的日志严重性， 而不必使用 Java 版 Error Reporting 软件包。

示例

使用 Cloud Logging Logback Appender 或 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 软件包。 如需了解详情，请参阅向 Error Reporting 进行身份验证。

如需在本地开发环境中使用本页面上的 Java 示例，请安装并初始化 gcloud CLI，然后使用您的用户凭据设置应用默认凭据。

1. Install the Google Cloud CLI.

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

   gcloud init

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

如需了解详情，请参阅 Set up authentication for a local development environment。

projects.events.report 方法也支持 API 密钥。 如果您要使用 API 密钥进行身份验证，则无需设置本地应用默认凭据文件。如需了解详情，请参阅 在 Google Cloud 身份验证文档中创建 API 密钥。

查看错误报告

在 Google Cloud 控制台中，转到 Error Reporting 页面：

前往 Error Reporting

您也可以使用搜索栏查找此页面。

如需了解详情，请参阅查看错误。