Yell 项目技术文档

本文档将为您提供 Yell 项目——一个 Ruby 的可扩展日志库——的安装指南、使用说明以及 API 使用文档，帮助您详细了解并使用该项目。

1. 安装指南

要全局安装 Yell，请在命令行中运行以下命令：

gem install yell

如果您希望在特定的 Ruby 项目中使用 Yell，您可以在 Gemfile 中添加以下依赖：

gem "yell"

然后运行 bundle install 来安装 Yell。

2. 项目使用说明

Yell 可以像其他日志库一样使用，但它提供了更高级的消息格式化功能。

基本使用

创建一个日志器，然后记录信息：

logger = Yell.new STDOUT

logger.info "Hello World"

输出示例：

2012-02-29T09:30:00+01:00 [ INFO] 65784 : Hello World

使用多个适配器

Yell 的强大之处在于支持多个适配器。内置的适配器不需要额外配置，且都是基于 IO 的。此外，还有其他适配器作为单独的 gem 可用。请查阅 wiki 了解更多信息。

标准适配器包括：

• :stdout：消息将写入 STDOUT
• :stderr：消息将写入 STDERR
• :file：消息将写入文件
• :datefile：消息将写入时间戳文件

示例

以下是如何组合使用适配器的一些示例：

将通知消息写入 STDOUT，错误消息写入 STDERR

logger = Yell.new do |l|
  l.adapter STDOUT, level: [:debug, :info, :warn]
  l.adapter STDERR, level: [:error, :fatal]
end

典型的生产环境日志器

配置一个从 :info 级别开始记录的日志器。低于 :error 级别的消息写入 production.log，而更高级别的消息写入 error.log。

logger = Yell.new do |l|
  l.level = 'gte.info'

  l.adapter :datefile, 'production.log', level: 'lte.warn'
  l.adapter :datefile, 'error.log', level: 'gte.error'
end

针对 Heroku 的生产环境日志器

在 Heroku 上部署时，通常不需要 rails_log_stdout gem。以下是如何配置 Yell 的示例：

logger = Yell.new do |l|
  l.level = 'gte.info'

  l.adapter :stdout, level: 'lte.warn'
  l.adapter :stderr, level: 'gte.error'
end

使用 Log4r 用户熟悉的配置

如果您习惯使用 Log4r，Yell 也提供了类似的功能：

require 'yell'

Yell.new :stdout, name: 'mylog'

Yell['mylog']

向现有类添加日志器

Yell 提供了一个简单的模块 Yell::Loggable，您可以直接包含在任何类中：

Yell.new :stdout, name: 'Foo'

class Foo
  include Yell::Loggable
end

Foo.logger.info "Hello World"

为所有类全局添加日志器

如果您希望为所有类添加日志器，可以这样做：

Yell.new :stdout, name: Object

Object.send :include, Yell::Loggable

logger.info "Hello from anything"
Integer.logger.info "Hello from Integer"

使用抑制器来过滤日志消息

如果您想抑制特定的日志消息，可以使用抑制器：

logger = Yell.new do |l|
  l.silence /^Started GET "\/assets/
  l.silence /^Served asset/
end

3. 项目 API 使用文档

Yell

API 文档提供了 Yell 的方法和配置选项的详细说明。以下是一些关键点：

• Yell.new([options])：创建一个新的日志器实例。
• logger.info(message)：记录一条信息级别的消息。
• logger.level=(level)：设置日志级别。
• logger.adapter(adapter, options)：添加一个新的日志适配器。

更多 API 信息和示例，请查阅 Yell 的官方文档。

4. 项目安装方式

如前所述，Yell 可以通过以下任一方式安装：

• 使用 gem install yell 命令进行全局安装。
• 将 gem "yell" 添加到您的 Gemfile 中，然后运行 bundle install。

以上是 Yell 项目的技术文档，希望对您有所帮助。