Home of: [工房 "藤車"] > [SourceForge.net における PTLog]

PTLog とは何か

本ドキュメントでは、 PTLog がどのようなものであるかを説明します。

PTLog が何をもたらすか

本節では、PTLog が利用者にもたらすものについて説明します。

基底フレームワークの差し替え可能性

PTLog は、 何時でも基底ログフレームワークの差し替え(= 選択)を行うことを可能にします。

本特徴により、 実装をログフレームワークに対して中立に保つことが出来ます。

詳細に関しては、 チュートリアル "ログフレームワークへの接続" 他を参照してください。

固有のログ分類

固有のログ分類の定義が可能です。 "ログ分類" は、一般的なログフレームワークにおける "ログレベル" とほぼ同等の意味を持ちます。

詳細に関しては、 チュートリアル "固有のログタイプ" 他を参照してください。

型ベースの分類

PTLog においては、 ログ分類は Java のクラス階層にマッピングされます。 一般的なログフレームワークにおける "スカラー値ベース" の分類に相対するものとして、 これを "型ベース" の分類と呼びます。

これにより、以下のことが可能となります:

詳細に関しては、 チュートリアル "固有のログタイプ" 他を参照してください。

値の整形

PTLog はさまざまな形式での指定 "値" の整形機能を提供します ("値" はログレコードの一部ではなく、ログメッセージの一部です)。

例えば、 int 値を16進形式で整形出来ます。

詳細に関しては、 チュートリアル "値のフォーマット" 他を参照してください。

1レコードへの詰め込み

PTLog は "+" 演算による結合をすること無しに、 複数の値を1レコードに詰め込む方法を提供します。

例えば、 メソッド引数の名前と値の全ての組を1レコードに詰め込むことが出来ます。

詳細に関しては、 チュートリアル "クライアントコードの記述" 他を参照してください。

PTLog が何をもたらさないか

本節では、PTLog が利用者にもたらさないものについて説明します。

備考: プロダクトとしての PTLog は、 java.io.Writer を用いたサンプル実装の基底ログフレームワークを内包しています。

しかし、 そのような実装は主として焦点を当てている事柄ではないため、 本節では当該部分に関しては 「PTLog によってもたらされるもの」としては扱いません。

出力のフィルタリング

ログ出力フィルタリングの決定および設定は、 PTLog ではなく基底ログフレームワークの責務です。

例えば、 Filter(JDK Logging API および Apache Log4j) がこの用途に利用されます。

しかし、繊細なフィルタリングを行う際には、 チュートリアル "固有のログタイプ" を参照する必要があるでしょう。

レコードの整形

最終的なログレコードの整形 (例: 日付/時刻、スレッド ID およびメッセージのレイアウト) は、 PTLog ではなく基底ログフレームワークの責務です。

例えば、 SimpleFormatter(JDK Logging API の場合)および PatternLayout(Apache Log4j の場合) がこの用途に利用されます。

レコードの書き出し

最終的なログレコードの書き出しは、 PTLog ではなく基底ログフレームワークの責務です。

例えば、 ConsoleHandler(JDK Logging API の場合)および ConsoleAppender(Apache Log4j の場合) がこの用途に利用されます。