LogFormatディレクティブ：ログファイルのフォーマットを定義する

Apache では Apache で起動している Web サーバにアクセスしてきたユーザーのログを残すことができますが、ユーザーの情報の中からどのようなデータをログとして残すのかについてログのフォーマットを定義することができます。ここでは Apache のログファイルで使用するフォーマットを設定する方法について解説します。

(Last modified: 2024-06-08)

LogFormatディレクティブの使い方
新しいフォーマットを定義する

LogFormatディレクティブの使い方

Apache のログファイルで使用するフォーマットを定義するには LogFormat ディレクティブを使用します。書式は次のとおりです。

LogFormat フォーマットの定義フォーマット名

記述できる場所は httpd.conf, VirtualHost です。

フォーマットは複数定義しておくことができ、ログの保存場所を指定する CustomLog ディレクティブの設定でどのフォーマットを使ってログを記録していくのかを指定することができます。

※ CustomLog ディレクティブについては「CustomLogディレクティブ：ログファイルの名前と使用するフォーマットを選択する」を参照されてください。

フォーマットの定義は次の設定項目を組み合わせて行います。

設定値	意味
%%	パーセント記号(%)そのもの
%a	アクセス元のIPアドレス
%A	サーバ(Apache)のIPアドレス
%B	送信されたバイト数(ヘッダーは含まず)
%b	送信されたバイト数(ヘッダーは含まず)。0バイトの時は「-｣
%D	リクエストの処理時間(マイクロ秒単位)
%f	リクエストされたファイル名
%h	アクセス元のホスト名
%H	リクエストのプロトコル名
%l	クライアントの識別子
%m	リクエストのメソッド名
%p	ポート番号
%P	プロセスID
%q	リクエストに含まれるクエリー文字列。空白以外は「?」が付く
%r	リクエストの最初の行の値
%s	レスポンスステータス
%>s	最後のレスポンスのステータス
%t	リクエストを受け付けた時刻
%T	処理にかかった時間(秒単位)
%u	認証ユーザー名
%U	リクエストのURLパス
%v	リクエストに対するバーチャルホスト名
%V	UseCanonicalNameによるサーバ名
%X	接続ステータス
%{クッキー名}C	リクエストに含まれるクッキーの値
%{環境変数名}e	環境変数名の値
%{ヘッダー名}i	リクエストに含まれるヘッダー名の値
%{ヘッダー名}o	レスポンスに含まれるヘッダー名の値
%{メモ}n	モジュールから渡されるメモの値
%{フォーマット}t	フォーマットされたリクエストを受け付けた時刻

logio_module モジュールが利用できる場合は次のフォーマットも使用できます。

設定値	意味
%I	受け取ったバイト数
%O	送信したバイト数

これらの項目を列挙しダブルクォーテーション(")で囲って指定します。フォーマット中にダブルクォーテーションを記述する場合は「\」でエスケープして記述します。

項目の中には {} で囲んで記述される項目があります。例えば %{ヘッダー名}i はヘッダーの中からヘッダー名に指定した値だけを取り出して記録します。 %{User-Agent}i と記述した場合にはヘッダーの中の User-Agent の値を保存します。

例えば「アクセス元のIPアドレス」「リクエストされたファイル名」「レスポンスステータス」だけが必要であれば、 LogFormat ディレクティブを使って次のようなフォーマットを httpd.conf に記述してください。

LogFormat "%a %f %s" mylogformat

httpd.conファイルでの記述

httpd.conf ファイルではデフォルト次の 2 のフォーマットが定義されています。

<IfModule log_config_module>
    #
    # The following directives define some format nicknames for use with
    # a CustomLog directive (see below).
    #
    LogFormat "%h %l %u %t \"%r\" %>s %b \"%{Referer}i\" \"%{User-Agent}i\"" combined
    LogFormat "%h %l %u %t \"%r\" %>s %b" common

    <IfModule logio_module>
      # You need to enable mod_logio.c to use %I and %O
      LogFormat "%h %l %u %t \"%r\" %>s %b \"%{Referer}i\" \"%{User-Agent}i\" %I %O" combinedio
    </IfModule>

</IfModule>

LogFormatディレクティブの使い方(1)

ログのフォーマットとして common および combined 、そして logio_module が利用できる場合には combinedio も使用できます。

common フォーマットは次のような構成になっています。ログの保存として common を指定した場合はこれらの情報が 1 行で記録されていきます。

%h    アクセス元のホスト名
%l    クライアントの識別子
%u    認証ユーザー名
%t    リクエストを受け付けた時刻
\%r\  リクエストの最初の行の値
%>s   最後のレスポンスのステータス
%b    送信されたバイト数

combined フォーマットは common フォーマットに次のような項目が追加されています。

\%{Referer}i\     リファラー
\%{User-Agent}i\  User Agent

combinedio フォーマットは combined フォーマットに次のような項目が追加されています。

%I  受け取ったバイト数
%O  送信したバイト数

これらのデフォルトで用意されているログのフォーマットを使用してもいいですし、新しくフォーマットを定義して使用することもできます。

デフォルトの設定では httpd.conf ファイルで CustomLog ディレクティブで common フォーマットが指定されています。

<IfModule log_config_module>

    #
    # The location and format of the access logfile (Common Logfile Format).
    # If you do not define any access logfiles within a <VirtualHost>
    # container, they will be logged here.  Contrariwise, if you *do*
    # define per-<VirtualHost> access logfiles, transactions will be
    # logged therein and *not* in this file.
    #
    CustomLog "logs/access.log" common

</IfModule>

LogFormatディレクティブの使い方(2)