Uses of Package
nablarch.core.log.basic
Package
Description
データベースに対するSQL実行機能を提供する。
各種ログの出力機能を提供する。
フレームワーク実装のログ出力機能を提供する。
運用担当者向けのログ出力機能を提供する。
NablarchのActionハンドラをJAX-RSのリソースクラスとして呼び出す事ができる機能を提供する。
nablarch.fw.launcher.Mainから出力するためのログメッセージをフォーマットする機能を提供する。
メッセージング処理中に出力されるログ情報に関連したクラスを格納したパッケージ。
画面オンライン処理方式向けフレームワーク標準ハンドラ。
-
-
-
ClassDescriptionファイルにログを書き込むクラス。
FileLogWriterクラスの特徴を下記に示す。
ログフォーマッタを設定で指定できる。 設定されたクラスに従いログファイルのローテーションを行うことができる。 初期処理と終了処理、ログファイルの切り替え時に、書き込み先のログファイルにINFOレベルでメッセージを出力する。 本クラスでは、ファイルへのログ書き込みにBufferedOutputStream
を使用する。
出力バッファのサイズは設定で変更できる。
書き込み処理では、書き込み後にすぐにフラッシュし、書き込んだ内容をファイルに反映する。
プロパティファイルの記述ルールを下記に示す。
filePath 書き込み先のファイルパス。必須。 encoding 書き込み時に使用する文字エンコーディング。オプション。
指定しなければシステムプロパティ(file.encoding)から取得した文字エンコーディング。 outputBufferSize 出力バッファのサイズ。オプション。
単位はキロバイト。1000バイトを1キロバイトと換算する。1以上を指定する。指定しなければ8KB。 rotatePolicy ファイルローテーション実行クラスのFQCNを指定する。オプション。
RotatePolicy
が実装されたクラスのFQCNを指定する。
デフォルトではFileSizeRotatePolicy
が使用される。
利用するローテーション実行クラス毎に、追加でプロパティの設定が必要となる。 本クラスでは、初期処理と終了処理、ログファイルの切り替え時に、書き込み先のログファイルにINFOレベルでメッセージを出力する。ログのフォーマットエラー出力を処理するインターフェース。構造化ログのオブジェクトを構築するインターフェース。ログ出力に必要な情報を保持するクラス。
スレッド名、ユーザID、リクエストIDは、スレッドに紐付く値をクラスの内部で設定する。ログのフォーマットを行うインタフェース。
ログのフォーマットの種類毎に本インタフェースの実装クラスを作成する。ログレベルを表す列挙型。
本フレームワークにおけるログレベルは、FATAL>ERROR>WARN>INFO>DEBUG>TRACEの6段階とし、FATALからTRACEに向かって順にレベルが低くなる。
レベルに応じた出力制御では、指定されたレベル以上のログを全て出力する。
例えば、WARNレベルが指定された場合は、FATALレベル,ERRORレベル,WARNレベルで出力を指示しているログのみ出力する。
ログレベルの定義を下記に示す。
下記を参考にプロジェクト毎にログレベルの使用方法を決定すること。 FATAL アプリケーションの継続が不可能になる深刻な問題が発生したことを示す。
監視が必須で即通報および即対応が必要となる。
通常は、運用監視体制と密接に関わるため、個別アプリケーションではなくフレームワークで出力する。 ERROR アプリケーションの継続に支障をきたす問題が発生したことを示す。
監視が必須であるが、通報および対応にFATALレベルほどの緊急性がない。
通常は、運用監視体制と密接に関わるため、個別アプリケーションではなくフレームワークで出力する。 WARN すぐには影響を与えないが、放置しておくとアプリケーションの継続に支障をきたす問題になる恐れがある事象が発生したことを示す。
できれば監視した方がよいが、ERRORレベルほどの重要性がない。
通常は、運用監視体制と密接に関わるため、個別アプリケーションではなくフレームワークで出力する。 INFO 本番運用時にアプリケーションの情報を出力するログレベル。
アクセスログや統計ログが該当する。
通常は、運用監視体制と密接に関わるため、個別アプリケーションではなくフレームワークで出力する。
ログファイルのサイズが肥大化しないよう出力内容を設計する。 DEBUG 開発時にデバッグ情報を出力するログレベル。
SQLログや性能ログが該当する。
本番運用時は、ログファイルのサイズが肥大化するため出力してはならない。 TRACE 開発時にデバッグ情報より、さらに細かい情報を出力したい場合に使用するログレベル。
本番運用時は、ログファイルのサイズが肥大化するため出力してはならない。LogPublisher
によって公開されたLogContext
を受け取るインタフェース。ログを出力先に書き込むインタフェース。
出力先の媒体毎に本インタフェースの実装クラスを作成する。LogWriter
の実装をサポートするクラス。
このクラスでは、下記の機能を提供する。LogLevel
に応じた出力制御LogFormatter
を使用したログのフォーマット 上記の機能は、プロパティファイルに設定を記述して使用する。
プロパティファイルの記述ルールを下記に示す。 writer.<LogWriter
の名称>.levelLogLevel
の名称。オプション。
LogLevel
の名称を指定する。
ここで指定したレベル以上のログを全て出力する。 指定がない場合はレベルに応じた出力制御を行わず、全てのレベルのログを出力する。 writer.<LogWriter
の名称>.formatter.classNameLogWriter
で使用するLogFormatter
のクラス名。
LogFormatter
を実装したクラスのFQCNを指定する。 指定がない場合はBasicLogFormatter
を使用する。 writer.<LogWriter
の名称>.formatter.<プロパティ名>LogFormatter
毎のプロパティに設定する値。
設定内容は、使用するLogFormatter
のJavadocを参照すること。ログ出力機能の設定からオブジェクトに対する設定を抜き出して保持するクラス。ログのローテーションを行うインタフェース。
ログのローテーションの種類毎に本インタフェースの実装クラスを作成する。 -
ClassDescriptionログレベルを表す列挙型。
本フレームワークにおけるログレベルは、FATAL>ERROR>WARN>INFO>DEBUG>TRACEの6段階とし、FATALからTRACEに向かって順にレベルが低くなる。
レベルに応じた出力制御では、指定されたレベル以上のログを全て出力する。
例えば、WARNレベルが指定された場合は、FATALレベル,ERRORレベル,WARNレベルで出力を指示しているログのみ出力する。
ログレベルの定義を下記に示す。
下記を参考にプロジェクト毎にログレベルの使用方法を決定すること。 FATAL アプリケーションの継続が不可能になる深刻な問題が発生したことを示す。
監視が必須で即通報および即対応が必要となる。
通常は、運用監視体制と密接に関わるため、個別アプリケーションではなくフレームワークで出力する。 ERROR アプリケーションの継続に支障をきたす問題が発生したことを示す。
監視が必須であるが、通報および対応にFATALレベルほどの緊急性がない。
通常は、運用監視体制と密接に関わるため、個別アプリケーションではなくフレームワークで出力する。 WARN すぐには影響を与えないが、放置しておくとアプリケーションの継続に支障をきたす問題になる恐れがある事象が発生したことを示す。
できれば監視した方がよいが、ERRORレベルほどの重要性がない。
通常は、運用監視体制と密接に関わるため、個別アプリケーションではなくフレームワークで出力する。 INFO 本番運用時にアプリケーションの情報を出力するログレベル。
アクセスログや統計ログが該当する。
通常は、運用監視体制と密接に関わるため、個別アプリケーションではなくフレームワークで出力する。
ログファイルのサイズが肥大化しないよう出力内容を設計する。 DEBUG 開発時にデバッグ情報を出力するログレベル。
SQLログや性能ログが該当する。
本番運用時は、ログファイルのサイズが肥大化するため出力してはならない。 TRACE 開発時にデバッグ情報より、さらに細かい情報を出力したい場合に使用するログレベル。
本番運用時は、ログファイルのサイズが肥大化するため出力してはならない。 -
-
-
-
ClassDescriptionログレベルを表す列挙型。
本フレームワークにおけるログレベルは、FATAL>ERROR>WARN>INFO>DEBUG>TRACEの6段階とし、FATALからTRACEに向かって順にレベルが低くなる。
レベルに応じた出力制御では、指定されたレベル以上のログを全て出力する。
例えば、WARNレベルが指定された場合は、FATALレベル,ERRORレベル,WARNレベルで出力を指示しているログのみ出力する。
ログレベルの定義を下記に示す。
下記を参考にプロジェクト毎にログレベルの使用方法を決定すること。 FATAL アプリケーションの継続が不可能になる深刻な問題が発生したことを示す。
監視が必須で即通報および即対応が必要となる。
通常は、運用監視体制と密接に関わるため、個別アプリケーションではなくフレームワークで出力する。 ERROR アプリケーションの継続に支障をきたす問題が発生したことを示す。
監視が必須であるが、通報および対応にFATALレベルほどの緊急性がない。
通常は、運用監視体制と密接に関わるため、個別アプリケーションではなくフレームワークで出力する。 WARN すぐには影響を与えないが、放置しておくとアプリケーションの継続に支障をきたす問題になる恐れがある事象が発生したことを示す。
できれば監視した方がよいが、ERRORレベルほどの重要性がない。
通常は、運用監視体制と密接に関わるため、個別アプリケーションではなくフレームワークで出力する。 INFO 本番運用時にアプリケーションの情報を出力するログレベル。
アクセスログや統計ログが該当する。
通常は、運用監視体制と密接に関わるため、個別アプリケーションではなくフレームワークで出力する。
ログファイルのサイズが肥大化しないよう出力内容を設計する。 DEBUG 開発時にデバッグ情報を出力するログレベル。
SQLログや性能ログが該当する。
本番運用時は、ログファイルのサイズが肥大化するため出力してはならない。 TRACE 開発時にデバッグ情報より、さらに細かい情報を出力したい場合に使用するログレベル。
本番運用時は、ログファイルのサイズが肥大化するため出力してはならない。 -