logformat

以前の名前:
動作条件:
デフォルト値: Squidのフォーマット定義は、squid標準以外としてcommon, combined, referrer, useragentを内蔵しています。
提案された設定:

アクセスログのフォーマット定義。

使用方法：

logformat <name> <format specification>

<format specification> は %書式コードが埋め込まれた文字列です。

%での書式コードは全てが同じ基本構造に従っていますが、書式コードはすべてオプションです。
出力文字列は、通常必要となれていないものはエスケープされ、必要なものだけが出力フォーマットにより出力されますが、必要に応じてそのフォーマットを明示的な出力フォーマットとして指定することができます。

% ["|[|'|#] [-] [[0]width] [{argument}] フォーマットコード

"	引用符で囲まれた文字列形式で出力
[       log_mime_hdrsを使ってSquidテキストログ形式を出力
#       URLの引用内のフォーマットを出力
'       そのまま出力
-       左揃え
width   最小/最大フィールド幅：
           [width_min][.width_max]
        最小値が0で始まる場合、フィールドはゼロが埋め込まれます。
        最大幅を超える文字列は切り捨てられます。
{arg}	ヘッダ名等などの引数

フォーマットコード：

%	   リテラル(literal:ありのまま)文字 %
sn         ログ行のエントリごとに固有シーケンス番号
err_code   Squidによって提供されるエラー応答のIDや内部エラーの識別子
err_detail 追加の err_code-dependent エラー情報
note       引数で指定されたメタヘッダー。
           さらに adaptation_meta 設定パラメータで設定された適応メタヘッダをログに記録します。
           引数が与えられなかった場合は、すべてのメタヘッダが記録されます。

コネクション関連の書式コード：

>a	クライアントの送信元IPアドレス
>A	クライアントのFQDN名
>p	クライアントの送信元ポート番号
>eui	クライアントの送信元 EUI (MACアドレス, EUI-48 または EUI-64 識別子)
>la     クライアントによって接続されたローカルIPアドレス
>lp     クライアントによって接続されたローカルポート番号
>qos    Squidが設定したクライアント接続のTOS/ DSCP値
>nfmark Squidが設定したクライアント接続のnetfilterマーク
la      クライアントによって接続されたローカルリスニングIP(Local listening IP)アドレス
lp	クライアントによって接続されたローカルリスニングポート(Local listening port)番号
<a      最後のサーバーまたはピア接続のサーバのIPアドレス
<A	サーバまたはピアのFQDN名
<p      最後のサーバーまたはピア接続のサーバのポート番号
<la	最後のサーバーまたはピア接続のローカルIPアドレス
<lp     最後のサーバーまたはピア接続のローカルポート番号
<qos	Squidが設定したサーバ接続の TOS/DSCP値
<nfmark quidが設定したサーバ接続のnetfilterマーク

時間に関連する書式コード

ts	時代由来の秒
tu	秒未満の時間 (ミリ秒)
tl      ローカル時間。オプションのstrftimeのフォーマット引数：
                default %d/%b/%Y:%H:%M:%S %z
tg	GMT時間。 オプションのstrftimeのフォーマット引数：
                default %d/%b/%Y:%H:%M:%S %z
tr      応答時間（ミリ秒）
dt	DNS検索を行った合計時間 (ミリ秒)

アクセス制御に関連する書式コード

et	外部のACLで返されるTag
ea	外部のACLで返されるログ文字列
un	ユーザ名 (すべての利用可能な)
ul      認証によるユーザ名
ue	外部ACLヘルパーによるユーザ名
ui	identによるユーザ名
us	SSLによるユーザ名

HTTPに関連する書式コード

[http::]>h	オリジナルから受信したリクエストヘッダー。
                殆どのフィールドは多くの場合保持されますが、Squidから送信された
                リクエストヘッダーと通常は異なります。 name[:[separator]element]
                形式のフィルター引数を使用して、オプションのヘッダーフィールドの
                name/valueを受け取ります。 
[http::]>ha     アダプテーション(adaptation/適応)とリダイレクト後に受信したリクエ
                ストヘッダ。殆どのフィールドは多くの場合保持されますが、Squidから
                送信されたリクエストヘッダーと通常は異なります。オプションのヘッ
                ダー名の引数は >h と同じ。
[http::]<h	リプライ(Reply)ヘッダー. オプションのヘッダー名の引数は >h と同じ。
[http::]>Hs     クライアントに送信されるHTTPステータスコード
[http::]<Hs	次のホップ(next hot)から受信したHTTPステータスコード
[http::]<bs     転送エンコード(transfer encoding)および制御メッセージの塊を除く、
                次のホップ(next hop)から受信した HTTP-equivalentのメッセージ本体の
                バイト数。FTP/Gopherで生成されるリストは受信された本体として扱われ
                ます。
[http::]mt	MIME コンテンツタイプ
[http::]rm	リクエストメソッド(GET/POST etc)
[http::]>rm	クライアントからのリクエストメソッド
[http::]<rm	サーバーまたはピア(peer)に送信したリクエストメソッド
[http::]ru	クライアントからのリクエストURL (ログのためにフィルターされた歴史)
[http::]>ru     クライアントからのリクエストUR
[http::]<ru	サーバーまたはピア(peer)に送信したリクエストURL
[http::]rp	ホスト名を除外したリクエストのURLパス
[http::]>rp	ホスト名を除外したクライアントからのリクエストのURLパス
[http::]<rp	ホスト名を除外したサーバーまたはピア(peer)に送信したリクエストのURL
                パス
[http::]rv	リクエストしたプロトコルバージョン
[http::]>rv	クライアントからのリクエストしたプロトコルバージョン
[http::]<rv	サーバーまたはピア(peer)からのリクエストしたプロトコルバージョン
[http::]<st	HTTPヘッダを含む送信されたリプライサイズ（応答サイズ）
[http::]>st	HTTPヘッダを含む受信要求サイズ。
                チャンクリクエスト(chunked requests)の場合、チャンク(塊)されたエン
                コードにメタデータは含まれていません。
[http::]>sh	受信したHTTPリクエストヘッダのサイズ
[http::]<sh	送信されたHTTP応答ヘッダーのサイズ
[http::]st	HTTPヘッダを含むリクエスト+返信サイズ
[http::]<sH	ハイ・オフセット送信の応答(Reply high offset sent)
[http::]<sS	Upstream オブジェクトのサイズ
[http::]<pt     ミリ秒単位のピアの応答時間。 タイマーは最後の要求バイトが次のホップ
                に送信されたときに開始し、最後の応答バイトを受信したときに停止します。
[http::]<tt	ミリ秒単位のサーバー側の合計の時間。
                タイマーは、最初に選択したピアに送信される最初の接続要求（またはI/O
                の書込み）で始まる。
                タイマーは、最後のピアとの最後のI/Oで停止します。

Squidの取り扱いに関連する書式コード

Ss	Squidのリクエストのステータス（TCP_MISSなど）
Sh	Squidの階層のステータス(DEFAULT_PARENTなど)

SSLに関連する書式コード

ssl::bump_mode	SslBumpのトランザクションの決定：
                全てのリクエストがバンピング(bumping)接続の上で受信できるように、バン
                ピング接続の開始のCONNECTリクエストにおいて Squidは対応した SslBump の
                モード("server-first" または "client-first")を記録する。
                これらのモードの詳細については ssl_bump オプションを参照してください。

                リクエストによって"none"ルールまたは全ルールに一致しない"ssl_bump" の
                ACL評価を引き起こした場合、"none"トークンが記録されます。

                それ以外の場合は、単一のダッシュ("-")が記録されます。

ICAPが有効になっている場合、次のコードは使用可能になる
（同様にICAPログコードはicap_logオプションを使用して文書化される）

icap::tt        HTTPトランザクションでのICAP処理時間の合計。
                ICAP ACLがチェックされ、ICAP処理が進行中である場合タイマーは進行します。

adapt::<last_h	HTTPトランザクションに関係する、最後のeCAPトランザクションからの最後の
                ICAPレスポンスまたはメタ情報のヘッダー。
                <h と同様に、オプションのヘッダー名(header name)の引数を受け入れます。

adapt::sum_trs トランザクションの開始時間の順で、コンマで区切られたリストとして適応トラ
               ンザクション応答時間(adaptation transaction response times)は合算され記
               憶される。
               各時間の値は、1つ又はそれ以上の適応ミリ秒(ICAPまたはeCAP)トランザクション
               の応答時間を表す整数値として記録される。
               失敗したトランザクションを再試行または反復されている場合、その時間は個々
               に記録されますが、交換(次の)トランザクションに追加されません。
               参照： adapt::all_trs
adapt::all_trs すべての適応(adaptation)トランザクション応答時間。
               adaptation_strs が、個々のトランザクションの応答時間と同じに加算される
               ことはありません。代わりに、すべてのトランザクション応答時間は個別に記録
               されます。

プレフィックスが adapt::*_trs の書式コードを中括弧内の適応サービス名と共に含んでいると、そのサービス固有の応答時間(s)を記録します。
例として： %{my_service}adapt::sum_trs

SSLが有効な場合、次の書式コードが使用できるようになります：

%ssl::>cert_subject Squidが、無効/不正な形式の証明書または証明書全く受け取っていない場合
                    の、受信したクライアントのSSL証明書またはダッシュ('-')の件名(Subject)
                    フィールド。
                    件名は頻繁にスペースが含まれているため、記録された値を符号化すること
                    を検討してください。

%ssl::>cert_issuer Squidが、無効/不正な形式の証明書または証明書全く受け取っていない場合
                    の、受信したクライアントのSSL証明書またはダッシュ('-')の発行者(Issuer)
                    フィールド。
                    発行者(Issuer)は頻繁にスペースが含まれているため、記録された値を符号
                    化することを検討してください。

利用可能なデフォルト(再定義を必要としない)の形式は次のとおりです。：

logformat squid      %ts.%03tu %6tr %>a %Ss/%03>Hs %<st %rm %ru %[un %Sh/%<a %mt

logformat common     %>a %[ui %[un [%tl] "%rm %ru HTTP/%rv" %>Hs %<st %Ss:%Sh

logformat combined   %>a %[ui %[un [%tl] "%rm %ru HTTP/%rv" %>Hs %<st "%{Referer}>h" "%{User-Agent}>h" %Ss:%Sh

logformat referrer   %ts.%03tu %>a %{Referer}>h %ru

logformat useragent  %>a [%tl] "%{User-Agent}>h"

ディレクティブ: logformat