summaryrefslogtreecommitdiff
path: root/docs-xml/manpages-3
diff options
context:
space:
mode:
authorBjörn Jacke <bj@sernet.de>2010-11-13 16:58:41 +0100
committerBjoern Jacke <bj@sernet.de>2010-11-13 17:13:24 +0000
commitf198c901dd8d364cef7f889bac9332b14261d864 (patch)
tree6770319731e98b313b1d0bfcd53a2e004113d440 /docs-xml/manpages-3
parent7d2260cdd18b7354c372d6e8833d1554ab7894d0 (diff)
downloadsamba-f198c901dd8d364cef7f889bac9332b14261d864.tar.gz
samba-f198c901dd8d364cef7f889bac9332b14261d864.tar.bz2
samba-f198c901dd8d364cef7f889bac9332b14261d864.zip
s3/doc: add missing documentation for vfs_time_audit
Autobuild-User: Björn Jacke <bj@sernet.de> Autobuild-Date: Sat Nov 13 17:13:24 UTC 2010 on sn-devel-104
Diffstat (limited to 'docs-xml/manpages-3')
-rw-r--r--docs-xml/manpages-3/vfs_time_audit.8.xml101
1 files changed, 101 insertions, 0 deletions
diff --git a/docs-xml/manpages-3/vfs_time_audit.8.xml b/docs-xml/manpages-3/vfs_time_audit.8.xml
new file mode 100644
index 0000000000..fc71e283ad
--- /dev/null
+++ b/docs-xml/manpages-3/vfs_time_audit.8.xml
@@ -0,0 +1,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">3.6</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: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: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: audit_timeout">3000</smbconfoption>
+</programlisting>
+</refsect1>
+
+
+<refsect1>
+ <title>VERSION</title>
+ <para>This man page is correct for version 3.6.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>