ログを記録するためのクラスです。
5段階の重要度に分けてログを記録します。
全てのメッセージは必ず重要度を持ちます。また Logger オブジェクトも同じように 重要度を持ちます。メッセージの重要度が Logger オブジェクトの重要度よりも 低い場合メッセージは記録されません。
普段は INFO しか記録していないけど、デバッグ情報が必要になった時には、 Logger オブジェクトの重要度を DEBUG に下げるなどという使い方をします。
require 'logger'
log = Logger.new(STDOUT)
log.level = Logger::WARN
log.debug("Created logger")
log.info("Program started")
log.warn("Nothing to do!")
上の例ではログには WARN のみが記録されます。下が出力例です。
W, [2005-02-10T20:03:56.489954 #12469] WARN -- : Nothing to do!
例外オブジェクトも記録するメッセージとして使えます。
require 'logger'
log = Logger.new(STDOUT)
log.level = Logger::ERROR
begin
File.each_line(path) do |line|
unless line =~ /^(\w+) = (.*)$/
log.error("Line in wrong format: #{line}")
end
end
rescue => err
log.fatal("Caught exception; exiting")
log.fatal(err)
end
Logger.new(logdev, shift_age = 0, shift_size = 1048576)Logger オブジェクトを生成する。logdev には 記録するファイル名か、write と close が定義されたオブジェクト(IO オブジェクトなど)を与えます。
logger = Logger.new(STDERR)
logger = Logger.new(STDOUT)
logger = Logger.new('logfile.log')
shift_age に Integer を与えた場合は、rotate したログファイルの 残す個数と解釈されます。shift_size 毎に rotate されます。 shift_age に 'daily', 'weekly', 'monthly' のいずれかの文字列を 与えた場合は、その間隔毎にログは rotate されます。
file = File.open('foo.log', File::WRONLY | File::APPEND)
logger = Logger.new(file, 'daily')
shift_size は shift_age に Integer を与えた場合にのみ 有効です。
add(severity, message = nil, progname = @progname)add(severity){ ... }メッセージををログに記録します。message は文字列か例外オブジェクトです。 severity にはメッセージの 重要度を DEBUG = 0 から UNKNOWN = 5 までの定数で指定します。数字が 大きいほど重要度も高くなります。メッセージの重要度 severity が Logger オブジェクトの level よりも低い場合、メッセージは記録されません。 progname にはログにメッセージと一緒に記録するプログラム名を与えます。 デフォルトはインスタンス変数 @progname です。
ブロックを与えた場合はブロックを評価した返り値をメッセージとしてログに記録します。
ユーザがこのメソッドを直接使うことはあまりありません
datetime_formatdatetime_format=ログに記録する時の日付のフォーマットです。デフォルトでは "%Y-%m-%dT%H:%M:%S.%06d " です。Time#strftime を参照して下さい。
debug?現在の Logger オブジェクトが DEBUG 以上の重要度のメッセージを記録するなら 真を返します。
info?現在の Logger オブジェクトが INFO 以上の重要度のメッセージを記録するなら 真を返します。
warn?現在の Logger オブジェクトが WARN 以上の重要度のメッセージを記録するなら 真を返します。
error?現在の Logger オブジェクトが ERROR 以上の重要度のメッセージを記録するなら 真を返します。
fatal?現在の Logger オブジェクトが FATAL 以上の重要度のメッセージを記録するなら 真を返します。
debug(progname = nil){ ... }debug(message = nil)debug{ ... }DEBUG 情報 message を記録します。ブロックを与えた場合は、ブロックを評価した 返り値をメッセージとして記録します。現在の Logger の重要度が DEBUG よりも高い場合、 メッセージは記録されません。
logger.debug "Waiting for input from user"
# ...
logger.debug { "User typed #{input}" }
引数とブロックを同時に与えた場合は、progname はプログラム名、ブロックを評価した 返り値がメッセージとなります。
logger.debug("MainApp") { "Received connection from #{ip}" }
info(progname = nil){ ... }info(message = nil)info{ ... }INFO 情報を記録します。debug を参照して下さい。
warn(progname = nil){ ... }warn(message = nil)warn{ ... }WARN 情報を記録します。debug を参照して下さい。
error(progname = nil){ ... }error(message = nil)error{ ... }ERROR 情報を記録します。debug を参照して下さい。
fatal(progname = nil){ ... }fatal(message = nil)fatal{ ... }FATAL 情報を記録します。debug を参照して下さい。
levellevel=Logger オブジェクトの重要度を設定します。重要度がこれより低いメッセージは 記録されません。
sev_thresholdsev_threshold=level の別名です。
prognameprogname=ログに記録するプログラム名を設定します。