Oink 项目技术文档

1. 安装指南

首先，将 Oink 添加到您的 Gemfile 中：

gem "oink"

然后执行以下命令来安装依赖项：

bundle install

在大多数 Rails 环境中，这样做就足够了，Oink 将通过 bundler 被自动加载。如果没有，请在您的应用程序中添加一个 require 'oink' 的语句。

2. 项目使用说明

Oink 是一个 Rails 插件和日志分析器，用于帮助缩小 Rails 应用程序中内存使用增加的源。

作为中间件，Oink 在应用程序运行时添加内存和 Active Record 实例化信息到 Rails 日志中，并提供一个可执行文件来帮助分析增强的日志。

配置中间件

推荐使用 initializer 来配置 Oink 中间件：

Rails.application.middleware.use Oink::Middleware

默认情况下，Oink 中间件会将日志条目写入应用程序根目录下的 log/oink.log 文件。您也可以通过传递一个可选的日志实例来初始化它，使 Oink 日志条目写入应用程序的默认日志文件：

Rails.application.middleware.use( Oink::Middleware, :logger => Rails.logger )

您可以配置 Oink 来记录内存和 Active Record 使用情况。使用 :instruments 选项来指定：

• 仅内存使用情况：

  Rails.application.middleware.use( Oink::Middleware, :instruments => :memory )
  

• 仅 Active Record 实例化计数：

  Rails.application.middleware.use( Oink::Middleware, :instruments => :activerecord )
  

请注意，之前配置 Oink 的方式，即将一组模块包含到 Rails 控制器中，已经被弃用。

3. 项目 API 使用文档

使用 Oink 可执行文件分析日志文件。以下是命令行选项：

Usage: oink [options] files
  -t, --threshold [INTEGER]        内存阈值为 MB
  -f, --file filepath              输出到文件
  --format FORMAT                  选择格式 (ss,v,s,verbose,short-summary,summary)
  -m, --memory                     检查内存阈值（默认）
  -r, --active-record              检查 Active Record 阈值

Oink 查找超过给定阈值的请求。在 "memory" 模式下（默认），阈值代表从前一个请求开始的内存增加量。在 "active record" 模式下（通过传递 --active-record 开关激活），阈值代表一个请求期间实例化的 Active Record 对象数量。

例如，要查找所有增加堆大小超过 75 MB 的操作，假设日志文件位于 /tmp/logs/：

$ oink --threshold=75 /tmp/logs/*

4. 项目安装方式

请参考上述 "安装指南" 部分。

---

本文档提供了 Oink 项目的安装、配置和使用方法。如需进一步的帮助，请参考项目 GitHub 仓库和 Wiki。