Trashed 项目技术文档

1. 安装指南

1.1 环境要求

• Ruby 1.8.7 及以上版本
• Rails 2/3/4/5
• StatsD 服务

1.2 安装步骤

1. 在 Gemfile 中添加以下内容：

   gem 'trashed'
   

2. 运行以下命令安装 gem：

   bundle install
   

2. 项目使用说明

2.1 Rails 5 配置

在 Rails 5（以及 Rails 3 和 4）中，将以下内容添加到 config/application.rb 的顶部：

require 'trashed/railtie'

然后在应用配置的主体部分添加：

module YourApp
  class Application < Rails::Application
    config.trashed.statsd = YourApp.statsd
  end
end

2.2 Rails 2 配置

在 Rails 2 中，将中间件添加到 config/environment.rb：

Rails::Initializer.run do |config|
  reporter = Trashed::Reporter.new
  reporter.logger = Rails.logger
  reporter.statsd = YourApp.statsd

  config.middleware.use Trashed::Rack, reporter
end

2.3 自定义维度

你可能希望按控制器、动作等维度统计数据。可以设置 #timing_dimensions 和 #gauge_dimensions 两个 lambda 函数来返回维度列表。

2.3.1 时间维度

config.trashed.timing_dimensions = ->(env) do
  if controller = env['action_controller.instance']
    name    = controller.controller_name
    action  = controller.action_name
    format  = controller.rendered_format || :none
    variant = controller.request.variant || :none

    [ :All,
      :"Controllers.#{name}",
      :"Actions.#{name}.#{action}.#{format}+#{variant}" ]
  end
end

2.3.2 状态维度

config.trashed.gauge_dimensions = ->(env) {
  [ :All,
    :"Stage.#{Rails.env}",
    :"Hosts.#{`hostname -s`.chomp}" ]
}

3. 项目 API 使用文档

3.1 主要 API

• Trashed::Reporter.new: 创建一个新的报告器实例。
• config.trashed.statsd: 配置 StatsD 客户端。
• config.trashed.timing_dimensions: 配置时间维度。
• config.trashed.gauge_dimensions: 配置状态维度。

3.2 示例

reporter = Trashed::Reporter.new
reporter.logger = Rails.logger
reporter.statsd = YourApp.statsd

config.middleware.use Trashed::Rack, reporter

4. 项目安装方式

4.1 通过 Gemfile 安装

在 Gemfile 中添加：

gem 'trashed'

然后运行：

bundle install

4.2 手动安装

可以通过以下命令手动安装：

gem install trashed

---

通过以上步骤，你可以成功安装并配置 Trashed 项目，开始监控你的 Rails 应用的资源使用情况。