YKLook説明書 クラス解説 YKLookLog 機能別   ABC
ページ内リンク一覧   スーパークラス   クラスメソッド   インスタンスメソッド   その他の項目  

YKLookLog


エラーログ、トレースログ、デバッグログ等、各種ログ出力用のクラスです。




クラスメソッド:   new   yk_log   yk_print   yk_print_exception
インスタンスメソッド:   yk_delete   yk_fullpath   yk_print   yk_print_exception   yk_set_dirname   yk_set_filename   yk_set_fullpath   yk_set_sizelimit
その他の項目: なし


 Object (Ruby 組み込みのクラス。すべてのオブジェクトのスーパークラス)
   ┃
   ┗ YKLookLog (このクラス)


new()  
new( path )
new( path , size )

インスタンスを生成します。
引数 path を使って yk_set_fullpath() を呼び出します。
引数 size を使って yk_set_sizelimit() を呼び出します。

引数 path の省略時の値は nil です。
引数 size の省略時の値は 1048576 です。
1048576 1024 * 1024 つまり1MB(1メガバイト)です。




yk_log()  

デフォルトのインスタンスを返します。
主にエラーログの出力用です。
YKLook 内部でも使っています。




yk_print( obj , ... )  

デフォルトのインスタンスに対して同名のメソッドを呼びます。
詳細はインスタンスメソッドの YKLookLog#yk_print() をご覧ください。




yk_print_exception( ex , obj , ... )  

デフォルトのインスタンスに対して同名のメソッドを呼びます。
詳細はインスタンスメソッドの YKLookLog#yk_print_exception() をご覧ください。



yk_delete()  

出力先のファイルを削除します。
ファイル名が未設定の場合は yk_fullpath() を実行し、そのファイルを削除します。




yk_fullpath()  

出力先のファイル名をフルパスで返します。
未設定の場合はデフォルトの出力先を自動設定後、それを返します。
デフォルトの出力先のファイル名についてはエラーの解決・デバッグ>ログファイルの説明をご覧ください。




yk_print( obj , ... )    

引数で指定された任意の個数のオブジェクトの内容をそれぞれ文字列にして、ログファイルに出力します。

引数のオブジェクトが配列のときは、その添字と要素を出力します。
引数のオブジェクトがハッシュのときは、そのキーと値を出力します。
配列の要素やハッシュの値が、さらに配列やハッシュの場合には、再帰的に出力処理をします。
その他のオブジェクトのときは、そのオブジェクトの to_s() メソッドの結果を出力しますが、その結果の文字列サイズが 200 バイトを超える場合はサイズのみを出力します。

ファイルへの出力時、ディスクとの同期をとっています。
出力先のファイル名は、後述のメソッドで事前に設定されていれば、それに出力します。未設定のときは、デフォルトの出力先になります。
デフォルトの出力先のファイル名についてはエラーの解決・デバッグ>ログファイルの説明をご覧ください。

このメソッドの呼び出しごとに、その時点での現在時刻とプロセスIDも出力します。
このメソッドの呼び出しまでのバックトレースの情報も出力したいときは yk_print_exception() を使ってください。

ログをファイルに出力する前にそのファイルのサイズを調べます。
ログファイルのサイズが指定値を超えたら、そのファイルをバックアップ用のファイル名に変更し、このファイルへの出力を止めます。
そして新しくログファイルをオープンしなおしてログを出力します。

バックアップ用のファイル名は、もとのファイル名に枝番「 _1 」を付けたものです。
ログファイルのサイズが指定値を超えるたびに、バックアップ用のファイルを上書きします。
限度サイズは1MB( 1048576 バイト)ですが、 yk_set_sizelimit() を使えば変更できます。




yk_print_exception( ex , obj , ... )    

yk_print() の処理内容に加えて、このメソッドの呼び出しまでのバックトレースの情報と、引数の ex で指定された例外クラスの出力処理もおこないます。
例外クラスの出力情報は、例外クラスの名前・メッセージ・バックトレースです。 YKLookError とその派生クラスの場合は付加情報も出力します。

例外クラスの出力は必要ないが、このメソッドの呼び出しまでのバックトレースの情報は出力したいときは、引数 ex true を指定してください。
このとき、このメソッドはバックトレース出力付きの yk_print() になります。




yk_set_dirname( dirname )  

出力先のディレクトリを指定します。
指定されたディレクトリがディスク上になければ自動作成します。
自動作成したときは、同時に chmod( 0777 ) も実行します。

注意: 自動作成するのは末端のディレクトリのみです。
それ以外の部分のディレクトリがないときは、エラーです。

引数 dirname nil のときは、ディレクトリを未設定の状態にします。

デフォルトの出力先についてはエラーの解決・デバッグ>ログファイルの説明をご覧ください。




yk_set_filename( filename )  

出力先のファイル名を指定します。ディレクトリ部分を除きます。
引数で指定されたファイル名にディレクトリが付いていた場合、そのディレクトリ部分を削除したものをファイル名とします。
引数に nil が指定されたときは未設定の状態にします。

ディレクトリを指定するときは yk_set_dirname() を使ってください。
ディレクトリも含んだパス名で指定するときは yk_set_fullpath() を使ってください。

デフォルトの出力先についてはエラーの解決・デバッグ>ログファイルの説明をご覧ください。




yk_set_fullpath( path )  

出力先のファイル名をフルパスで指定します。
引数に nil が指定されたときは未設定の状態にします。
デフォルトの出力先についてはエラーの解決・デバッグ>ログファイルの説明をご覧ください。




yk_set_sizelimit( size )  

ログファイルの出力限度サイズをバイト数で指定します。
引数に nil が指定されたときは、サイズ無制限とみなします。
1024 よりも小さい数値は指定できません。
デフォルト値は 1048576 です。
1048576 1024 * 1024 つまり1MB(1メガバイト)です。

ログファイルのサイズが指定値を超えたら、そのファイルをバックアップ用のファイル名に変更し、このファイルへの出力を止めます。
そして新しくログファイルをオープンしなおしてログを出力します。

このメソッドで指定するサイズはファイルひとつ分のものです。
バックアップ用のファイルを含めたサイズとしては、このメソッドで指定した値の2倍になります。

バックアップ用のファイル名は、もとのファイル名に枝番「 _1 」を付けたものです。
ログファイルのサイズが指定値を超えるたびに、バックアップ用のファイルを上書きします。



なし



ページ内リンク一覧   スーパークラス   クラスメソッド   インスタンスメソッド   その他の項目  
YKLook説明書 クラス解説 YKLookLog 機能別   ABC


Copyright (c) 2003-2010 YorozuKotowariYa Ltd.