summaryrefslogtreecommitdiff
path: root/docs/manpages/vfs_time_audit.8
diff options
context:
space:
mode:
Diffstat (limited to 'docs/manpages/vfs_time_audit.8')
-rw-r--r--docs/manpages/vfs_time_audit.871
1 files changed, 71 insertions, 0 deletions
diff --git a/docs/manpages/vfs_time_audit.8 b/docs/manpages/vfs_time_audit.8
new file mode 100644
index 0000000000..4c58096f80
--- /dev/null
+++ b/docs/manpages/vfs_time_audit.8
@@ -0,0 +1,71 @@
+'\" t
+.\" Title: vfs_time_audit
+.\" Author: [see the "AUTHOR" section]
+.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
+.\" Date: 01/22/2012
+.\" Manual: System Administration tools
+.\" Source: Samba 3.6
+.\" Language: English
+.\"
+.TH "VFS_TIME_AUDIT" "8" "01/22/2012" "Samba 3\&.6" "System Administration tools"
+.\" -----------------------------------------------------------------
+.\" * set default formatting
+.\" -----------------------------------------------------------------
+.\" disable hyphenation
+.nh
+.\" disable justification (adjust text to left margin only)
+.ad l
+.\" -----------------------------------------------------------------
+.\" * MAIN CONTENT STARTS HERE *
+.\" -----------------------------------------------------------------
+.SH "NAME"
+vfs_time_audit \- samba vfs module to log slow VFS operations
+.SH "SYNOPSIS"
+.HP \w'\ 'u
+vfs objects = time_audit
+.SH "DESCRIPTION"
+.PP
+This VFS module is part of the
+\fBsamba\fR(7)
+suite\&.
+.PP
+The
+time_audit
+VFS module logs system calls that take longer than the number of milliseconds defined by the variable
+time_audit:audit_timeout\&. It will log the calls and the time spent in it\&.
+.PP
+It\'s kind of comparable with
+strace \-T
+and is helpful to reveal performance problems with the underlying file and storage subsystems\&.
+.PP
+This module is stackable\&.
+.SH "OPTIONS"
+.PP
+time_audit:audit_timeout = number of milliseconds
+.RS 4
+VFS calls that take longer than the defined number of milliseconds that should be logged\&. The default is 10000 (10s)\&.
+.RE
+.SH "EXAMPLES"
+.PP
+This would log VFS calls that take longer than 3 seconds:
+.sp
+.if n \{\
+.RS 4
+.\}
+.nf
+ \fI[sample_share]\fR
+ \m[blue]\fBpath = /test/sample_share\fR\m[]
+ \m[blue]\fBvfs objects = time_audit\fR\m[]
+ \m[blue]\fBtime_audit: audit_timeout = 3000\fR\m[]
+.fi
+.if n \{\
+.RE
+.\}
+.SH "VERSION"
+.PP
+This man page is correct for version 3\&.6\&.0 of the Samba suite\&.
+.SH "AUTHOR"
+.PP
+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\&.
+.PP
+The time_audit VFS module was created with contributions from Abhidnya Chirmule\&.