RailsMetrics 技术文档

本文档将详细介绍如何安装、使用以及配置 RailsMetrics，帮助您更好地理解和应用这个项目。

1. 安装指南

RailsMetrics 的安装过程非常简单。首先，您需要将其作为 gem 安装：

gem install rails_metrics

然后，将 gem 添加到您的 Gemfile 中。目前，建议只在开发环境中安装：

group :development do
  gem "rails_metrics"
end

接下来，使用内置的生成器创建您的模型：

rails g rails_metrics Metric

您可以自定义 RailsMetrics 存储的名称，而不是使用默认的 Metric。运行生成的迁移文件，并重启服务器。现在，您应该能够通过访问 "/rails_metrics" 来查看存储的数据。

2. 项目的使用说明

RailsMetrics 是一个引擎，它可以钩入您的应用程序，监听 ActiveSupport::Notifications 并显示相关的统计信息。RailsMetrics 使用线程将通知保存在数据库中的进程内队列。您可以根据每个请求查看图表，了解哪些查询、动作、模板渲染等是缓慢的。

目前，RailsMetrics 仅支持 ActiveRecord 作为 ORM，但添加其他数据存储应该很简单（查看 lib/rails_metrics/orm/active_record.rb）。由于 RailsMetrics 的多线程行为，您无法使用 SQLite 作为数据库，但是 MySQL 和 PostgreSQL 可以正常工作。

3. 项目API使用文档

RailsMetrics 的配置主要通过以下参数进行：

• config.rails_metrics.set_store：设置 RailsMetrics 的存储，使用生成器时会自动配置。

config.rails_metrics.set_store = lambda { ::Metric }

• config.rails_metrics.ignore_patterns：添加一个模式，用于忽略特定的通知。

config.rails_metrics.ignore_patterns << /verbose_plugin/

• config.rails_metrics.ignore_lambdas：根据通知的有效负载忽略通知。

config.rails_metrics.ignore_lambdas[:verbose_plugin] = lambda { |name, payload|
  payload[:some_value] =~ /some_expression/
}

4. 项目安装方式

以下是项目的安装方式：

1. 安装 Bundler：

gem install bundler

2. 使用 Bundler 安装依赖：

bundle install

3. 准备测试环境：

rake prepare

4. 运行测试套件：

rake test

通过以上步骤，您应该能够成功安装并运行 RailsMetrics，从而监控和优化您的应用程序性能。