source: trunk/server/docs/manpages/vfs_time_audit.8@ 745

Last change on this file since 745 was 745, checked in by Silvan Scherrer, 13 years ago

Samba Server: updated trunk to 3.6.0

File size: 2.3 KB
Line 
1'\" t
2.\" Title: vfs_time_audit
3.\" Author: [see the "AUTHOR" section]
4.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
5.\" Date: 08/08/2011
6.\" Manual: System Administration tools
7.\" Source: Samba 3.6
8.\" Language: English
9.\"
10.TH "VFS_TIME_AUDIT" "8" "08/08/2011" "Samba 3\&.6" "System Administration tools"
11.\" -----------------------------------------------------------------
12.\" * set default formatting
13.\" -----------------------------------------------------------------
14.\" disable hyphenation
15.nh
16.\" disable justification (adjust text to left margin only)
17.ad l
18.\" -----------------------------------------------------------------
19.\" * MAIN CONTENT STARTS HERE *
20.\" -----------------------------------------------------------------
21.SH "NAME"
22vfs_time_audit \- samba vfs module to log slow VFS operations
23.SH "SYNOPSIS"
24.HP \w'\ 'u
25vfs objects = time_audit
26.SH "DESCRIPTION"
27.PP
28This VFS module is part of the
29\fBsamba\fR(7)
30suite\&.
31.PP
32The
33time_audit
34VFS module logs system calls that take longer than the number of milliseconds defined by the variable
35time_audit:audit_timeout\&. It will log the calls and the time spent in it\&.
36.PP
37It\'s kind of comparable with
38strace \-T
39and is helpful to reveal performance problems with the underlying file and storage subsystems\&.
40.PP
41This module is stackable\&.
42.SH "OPTIONS"
43.PP
44time_audit:audit_timeout = number of milliseconds
45.RS 4
46VFS calls that take longer than the defined number of milliseconds that should be logged\&. The default is 10000 (10s)\&.
47.RE
48.SH "EXAMPLES"
49.PP
50This would log VFS calls that take longer than 3 seconds:
51.sp
52.if n \{\
53.RS 4
54.\}
55.nf
56 \fI[sample_share]\fR
57 \m[blue]\fBpath = /test/sample_share\fR\m[]
58 \m[blue]\fBvfs objects = time_audit\fR\m[]
59 \m[blue]\fBtime_audit: audit_timeout = 3000\fR\m[]
60.fi
61.if n \{\
62.RE
63.\}
64.SH "VERSION"
65.PP
66This man page is correct for version 3\&.6\&.0 of the Samba suite\&.
67.SH "AUTHOR"
68.PP
69The 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\&.
70.PP
71The time_audit VFS module was created with contributions from Abhidnya Chirmule\&.
Note: See TracBrowser for help on using the repository browser.