mirror of
				https://github.com/samba-team/samba.git
				synced 2025-10-25 19:33:18 +03:00 
			
		
		
		
	writing that they are correct for version x is not always precise. But we're working on that also :-) Signed-off-by: Bjoern Jacke <bjacke@samba.org> Reviewed-by: Andrew Bartlett <abartlet@samba.org> Reviewed-by: Garming Sam <garming@catalyst.net.nz>
		
			
				
	
	
		
			102 lines
		
	
	
		
			2.6 KiB
		
	
	
	
		
			XML
		
	
	
	
	
	
			
		
		
	
	
			102 lines
		
	
	
		
			2.6 KiB
		
	
	
	
		
			XML
		
	
	
	
	
	
| <?xml version="1.0" encoding="UTF-8"?>
 | |
| <!DOCTYPE refentry PUBLIC "-//Samba-Team//DTD DocBook V4.2-Based Variant V1.0//EN" "http://www.samba.org/samba/DTD/samba-doc">
 | |
| <refentry id="vfs_time_audit.8">
 | |
| 
 | |
| <refmeta>
 | |
| 	<refentrytitle>vfs_time_audit</refentrytitle>
 | |
| 	<manvolnum>8</manvolnum>
 | |
| 	<refmiscinfo class="source">Samba</refmiscinfo>
 | |
| 	<refmiscinfo class="manual">System Administration tools</refmiscinfo>
 | |
| 	<refmiscinfo class="version">&doc.version;</refmiscinfo>
 | |
| </refmeta>
 | |
| 
 | |
| 
 | |
| <refnamediv>
 | |
| 	<refname>vfs_time_audit</refname>
 | |
| 	<refpurpose>samba vfs module to log slow VFS operations</refpurpose>
 | |
| </refnamediv>
 | |
| 
 | |
| <refsynopsisdiv>
 | |
| 	<cmdsynopsis>
 | |
| 		<command>vfs objects = time_audit</command>
 | |
| 	</cmdsynopsis>
 | |
| </refsynopsisdiv>
 | |
| 
 | |
| <refsect1>
 | |
| 	<title>DESCRIPTION</title>
 | |
| 
 | |
| 	<para>This VFS module is part of the
 | |
| 	<citerefentry><refentrytitle>samba</refentrytitle>
 | |
| 	<manvolnum>7</manvolnum></citerefentry> suite.</para>
 | |
| 
 | |
| 	<para>The <command>time_audit</command> VFS module logs system calls
 | |
| 	that take longer than the number of milliseconds defined by the variable
 | |
| 	<command>time_audit:timeout</command>. It will log the calls and
 | |
| 	the time spent in it.
 | |
| 	</para>
 | |
| 
 | |
| 	<para>It's kind of comparable with <command>strace -T</command> and
 | |
| 	is helpful to reveal performance problems with the underlying file
 | |
| 	and storage subsystems.</para>
 | |
| 
 | |
| 	<para>This module is stackable.</para>
 | |
| 
 | |
| </refsect1>
 | |
| 
 | |
| 
 | |
| <refsect1>
 | |
| 	<title>OPTIONS</title>
 | |
| 
 | |
| 	<variablelist>
 | |
| 
 | |
| 		<varlistentry>
 | |
| 
 | |
| 		<term>time_audit:timeout = number of milliseconds</term>
 | |
| 		<listitem>
 | |
| 		<para>VFS calls that take longer than the defined number of milliseconds
 | |
| 		that should be logged. The default is 10000 (10s).
 | |
| 		</para>
 | |
| 		</listitem>
 | |
| 
 | |
| 		</varlistentry>
 | |
| 
 | |
| 
 | |
| 
 | |
| 	</variablelist>
 | |
| </refsect1>
 | |
| 
 | |
| <refsect1>
 | |
| 	<title>EXAMPLES</title>
 | |
| 
 | |
| 	<para>This would log VFS calls that take longer than 3 seconds:</para>
 | |
| 
 | |
| <programlisting>
 | |
|         <smbconfsection name="[sample_share]"/>
 | |
| 	<smbconfoption name="path">/test/sample_share</smbconfoption>
 | |
| 	<smbconfoption name="vfs objects">time_audit</smbconfoption>
 | |
| 	<smbconfoption name="time_audit:timeout">3000</smbconfoption>
 | |
| </programlisting>
 | |
| </refsect1>
 | |
| 
 | |
| 
 | |
| <refsect1>
 | |
| 	<title>VERSION</title>
 | |
| 	<para>This man page is part of version &doc.version; of the Samba suite.
 | |
| 	</para>
 | |
| </refsect1>
 | |
| 
 | |
| <refsect1>
 | |
| 	<title>AUTHOR</title>
 | |
| 
 | |
| 	<para>The original Samba software and related utilities
 | |
| 	were created by Andrew Tridgell. Samba is now developed
 | |
| 	by the Samba Team as an Open Source project similar
 | |
| 	to the way the Linux kernel is developed.</para>
 | |
| 
 | |
| 	<para>The time_audit VFS module was created with contributions from
 | |
| 	Abhidnya Chirmule.
 | |
| 	</para>
 | |
| </refsect1>
 | |
| 
 | |
| </refentry>
 |