Jak poprawnie logować się wewnątrz mojego klejnotu Ruby?

Question

Obecnie używam puts, ale jestem pewien, że to nie jest poprawna odpowiedź. W jaki sposób poprawnie skonfigurować rejestrator, w moim klejnocie, aby wygenerować moje wewnętrzne rejestrowanie zamiast puts?

Answer 1

trochę przykład:

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) 

Podczas inicjalizacji ty utwórz rejestrator (@log). W twoich metodach nazywasz logger.

Dzięki @log.level= (lub MyClass#log.level=) możesz wpływać na to, które wiadomości są używane.

Możesz użyć różnych programów wyjściowych (w moim przykładzie loguję do STDOUT). Można również mieszać outputters (np STDOUT z ostrzeżeniami, każde dane (w tym debug) do pliku ...)

Answer 2

Najbardziej elastyczne podejście dla użytkowników klejnotów polega na umożliwieniu im dostarczenia rejestratora zamiast instalowania go wewnątrz klejnotu. W najprostszej może to być

class MyGem 
    class << self 
    attr_accessor :logger 
    end 
end 

wtedy użyć MyGem.logger.info "hello" do wiadomości dziennika z klejnot (warto zawinąć go w metodzie narzędzie, które sprawdza, czy rejestrator jest ustawiony w ogóle)

Użytkownicy Twój gem można następnie kontrolować, gdzie wiadomości się zalogować do (pliku, syslog, stdout, etc ...)

Answer 3

Myślę, że najprostszym sposobem jest użycie go w ten sposób

Rails.logger.info "hello" 

Answer 4

można zachować rejestrator w swoim module najwyższego poziomu. Zezwól użytkownikowi na ustawienie własnego rejestratora, ale zapewnia rozsądne ustawienie domyślne dla tych, którzy nie dbają o rejestrację. Dla np.

module MyGem 
    class << self 
    attr_writer :logger 

    def logger 
     @logger ||= Logger.new($stdout).tap do |log| 
     log.progname = self.name 
     end 
    end 
    end 
end 

Następnie, w dowolnym miejscu w obrębie kodu gem można uzyskać dostęp do rejestratora. Dla np.

class MyGem::SomeClass 

    def some_method 
    # ... 
    MyGem.logger.info 'some info' 
    end 

end 

Referencje:

• Using the Ruby Logger
• Logger