web-dev-qa-db-ja.com

Rubyロガーログ出力をファイルと同様にstdoutに出力するにはどうすればよいですか?

ロガーのティー機能のようなもの。

87
Manish Sapariya

複数のIOオブジェクトに書き込む擬似IOクラスを作成できます。何かのようなもの:

class MultiIO
  def initialize(*targets)
     @targets = targets
  end

  def write(*args)
    @targets.each {|t| t.write(*args)}
  end

  def close
    @targets.each(&:close)
  end
end

次に、それをログファイルとして設定します。

log_file = File.open("log/debug.log", "a")
Logger.new MultiIO.new(STDOUT, log_file)

LoggerputsオブジェクトでMultiIOを呼び出すたびに、STDOUTとログファイルの両方に書き込みます。

編集:先に進み、インターフェースの残りの部分を見つけました。ログデバイスは、writeおよびcloseputsではなく)に応答する必要があります。 MultiIOがそれらに応答し、それらを実際のIOオブジェクトにプロキシする限り、これは機能するはずです。

117
David

@Davidのソリューションは非常に優れています。彼のコードに基づいて、複数のターゲット用の汎用デリゲータークラスを作成しました。

require 'logger'

class MultiDelegator
  def initialize(*targets)
    @targets = targets
  end

  def self.delegate(*methods)
    methods.each do |m|
      define_method(m) do |*args|
        @targets.map { |t| t.send(m, *args) }
      end
    end
    self
  end

  class <<self
    alias to new
  end
end

log_file = File.open("debug.log", "a")
log = Logger.new MultiDelegator.delegate(:write, :close).to(STDOUT, log_file)
46
jonas054

Rails 3または4にある場合 このブログ投稿 が指摘しているように、 Rails 4にはこの機能が組み込まれています 。できる:

# config/environment/production.rb
file_logger = Logger.new(Rails.root.join("log/alternative-output.log"))
config.logger.extend(ActiveSupport::Logger.broadcast(file_logger))

またはRails 3の場合、バックポートできます:

# config/initializers/alternative_output_log.rb

# backported from Rails4
module ActiveSupport
  class Logger < ::Logger
    # Broadcasts logs to multiple loggers. Returns a module to be
    # `extended`'ed into other logger instances.
    def self.broadcast(logger)
      Module.new do
        define_method(:add) do |*args, &block|
          logger.add(*args, &block)
          super(*args, &block)
        end

        define_method(:<<) do |x|
          logger << x
          super(x)
        end

        define_method(:close) do
          logger.close
          super()
        end

        define_method(:progname=) do |name|
          logger.progname = name
          super(name)
        end

        define_method(:formatter=) do |formatter|
          logger.formatter = formatter
          super(formatter)
        end

        define_method(:level=) do |level|
          logger.level = level
          super(level)
        end
      end
    end
  end
end

file_logger = Logger.new(Rails.root.join("log/alternative-output.log"))
Rails.logger.extend(ActiveSupport::Logger.broadcast(file_logger))
33
phillbaker

私は他の提案をとても気に入っていますが、この同じ問題を抱えていることを発見しましたが、STDERRとファイルのログレベルを変える機能が必要でした。

IOレベルではなくロガーレベルで多重化するルーティング戦略になりました。これにより、各ロガーが独立したログレベルで動作できるようになります。

class MultiLogger
  def initialize(*targets)
    @targets = targets
  end

  %w(log debug info warn error fatal unknown).each do |m|
    define_method(m) do |*args|
      @targets.map { |t| t.send(m, *args) }
    end
  end
end

stderr_log = Logger.new(STDERR)
file_log = Logger.new(File.open('logger.log', 'a'))

stderr_log.level = Logger::INFO
file_log.level = Logger::DEBUG

log = MultiLogger.new(stderr_log, file_log)
12
dsz

シンプルなものが好きな人のために:

log = Logger.new("| tee test.log") # note the pipe ( '|' )
log.info "hi" # will log to both STDOUT and test.log

ソース

または、ロガーフォーマッタでメッセージを印刷します。

log = Logger.new("test.log")
log.formatter = proc do |severity, datetime, progname, msg|
    puts msg
    msg
end
log.info "hi" # will log to both STDOUT and test.log

私は実際にこの手法を使用して、ログファイル、クラウドロガーサービス(ログエントリ)に印刷し、それが開発環境の場合-STDOUTにも印刷します。

10
Igor

複数のデバイスロギング機能をLoggerに直接追加することもできます。

require 'logger'

class Logger
  # Creates or opens a secondary log file.
  def attach(name)
    @logdev.attach(name)
  end

  # Closes a secondary log file.
  def detach(name)
    @logdev.detach(name)
  end

  class LogDevice # :nodoc:
    attr_reader :devs

    def attach(log)
      @devs ||= {}
      @devs[log] = open_logfile(log)
    end

    def detach(log)
      @devs ||= {}
      @devs[log].close
      @devs.delete(log)
    end

    alias_method :old_write, :write
    def write(message)
      old_write(message)

      @devs ||= {}
      @devs.each do |log, dev|
        dev.write(message)
      end
    end
  end
