设置 Ruby 版 Error Reporting

您可以使用 Ruby 版 Stackdriver Error Reporting 库将 Ruby 应用提供的错误报告发送到 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

  5. 安装 Ruby 2.2+ 或更高版本。

安装客户端库

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

  1. 将 Stackdriver gem 添加到 Gemfile:

    gem "stackdriver"
  2. 使用 Bundler 安装 gem:

    bundle install

启用库

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

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

require "google/cloud/error_reporting"

use Google::Cloud::ErrorReporting::Middleware

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

配置客户端库

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

报告错误

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

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

手动报告错误

您可以通过调用 report 方法手动报告错误,如以下示例所示:

require "google/cloud/error_reporting"

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

在 Google Cloud Platform 上运行

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

App Engine 柔性环境

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

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

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

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

使用 Ruby on Rails 配置界面

要在 Ruby on Rails 框架中使用 Ruby 版 Stackdriver Error Reporting 库,请通过 Ruby on Rails 配置界面提供参数:

# 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 设置共享配置:

# 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,请添加以下内容:

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

使用 instrumentation 配置界面

要在其他基于 Rack 的应用中使用 Ruby 版 Stackdriver Error Reporting 库,请通过配置界面提供参数:

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

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

require "stackdriver"

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

查看错误报告

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

转到 Error Reporting 信息中心

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

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

发送以下问题的反馈:

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