Ruby 3.4 リファレンスマニュアル

class Logger::LogDevice

[edit]

要約

Logger の内部で使用するログの出力先を表すクラスです。

目次

特異メソッド
インスタンスメソッド

特異メソッド

new(log = nil, shift_age: nil, shift_size: nil, shift_period_suffix: nil, binmode: false, reraise_write_errors: []) -> Logger::LogDevice[permalink][rdoc][edit]

ログの出力先を初期化します。

[PARAM] log:
ログの出力先。ログを書き込むファイル名か、IO オブジェクトを指定します。省略すると nil が使用されますが、実行中に例外が発生します。
[PARAM] shift_age:
ログファイルを保持する数か、ログファイルを切り替える頻度を指定します。頻度には daily, weekly, monthly を文字列で指定できます。 log にファイル名を指定した場合のみ有効です。省略した場合は 7 です。
[PARAM] shift_size:
shift_age を整数で指定した場合のみ有効です。このサイズ(バイト数)でログファイルを切り替えます。省略した場合は 1048576 (1 MByte) です。
[PARAM] shift_period_suffix:
daily、weekly、monthly でログファイルの切り替えを行う時のログファイルの名の末尾に追加する文字列のフォーマットを指定します。省略した場合は '%Y%m%d' です。
[PARAM] binmode:
ログファイルをバイナリモードで書き込むかどうかを指定します。省略した場合は false です。
[PARAM] reraise_write_errors:
ログの書き込みやログファイルの切り替えで発生した例外のうち、再度 raise する例外クラスの配列を指定します。それ以外の例外は警告を出して無視します。省略した場合は空配列です。

[SEE_ALSO] Logger.new

インスタンスメソッド

close -> nil[permalink][rdoc][edit]

出力先の IO オブジェクトを閉じます。

このメソッドは同期されます。

[SEE_ALSO] IO#close

dev -> IO[permalink][rdoc][edit]

出力先の IO オブジェクトを取得します。

filename -> String | nil[permalink][rdoc][edit]

出力先のファイル名を取得します。

出力先がファイルではない場合は nil を返します。

write(message) -> Integer[permalink][rdoc][edit]

出力先の IO オブジェクトにメッセージを書き込みます。

このメソッドは同期されます。

[SEE_ALSO] IO#write