Apche日志系列(3)：定制日志

有时候我们需要定制Apache默认日志的格式和内容，比如增加或减少日志所记录的信息、改变默认日志文件的格式等。本文介绍可以用日志记录的所有信息，以及如何设置Apache使其记录这些信息。

一、定义日志格式

很 久以前，日志文件只有一种格式，这就是“公共格式”，许多人已经习惯于使用这种格式。随后出现了定制日志格式，而且看起来定制日志格式更很受欢迎，即使公 共日志格式本身也重新用定制日志格式定义。本文介绍的就是如何随心所欲地定制日志文件的格式、如何让日志文件记录自己想要的信息。

定制日志文件的格式涉及到两个指令，即LogFormat指令和CustomLog指令。默认httpd.conf文件提供了关于这两个指令的几个示例。

LogFormat指令：定义格式并为格式指定一个名字，以后我们就可以直接引用这个名字。

CustomLog指令：设置日志文件，并指明日志文件所用的格式（通常通过格式的名字）。

LogFormat指令的功能是定义日志格式并为它指定一个名字。例如，在默认的httpd.conf文件中，我们可以找到下面这行代码：

LogFormat "%h %l %u %t \"%r\" %>s %b" common

该指令创建了一种名为“common”的日志格式，日志的格式在双引号包围的内容中指定。格式字符串中的每一个变量代表着一项特定的信息，这些信息按照格式串规定的次序写入到日志文件。 Apache文档已经给出了所有可用于格式串的变量及其含义，下面是其译文：

%a: 远程IP地址

%A: 本地IP地址

%B: 已发送的字节数，不包含HTTP头

%b: CLF格式的已发送字节数量，不包含HTTP头。例如当没有发送数据时，写入‘-’而不是0。

%{FOOBAR}e: 环境变量FOOBAR的内容

%f: 文件名字

%h: 远程主机

%H 请求的协议

%Foobar}i: Foobar的内容，发送给服务器的请求的标头行。

%l: 远程登录名字（来自identd，如提供的话）

%m: 请求的方法

%{Foobar}n: 来自另外一个模块的注解“Foobar”的内容

%{Foobar}o: Foobar的内容，应答的标头行

%p: 服务器响应请求时使用的端口

%P: 响应请求的子进程ID。

%q: 查询字符串（如果存在查询字符串，则包含“?”后面的部分；否则，它是一个空字符串。）

%r: 请求的第一行

%s: 状态。对于进行内部重定向的请求，这是指*原来*请求的状态。如果用%...>s，则是指后来的请求。

%t: 以公共日志时间格式表示的时间（或称为标准英文格式）

%{format}t: 以指定格式format表示的时间

%T: 为响应请求而耗费的时间，以秒计

%u: 远程用户（来自auth；如果返回状态（%s）是401则可能是伪造的）

%U: 用户所请求的URL路径

%v: 响应请求的服务器的ServerName

%V: 依照UseCanonicalName设置得到的服务器名字

分析前面来自默认httpd.conf文件的LogFormat指令示例，可以看出它创建了一种名为“common”的日志格式，其中包括：远程主机，远程登录名字，远程用户，请求时间，请求的第一行代码，请求状态，以及发送的字节数。 LogFormat "%V %h %l %u %t \"%r\" %>s %b" common

【补充】"<"和">"修饰符可以用来指定对于已被内部重定向的请求是选择原始的请求还是选择最终的请求。默认情况下，%s, %U, %T, %D, %r 使用原始请求，而所有其他格式串则选择最终请求。例如，%>s 可以用于记录请求的最终状态，而 %<u 则记录一个已经被内部重定向到非认证资源的请求的原始认证用户。

如果在“%”和变量之间放入了一个或者多个HTTP状态代码，则只有当请求返回的状态代码属于指定的状态代码之一时，变量所代表的内容才会被记录。例如，如果我们想要记录的是网站的所有无效链接，那么可以使用：

LogFormat %404{Referer}i BrokenLinks

反之，如果我们想要记录那些状态代码不等于指定值的请求，只需加入一个“!”符号即可：

LogFormat %!200U SomethingWrong