GELF Ruby 库技术文档

1. 安装指南

首先，确保您的系统中已经安装了Ruby。接下来，您可以使用Ruby的包管理工具gem来安装GELF Ruby库。

gem install gelf-rb

确保安装成功，可以通过以下命令查看已安装的gem：

gem list gelf-rb

2. 项目使用说明

本项目提供了两种方式来发送GELF消息到Graylog或Logstash：Gelf::Notifier和Gelf::Logger。

Gelf::Notifier

Gelf::Notifier允许您通过UDP发送任意消息到Graylog。

n = GELF::Notifier.new("localhost", 12201)

# 发送带有自定义属性和额外参数"foo"的消息
n.notify!(:short_message => "foo", :full_message => "这里有一些内容\n\n回溯信息？!", :_foo => "bar")

# 传递任何响应.to_hash方法的对象
n.notify!(Exception.new)

默认推荐通过UDP发送，但您也可以选择通过TCP发送：

n = GELF::Notifier.new("127.0.0.1", 12201, "LAN", { :protocol => GELF::Protocol::TCP })

注意，对于TCP，LAN或WAN选项会被忽略，因为不会进行分片。

Gelf::Logger

Gelf::Logger兼容标准Ruby Logger接口，可以互换使用。在内部，它使用Gelf::Notifier通过UDP发送日志消息到Graylog。

logger = GELF::Logger.new("localhost", 12201, "WAN", { :facility => "应用名" })

logger.debug "调试信息"
logger.info "普通信息"
logger.warn "警告信息"
logger.error "错误信息"
logger.fatal "严重错误信息"

logger << "直接发送的消息"

WAN或LAN选项会影响UDP分片大小，取决于您是在本地网络（LAN）发送还是在更远的路由（例如通过互联网）发送，应相应设置。

由于它兼容Logger接口，您还可以在Rails应用程序中使用它：

# config/environments/production.rb
config.logger = GELF::Logger.new("localhost", 12201, "WAN", { :facility => "应用名" })

3. 项目API使用文档

本项目API的使用详情可以在RDoc中查看，但请注意，本文档中不包括任何链接。

4. 项目安装方式

如“安装指南”部分所述，您可以通过Ruby的gem命令来安装本项目。

gem install gelf-rb

确保在安装任何gem之前，您的系统中已经安装了Ruby。