Wie melde ich mich korrekt in meinem Ruby-Juwel?

Question

Derzeit verwende ich puts, aber ich bin mir sicher, dass das nicht die richtige Antwort ist. Wie richte ich einen Logger innerhalb meines Edelsteins korrekt ein, um meine interne Protokollierung anstelle von puts auszugeben?

Answer 1

ein kleines Beispiel:

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) 

Während der Initialisierung Sie Erstellen Sie einen Logger (@log). In Ihren Methoden rufen Sie den Logger an.

Mit @log.level= (oder MyClass#log.level=) können Sie beeinflussen, welche Nachrichten verwendet werden.

Sie können verschiedene Ausgabegeräte verwenden (in meinem Beispiel logge ich mich in STDOUT ein). Sie können auch outputters (zB STDOUT mit Warnungen, die alle Daten (einschließlich debug) in eine Datei ...) mischen

Answer 2

Der flexibelste Ansatz für Benutzer Ihres Edelsteins ist, dass sie einen Logger bereitstellen, anstatt ihn innerhalb des Edelsteins einzurichten. In seiner einfachsten Form könnte dies

sein

class MyGem 
    class << self 
    attr_accessor :logger 
    end 
end 

Sie verwenden MyGem.logger.info "hello" dann Nachrichten aus Ihrem Juwel einzuloggen (möchten Sie vielleicht in einem Hilfsmethode umhüllen, die prüft, ob ein Logger überhaupt eingestellt ist)

Benutzer von Ihre Perle kann dann steuern, wo Nachrichten protokolliert werden (eine Datei, syslog, stdout, etc ...)

Answer 3

Ich denke, der einfachste Ansatz es auf diese Weise

Rails.logger.info "hello" 

Answer 4

Sie halten zu verwenden ist Logger in Ihrem Top-Level-Modul. Benutzern erlauben, ihren eigenen Logger einzurichten, aber einen angemessenen Standard für diejenigen bereitzustellen, die sich nicht mit der Protokollierung befassen. Für z.B.

module MyGem 
    class << self 
    attr_writer :logger 

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

Dann können Sie überall in Ihrem Gem-Code auf den Logger zugreifen. Für z.B.

class MyGem::SomeClass 

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

end 

Referenzen:

• Using the Ruby Logger
• Logger