カスタムログ書式

カスタムログ書式 + +

LogFormat ディレクティブと + CustomLog + ディレクティブの書式を指定する引数は文字列です。この文字列を使ってそれぞれの + リクエストがログファイルにログ収集されます。その文字列には + ログファイルにそのまま + 書かれる文字列や、それぞれ改行とタブを現す C 言語 + 形式の制御文字 "\n" と "\t" + とを含めることができます。そのまま出力させたい引用符とバックスラッシュは + バックスラッシュでエスケープする必要があります。

+ +

リクエストの特徴そのものは "%" + ディレクティブを書式の文字列に書くことで + ログ収集されます。"%" + ディレクティブはログファイル中では以下のような + 値で置換されます:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

フォーマット文字列説明

%% パーセント記号

%...a リモート IP アドレス

%...A ローカル IP アドレス

%...B HTTP ヘッダ以外の送られたバイト数

%...b HTTP ヘッダ以外の送られたバイト数。CLF 書式。 + すなわち、1 バイトも送られなかったときは 0 ではなく、 + '-' になる

%...{Foobar}C サーバに送られたリクエスト中のクッキー Foobar の値

%...D リクエストを処理するのにかかった時間、ミリ秒単位

%...{FOOBAR}e 環境変数 FOOBAR の内容

%...f ファイル名

%...h リモートホスト

%...H リクエストプロトコル

%...{Foobar}i サーバに送られたリクエストの Foobar: + ヘッダの内容

%...l (identd からもし提供されていれば) リモートログ名。 + これは mod_ident がサーバに存在して、 + IdentityCheck + ディレクティブが On に設定されていない限り、 + - になります。

%...m リクエストメソッド

%...{Foobar}n 他のモジュールからのメモ Foobar の内容

%...{Foobar}o 応答の Foobar: ヘッダの内容

%...p リクエストを扱っているサーバの正式なポート

%...P リクエストを扱った子プロセスのプロセス ID

%...{format}P リクエストを扱ったワーカーのプロセス ID かスレッド ID。 + format として有効な値は pid と tid +

%...q 問い合せ文字列 (存在する場合は前に ? が追加される。 + そうでない場合は空文字列)

%...r リクエストの最初の行

%...s ステータス。内部でリダイレクトされたリクエストは、元々の + リクエストのステータス --- 最後のステータスは %...>s +

%...t 時刻。CLF の時刻の書式 (標準の英語の書式)

%...{format}t format で与えられた書式による時刻。format は + strftime (3) の + 書式である必要がある。(地域化されている可能性がある)

%...T リクエストを扱うのにかかった時間、秒単位

%...u リモートユーザ (認証によるもの。ステータス (%s) が + 401 のときは意味がないものである可能性がある) +

%...U リクエストされた URL パス。クエリ文字列は含まない

%...v リクエストを扱っているサーバの正式な ServerName

%...V UseCanonicalName の設定によるサーバ名

%...X

応答が完了したときの接続ステータス: + + + + + + + + + +

`X` =	応答が完了する前に接続が異常終了
`+` =	応答が送られた後に接続を持続することが可能
`-` =	応答が送られた後に接続が切られる

+ +

(このディレクティブは Apache + 1.3 の後期のバージョンでは %...c に割り当てられて + いましたが、これは歴史的に ssl が使用している + %...{var}c + 構文と衝突していました。)

%...I リクエストとヘッダを含む、受け取ったバイト数。 + 0 にはならない。 + これを使用するためには mod_logio が必要

%...O ヘッダを含む、送信したバイト数。0 にはならない。 + これを使用するためには mod_logio が必要

+ +

"..." は何もないか (例えば、 + "%h %u %r %s %b" のように)、 + その項目を含めるかどうかの条件 (もし条件に合わなかったときは + その項目は "-" になります) にすることができます。条件の形式は + HTTP ステータスコードのリストで、前に "!" を付けることもできます。 + ですから、"%400,501{User-agent}i" は 400 エラーと 501 エラー + (Bad Request と Not Implemented) のときのみ User-agent: + をログ収集します。 + "%!200,304,302{Referer}i" は普通のステータスを返さなかった + すべてのリクエストで Referer: をログ収集します。

+ +

httpd 2.0 の 1.3.25 より前のバージョンでは、 + %...r, %...i, + %...o の文字列は + エスケープされていなかったことに + 注意してください。これは主に Common Log Format からの要求によるものです。 + これは、クライアントがログに制御文字を挿入することができるということで、 + 生のログファイルを扱うときには非常に注意が必要でした。

+ +

セキュリティ上の理由により 2.0.46 より印字不可能な文字と + 他の特別な文字は、ほとんど \xhh という + 文字列でエスケープされるようになりました。ここで、hh は + そのままのバイトの値の 16 進での値です。この規則の例外には、 + バックスラッシュを使ってエスケープされる " と \ と、 + C 形式の表記法が使われる空白文字 (\n, \t など) が + あります。

+ +

よく使われるフォーマット文字列は:

+ +

Common Log Format (CLF): "%h %l %u %t \"%r\" %>s %b"
バーチャルホスト付き Common Log Format: "%v %h %l %u %t \"%r\" %>s %b"
NCSA extended/combined ログ書式: "%h %l %u %t \"%r\" %>s %b \"%{Referer}i\" + \"%{User-agent}i\""
Referer ログ書式: "%{Referer}i -> %U"
Agent (ブラウザ) ログ書式: "%{User-agent}i"

+ +

%v と %p にはそれぞれ、 + リクエストを扱っているサーバの正規化された + ServerName と Listen が使われるということに注意してください。 + これは UseCanonicalName の + 設定に関わらず、常にそうなります。そうしないとどの + ホストが実際にリクエストを扱ったのかを知るために、 + ログ解析プログラムがバーチャルホストのマッチングをとるアルゴリズム全体を + 再実装しなければならなくなるからです。