]> git.ipfire.org Git - thirdparty/cups.git/blob - doc/help/access_log-reference.html
Load cups into easysw/current.
[thirdparty/cups.git] / doc / help / access_log-reference.html
1 <HTML>
2 <!-- SECTION: References -->
3 <HEAD>
4 <TITLE>access_log</TITLE>
5 </HEAD>
6 <BODY>
7
8 <P>The <VAR>access_log</VAR> file lists each HTTP resource that
9 is accessed by a web browser or client. Each line is in an
10 extended version of the so-called "Common Log Format" used by
11 many web servers and web reporting tools:</P>
12
13 <P CLASS="command">
14
15 host group user date-time \"method resource version\" status
16 bytes ipp-operation ipp-status<BR>
17
18 <BR>
19
20 10.0.1.2 - - [01/Dec/2005:21:50:28 +0000] "POST / HTTP/1.1" 200
21 317 CUPS-Get-Printers
22 successful-ok-ignored-or-substituted-attributes<BR>
23
24 localhost - - [01/Dec/2005:21:50:32 +0000] "GET /admin HTTP/1.1"
25 200 0 - -<BR>
26
27 localhost - - [01/Dec/2005:21:50:32 +0000] "POST / HTTP/1.1" 200
28 157 CUPS-Get-Printers
29 successful-ok-ignored-or-substituted-attributes<BR>
30
31 localhost - - [01/Dec/2005:21:50:32 +0000] "POST / HTTP/1.1" 200
32 1411 CUPS-Get-Devices -<BR>
33
34 localhost - - [01/Dec/2005:21:50:32 +0000] "GET /admin HTTP/1.1"
35 200 6667 - -<BR>
36
37 </P>
38
39 <P>The <I>host</I> field will normally only be an IP address
40 unless you have enabled the <A
41 HREF="cupsd-conf-reference.html#HostNameLookups"><CODE>HostNameLookups</CODE></A>
42 directive in the <VAR>cupsd.conf</VAR> file or if the IP address
43 corresponds to your local machine.</P>
44
45 <P>The <I>group</I> field always contains "-".</P>
46
47 <P>The <I>user</I> field is the authenticated username of the
48 requesting user. If no username and password is supplied for the
49 request then this field contains "-".</P>
50
51 <P>The <I>date-time</I> field is the date and time of the request
52 in local time and is in the format:</P>
53
54 <P CLASS="command">
55 [DD/MON/YYYY:HH:MM:SS +ZZZZ]
56 </P>
57
58 <P>The <I>method</I> field is the HTTP method used: "GET",
59 "OPTIONS", "PUT", or "POST". "GET" requests are used to get files
60 from the server, both for the web interface and to get
61 configuration and log files. "OPTIONS" requests are used to
62 upgrade connections to TLS encryption. "PUT" requests are used to
63 upload configuration files. "POST" requests are used for web
64 interface forms and IPP requests.</P>
65
66 <P>The <I>resource</I> field is the filename of the requested
67 resource.</P>
68
69 <P>The <I>version</I> field is the HTTP specification version used by the
70 client. For CUPS clients this will always be "HTTP/1.1".</P>
71
72 <P>The <I>status</I> field contains the HTTP result status of the
73 request, as follows:</P>
74
75 <UL>
76
77 <LI><CODE>200</CODE> - Successful operation.</LI>
78
79 <LI><CODE>201</CODE> - File created/modified successfully.</LI>
80
81 <LI><CODE>304</CODE> - The requested file has not changed.</LI>
82
83 <LI><CODE>400</CODE> - Bad HTTP request; typically this
84 means that you have a malicious program trying to access
85 your server.</LI>
86
87 <LI><CODE>401</CODE> - Unauthorized, authentication
88 (username + password) is required.</LI>
89
90 <LI><CODE>403</CODE> - Access is forbidden; typically
91 this means that a client tried to access a file or
92 resource they do not have permission to access.</LI>
93
94 <LI><CODE>404</CODE> - The file or resource does not
95 exist.</LI>
96
97 <LI><CODE>405</CODE> - URL access method is not allowed;
98 typically this means you have a web browser using your
99 server as a proxy.</LI>
100
101 <LI><CODE>413</CODE> - Request too large; typically this
102 means that a client tried to print a file larger than the
103 <A
104 HREF="cupsd-conf-reference.html#MaxRequestSize"><CODE>MaxRequestSize</CODE></A>
105 allows.</LI>
106
107 <LI><CODE>426</CODE> - Upgrading to TLS-encrypted
108 connection.</LI>
109
110 <LI><CODE>500</CODE> - Server error; typically this
111 happens when the server is unable to open/create a file -
112 consult the <VAR>error_log</VAR> file for details.</LI>
113
114 <LI><CODE>501</CODE> - The client requested encryption
115 but encryption support is not enabled/compiled in.</LI>
116
117 <LI><CODE>505</CODE> - HTTP version number not supported;
118 typically this means that you have a malicious program
119 trying to access your server.</LI>
120
121 </UL>
122
123 <P>The <I>bytes</I> field contains the number of bytes in the
124 request. For POST requests the <I>bytes</I> field contains the
125 number of bytes of non-IPP data that is received from the
126 client.</P>
127
128 <P>The <I>ipp-operation</I> field contains either "-" for non-IPP
129 requests or the IPP operation name for POST requests containing
130 an IPP request.</P>
131
132 <P>The <I>ipp-status</I> field contains either "-" for non-IPP
133 requests or the IPP status code name for POST requests containing
134 an IPP response.</P>
135
136 </BODY>
137 </HTML>