class WEBrick::BasicLog (Ruby 3.0 リファレンスマニュアル)

要約

ログを取る機能を提供するクラスです。

特異メソッド

new(log_file = nil, level = WEBrick::BasicLog::INFO) -> WEBrick::BasicLog[permalink][rdoc][edit]

WEBrick::BasicLog オブジェクトを生成して返します。

[PARAM] log_file:: ログを記録する先のオブジェクトを指定します。メソッド << が定義されている必要があります。通常は String オブジェクトか IO オブジェクトです。nil を指定した場合、標準エラー出力にログを出力します。
[PARAM] level:: ログレベルを定数で指定します。このログレベルと同じかより重要なレベルのデータのみを記録します。ログレベルは重要度の順に FATAL, ERROR, WARN, INFO, DEBUG の5段階があります。 FATAL の重要度が一番高く DEBUG が一番低いです。

require 'webrick'
logger = WEBrick::BasicLog.new('testfile', WEBrick::BasicLog::FATAL)

インスタンスメソッド

self << obj -> ()[permalink][rdoc][edit]

指定された obj を to_s メソッドで文字列に変換してから、ログレベル INFO でログに記録します。

[PARAM] obj:: 記録したいオブジェクトを指定します。文字列でない場合は to_s メソッドで文字列に変換します。

require 'webrick'
logger = WEBrick::BasicLog.new()
logger << 'hoge'

close -> ()[permalink][rdoc][edit]

自身を閉じます。ログを取ることができなくなります。

debug(msg) -> ()[permalink][rdoc][edit]

ログレベル DEBUG で文字列 msg をログに記録します。自身の level が DEBUG より重要度が高い場合には記録しません。

行頭に level を表す文字列が追加されます。 msg の終端が "\n" でない場合には "\n" を追加します。

[PARAM] msg:: 記録したい文字列を指定します。文字列でない場合は to_s メソッドで文字列に変換します。

debug? -> bool[permalink][rdoc][edit]

自身のログレベルが DEBUG 以上の時に true を返します。そうでない場合に false を返します。

error(msg) -> ()[permalink][rdoc][edit]

ログレベル ERROR で文字列 msg をログに記録します。自身の level が ERROR より重要度が高い場合には記録しません。

行頭に level を表す文字列が追加されます。 msg の終端が "\n" でない場合には "\n" を追加します。

[PARAM] msg:: 記録したい文字列を指定します。文字列でない場合は to_s メソッドで文字列に変換します。

error? -> bool[permalink][rdoc][edit]

自身のログレベルが ERROR 以上の時に true を返します。そうでない場合に false を返します。

fatal(msg) -> ()[permalink][rdoc][edit]

ログレベル FATAL で文字列 msg をログに記録します。

行頭に level を表す文字列が追加されます。 msg の終端が "\n" でない場合には "\n" を追加します。

[PARAM] msg:: 記録したい文字列を指定します。文字列でない場合は to_s メソッドで文字列に変換します。

require 'webrick'
logger = WEBrick::BasicLog.new()
logger.fatal('out of money')       #=> FATAL out of money   (標準エラー出力に出力)

fatal? -> bool[permalink][rdoc][edit]

自身のログレベルが FATAL 以上の時に true を返します。そうでない場合に false を返します。

info(msg) -> ()[permalink][rdoc][edit]

ログレベル INFO で文字列 msg をログに記録します。自身の level が INFO より重要度が高い場合には記録しません。

行頭に level を表す文字列が追加されます。 msg の終端が "\n" でない場合には "\n" を追加します。

[PARAM] msg:: 記録したい文字列を指定します。文字列でない場合は to_s メソッドで文字列に変換します。

info? -> bool[permalink][rdoc][edit]

自身のログレベルが INFO 以上の時に true を返します。そうでない場合に false を返します。

level -> Integer[permalink][rdoc][edit]

level=(lv)

自身のログレベルを表すアクセサです。

[PARAM] lv:: ログレベルを定数で指定します。

log(level, msg) -> ()[permalink][rdoc][edit]

指定された msg を指定されたログレベル level でログに記録します。

[PARAM] level:: 記録したい msg のレベルを FATAL, ERROR, WARN, INFO, DEBUG のいずれかの定数で指定します。
[PARAM] msg:: 記録したい文字列を指定します。

warn(msg) -> ()[permalink][rdoc][edit]

ログレベル WARN で文字列 msg をログに記録します。自身の level が WARN より重要度が高い場合には記録しません。

行頭に level を表す文字列が追加されます。 msg の終端が "\n" でない場合には "\n" を追加します。

[PARAM] msg:: 記録したい文字列を指定します。文字列でない場合は to_s メソッドで文字列に変換します。

warn? -> bool[permalink][rdoc][edit]

自身のログレベルが WARN 以上の時に true を返します。そうでない場合に false を返します。

定数

DEBUG[permalink][rdoc][edit]: ログレベルを表す定数です。重要度は5番です。
ERROR[permalink][rdoc][edit]: ログレベルを表す定数です。重要度は2番です。
FATAL[permalink][rdoc][edit]: ログレベルを表す定数です。重要度は1番です。
INFO[permalink][rdoc][edit]: ログレベルを表す定数です。重要度は4番です。
WARN[permalink][rdoc][edit]: ログレベルを表す定数です。重要度は3番です。

要約

目次

特異メソッド

インスタンスメソッド

定数