public class ApacheLogFormat extends Object implements AccessLogFormat
AccessLogFormat
using a standard vaguely similar and heavily
influenced by Apache's
own custom access log formats.
As with Apache, the format string specified at construction should be composed of these tokens:
%% |
The literal percent sign (can also be escaped with back-slash, like "\% " |
---|---|
%a |
Remote IP-address |
%A |
Local IP-address |
%b |
Size of response in bytes, excluding HTTP headers, using "- " (a dash character) rather than a "0 " (zero) when no bytes are sent |
%B |
Size of response in bytes, excluding HTTP headers |
%{Foobar}C |
The contents of cookie "Foobar " in the request sent to the server |
%D |
The time taken to serve the request, in microseconds |
%h |
Remote host name |
%{local|remote}h |
Host name, either "local " or "remote " |
%H |
The request protocol |
%{Foobar}i |
The contents of the "Foobar: ... " header in the request |
%m |
The request method |
%{Foobar}o |
The contents of the "Foobar: ... " header in the response |
%p |
Local port number |
%{local|remote}p |
The port number, either "local " or "remote " |
%q |
The query string, prepended with a "? " (question mark) if a query string exists, otherwise an empty string |
%r |
First line of request, an alias to "%m %U%q %H " |
%s |
Status code |
%t |
The time the request was received, in standard English format (like "[09/Feb/2014:12:00:34 +0900] ") |
%{[format][@timezone]}t |
The time the request was received. Both format and timezone are optional
@ " character needs to be used in the format, it must be escaped as "@@" |
%T |
The time taken to serve the request, in seconds |
%{...}T |
The time taken to serve the request. The parameter can be a time unit like:
|
%u |
The remote user name |
%U |
The URL path requested, not including any query string |
%v |
The name of the server which served the request |
Modifier and Type | Field and Description |
---|---|
static ApacheLogFormat |
AGENT
A format compatible with Apache's user-agent format.
|
static String |
AGENT_FORMAT
A
String representing our version of Apache's user-agent format. |
static ApacheLogFormat |
AGENT_UTC
|
static ApacheLogFormat |
COMBINED
A format compatible with Apache's combined format.
|
static String |
COMBINED_FORMAT
A
String representing our version of Apache's combined format. |
static ApacheLogFormat |
COMBINED_UTC
|
static ApacheLogFormat |
COMMON
A format compatible with Apache's common format.
|
static String |
COMMON_FORMAT
A
String representing our version of Apache's common format. |
static ApacheLogFormat |
COMMON_UTC
|
static ApacheLogFormat |
REFERER
A format compatible with Apache's referer format.
|
static String |
REFERER_FORMAT
A
String representing our version of Apache's referer format. |
static ApacheLogFormat |
REFERER_UTC
|
static ApacheLogFormat |
VHOST_COMBINED
A format compatible with Apache's combined with virtual-hosts format.
|
static String |
VHOST_COMBINED_FORMAT
A
String representing our version of Apache's combined with virtual-hosts format. |
static ApacheLogFormat |
VHOST_COMBINED_UTC
|
static ApacheLogFormat |
VHOST_COMMON
A format compatible with Apache's common with virtual-hosts format.
|
static String |
VHOST_COMMON_FORMAT
A
String representing our version of Apache's common with virtual-hosts format. |
static ApacheLogFormat |
VHOST_COMMON_UTC
|
Constructor and Description |
---|
ApacheLogFormat(String format)
Create a new
ApacheLogFormat instance by parsing the format
from the specified String . |
ApacheLogFormat(TimeZone timeZone,
String format)
Create a new
ApacheLogFormat instance by parsing the format
from the specified String . |
Modifier and Type | Method and Description |
---|---|
String |
format(Response response,
Date timeStamp,
long responseNanos)
|
String |
getFormat()
Return the normalized format associated with this instance.
|
public static final String COMMON_FORMAT
String
representing our version of Apache's common format.public static final String COMBINED_FORMAT
String
representing our version of Apache's combined format.public static final String VHOST_COMMON_FORMAT
String
representing our version of Apache's common with virtual-hosts format.public static final String VHOST_COMBINED_FORMAT
String
representing our version of Apache's combined with virtual-hosts format.public static final String REFERER_FORMAT
String
representing our version of Apache's referer format.public static final String AGENT_FORMAT
String
representing our version of Apache's user-agent format.public static final ApacheLogFormat COMMON
public static final ApacheLogFormat COMBINED
public static final ApacheLogFormat VHOST_COMMON
public static final ApacheLogFormat VHOST_COMBINED
public static final ApacheLogFormat REFERER
public static final ApacheLogFormat AGENT
public static final ApacheLogFormat COMMON_UTC
public static final ApacheLogFormat COMBINED_UTC
public static final ApacheLogFormat VHOST_COMMON_UTC
public static final ApacheLogFormat VHOST_COMBINED_UTC
public static final ApacheLogFormat REFERER_UTC
public static final ApacheLogFormat AGENT_UTC
public ApacheLogFormat(String format)
ApacheLogFormat
instance by parsing the format
from the specified String
.public ApacheLogFormat(TimeZone timeZone, String format)
ApacheLogFormat
instance by parsing the format
from the specified String
.public String format(Response response, Date timeStamp, long responseNanos)
AccessLogFormat
Response
and return
a String
which can be appended to an access log file.format
in interface AccessLogFormat
response
- The Response
holding the data to format.timeStamp
- The Date
at which the request was originated.responseNanos
- The time, in nanoseconds, the Response
took to complete.public String getFormat()
Copyright © 2015 Oracle Corporation. All rights reserved.