docs-xml: mention that the man pages are "part of" version x
[sfrench/samba-autobuild/.git] / docs-xml / manpages / vfs_time_audit.8.xml
1 <?xml version="1.0" encoding="UTF-8"?>
2 <!DOCTYPE refentry PUBLIC "-//Samba-Team//DTD DocBook V4.2-Based Variant V1.0//EN" "http://www.samba.org/samba/DTD/samba-doc">
3 <refentry id="vfs_time_audit.8">
4
5 <refmeta>
6         <refentrytitle>vfs_time_audit</refentrytitle>
7         <manvolnum>8</manvolnum>
8         <refmiscinfo class="source">Samba</refmiscinfo>
9         <refmiscinfo class="manual">System Administration tools</refmiscinfo>
10         <refmiscinfo class="version">&doc.version;</refmiscinfo>
11 </refmeta>
12
13
14 <refnamediv>
15         <refname>vfs_time_audit</refname>
16         <refpurpose>samba vfs module to log slow VFS operations</refpurpose>
17 </refnamediv>
18
19 <refsynopsisdiv>
20         <cmdsynopsis>
21                 <command>vfs objects = time_audit</command>
22         </cmdsynopsis>
23 </refsynopsisdiv>
24
25 <refsect1>
26         <title>DESCRIPTION</title>
27
28         <para>This VFS module is part of the
29         <citerefentry><refentrytitle>samba</refentrytitle>
30         <manvolnum>7</manvolnum></citerefentry> suite.</para>
31
32         <para>The <command>time_audit</command> VFS module logs system calls
33         that take longer than the number of milliseconds defined by the variable
34         <command>time_audit:timeout</command>. It will log the calls and
35         the time spent in it.
36         </para>
37
38         <para>It's kind of comparable with <command>strace -T</command> and
39         is helpful to reveal performance problems with the underlying file
40         and storage subsystems.</para>
41
42         <para>This module is stackable.</para>
43
44 </refsect1>
45
46
47 <refsect1>
48         <title>OPTIONS</title>
49
50         <variablelist>
51
52                 <varlistentry>
53
54                 <term>time_audit:timeout = number of milliseconds</term>
55                 <listitem>
56                 <para>VFS calls that take longer than the defined number of milliseconds
57                 that should be logged. The default is 10000 (10s).
58                 </para>
59                 </listitem>
60
61                 </varlistentry>
62
63
64
65         </variablelist>
66 </refsect1>
67
68 <refsect1>
69         <title>EXAMPLES</title>
70
71         <para>This would log VFS calls that take longer than 3 seconds:</para>
72
73 <programlisting>
74         <smbconfsection name="[sample_share]"/>
75         <smbconfoption name="path">/test/sample_share</smbconfoption>
76         <smbconfoption name="vfs objects">time_audit</smbconfoption>
77         <smbconfoption name="time_audit:timeout">3000</smbconfoption>
78 </programlisting>
79 </refsect1>
80
81
82 <refsect1>
83         <title>VERSION</title>
84         <para>This man page is part of version &doc.version; of the Samba suite.
85         </para>
86 </refsect1>
87
88 <refsect1>
89         <title>AUTHOR</title>
90
91         <para>The original Samba software and related utilities
92         were created by Andrew Tridgell. Samba is now developed
93         by the Samba Team as an Open Source project similar
94         to the way the Linux kernel is developed.</para>
95
96         <para>The time_audit VFS module was created with contributions from
97         Abhidnya Chirmule.
98         </para>
99 </refsect1>
100
101 </refentry>