Rack::Bug 技术文档

1. 安装指南

1.1 Rails 项目安装

在 Rails 项目中，可以通过以下步骤安装 Rack::Bug：

1. 使用 script/plugin 命令安装插件：

   script/plugin install git://github.com/brynary/rack-bug.git
   

2. 在 config/environments/development.rb 文件中添加以下配置：

   config.middleware.use "Rack::Bug",
     :secret_key => "someverylongandveryhardtoguesspreferablyrandomstring"
   

3. 添加书签工具到浏览器：

   open http://RAILS_APP/__rack_bug__/bookmarklet.html
   

1.2 非 Rails Rack 应用安装

对于非 Rails 的 Rack 应用，可以直接使用 Rack::Bug 作为中间件：

1. 在应用中引入 Rack::Bug：

   use Rack::Bug
   

2. 如果需要使用日志面板，定义 LOGGER 常量，该常量应为 Ruby 的 Logger 或 ActiveSupport::BufferedLogger。

2. 项目的使用说明

2.1 功能概述

Rack::Bug 是一个用于 Rack 应用的诊断工具栏，能够在应用运行时注入一个浮动 div，用于探索日志、数据库查询、模板渲染时间等信息。

2.2 默认面板

Rack::Bug 默认包含以下面板：

• Rails Info
• Timer
• Request Variables
• SQL
• Active Record
• Cache
• Templates
• Log
• Memory

此外，还提供了其他可选面板，如 Redis 和 Sphinx。

2.3 自定义面板

可以通过配置自定义面板的顺序和内容：

require "rack/bug"

ActionController::Dispatcher.middleware.use Rack::Bug,
  :secret_key => "someverylongandveryhardtoguesspreferablyrandomstring",
  :panel_classes => [
    Rack::Bug::TimerPanel,
    Rack::Bug::RequestVariablesPanel,
    Rack::Bug::RedisPanel,
    Rack::Bug::TemplatesPanel,
    Rack::Bug::LogPanel,
    Rack::Bug::MemoryPanel
  ]

3. 项目API使用文档

3.1 中间件配置

Rack::Bug 可以通过以下方式进行配置：

• secret_key: 用于安全验证的密钥。
• panel_classes: 自定义面板的类列表。
• ip_masks: 限制访问的 IP 地址。
• password: 限制访问的密码。

3.2 安全配置

可以通过 IP 地址或密码来限制访问：

• IP 地址限制:

  require "ipaddr"
  
  ActionController::Dispatcher.middleware.use "Rack::Bug"
    :secret_key => "someverylongandveryhardtoguesspreferablyrandomstring",
    :ip_masks   => [IPAddr.new("2.2.2.2/0")]
  

• 密码限制:

  ActionController::Dispatcher.middleware.use "Rack::Bug",
    :secret_key => "someverylongandveryhardtoguesspreferablyrandomstring",
    :password   => "yourpassword"
  

4. 项目安装方式

4.1 开发环境安装

在开发环境中，需要安装以下 gem：

• rspec
• rack-test
• webrat
• sinatra

4.2 生产环境安装

Rack::Bug 可以在生产环境中运行，用于特定的故障排查。配置方式与开发环境类似，但需要注意安全配置。

4.3 许可证

Rack::Bug 使用 MIT 许可证，详细信息请参阅 MIT-LICENSE.txt 文件。

---

通过以上文档，您可以详细了解 Rack::Bug 的安装、使用和配置方法，帮助您更好地在项目中使用该工具。