Debian Codegraph @

upstream/opensuse-tumbleweed/man8/vfs_time_audit.8

raw
1 '\" t
2 .\" Title: vfs_time_audit
3 .\" Author: [see the "AUTHOR" section]
4 .\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
5 .\" Date: 05/26/2026
6 .\" Manual: System Administration tools
7 .\" Source: Samba 4.23.8-git.477.f78166bceedSUSE-oS16.9-x86_64
8 .\" Language: English
9 .\"
10 .TH "VFS_TIME_AUDIT" "8" "05/26/2026" "Samba 4\&.23\&.8\-git\&.477\&.f78166bcee" "System Administration tools"
11 .\" -----------------------------------------------------------------
12 .\" * Define some portability stuff
13 .\" -----------------------------------------------------------------
14 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
15 .\" http://bugs.debian.org/507673
16 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
17 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
18 .ie \n(.g .ds Aq \(aq
19 .el .ds Aq '
20 .\" -----------------------------------------------------------------
21 .\" * set default formatting
22 .\" -----------------------------------------------------------------
23 .\" disable hyphenation
24 .nh
25 .\" disable justification (adjust text to left margin only)
26 .ad l
27 .\" -----------------------------------------------------------------
28 .\" * MAIN CONTENT STARTS HERE *
29 .\" -----------------------------------------------------------------
30 .SH "NAME"
31 vfs_time_audit \- samba vfs module to log slow VFS operations
32 .SH "SYNOPSIS"
33 .HP \w'\ 'u
34 vfs objects = time_audit
35 .SH "DESCRIPTION"
36 .PP
37 This VFS module is part of the
38 \fBsamba\fR(7)
39 suite\&.
40 .PP
41 The
42 time_audit
43 VFS module logs system calls that take longer than the number of milliseconds defined by the variable
44 time_audit:timeout\&. It will log the calls and the time spent in it\&.
45 .PP
46 It\*(Aqs kind of comparable with
47 strace \-T
48 and is helpful to reveal performance problems with the underlying file and storage subsystems\&.
49 .PP
50 This module is stackable\&.
51 .SH "OPTIONS"
52 .PP
53 time_audit:timeout = number of milliseconds
54 .RS 4
55 VFS calls that take longer than the defined number of milliseconds that should be logged\&. The default is 10000 (10s)\&.
56 .RE
57 .SH "EXAMPLES"
58 .PP
59 This would log VFS calls that take longer than 3 seconds:
60 .sp
61 .if n \{\
62 .RS 4
63 .\}
64 .nf
65 \fI[sample_share]\fR
66 \m[blue]\fBpath = /test/sample_share\fR\m[]
67 \m[blue]\fBvfs objects = time_audit\fR\m[]
68 \m[blue]\fBtime_audit:timeout = 3000\fR\m[]
69 .fi
70 .if n \{\
71 .RE
72 .\}
73 .SH "VERSION"
74 .PP
75 This man page is part of version 4\&.23\&.8\-git\&.477\&.f78166bceedSUSE\-oS16\&.9\-x86_64 of the Samba suite\&.
76 .SH "AUTHOR"
77 .PP
78 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\&.
79 .PP
80 The time_audit VFS module was created with contributions from Abhidnya Chirmule\&.