Airbrake Ruby 项目技术文档

1. 安装指南

1.1 使用 Bundler 安装

将 Airbrake gem 添加到你的 Gemfile 中：

gem 'airbrake'

然后执行以下命令安装 gem：

bundle install

1.2 手动安装

如果你不使用 Bundler，可以通过以下命令手动安装 Airbrake gem：

gem install airbrake

2. 项目的使用说明

Airbrake 是一款提供强大异常追踪功能的在线工具，适用于任何 Ruby 应用程序。它可以轻松地查看错误、将错误与代码片段关联，并追踪错误到最近的更改。

2.1 集成到 Rails 应用

为了将 Airbrake 集成到你的 Rails 应用中，你需要知道你的项目 ID 和项目 Key。设置环境变量 AIRBRAKE_PROJECT_ID 和 AIRBRAKE_PROJECT_KEY 为你的项目值，并生成 Airbrake 配置：

export AIRBRAKE_PROJECT_ID=<项目ID>
export AIRBRAKE_PROJECT_KEY=<项目KEY>
rails g airbrake

对于 Heroku add-on 用户，可以省略指定 key 和 ID。

2.2 使用 Airbrake API

在配置好 Airbrake 后，你可以在应用中捕获异常并将其发送到 Airbrake：

begin
  # 可能抛出异常的代码
rescue => e
  Airbrake.notify(e)
end

3. 项目API使用文档

Airbrake 提供了一个 API，用于发送异常和事件。以下是基本的使用方式：

3.1 发送异常

require 'airbrake'

project_id = "<你的项目ID>"
project_key = "<你的项目KEY>"
config = {
  project_id: project_id,
  project_key: project_key,
  host: 'api.airbrake.io',
  port: 80,
  secure: false,
}

Airbrake.configure do |c|
  c.project_id = config[:project_id]
  c.project_key = config[:project_key]
  c.useSSL = config[:secure]
end

begin
  # 可能抛出异常的代码
rescue => e
  Airbrake.notify(e)
end

3.2 发送事件

require 'airbrake'

# 配置同上

# 创建一个事件
event = {
  error: {
    class: 'MyCustomError',
    message: '这是自定义错误消息',
  },
  backtrace: ['我的错误堆栈'],
}

Airbrake.notify(event)

4. 项目安装方式

请参考上述“安装指南”部分，使用 Bundler 或手动安装 Airbrake gem。