From 5c463c80010e3fe3c7fd393bd47f807707045ef2 Mon Sep 17 00:00:00 2001
From: John Terpstra <jht@samba.org>
Date: Thu, 23 Sep 2004 06:21:24 +0000
Subject: Add more debugging information, both generic and for the VFS
 extd_audit module. (This used to be commit
 c1763e368c1152b8117d1934147a508b3b089316)

---
 docs/Samba-HOWTO-Collection/Bugs.xml | 46 ++++++++++++++++++++++++++++++++++++
 docs/Samba-HOWTO-Collection/VFS.xml  | 34 ++++++++++++++++++++++++++
 2 files changed, 80 insertions(+)

(limited to 'docs')

diff --git a/docs/Samba-HOWTO-Collection/Bugs.xml b/docs/Samba-HOWTO-Collection/Bugs.xml
index 12f8055599..09b4899276 100644
--- a/docs/Samba-HOWTO-Collection/Bugs.xml
+++ b/docs/Samba-HOWTO-Collection/Bugs.xml
@@ -121,6 +121,52 @@ all bugs can be tracked at a setting of <constant>10</constant>, but be
 prepared for a large volume of log data.
 </para>
 
+	<sect2>
+	<title>Debugging Specific Operations</title>
+
+	<para>
+	Samba-3.x permits debugging (logging) of specific functional components without unnecessarily
+	cluttering the log files with detailed logs for all operations. An example configuration to 
+	achive this is shown in:
+	</para>
+
+<para>
+<smbconfblock>
+<smbconfoption><name>log level</name><value>0 tdb:3 passdb:5 auth:4 vfs:2</value></smbconfoption>
+<smbconfoption><name>max log size</name><value>0</value></smbconfoption>
+<smbconfoption><name>log file</name><value>/var/log/samba/%U.%m.log</value></smbconfoption>
+</smbconfblock>
+</para>
+
+	<para>
+	This will cause the level of detail to be expanded to the debug class (log level) passed to
+	each funtional area per the value shown above. The first value passed to the <parameter>log level</parameter>
+	of <constant>0</constant> means turn off all unnecessary debugging except the debug classes set for
+	the functional areas as specified. The table shown in <link linkend="dbgclass">Debugable Functions</link>
+	may be used to affect very precise analysis of each SMB operation Samba is conducting.
+	</para>
+
+	<table frame="all" id="dbgclass">
+		<title>Debuggable Functions</title>
+	<tgroup cols="2" align="center">
+		<thead>
+		<row><entry>Function Name</entry><entry>Function Name</entry></row>
+		</thead>
+		<tbody>
+		<row><entry>all</entry><entry>passdb</entry></row>
+		<row><entry>tdb</entry><entry>sam</entry></row>
+		<row><entry>printdrivers</entry>auth<entry></entry></row>
+		<row><entry>lanman</entry><entry>winbind</entry></row>
+		<row><entry>smb</entry><entry>vfs</entry></row>
+		<row><entry>rpc_parse</entry><entry>idmap</entry></row>
+		<row><entry>rpc_srv</entry><entry>quota</entry></row>
+		<row><entry>rpc_cli</entry><entry>acls</entry></row>
+		</tbody>
+	</tgroup>
+	</table>
+
+	</sect2>
+
 </sect1>
 
 <sect1>
diff --git a/docs/Samba-HOWTO-Collection/VFS.xml b/docs/Samba-HOWTO-Collection/VFS.xml
index d9030a5633..48770f5412 100644
--- a/docs/Samba-HOWTO-Collection/VFS.xml
+++ b/docs/Samba-HOWTO-Collection/VFS.xml
@@ -138,6 +138,40 @@ This can be done using a configuration similar to the one shown in <link linkend
 		</tgroup>
 		</table>
 
+		<sect3>
+		<title>Configuration of Auditing</title>
+
+		<para>
+		This auditing tool is more felxible than most people readily will recognize. There are a number of ways
+		by which useful logging information can be recorded.
+		</para>
+
+		<itemizedlist>
+			<listitem><para>Syslog can be used to record all transaction. This can be disabled by setting
+					in the &smb.conf; file <parameter>syslog = 0</parameter>.</para></listitem>
+			<listitem><para>Logging can take place to the default log file (<filename>log.smbd</filename>)
+					for all loaded VFS modules just be setting in the &smb.conf; file
+					<parameter>log level = 0 vfs:x</parameter>, where x is the log level.
+					This will disable general logging while activating all logging of VFS
+					module activity at the log level specified.</para></listitem>
+			<listitem><para>Detailed logging can be obtained per user, per client machine, etc.
+					This requires the above together with the creative use of the
+					<parameter>log file</parameter> settings.</para>
+					<para>An example of detailed per-user and per-machine logging can
+					be obtained by setting 
+					<smbconfoption><name>log level</name>
+					<value>/var/log/samba/%U.%m.log</value></smbconfoption>.
+					</para></listitem>
+		</itemizedlist>
+
+		<para>
+		Auditing information often must be preserved for a long time. So that the log files do not get rotated
+		it is essential that the <smbconfoption><name>max log size</name><value>0</value></smbconfoption> be set
+		in the &smb.conf; file.
+		</para>
+
+		</sect3>
+
 	</sect2>
 
 	<sect2 id="fakeperms">
-- 
cgit