install-and-document-klog-krb5-20080627
[openafs.git] / doc / xml / AdminReference / sect5 / VLLog.xml
1 <?xml version="1.0" encoding="UTF-8"?>
2 <refentry id="VLLog5">
3   <refmeta>
4     <refentrytitle>VLLog</refentrytitle>
5     <manvolnum>5</manvolnum>
6   </refmeta>
7   <refnamediv>
8     <refname>VLLog</refname>
9     <refpurpose>Traces Volume Location Server operations</refpurpose>
10   </refnamediv>
11   <refsect1>
12     <title>Description</title>
13     <para>The <replaceable>VLLog</replaceable> file records a trace of Volume Location (VL) Server
14     (<emphasis role="bold">vlserver</emphasis> process) operations on the local machine and describes any
15     error conditions it encounters.</para>
16
17     <para>If the <replaceable>VLLog</replaceable> file does not already exist in the
18     <replaceable>/usr/afs/logs</replaceable> directory when the VL Server starts, the server
19     process creates it and writes initial start-up messages to it. If there
20     is an existing file, the VL Server renames it to <replaceable>VLLog.old</replaceable>,
21     overwriting the existing <replaceable>VLLog.old</replaceable> file if it exists.</para>
22
23     <para>The file is in ASCII format. Administrators listed in the
24     <replaceable>/usr/afs/etc/UserList</replaceable> file can use the <emphasis role="bold">bos getlog</emphasis> command to display
25     its contents. Alternatively, log onto the server machine and use a text
26     editor or a file display command such as the UNIX <emphasis role="bold">cat</emphasis> command. By
27     default, the mode bits on the <replaceable>VLLog</replaceable> file grant the required <computeroutput>r</computeroutput> (read)
28     permission to all users.</para>
29
30     <para>The VL Server records operations only as it completes them, and cannot
31     recover from failures by reviewing the file. The log contents are useful
32     for administrative evaluation of process failures and other problems.</para>
33
34     <para>The VL Server can record messages at three levels of detail. By default,
35     it records only very rudimentary messages. To increase logging to the
36     first level of detail, issue the following command while logged onto the
37     database server machine as the local superuser <computeroutput>root</computeroutput>.</para>
38
39 <programlisting>
40    # kill -TSTP &amp;lt;vlserver_pid&amp;gt;
41
42 </programlisting>
43       <para>where &lt;vlserver_pid&gt; is the process ID of the vlserver process, as
44       reported in the output from the standard UNIX <emphasis role="bold">ps</emphasis> command. To increase
45       to the second and third levels of detail, repeat the command.</para>
46
47       <para>To disable logging, issue the following command.</para>
48
49 <programlisting>
50    # kill -HUP &amp;lt;vlserver_pid&amp;gt;
51
52 </programlisting>
53         <para>To decrease the level of logging, first completely disable it and then
54         issue the <computeroutput>kill -TSTP</computeroutput> command as many times as necessary to reach the
55         desired level.</para>
56
57       </refsect1>
58       <refsect1>
59         <title>See Also</title>
60         <para><link linkend="UserList5">UserList(5)</link>,
61         <link linkend="bos_getlog8">bos_getlog(8)</link>,
62         <link linkend="vlserver8">vlserver(8)</link></para>
63
64       </refsect1>
65       <refsect1>
66         <title>Copyright</title>
67         <para>IBM Corporation 2000. &lt;http://www.ibm.com/&gt; All Rights Reserved.</para>
68
69         <para>This documentation is covered by the IBM Public License Version 1.0.  It was
70         converted from HTML to POD by software written by Chas Williams and Russ
71         Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.</para>
72
73       </refsect1>
74     </refentry>