Airbrake 技术文档

1. 安装指南

使用 Bundler 安装

在您的 Gemfile 中添加 Airbrake gem：

gem 'airbrake'

然后运行 bundle install 来安装依赖。

手动安装

在终端中执行以下命令：

gem install airbrake

2. 项目的使用说明

Airbrake 是一个强大的异常跟踪工具，能够帮助您在 Ruby 应用程序中捕获和调试错误。它能够自动捕获未处理的异常，并将相关信息发送到 Airbrake 仪表盘，方便您快速定位和解决问题。

Rails 集成

要将 Airbrake 集成到 Rails 应用程序中，您需要知道项目的 project id 和 project key。设置以下环境变量并生成 Airbrake 配置文件：

export AIRBRAKE_PROJECT_ID=<PROJECT ID>
export AIRBRAKE_PROJECT_KEY=<PROJECT KEY>

rails g airbrake

此命令将在 config/initializers/airbrake.rb 中生成 Airbrake 配置文件。确保此文件已提交到版本控制系统中。

Sinatra 集成

在 Sinatra 应用程序中使用 Airbrake，只需 require Airbrake gem，配置它并使用 Rack 中间件：

require 'sinatra/base'
require 'airbrake'

Airbrake.configure do |c|
  c.project_id = 113743
  c.project_key = 'fd04e13d806a90f96614ad8e529b2822'
  c.logger.level = Logger::DEBUG
end

class MyApp < Sinatra::Base
  use Airbrake::Rack::Middleware

  get('/') { 1/0 }
end

run MyApp.run!

Rack 集成

在任何 Rack 应用程序中使用 Airbrake，只需 use Airbrake 的 Rack 中间件并配置通知器：

require 'airbrake'
require 'airbrake/rack'

Airbrake.configure do |c|
  c.project_id = 113743
  c.project_key = 'fd04e13d806a90f96614ad8e529b2822'
end

use Airbrake::Rack::Middleware

3. 项目 API 使用文档

Airbrake 提供了丰富的 API 用于手动报告错误和自定义错误信息。

手动报告错误

您可以使用 Airbrake.notify 方法手动报告错误：

begin
  1 / 0
rescue => exception
  Airbrake.notify(exception)
end

控制器辅助方法

在 Rails 控制器中，您可以使用 #notify_airbrake 和 #notify_airbrake_sync 辅助方法来手动报告错误。这些方法会自动添加 Rack 环境信息到通知中。

class MyController < ApplicationController
  def index
    begin
      1 / 0
    rescue => exception
      notify_airbrake(exception)
    end
  end
end

用户信息报告

Airbrake 能够自动报告当前登录用户的信息（如 id、email、username 等），前提是您使用了如 Devise 这样的认证库。

4. 项目安装方式

Rails 应用程序

在 Rails 应用程序中，您可以通过以下步骤安装和配置 Airbrake：

1. 在 Gemfile 中添加 gem 'airbrake'。
2. 运行 bundle install。
3. 设置 AIRBRAKE_PROJECT_ID 和 AIRBRAKE_PROJECT_KEY 环境变量。
4. 运行 rails g airbrake 生成配置文件。

Sinatra 应用程序

在 Sinatra 应用程序中，您可以通过以下步骤安装和配置 Airbrake：

1. 在应用程序文件中 require 'airbrake'。
2. 配置 Airbrake 通知器。
3. 使用 use Airbrake::Rack::Middleware 启用 Rack 中间件。

Rack 应用程序

在 Rack 应用程序中，您可以通过以下步骤安装和配置 Airbrake：

1. 在应用程序文件中 require 'airbrake' 和 require 'airbrake/rack'。
2. 配置 Airbrake 通知器。
3. 使用 use Airbrake::Rack::Middleware 启用 Rack 中间件。

通过以上步骤，您可以成功安装并配置 Airbrake，开始捕获和调试应用程序中的异常。