Obaq::Logライブラリを使用するには、下記の手順が必要となります。
Obaqモジュールをincludeする
require "obaq/log"を行ない、include Obaqしてください。
初期化メソッドを呼び出す
ソースの先頭で(includeの直後に) Log::setup_default等の初期化メソッドを呼び出して下さい。
カテゴリーの生成
log = Log::lgc.get_category(カテゴリー名)
出力メソッドの使用
カテゴリに対して info(メッセージ) などのログ出力メソッドを呼び出します。
つまり、まとめると以下のようになります。
require "obaq/log"
include Obaq
Log::setup_default
log = Log::lgc.get_category("msg")
log.info("info msg")
ログの出力やカテゴリの設定を行う前に、初期化メソッドを実行してください。
初期化メソッドには以下の種類があります。
setup_default
INFOレベル以上の全てのメッセージをコンソールに出力するように設定します。
setup_debug
全てのメッセージをファイル名、行番号、メソッド名つきでコンソールに出力するように設定します。
出力例
debug:log1.rb:37:main:debug msg
debug:log1.rb:39:main:2001-05-22
debug:log1.rb:40:main:#<Date: 2452052,2299161>
debug:log1.rb:41:main:info msg
setup
デフォルトの設定ファイル(obaqlog.conf)から設定します。
setup_from_file(ファイル名)
指定した設定ファイルから設定します。
setup_inline <<-END
プログラム内にインラインで記述した設定ファイルから設定します。
簡単に使用するには、デバッグ中はsetup_debugを使用し、運用時にはsetup_defaultを使用してください。
その他のメソッドは細かい設定が必要な場合に使用します。