log4j

出典: フリー百科事典『ウィキペディア(Wikipedia)』
移動: 案内検索
Apache log4j
開発元 Apacheソフトウェア財団
最新版 1.2.17 / 2012年5月6日(2年前) (2012-05-06
プラットフォーム クロスプラットフォーム
種別 ロギングツール
ライセンス Apache 2.0 ライセンス
公式サイト http://logging.apache.org/log4j
テンプレートを表示

Apache log4jは、Javaロギングユーティリティ。元々はCeki Gülcüにより開発されていたが、現在はApacheソフトウェア財団のプロジェクトの一つとなっている。主にデバッグ用ツールとして使用されている。log4jは、Java Logging Frameworksの一つである。

Ceki Gülcüはその後、log4j互換の後継として、SLF4J[1]Logbackの開発プロジェクトを立ち上げている。

機能[編集]

ログレベル[編集]

log4jは、6つのログレベルを標準提供する。この他に利用者が任意のログレベルを追加することも可能である。ログレベルが高い(情報量が少ない)ものから低い(情報量が多い)ものへと順に並べると下表の通り。

FATAL 致命的なエラー。プログラムの異常終了を伴うようなもの。コンソール等に即時出力することを想定
ERROR エラー。予期しないその他の実行時エラー。コンソール等に即時出力することを想定
WARN 警告。廃要素となったAPIの使用、APIの不適切な使用、エラーに近い事象など、実行時に生じた異常とは言い切れないが正常とも異なる何らかの予期しない問題。コンソール等に即時出力することを想定
INFO 情報。実行時の何らかの注目すべき事象(開始や終了など)。コンソール等に即時出力することを想定。従ってメッセージ内容は簡潔に止めるべき
DEBUG デバッグ用の情報。システムの動作状況に関する詳細な情報。コンソールではなくログ上にだけ出力することを想定
TRACE トレース情報。更に詳細な情報。コンソールではなくログ上にだけ出力することを想定

設定ファイル[編集]

log4jは、二つの方法で設定が可能である。一つはプロパティファイル、もう一つはXMLファイルである。両者とも、3つの主要なコンポーネント(ロガー、アペンダ、レイアウト)について定義することができる。ファイルにより設定を行うため、log4jを使用しているアプリケーションを変更することなく、ロギングをon/offできるという利点がある。たとえば、問題が発生するまではロギングをoffで動作させておき、設定ファイルを変更することで簡単にロギングを再開する、という使い方ができる。

ロガー(Loggers)は論理的なログファイル名であり、Javaアプリケーションはこれらの名前を意識する。個々のロガーにて取得するログのレベル(FATAL、ERROR等々)はロガー毎に独立に設定できる。古いバージョンのlog4jでは、これらは「カテゴリ」と「優先度」と呼ばれていたが、現バージョンではそれぞれ「ロガー」と「レベル」と呼んでいる。

アペンダ(Appenders)は具体的な出力処理を行う。アペンダには様々な種類があり、それぞれ内容を表す名前が付いている。例えばFileAppender、ConsoleAppender、SocketAppender、SyslogAppender、NTEventLogAppenderなどがあり、SMTPAppenderというものさえある。任意のロガーには複数のアペンダを付与できるので、同じログ情報を例えばローカルのファイルと他のコンピュータ上のソケット(en)リスナに同時に出力する、などという使い方が可能。

レイアウト(Layouts)は一件ずつのログを整形するためにアペンダによって参照される。例えば行単位に出力するログを整形する方法としてPatternLayoutというものがあり、これはC言語printf関数によく似た書式指定子を使える。他にもHTMLLayoutやXMLLayoutなどがあり、これらはそれぞれHTMLやXMLの書式に整形したい場合に使える。

設定例[編集]

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE log4j:configuration PUBLIC
"http://logging.apache.org/log4j/docs/api/org/apache/log4j/xml/log4j.dtd">
<log4j:configuration>
    <!-- アペンダとは出力先のことであり、例えばコンソールやファイルを指す。
    アペンダの名前は好きに決めてよい。-->
    <appender name="stdout" class="org.apache.log4j.ConsoleAppender">
        <layout class="org.apache.log4j.PatternLayout">
            <param name="ConversionPattern"
                value="%d{ABSOLUTE} %5p %c{1}:%L - %m%n" />
        </layout>
    </appender>
 
    <!-- 'org.springframework'カテゴリのロガーは、infoレベル以上のメッセージのみロギングする。
    もしロガーをクラス名で検索し(例:Logger.getLogger(AClass.class))AClassが
    springframework.orgパッケージに属するなら、そのロガーはこのカテゴリに属する。-->
    <logger name="org.springframework">
        <level value="info"/>
    </logger>
 
    <!-- springは原則としてinfo以上のログしか取らないが、PropertyEditorRegistrySupportクラスについては
    デバッグログも欲しい-->
    <logger name="org.springframework.beans.PropertyEditorRegistrySupport">
        <level value="debug"/>
    </logger>
 
    <logger name="org.acegisecurity">
        <level value="info"/>
    </logger>
 
    <root><!-- rootカテゴリ -->
        <!-- 別途定義が無い限り、デバッグレベル以上の全てのメッセージをロギングする。-->
        <!-- 別途定義が無い限り、全てのログは「stdout」アペンダにてロギングされる。 -->
        <level value="debug" />
        <appender-ref ref="stdout" />
    </root>
</log4j:configuration>

(訳注:この設定例中に出現する「カテゴリ」という用語と、「ロガー」の旧称としての「カテゴリ」との関係は不詳。)

ログビューア[編集]

ApacheにはChainsawen)という別プロジェクトが存在しており、これはlog4jにて生成されたログファイルを利用する。ChainsawはJavaベースのGUIビューアであり、豊富な機能を持つ。Chainsawもlog4jに類似した設定ファイルを使用する。log4j向けのビューアは他にもあるが(例:log2webオープンソースかつウェブベース)、Chainsawに比較して機能が少ない。

外部リンク[編集]

ポート[編集]