end

例えば:

logger = Logger.new(STDOUT)
logger.warn('This message goes to stdout')

logger.attach('logfile.txt')
logger.warn('This message goes both to stdout and logfile.txt')

logger.detach('logfile.txt')
logger.warn('This message goes just to stdout')
10

@ jonas054の答えに触発された別の実装があります。

これは Delegator に類似したパターンを使用します。この方法では、ターゲットオブジェクトのいずれかで定義されているすべてのメソッドを委任するため、委任するすべてのメソッドをリストする必要はありません。

class Tee < DelegateToAllClass(IO)
end

$stdout = Tee.new(STDOUT, File.open("#{__FILE__}.log", "a"))

Loggerでもこれを使用できるはずです。

delegate_to_all.rbはここから入手できます: https://Gist.github.com/TylerRick/4990898

9
Tyler Rick

上記の@ jonas054の回答は素晴らしいですが、新しいデリゲートごとにMultiDelegatorクラスを汚染します。 MultiDelegatorを数回使用すると、クラスにメソッドが追加され続けますが、これは望ましくありません。 (たとえば、以下を参照してください)

同じ実装ですが、匿名クラスを使用しているため、メソッドは委任者クラスを汚染しません。

class BetterMultiDelegator

  def self.delegate(*methods)
    Class.new do
      def initialize(*targets)
        @targets = targets
      end

      methods.each do |m|
        define_method(m) do |*args|
          @targets.map { |t| t.send(m, *args) }
        end
      end

      class <<self
        alias to new
      end
    end # new class
  end # delegate

end

変更された実装とは対照的な、元の実装によるメソッド汚染の例を次に示します。

tee = MultiDelegator.delegate(:write).to(STDOUT)
tee.respond_to? :write
# => true
tee.respond_to? :size
# => false 

上記はすべて良好です。 teeにはwriteメソッドがありますが、sizeメソッドはありません。次に、別のデリゲートを作成するときを考えます。

tee2 = MultiDelegator.delegate(:size).to("bar")
tee2.respond_to? :size
# => true
tee2.respond_to? :write
# => true   !!!!! Bad
tee.respond_to? :size
# => true   !!!!! Bad

あらいやだ、 tee2sizeに期待どおりに応答しますが、最初のデリゲートのためにwriteにも応答します。メソッド汚染により、teeでさえsizeに応答するようになりました。

これを匿名クラスソリューションとは対照的に、すべてが期待どおりです。

see = BetterMultiDelegator.delegate(:write).to(STDOUT)
see.respond_to? :write
# => true
see.respond_to? :size
# => false

see2 = BetterMultiDelegator.delegate(:size).to("bar")
see2.respond_to? :size
# => true
see2.respond_to? :write
# => false
see.respond_to? :size
# => false
3
Rado

標準のロガーに制限されていますか?

そうでない場合は、 log4r を使用できます。

require 'log4r' 

LOGGER = Log4r::Logger.new('mylog')
LOGGER.outputters << Log4r::StdoutOutputter.new('stdout')
LOGGER.outputters << Log4r::FileOutputter.new('file', :filename => 'test.log') #attach to existing log-file

LOGGER.info('aa') #Writs on STDOUT and sends to file

1つの利点:stdoutとfileに異なるログレベルを定義することもできます。

2
knut

早くて汚い(参照: https://coderwall.com/p/y_b3ra/log-to-stdout-and-a-file-at-the-same-time

require 'logger'
ll=Logger.new('| tee script.log')
ll.info('test')
2
Jose Alban

「すべてのメソッドをサブ要素に委任する」という同じ考えに行きましたが、他の人は既に検討していましたが、メソッドの最後の呼び出しの戻り値をそれぞれに返しています。しなかった場合、logger-colorsIntegerを予期しており、mapはArrayを返していました。

class MultiIO
  def self.delegate_all
    IO.methods.each do |m|
      define_method(m) do |*args|
        ret = nil
        @targets.each { |t| ret = t.send(m, *args) }
        ret
      end
    end
  end

  def initialize(*targets)
    @targets = targets
    MultiIO.delegate_all
  end
end

これにより、すべてのメソッドがすべてのターゲットに再デリゲートされ、最後の呼び出しの戻り値のみが返されます。

また、色が必要な場合は、STDOUTまたはSTDERRを最後に配置する必要があります。色が出力されるのは2つだけであるためです。ただし、その後、ファイルに色も出力されます。

logger = Logger.new MultiIO.new(File.open("log/test.log", 'w'), STDOUT)
logger.error "Roses are red"
logger.unknown "Violets are blue"
1
Jerska

これらのいくつかのことを実行できる小さなRubyGemを作成しました。

# Pipe calls to an instance of Ruby's logger class to $stdout
require 'teerb'

log_file = File.open("debug.log", "a")
logger = Logger.new(TeeRb::IODelegate.new(log_file, STDOUT))

logger.warn "warn"
$stderr.puts "stderr hello"
puts "stdout hello"

Githubでコードを見つけることができます: teerb

1
Patrick Hüsler

もう1つのオプション;-)

