xref: /aosp_15_r20/external/libcups/doc/help/man-cupsd-logs.html (revision 5e7646d21f1134fb0638875d812ef646c12ab91e)
1*5e7646d2SAndroid Build Coastguard Worker<!DOCTYPE HTML>
2*5e7646d2SAndroid Build Coastguard Worker<html>
3*5e7646d2SAndroid Build Coastguard Worker<!-- SECTION: Man Pages -->
4*5e7646d2SAndroid Build Coastguard Worker<head>
5*5e7646d2SAndroid Build Coastguard Worker	<link rel="stylesheet" type="text/css" href="../cups-printable.css">
6*5e7646d2SAndroid Build Coastguard Worker	<title>cupsd-logs(5)</title>
7*5e7646d2SAndroid Build Coastguard Worker</head>
8*5e7646d2SAndroid Build Coastguard Worker<body>
9*5e7646d2SAndroid Build Coastguard Worker<h1 class="title">cupsd-logs(5)</h1>
10*5e7646d2SAndroid Build Coastguard Worker<h2 class="title"><a name="NAME">Name</a></h2>
11*5e7646d2SAndroid Build Coastguard Workercupsd-logs - cupsd log files (access_log, error_log, and page_log)
12*5e7646d2SAndroid Build Coastguard Worker<h2 class="title"><a name="DESCRIPTION">Description</a></h2>
13*5e7646d2SAndroid Build Coastguard Worker<b>cupsd</b>(8)
14*5e7646d2SAndroid Build Coastguard Workernormally maintains three log files: <i>access_log</i> to track requests that are submitted to the scheduler, <i>error_log</i> to track progress and errors, and <i>page_log</i> to track pages that are printed.
15*5e7646d2SAndroid Build Coastguard WorkerConfiguration directives in
16*5e7646d2SAndroid Build Coastguard Worker<b>cupsd.conf</b>(5)
17*5e7646d2SAndroid Build Coastguard Workerand
18*5e7646d2SAndroid Build Coastguard Worker<b>cups-files.conf</b>(5)
19*5e7646d2SAndroid Build Coastguard Workercontrol what information is logged and where it is stored.
20*5e7646d2SAndroid Build Coastguard Worker<h3><a name="ACCESS_LOG_FILE_FORMAT">Access Log File Format</a></h3>
21*5e7646d2SAndroid Build Coastguard WorkerThe <i>access_log</i> file lists each HTTP resource that is accessed by a web browser or client.
22*5e7646d2SAndroid Build Coastguard WorkerEach line is in an extended version of the so-called "Common Log Format" used by many web servers and web reporting tools:
23*5e7646d2SAndroid Build Coastguard Worker<pre class="man">
24*5e7646d2SAndroid Build Coastguard Worker
25*5e7646d2SAndroid Build Coastguard Worker    <i>host group user date-time </i>"<i>method resource version</i>" <i>status bytes
26*5e7646d2SAndroid Build Coastguard Worker      ipp-operation ipp-status</i>
27*5e7646d2SAndroid Build Coastguard Worker
28*5e7646d2SAndroid Build Coastguard Worker</pre>
29*5e7646d2SAndroid Build Coastguard WorkerFor example:
30*5e7646d2SAndroid Build Coastguard Worker<pre class="man">
31*5e7646d2SAndroid Build Coastguard Worker
32*5e7646d2SAndroid Build Coastguard Worker    10.0.1.2 - - [01/Dec/2005:21:50:28 +0000] "POST / HTTP/1.1" 200 317
33*5e7646d2SAndroid Build Coastguard Worker      CUPS-Get-Printers successful-ok-ignored-or-substituted-attributes
34*5e7646d2SAndroid Build Coastguard Worker    localhost - - [01/Dec/2005:21:50:32 +0000] "GET /admin HTTP/1.1"
35*5e7646d2SAndroid Build Coastguard Worker      200 0 - -
36*5e7646d2SAndroid Build Coastguard Worker    localhost - - [01/Dec/2005:21:50:32 +0000] "POST / HTTP/1.1"
37*5e7646d2SAndroid Build Coastguard Worker      200 157 CUPS-Get-Printers
38*5e7646d2SAndroid Build Coastguard Worker      successful-ok-ignored-or-substituted-attributes
39*5e7646d2SAndroid Build Coastguard Worker    localhost - - [01/Dec/2005:21:50:32 +0000] "POST / HTTP/1.1"
40*5e7646d2SAndroid Build Coastguard Worker      200 1411 CUPS-Get-Devices -
41*5e7646d2SAndroid Build Coastguard Worker    localhost - - [01/Dec/2005:21:50:32 +0000] "GET /admin HTTP/1.1"
42*5e7646d2SAndroid Build Coastguard Worker      200 6667 - -
43*5e7646d2SAndroid Build Coastguard Worker
44*5e7646d2SAndroid Build Coastguard Worker</pre>
45*5e7646d2SAndroid Build Coastguard WorkerThe <i>host</i> field will normally only be an IP address unless you have enabled the HostNameLookups directive in the <i>cupsd.conf</i> file or if the IP address corresponds to your local machine.
46*5e7646d2SAndroid Build Coastguard Worker<p>The <i>group</i> field always contains "-".
47*5e7646d2SAndroid Build Coastguard Worker<p>The <i>user</i> field is the authenticated username of the requesting user.
48*5e7646d2SAndroid Build Coastguard WorkerIf no username and password is supplied for the request then this field contains "-".
49*5e7646d2SAndroid Build Coastguard Worker<p>The <i>date-time</i> field is the date and time of the request in local time and is in the format "[DD/MON/YYYY:HH:MM:SS +ZZZZ]".
50*5e7646d2SAndroid Build Coastguard Worker<p>The <i>method</i> field is the HTTP method used: "GET", "HEAD", "OPTIONS", "POST", or "PUT".
51*5e7646d2SAndroid Build Coastguard Worker"GET" requests are used to get files from the server, both for the web interface and to get configuration and log files.
52*5e7646d2SAndroid Build Coastguard Worker"HEAD" requests are used to get information about a resource prior to a "GET".
53*5e7646d2SAndroid Build Coastguard Worker"OPTIONS" requests are used to upgrade connections to TLS encryption.
54*5e7646d2SAndroid Build Coastguard Worker"POST" requests are used for web interface forms and IPP requests.
55*5e7646d2SAndroid Build Coastguard Worker"PUT" requests are used to upload configuration files.
56*5e7646d2SAndroid Build Coastguard Worker<p>The <i>resource</i> field is the filename of the requested resource.
57*5e7646d2SAndroid Build Coastguard Worker<p>The <i>version</i> field is the HTTP specification version used by the client.
58*5e7646d2SAndroid Build Coastguard WorkerFor CUPS clients this will always be "HTTP/1.1".
59*5e7646d2SAndroid Build Coastguard Worker<p>The <i>status</i> field contains the HTTP result status of the request, as follows:
60*5e7646d2SAndroid Build Coastguard Worker<div style="margin-left: 5.0em;">
61*5e7646d2SAndroid Build Coastguard Worker<dl class="man">
62*5e7646d2SAndroid Build Coastguard Worker<dt>200
63*5e7646d2SAndroid Build Coastguard Worker<dd style="margin-left: 5.0em">Successful operation.
64*5e7646d2SAndroid Build Coastguard Worker<dt>201
65*5e7646d2SAndroid Build Coastguard Worker<dd style="margin-left: 5.0em">File created/modified successfully.
66*5e7646d2SAndroid Build Coastguard Worker<dt>304
67*5e7646d2SAndroid Build Coastguard Worker<dd style="margin-left: 5.0em">The requested file has not changed.
68*5e7646d2SAndroid Build Coastguard Worker<dt>400
69*5e7646d2SAndroid Build Coastguard Worker<dd style="margin-left: 5.0em">Bad HTTP request; typically this means that you have a malicious program trying to access your server.
70*5e7646d2SAndroid Build Coastguard Worker<dt>401
71*5e7646d2SAndroid Build Coastguard Worker<dd style="margin-left: 5.0em">Unauthorized, authentication (username + password) is required.
72*5e7646d2SAndroid Build Coastguard Worker<dt>403
73*5e7646d2SAndroid Build Coastguard Worker<dd style="margin-left: 5.0em">Access is forbidden; typically this means that a client tried to access a file or resource they do not have permission to access.
74*5e7646d2SAndroid Build Coastguard Worker<dt>404
75*5e7646d2SAndroid Build Coastguard Worker<dd style="margin-left: 5.0em">The file or resource does not exist.
76*5e7646d2SAndroid Build Coastguard Worker<dt>405
77*5e7646d2SAndroid Build Coastguard Worker<dd style="margin-left: 5.0em">URL access method is not allowed; typically this means you have a web browser using your server as a proxy.
78*5e7646d2SAndroid Build Coastguard Worker<dt>413
79*5e7646d2SAndroid Build Coastguard Worker<dd style="margin-left: 5.0em">Request too large; typically this means that a client tried to print a file larger than the MaxRequestSize allows.
80*5e7646d2SAndroid Build Coastguard Worker<dt>426
81*5e7646d2SAndroid Build Coastguard Worker<dd style="margin-left: 5.0em">Upgrading to TLS-encrypted connection.
82*5e7646d2SAndroid Build Coastguard Worker<dt>500
83*5e7646d2SAndroid Build Coastguard Worker<dd style="margin-left: 5.0em">Server error; typically this happens when the server is unable to open/create a file - consult the error_log file for details.
84*5e7646d2SAndroid Build Coastguard Worker<dt>501
85*5e7646d2SAndroid Build Coastguard Worker<dd style="margin-left: 5.0em">The client requested encryption but encryption support is not enabled/compiled in.
86*5e7646d2SAndroid Build Coastguard Worker<dt>505
87*5e7646d2SAndroid Build Coastguard Worker<dd style="margin-left: 5.0em">HTTP version number not supported; typically this means that you have a malicious program trying to access your server.
88*5e7646d2SAndroid Build Coastguard Worker</div>
89*5e7646d2SAndroid Build Coastguard Worker</dl>
90*5e7646d2SAndroid Build Coastguard Worker<p>The <i>bytes</i> field contains the number of bytes in the request.
91*5e7646d2SAndroid Build Coastguard WorkerFor POST requests the bytes field contains the number of bytes of non-IPP data that is received from the client.
92*5e7646d2SAndroid Build Coastguard Worker<p>The <i>ipp-operation</i> field contains either "-" for non-IPP requests or the IPP operation name for POST requests containing an IPP request.
93*5e7646d2SAndroid Build Coastguard Worker<p>The <i>ipp-status</i> field contains either "-" for non-IPP requests or the IPP status code name for POST requests containing an IPP response.
94*5e7646d2SAndroid Build Coastguard Worker<h3><a name="ERROR_LOG_FILE_FORMAT">Error Log File Format</a></h3>
95*5e7646d2SAndroid Build Coastguard WorkerThe <i>error_log</i> file lists messages from the scheduler - errors, warnings, etc. The LogLevel directive in the
96*5e7646d2SAndroid Build Coastguard Worker<b>cupsd.conf</b>(5)
97*5e7646d2SAndroid Build Coastguard Workerfile controls which messages are logged:
98*5e7646d2SAndroid Build Coastguard Worker<pre class="man">
99*5e7646d2SAndroid Build Coastguard Worker
100*5e7646d2SAndroid Build Coastguard Worker    level date-time message
101*5e7646d2SAndroid Build Coastguard Worker
102*5e7646d2SAndroid Build Coastguard Worker</pre>
103*5e7646d2SAndroid Build Coastguard WorkerFor example:
104*5e7646d2SAndroid Build Coastguard Worker<pre class="man">
105*5e7646d2SAndroid Build Coastguard Worker
106*5e7646d2SAndroid Build Coastguard Worker    I [20/May/1999:19:18:28 +0000] [Job 1] Queued on 'DeskJet' by 'mike'.
107*5e7646d2SAndroid Build Coastguard Worker    D [20/May/1999:19:18:28 +0000] [Job 1] argv[0]="DeskJet"
108*5e7646d2SAndroid Build Coastguard Worker    D [20/May/1999:19:18:28 +0000] [Job 1] argv[1]="1"
109*5e7646d2SAndroid Build Coastguard Worker    D [20/May/1999:19:18:28 +0000] [Job 1] argv[2]="mike"
110*5e7646d2SAndroid Build Coastguard Worker    D [20/May/1999:19:18:28 +0000] [Job 1] argv[3]="myjob"
111*5e7646d2SAndroid Build Coastguard Worker    D [20/May/1999:19:18:28 +0000] [Job 1] argv[4]="1"
112*5e7646d2SAndroid Build Coastguard Worker    D [20/May/1999:19:18:28 +0000] [Job 1] argv[5]="media=
113*5e7646d2SAndroid Build Coastguard Worker      na_letter_8.5x11in sides=one-sided"
114*5e7646d2SAndroid Build Coastguard Worker    D [20/May/1999:19:18:28 +0000] [Job 1] argv[6]="/var/spool/cups/
115*5e7646d2SAndroid Build Coastguard Worker      d000001-001"
116*5e7646d2SAndroid Build Coastguard Worker    I [20/May/1999:19:21:02 +0000] [Job 2] Queued on 'DeskJet' by 'mike'.
117*5e7646d2SAndroid Build Coastguard Worker    I [20/May/1999:19:22:24 +0000] [Job 2] Canceled by 'mike'.
118*5e7646d2SAndroid Build Coastguard Worker
119*5e7646d2SAndroid Build Coastguard Worker</pre>
120*5e7646d2SAndroid Build Coastguard WorkerThe <i>level</i> field contains the type of message:
121*5e7646d2SAndroid Build Coastguard Worker<dl class="man">
122*5e7646d2SAndroid Build Coastguard Worker<dt>A
123*5e7646d2SAndroid Build Coastguard Worker<dd style="margin-left: 5.0em">Alert message (LogLevel alert)
124*5e7646d2SAndroid Build Coastguard Worker<dt>C
125*5e7646d2SAndroid Build Coastguard Worker<dd style="margin-left: 5.0em">Critical error message (LogLevel crit)
126*5e7646d2SAndroid Build Coastguard Worker<dt>D
127*5e7646d2SAndroid Build Coastguard Worker<dd style="margin-left: 5.0em">Debugging message (LogLevel debug)
128*5e7646d2SAndroid Build Coastguard Worker<dt>d
129*5e7646d2SAndroid Build Coastguard Worker<dd style="margin-left: 5.0em">Detailed debugging message (LogLevel debug2)
130*5e7646d2SAndroid Build Coastguard Worker<dt>E
131*5e7646d2SAndroid Build Coastguard Worker<dd style="margin-left: 5.0em">Normal error message (LogLevel error)
132*5e7646d2SAndroid Build Coastguard Worker<dt>I
133*5e7646d2SAndroid Build Coastguard Worker<dd style="margin-left: 5.0em">Informational message (LogLevel info)
134*5e7646d2SAndroid Build Coastguard Worker<dt>N
135*5e7646d2SAndroid Build Coastguard Worker<dd style="margin-left: 5.0em">Notice message (LogLevel notice)
136*5e7646d2SAndroid Build Coastguard Worker<dt>W
137*5e7646d2SAndroid Build Coastguard Worker<dd style="margin-left: 5.0em">Warning message (LogLevel warn)
138*5e7646d2SAndroid Build Coastguard Worker<dt>X
139*5e7646d2SAndroid Build Coastguard Worker<dd style="margin-left: 5.0em">Emergency error message (LogLevel emerg)
140*5e7646d2SAndroid Build Coastguard Worker</dl>
141*5e7646d2SAndroid Build Coastguard Worker<p>The <i>date-time</i> field contains the date and time of when the page started printing. The format of this field is identical to the data-time field in the <i>access_log</i> file.
142*5e7646d2SAndroid Build Coastguard Worker<p>The <i>message</i> field contains a free-form textual message.
143*5e7646d2SAndroid Build Coastguard WorkerMessages from job filters are prefixed with "[Job NNN]" where "NNN" is the job ID.
144*5e7646d2SAndroid Build Coastguard Worker<h3><a name="PAGE_LOG_FILE_FORMAT">Page Log File Format</a></h3>
145*5e7646d2SAndroid Build Coastguard WorkerThe <i>page_log</i> file lists the total number of pages (sheets) that are printed.
146*5e7646d2SAndroid Build Coastguard WorkerBy default, each line contains the following information:
147*5e7646d2SAndroid Build Coastguard Worker<pre class="man">
148*5e7646d2SAndroid Build Coastguard Worker
149*5e7646d2SAndroid Build Coastguard Worker    <i>printer user job-id date-time </i><b>total </b><i>num-sheets job-billing
150*5e7646d2SAndroid Build Coastguard Worker      job-originating-host-name job-name media sides</i>
151*5e7646d2SAndroid Build Coastguard Worker
152*5e7646d2SAndroid Build Coastguard Worker</pre>
153*5e7646d2SAndroid Build Coastguard WorkerFor example the entry for a two page job called "myjob" might look like:
154*5e7646d2SAndroid Build Coastguard Worker<pre class="man">
155*5e7646d2SAndroid Build Coastguard Worker
156*5e7646d2SAndroid Build Coastguard Worker    DeskJet root 1 [20/May/1999:19:21:06 +0000] total 2 acme-123
157*5e7646d2SAndroid Build Coastguard Worker      localhost myjob na_letter_8.5x11in one-sided
158*5e7646d2SAndroid Build Coastguard Worker
159*5e7646d2SAndroid Build Coastguard Worker</pre>
160*5e7646d2SAndroid Build Coastguard WorkerThe PageLogFormat directive in the
161*5e7646d2SAndroid Build Coastguard Worker<b>cupsd.conf</b>(5)
162*5e7646d2SAndroid Build Coastguard Workerfile can be used to change this information.
163*5e7646d2SAndroid Build Coastguard Worker<p>The <i>printer</i> field contains the name of the printer that printed the page.
164*5e7646d2SAndroid Build Coastguard WorkerIf you send a job to a printer class, this field will contain the name of the printer that was assigned the job.
165*5e7646d2SAndroid Build Coastguard Worker<p>The <i>user</i> field contains the name of the user (the IPP requesting-user-name attribute) that submitted this file for printing.
166*5e7646d2SAndroid Build Coastguard Worker<p>The <i>job-id</i> field contains the job number of the page being printed.
167*5e7646d2SAndroid Build Coastguard Worker<p>The <i>date-time</i> field contains the date and time of when the page started printing.
168*5e7646d2SAndroid Build Coastguard WorkerThe format of this field is identical to the data-time field in the <i>access_log</i> file.
169*5e7646d2SAndroid Build Coastguard Worker<p>The <i>num-sheets</i> field provides the total number of pages (sheets) that have been printed on for the job.
170*5e7646d2SAndroid Build Coastguard Worker<p>The <i>job-billing</i> field contains a copy of the job-billing or job-account-id attributes provided with the IPP Create-Job or Print-Job requests or "-" if neither was provided.
171*5e7646d2SAndroid Build Coastguard Worker<p>The <i>job-originating-host-name</i> field contains the hostname or IP address of the client that printed the job.
172*5e7646d2SAndroid Build Coastguard Worker<p>The <i>job-name</i> field contains a copy of the job-name attribute provided with the IPP Create-Job or Print-Job requests or "-" if none was provided.
173*5e7646d2SAndroid Build Coastguard Worker<p>The <i>media</i> field contains a copy of the media or media-col/media-size attribute provided with the IPP Create-Job or Print-Job requests or "-" if none was provided.
174*5e7646d2SAndroid Build Coastguard Worker<p>The <i>sides</i> field contains a copy of the sides attribute provided with the IPP Create-Job or Print-Job requests or "-" if none was provided.
175*5e7646d2SAndroid Build Coastguard Worker<h2 class="title"><a name="SEE_ALSO">See Also</a></h2>
176*5e7646d2SAndroid Build Coastguard Worker<b>cupsd</b>(8),
177*5e7646d2SAndroid Build Coastguard Worker<b>cupsd.conf</b>(5),
178*5e7646d2SAndroid Build Coastguard Worker<b>cups-files.conf</b>(5),
179*5e7646d2SAndroid Build Coastguard WorkerCUPS Online Help (<a href="http://localhost:631/help">http://localhost:631/help</a>)
180*5e7646d2SAndroid Build Coastguard Worker<h2 class="title"><a name="COPYRIGHT">Copyright</a></h2>
181*5e7646d2SAndroid Build Coastguard WorkerCopyright &copy; 2007-2019 by Apple Inc.
182*5e7646d2SAndroid Build Coastguard Worker
183*5e7646d2SAndroid Build Coastguard Worker</body>
184*5e7646d2SAndroid Build Coastguard Worker</html>
185