blob: 2e44ba07f6de96bff98128ea9efa1e4b409deb2e (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
|
<?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">4.5</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 correct for version 4.0.0 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>
|
