如何正确登录我的Ruby宝石

Question

目前我使用的是puts，但我确信这不是正确的答案。如何在我的gem中正确设置记录器，以输出我的内部日志而不是puts？

Answer 1

您可以将记录器保留在顶级模块中。允许用户设置自己的日志记录程序，但为那些不关心日志记录的人提供一个合理的默认值。例如

module MyGem
  class << self
    attr_writer :logger
    def logger
      @logger ||= Logger.new($stdout).tap do |log|
        log.progname = self.name
      end
    end
  end
end

然后，在您的gem代码中的任何地方，您都可以访问记录器。例如

class MyGem::SomeClass
  def some_method
    # ...
    MyGem.logger.info 'some info'
  end
end

参考文献：

• 使用Ruby Logger
• Logger

Answer 2

对于gem用户来说，最灵活的方法是让他们提供一个记录器，而不是在gem中设置它。最简单地说，这可能是

class MyGem
  class << self
    attr_accessor :logger
  end
end

然后使用MyGem.logger.info "hello"记录来自gem的消息（您可能希望将其封装在一个实用程序方法中，该方法测试是否设置了记录器）

然后，gem的用户可以控制消息记录到哪里（文件、syslog、stdout等）

Answer 3

一个小例子：

gem 'log4r'
require 'log4r' 
class MyClass
  def initialize(name)
    @log = Log4r::Logger.new(name)
    #Add outputter
    #~ log.outputters << Log4r::FileOutputter.new('log_file', :filename => 'mini_example.log', :level => Log4r::ALL )
    log.outputters << Log4r::StdoutOutputter.new('log_stdout') #, :level => Log4r::WARN )
    #~ log.outputters << Log4r::StderrOutputter.new('log_stderr', :level => Log4r::ERROR)
    @log.level = Log4r::INFO
    @log.info("Creation")
    #~ @log.level = Log4r::OFF
  end
  attr_reader :log
  def myfunction(*par)
    @log.debug("myfunction is called")
    @log.warn("myfunction: No parameter") if par.empty?
  end
end  
x = MyClass.new('x')
x.myfunction
y = MyClass.new('y')
y.myfunction
y.myfunction(:a)
y.log.level = Log4r::DEBUG
y.myfunction(:a)

在初始化期间，您将创建一个Logger（@log）。在您的方法中，您调用记录器。

使用@log.level=（或MyClass#log.level=），您可以影响使用的消息。

您可以使用不同的输出程序（在我的示例中，我登录到STDOUT）。您也可以混合输出（例如STDOUT和警告，每个数据（包括DEBUG）到一个文件…）

Answer 4

我认为最简单的方法是以这种方式使用

Rails.logger.info "hello"