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

您可以通过 Go 将错误报告发送到 Error Reporting 如何使用 Google Cloud 中的 Go 版 Error Reporting 软件包。 使用 Go 版 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. 登录您的 Google Cloud 账号。如果您是 Google Cloud 新手，请创建一个账号来评估我们的产品在实际场景中的表现。新客户还可获享 $300 赠金，用于运行、测试和部署工作负载。

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. 确保您的 Google Cloud 项目已启用结算功能。

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. 确保您的 Google Cloud 项目已启用结算功能。

7. Enable the Error Reporting API .

   Enable the API

安装客户端库

借助 Go 版 Error Reporting 程序包，您可以监控和查看 几乎可在任何位置运行的应用。

1. 使用 go get 安装程序包：

   go get cloud.google.com/go/errorreporting

如需详细了解如何安装，请参阅 Go 版 Error Reporting 软件包的文档。您还可以使用问题跟踪器来报告问题。

配置客户端库

您可以自定义 Go 版 Stackdriver Error Reporting 程序包的行为。参阅 godoc。

在 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) 您的默认服务账号

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

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

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

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) 您的默认服务账号

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

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

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

示例

以下示例演示了如何使用 Go 客户端库 报告自定义错误事件：

// Sample errorreporting_quickstart contains is a quickstart
// example for the Google Cloud Error Reporting API.
package main

import (
	"context"
	"errors"
	"log"
	"os"

	"cloud.google.com/go/errorreporting"
)

var errorClient *errorreporting.Client

func main() {
	// Set your Google Cloud Platform project ID via environment or explicitly
	projectID := os.Getenv("GOOGLE_CLOUD_PROJECT")
	args := os.Args[1:]
	if len(args) > 0 && args[0] != "" {
		projectID = args[0]
	}

	ctx := context.Background()
	var err error
	errorClient, err = errorreporting.NewClient(ctx, projectID, errorreporting.Config{
		ServiceName:    "errorreporting_quickstart",
		ServiceVersion: "0.0.0",
		OnError: func(err error) {
			log.Printf("Could not report the error: %v", err)
		},
	})
	if err != nil {
		log.Fatal(err)
	}
	defer errorClient.Close()

	err = errors.New("something went wrong")
	if err != nil {
		logAndPrintError(err)
		return
	}
}

func logAndPrintError(err error) {
	/// Client autopopulates the error context of the error. For more details about the context see:
	/// https://cloud.google.com/error-reporting/reference/rest/v1beta1/ErrorContext
	errorClient.Report(errorreporting.Entry{
		Error: err,
	})
	log.Print(err)
}

要查看更多示例了解如何报告紧急状况和错误，请参阅 godoc。

在本地开发环境中运行应用

如需在本地开发环境中使用适用于 Go 的 Error Reporting 软件包，请执行以下操作： 例如在自己的工作站上运行库，则必须提供 使用本地应用默认凭据创建 Go 版 Error Reporting 软件包。 如需了解详情，请参阅向 Error Reporting 进行身份验证。

如需在本地开发环境中使用本页面上的 Go 示例，请安装并初始化 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

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

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