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