设置 Java 版 Error Reporting

您可以使用 Java 版 Stackdriver Error Reporting 软件包将 Java 应用提供的错误报告发送到 Stackdriver Error Reporting。

Error Reporting 已与 App EngineCompute EngineGoogle Kubernetes Engine 等部分 Google Cloud Platform 产品集成。Error Reporting 可显示在这些产品上运行的应用记录到 Stackdriver Logging 的错误。如需了解详情,请参阅在 Google Cloud Platform 上运行

您还可以使用 Stackdriver Logging 将错误数据发送到 Error Reporting。如需了解数据格式设置要求,请参阅设置 Stackdriver Logging 中的错误消息格式

准备工作

  1. 登录您的 Google 帐号。

    如果您还没有 Google 帐号,请注册新帐号

  2. 选择或创建 Google Cloud Platform 项目。

    转到“管理资源”页面

  3. 确保您的 Google Cloud Platform 项目已启用结算功能。

    了解如何启用结算功能

  4. 启用Error Reporting API 。

    启用 API

安装客户端库

借助 Java 版 Stackdriver Error Reporting 程序包,您可以监控和查看几乎在任何位置运行的 Java 应用所报告的错误。

要了解安装详情,请参阅 Java 版 Stackdriver Error Reporting 程序包的文档。您还可以使用问题跟踪器来报告问题。

配置客户端库

您可以自定义 Java 版 Stackdriver Error Reporting 程序包的行为。详情请参阅 Java API 参考文档

报告错误

只在需要报告自定义错误事件时才使用 Java 版 Stackdriver Error Reporting 程序包。

使用 Stackdriver Logback Appenderjava.util.logging Stackdriver Handler 记录的异常会自动报告给 Error Reporting 控制台。下述示例演示了如何使用 API 报告自定义错误事件:

import com.google.cloud.ServiceOptions;
import com.google.cloud.errorreporting.v1beta1.ReportErrorsServiceClient;
import com.google.devtools.clouderrorreporting.v1beta1.ErrorContext;
import com.google.devtools.clouderrorreporting.v1beta1.ProjectName;
import com.google.devtools.clouderrorreporting.v1beta1.ReportedErrorEvent;
import com.google.devtools.clouderrorreporting.v1beta1.SourceLocation;

/**
 * Snippet demonstrates using the Stackdriver Error Reporting API to report a custom error event.
 * <p>
 * This library is not required on App Engine, errors written to stderr are automatically written
 * to Stackdriver Error Reporting.
 * It is also not required if you are writing logs to Stackdriver Logging.
 * Errors written to Stackdriver Logging that contain an exception or stack trace
 * are automatically written out to Stackdriver Error Reporting.
 */
public class QuickStart {
  public static void main(String[] args) throws Exception {

    // Google Cloud Platform Project ID
    String projectId = (args.length > 0) ? args[0] : ServiceOptions.getDefaultProjectId();
    ProjectName projectName = ProjectName.of(projectId);

    // Instantiate an Error Reporting Client
    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();
      // Report an event synchronously, use .reportErrorEventCallable for asynchronous reporting.
      reportErrorsServiceClient.reportErrorEvent(projectName, customErrorEvent);
    }
  }
}
如需了解如何检索和管理错误统计信息以及各个事件的数据,请参阅 Java API 参考文档

在 Google Cloud Platform 上运行

要使用 Java 版 Stackdriver Error Reporting 软件包,需具备 Cloud IAM Error Reporting 写入者角色。大多数 Google Cloud Platform 计算平台默认提供此角色。

App Engine 柔性环境

App Engine 默认授予 Error Reporting 写入者角色

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

系统会自动为 App Engine 柔性环境应用启用 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);
    }
  }
}

GKE

GKE 上,您必须在创建集群时添加 cloud-platform 访问权限范围,如以下示例命令所示:

gcloud container clusters create example-cluster-name --scopes https://www.googleapis.com/auth/cloud-platform

Compute Engine

使用 Compute Engine 虚拟机实例时,请为每个实例添加 cloud-platform 访问权限范围。通过 Google Cloud Platform Console 创建新实例时,您可以在创建实例面板的身份和 API 访问权限部分中执行此操作。请使用 Compute Engine 默认服务帐号或您选用的其他服务帐号,并在身份和 API 访问权限部分中勾选允许所有 Cloud API 的全面访问权限。无论您选择哪个服务帐号,都请确保已在 GCP Console 的 IAM 和管理部分向其授予 Error Reporting 写入者角色

在本地和其他位置运行

要在 Google Cloud Platform 外部使用 Java 版 Stackdriver Error Reporting 程序包,您必须直接向 Java 版 Stackdriver Error Reporting 程序包提供 GCP 项目 ID 和相应的服务帐号凭据。这适用于下列三种情况:在您自己的工作站上运行库、在数据中心的计算机上运行库,以及在其他云提供商的虚拟机实例上运行库。如需了解详情,请参阅手动获取和提供服务帐号凭据

查看错误报告

部署后,您可以在 GCP Console Error Reporting 信息中心查看错误报告。

转到 Error Reporting 信息中心

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

此页内容是否有用?请给出您的反馈和评价:

发送以下问题的反馈:

此网页
Stackdriver Error Reporting
需要帮助?请访问我们的支持页面