设置 Ruby 版 Error Reporting

您可以使用 Ruby 版 Error Reporting 库，从 Ruby 应用向 Error Reporting 发送错误报告。

Error Reporting 已与某些 Google Cloud 服务集成，例如 App Engine、Compute Engine 和 Google Kubernetes Engine。Error Reporting 可显示在这些服务上运行的应用记录到 Cloud Logging 中的错误。如需了解详情，请参阅本页面上的在 Google Cloud Platform 上运行。

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

准备工作

登录您的 Google 帐号。
如果您还没有 Google 帐号，请注册一个新帐号。

在 Cloud Console 的项目选择器页面上，选择或创建 Cloud 项目。

注意：如果您不打算保留在此过程中创建的资源，请创建新的项目，而不要选择现有的项目。完成本教程介绍的步骤后，您可以删除所创建的项目，并移除与该项目关联的所有资源。

转到项目选择器页面

确保您的 Google Cloud 项目已启用结算功能。了解如何确认您的项目已启用结算功能。

启用 Error Reporting API 。
启用 API

安装 Ruby 2.2+ 或更高版本。

安装客户端库

借助 Ruby 版 Error Reporting 库，您可以监控和查看几乎在任何位置运行的 Ruby 应用所报告的错误。

将 Google Cloud 的操作套件 gem 添加到您的 Gemfile 中：

在 GitHub 上查看反馈
```
gem "stackdriver"
```
使用 Bundler 安装 gem：
```
bundle install
```

启用库

如果您正在使用 Ruby on Rails，Bundler 会在启动时自动将库加载到您的应用中。

其他基于 Rack 的应用可以使用库提供的 Rack Middleware：

在 GitHub 上查看反馈

require "google/cloud/error_reporting"

use Google::Cloud::ErrorReporting::Middleware

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

配置客户端库

您可以自定义 Ruby 版 Error Reporting 库的行为。如需查看可能的配置选项的列表，请参阅库的配置。

报告错误

报告基于 Rack 的框架中的错误

通过 Ruby 版 Error Reporting 库，您可以将 Error Reporting 轻松集成到常用的基于 Rack 的 Ruby Web 框架中，例如 Ruby on Rails 和 Sinatra。该库启用后，它会自动报告从应用的 Rack 堆栈捕获的异常。

手动报告错误

您可以调用 report 方法来手动报告错误，如以下示例所示：

在 GitHub 上查看反馈

require "google/cloud/error_reporting"

begin
  raise "Raise an exception for Error Reporting."
rescue StandardError => e
  Google::Cloud::ErrorReporting.report e
end

在 Google Cloud 上运行

要使用 Ruby 版 Error Reporting 库，您必须具备 Identity and Access Management 的 Error Reporting Writer 角色。大多数 Google Cloud 计算平台均默认提供此角色。

您可以使用以下 Google Cloud 环境配置 Ruby 版 Error Reporting。

App Engine 柔性环境

App Engine 默认授予 Error Reporting Writer 角色。

您无需明确提供凭据即可使用 Ruby 版 Error Reporting 库。

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

Google Kubernetes Engine

在 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 Console 创建新实例时，您可以在创建实例面板的身份和 API 访问权限部分执行此操作。请使用 Compute Engine 默认服务帐号或您选用的其他服务帐号，并在身份和 API 访问权限部分中勾选允许所有 Cloud API 的全面访问权限。无论您选择哪个服务帐号，都请确保已在 Cloud Console 的 IAM 和管理部分向该服务帐号授予 Error Reporting Writer 角色。

在本地和其他位置运行

如需在 Google Cloud 之外（包括您自己的工作站、您数据中心的计算机或另一家云提供商的虚拟机实例上）使用 Ruby 版 Error Reporting 库，您必须直接向 Ruby 版 Error Reporting 库提供您的 Google Cloud 项目 ID 和相应的服务帐号凭据。

您可以手动创建和获取服务帐号凭据。指定角色字段时，请使用 Error Reporting Writer 角色。如需详细了解 Identity and Access Management 角色，请转到访问权限控制指南。

使用 Ruby on Rails 配置界面

要在 Ruby on Rails 框架中使用 Ruby 版 Error Reporting 库，请通过 Ruby on Rails 配置界面提供如下参数：

在 GitHub 上查看反馈

# Add this to config/environments/*.rb
Rails.application.configure do |config|
  # Stackdriver Error Reporting specific parameters
  config.google_cloud.error_reporting.project_id = "YOUR-PROJECT-ID"
  config.google_cloud.error_reporting.keyfile    = "/path/to/service-account.json"
end

您还可以使用以下代码为所有 Stackdriver gem 设置共享配置：

在 GitHub 上查看反馈

# Add this to config/environments/*.rb
Rails.application.configure do |config|
  # Stackdriver Shared parameters
  config.google_cloud.project_id = "YOUR-PROJECT-ID"
  config.google_cloud.keyfile    = "/path/to/service-account.json"
end

如果 Rails 在生产模式下运行，则 Error Reporting 默认处于启用状态。要在开发模式下启用 Error Reporting，请添加以下代码：

在 GitHub 上查看反馈

# Add this to config/environments/development.rb
Rails.application.configure do |config|
  config.google_cloud.use_error_reporting = true
end

使用 instrumentation 配置界面

如需在其他基于 Rack 的应用中使用 Ruby 版 Error Reporting 库，请通过配置界面提供如下参数：

在 GitHub 上查看反馈

require "google/cloud/error_reporting"

Google::Cloud.configure do |config|
  # Stackdriver Error Reporting specific parameters
  config.error_reporting.project_id = "YOUR-PROJECT-ID"
  config.error_reporting.keyfile    = "/path/to/service-account.json"
end

您还可以使用以下代码，为所有 Google Cloud 的运维套件 gem 设置共享配置：

在 GitHub 上查看反馈

require "stackdriver"

Google::Cloud.configure do |config|
  # Stackdriver Shared parameters
  config.project_id = "YOUR-PROJECT-ID"
  config.keyfile    = "/path/to/service-account.json"
end

查看错误报告

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

转到 Error Reporting 信息中心

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