require 'logger'

class MultiDelegator
  def initialize(*targets)
    @targets = targets
  end

  def method_missing(method_sym, *arguments, &block)
    @targets.each do |target|
      target.send(method_sym, *arguments, &block) if target.respond_to?(method_sym)
    end
  end
end

log = MultiDelegator.new(Logger.new(STDOUT), Logger.new(File.open("debug.log", "a")))

log.info('Hello ...')
0
Michael Voigt

これは、@ radoのソリューションの簡略化です。

def delegator(*methods)
  Class.new do
    def initialize(*targets)
      @targets = targets
    end

    methods.each do |m|
      define_method(m) do |*args|
        @targets.map { |t| t.send(m, *args) }
      end
    end

    class << self
      alias for new
    end
  end # new class
end # delegate

アウタークラスラッパーを必要とせずに、彼と同じ利点があります。その便利なユーティリティは、別個のRubyファイルにあります。

ワンライナーとして使用して、次のような委任者インスタンスを生成します。

IO_delegator_instance = delegator(:write, :read).for(STDOUT, STDERR)
IO_delegator_instance.write("blah")

または、次のようにファクトリとして使用します。

logger_delegator_class = delegator(:log, :warn, :error)
secret_delegator = logger_delegator_class(main_logger, secret_logger)
secret_delegator.warn("secret")

general_delegator = logger_delegator_class(main_logger, debug_logger, other_logger) 
general_delegator.log("message")
0
Charles Murphy

私はMultiIOアプローチが好きです。 RubyLogger)でうまく機能します。pure IOIOオブジェクトが持つことが期待されるいくつかのメソッドがないため、動作を停止します。Pipesはここで前に言及しました: どのようにRubyロガーログ出力をファイルと同様にstdoutに出力できますか? があります。

def watch(cmd)
  output = StringIO.new
  IO.popen(cmd) do |fd|
    until fd.eof?
      bit = fd.getc
      output << bit
      $stdout.putc bit
    end
  end
  output.rewind
  [output.read, $?.success?]
ensure
  output.close
end

result, success = watch('./my/Shell_command as a String')

これは質問に直接答えないことを知っていますが、強く関連しています。複数のIOへの出力を検索するたびに、このスレッドに出くわしたので、これも役立つことを願っています。

0
knugie

もう一つの方法。タグ付きログを使用しており、別のログファイルにもタグが必要な場合は、この方法で行うことができます

# backported from Rails4
# config/initializers/active_support_logger.rb
module ActiveSupport
 class Logger < ::Logger

 # Broadcasts logs to multiple loggers. Returns a module to be
 # `extended`'ed into other logger instances.
 def self.broadcast(logger)
  Module.new do
    define_method(:add) do |*args, &block|
      logger.add(*args, &block)
      super(*args, &block)
    end

    define_method(:<<) do |x|
      logger << x
      super(x)
    end

    define_method(:close) do
      logger.close
      super()
    end

    define_method(:progname=) do |name|
      logger.progname = name
      super(name)
    end

    define_method(:formatter=) do |formatter|
      logger.formatter = formatter
      super(formatter)
    end

    define_method(:level=) do |level|
      logger.level = level
      super(level)
    end

   end # Module.new
 end # broadcast

 def initialize(*args)
   super
   @formatter = SimpleFormatter.new
 end

  # Simple formatter which only displays the message.
  class SimpleFormatter < ::Logger::Formatter
   # This method is invoked when a log event occurs
   def call(severity, time, progname, msg)
   element = caller[4] ? caller[4].split("/").last : "UNDEFINED"
    "#{Thread.current[:activesupport_tagged_logging_tags]||nil } # {time.to_s(:db)} #{severity} #{element} -- #{String === msg ? msg : msg.inspect}\n"
   end
  end

 end # class Logger
end # module ActiveSupport

custom_logger = ActiveSupport::Logger.new(Rails.root.join("log/alternative_#{Rails.env}.log"))
Rails.logger.extend(ActiveSupport::Logger.broadcast(custom_logger))

この後、代替ロガーでuuidタグを取得します

["fbfea87d1d8cc101a4ff9d12461ae810"] 2015-03-12 16:54:04 INFO logger.rb:28:in `call_app' -- 
["fbfea87d1d8cc101a4ff9d12461ae810"] 2015-03-12 16:54:04 INFO   logger.rb:31:in `call_app' -- Started POST "/psp/entrypoint" for 192.168.56.1 at 2015-03-12 16:54:04 +0700

それが誰かを助けることを願っています。

0
retgoat