1SEIVOT(1) General Commands Manual SEIVOT(1)
2
6 seivot - benchmark backup application (obnam)
7
9 seivot [--benchmark-fsck] [--no-benchmark-fsck] [--config=FILE]
10 [--dump-config] [--dump-setting-names] [--generate-manpage=TEMPLATE]
11 [-h] [--help] [--help-all] [--list-config-files] [--version]
12 [--no-default-configs] [--description=TEXT] [--drop-caches]
13 [--no-drop-caches] [--dump-memory-profile=METHOD]
14 [--encrypt-with=KEYID] [--file-size=SIZE] [--generations=COUNT]
15 [--incremental-data=SIZE] [--initial-data=SIZE]
16 [--larch-branch=LARCH-BRANCH] [--log=FILE] [--log-keep=N]
17 [--log-level=LEVEL] [--log-max=SIZE] [--log-mode=MODE]
18 [--memory-dump-interval=SECONDS] [--obnam-branch=OBNAM-BRANCH]
19 [--obnam-config=FILE] [--obnam-profile=NAMEPATTERN] [--output=FILE]
20 [--profile-name=PROFILE-NAME] [--program=PROGRAM]
21 [--sftp-delay=SFTP-DELAY] [--use-existing=DIR] [--use-sftp-repository]
22 [--no-use-sftp-repository] [--use-sftp-root] [--no-use-sftp-root]
23 [--verify] [--no-verify] [FILE]...
24
26 seivot benchmarks a backup application. It has been written primarily
27 for obnam(1), but could be extended for other backup applications.
28 seivot generates some live data using genbackupdata(1), and then runs
30 the backup application. It then generates some more live data, and
31 runs a second backup generation, etc. It stores the measurements in an
32 output file. See seivots-summary(1) for a tool to show data from such
33 files in a tabular fashion. (seivot does not itself show the tabular
34 data, because one is rarely interested in the output from just one run,
35 and instead wants to contrast it with other runs).
36
38 --benchmark-fsck
39 benchmark fsck?
40 --no-benchmark-fsck
42 opposite of --benchmark-fsck
43 --description=TEXT
45 free-form description of this backup run
46 --drop-caches
48 clear Linux kernel cache before running commands (will ask for
49 sudo pasword
50 --no-drop-caches
52 opposite of --drop-caches
53 --encrypt-with=KEYID
55 encrypt backups with KEYID
56 --file-size=SIZE
58 size of files to create
59 --generate-manpage=TEMPLATE
61 fill in manual page TEMPLATE
62 --generations=COUNT
64 total number of generations to measure (5)
65 -h, --help
67 show this help message and exit
68 --incremental-data=SIZE
70 add SIZE live data for additional generations (1024)
71 --initial-data=SIZE
73 size of initial live data (1024)
74 --larch-branch=LARCH-BRANCH
76 bzr branch from which to use larch (default is installed larch)
77 --obnam-branch=OBNAM-BRANCH
79 bzr branch from which to run obnam (default is installed obnam)
80 --obnam-config=FILE
82 use FILE as an Obnam configuration file
83 --obnam-profile=NAMEPATTERN
85 store Python profiling output in files named after NAMEPATTERN
86 (no profiling, unless set); %(foo)s in pattern gets filled in,
87 where foo is op (for backup/restore/etc), gen, or order (cumula‐
88 tive/time)
89 --output=FILE
91 write output to FILE, instead of standard output
92 --profile-name=PROFILE-NAME
94 name of backup use-case profile name (for documentation purposes
95 only)
96 --program=PROGRAM
98 program to benchmark (obnam)
99 --sftp-delay=SFTP-DELAY
101 add an artificial delay (in milliseconds) to all SFTP transfers
102 --use-existing=DIR
104 use exiting DIR for initial generation
105 --use-sftp-repository
107 access backup repository over the network via sftp
108 --no-use-sftp-repository
110 opposite of --use-sftp-repository
111 --use-sftp-root
113 access backup repository over the network via sftp
114 --no-use-sftp-root
116 opposite of --use-sftp-root
117 --verify
119 verify restored data
120 --no-verify
122 opposite of --verify
123 --version
125 show program's version number and exit
126 Configuration files and settings
128 --config=FILE
129 add FILE to config files
130 --dump-config
132 write out the entire current configuration
133 --dump-setting-names
135 write out all names of settings and quit
136 --help-all
138 show all options
139 --list-config-files
141 list all possible config files
142 --no-default-configs
144 clear list of configuration files to read
145 Logging
147 --log=FILE
148 write log entries to FILE (default is to not write log files at
149 all); use "syslog" to log to system log, "stderr" to log to the
150 standard error output, or "none" to disable logging
151 --log-keep=N
153 keep last N logs (10)
154 --log-level=LEVEL
156 log at LEVEL, one of debug, info, warning, error, critical, fa‐
157 tal (default: debug)
158 --log-max=SIZE
160 rotate logs larger than SIZE, zero for never (default: 0)
161 --log-mode=MODE
163 set permissions of new log files to MODE (octal; default 0600)
164 Peformance
166 --dump-memory-profile=METHOD
167 make memory profiling dumps using METHOD, which is one of: none,
168 simple, or meliae (default: simple)
169 --memory-dump-interval=SECONDS
171 make memory profiling dumps at least SECONDS apart
172
174 To run a simple benchmark:
175 seivot --initial-data=10G --incremental-data=1G
177
179 seivots-summary(1), obnam(1).
180 SEIVOT(1)