类 Syslog::Logger

Syslog::Logger 是一个 Logger 的类似物，它通过 syslog 进行日志记录，而不是写入文件。您可以使用 Syslog::Logger 在多台机器之间聚合日志。

默认情况下，Syslog::Logger 使用程序名称“ruby”，但可以通过 Syslog::Logger.new 的第一个参数更改。

注意！您只能在第一次初始化 Syslog::Logger 时设置 Syslog::Logger 程序名称。这是 Syslog::Logger 使用 syslog 的方式的限制（在某种程度上，也是 syslog(3) 工作方式的限制）。尝试在第一次初始化后更改 Syslog::Logger 的程序名称将被忽略。

示例¶ ↑

以下将记录到您本地机器上的 syslogd

require 'syslog/logger'

log = Syslog::Logger.new 'my_program'
log.info 'this line will be logged via syslog(3)'

此外，还可以设置 facility 来指定将使用的 facility 级别

log.info 'this line will be logged using Syslog default facility level'

log_local1 = Syslog::Logger.new 'my_program', Syslog::LOG_LOCAL1
log_local1.info 'this line will be logged using local1 facility level'

您可能需要先执行一些 syslog.conf 设置。对于 BSD 机器，请将以下行添加到 /etc/syslog.conf

!my_program
*.*                                             /var/log/my_program.log

然后触摸 /var/log/my_program.log 并使用 HUP 信号 syslogd（在 FreeBSD 上，使用 killall -HUP syslogd）。

如果您希望日志自动滚动和归档，请参阅 newsyslog.conf(5) 和 newsyslog(8) 手册页。

常量

LEVEL_MAP

将 Logger 警告类型映射到 syslog(3) 警告类型。

来自 Ruby 应用程序的消息不被认为与来自使用 syslog(3) 的其他系统守护进程的消息一样关键，因此大多数消息都被降低了一个级别。例如，Ruby 的 Logger 的致命消息被认为是 syslog(3) 的错误。

VERSION

您正在使用的 Syslog::Logger 版本。

属性

facility[RW]

facility 参数用于指定记录消息的程序类型。

formatter[RW]

日志格式化器，作为 Proc，它将接受四个参数并返回格式化的消息。参数是

severity: 日志消息的严重程度。
time: 表示日志消息记录时间的 Time 实例。
progname: 配置的或传递给 logger 方法的 progname。
msg: 用户传递给日志消息的 Object；不一定是字符串。

块应返回一个可以通过 write 写入日志设备的对象。当未设置格式化器时，将使用默认格式化器。

level[RW]

用于 Logger 兼容性的日志级别。

公共类方法

make_methods(meth) 点击以切换源代码

为级别 meth 构建方法。

# File syslog/lib/syslog/logger.rb, line 107
  def self.make_methods meth
    level = ::Logger.const_get(meth.upcase)
    eval <<-EOM, nil, __FILE__, __LINE__ + 1
      def #{meth}(message = nil, &block)
        add(#{level}, message, &block)
      end

      def #{meth}?
        level <= #{level}
      end
    EOM
  end

new(program_name = 'ruby', facility = nil) 点击以切换源代码

填充 Logger 兼容性的变量。如果这是 Syslog::Logger 的第一个实例，则可以将 program_name 设置为更改记录的程序名称。可以设置 facility 来指定将使用的设施级别。

由于 syslog 的工作方式，只能选择一个程序名称。

# File syslog/lib/syslog/logger.rb, line 191
def initialize program_name = 'ruby', facility = nil
  @level = ::Logger::DEBUG
  @formatter = Formatter.new

  @@syslog ||= Syslog.open(program_name)

  @facility = (facility || @@syslog.facility)
end

syslog() 点击以切换源代码

返回在创建第一个实例时初始化的内部 Syslog 对象。

# File syslog/lib/syslog/logger.rb, line 93
def self.syslog
  @@syslog
end

syslog=(syslog) 点击以切换源代码

指定要使用的内部 Syslog 对象。

# File syslog/lib/syslog/logger.rb, line 100
def self.syslog= syslog
  @@syslog = syslog
end

公共实例方法

add(severity, message = nil, progname = nil, &block) 点击以切换源代码

几乎与 Logger#add 相同。progname 被忽略。

# File syslog/lib/syslog/logger.rb, line 203
def add severity, message = nil, progname = nil, &block
  severity ||= ::Logger::UNKNOWN
  level <= severity and
    @@syslog.log( (LEVEL_MAP[severity] | @facility), '%s', formatter.call(severity, Time.now, progname, (message || block.call)) )
  true
end

debug() 点击以切换源代码

在调试（syslog 调试）日志级别记录 message，或记录从块返回的消息。

# File syslog/lib/syslog/logger.rb, line 151

error() 点击以切换源代码

在错误（syslog 警告）日志级别记录message，或记录块返回的消息。

# File syslog/lib/syslog/logger.rb, line 133

fatal() 点击切换源代码

在致命（syslog 错误）日志级别记录message，或记录块返回的消息。

# File syslog/lib/syslog/logger.rb, line 127

info() 点击切换源代码

在信息（syslog 信息）日志级别记录message，或记录块返回的消息。

# File syslog/lib/syslog/logger.rb, line 145

unknown() 点击切换源代码

在未知（syslog 警告）日志级别记录message，或记录块返回的消息。

# File syslog/lib/syslog/logger.rb, line 121

warn() 点击切换源代码

在警告（syslog 通知）日志级别记录message，或记录块返回的消息。

# File syslog/lib/syslog/logger.rb, line 139