mirror of
https://github.com/borgbackup/borg.git
synced 2024-12-29 11:16:43 +00:00
101 lines
3.5 KiB
Groff
101 lines
3.5 KiB
Groff
.\" Man page generated from reStructuredText.
|
|
.
|
|
.TH BORG-BENCHMARK-CRUD 1 "2017-11-25" "" "borg backup tool"
|
|
.SH NAME
|
|
borg-benchmark-crud \- Benchmark Create, Read, Update, Delete for archives.
|
|
.
|
|
.nr rst2man-indent-level 0
|
|
.
|
|
.de1 rstReportMargin
|
|
\\$1 \\n[an-margin]
|
|
level \\n[rst2man-indent-level]
|
|
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
|
-
|
|
\\n[rst2man-indent0]
|
|
\\n[rst2man-indent1]
|
|
\\n[rst2man-indent2]
|
|
..
|
|
.de1 INDENT
|
|
.\" .rstReportMargin pre:
|
|
. RS \\$1
|
|
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
|
|
. nr rst2man-indent-level +1
|
|
.\" .rstReportMargin post:
|
|
..
|
|
.de UNINDENT
|
|
. RE
|
|
.\" indent \\n[an-margin]
|
|
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
|
.nr rst2man-indent-level -1
|
|
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
|
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
|
|
..
|
|
.SH SYNOPSIS
|
|
.sp
|
|
borg [common options] benchmark crud [options] REPO PATH
|
|
.SH DESCRIPTION
|
|
.sp
|
|
This command benchmarks borg CRUD (create, read, update, delete) operations.
|
|
.sp
|
|
It creates input data below the given PATH and backups this data into the given REPO.
|
|
The REPO must already exist (it could be a fresh empty repo or an existing repo, the
|
|
command will create / read / update / delete some archives named borg\-test\-data* there.
|
|
.sp
|
|
Make sure you have free space there, you\(aqll need about 1GB each (+ overhead).
|
|
.sp
|
|
If your repository is encrypted and borg needs a passphrase to unlock the key, use:
|
|
.sp
|
|
BORG_PASSPHRASE=mysecret borg benchmark crud REPO PATH
|
|
.sp
|
|
Measurements are done with different input file sizes and counts.
|
|
The file contents are very artificial (either all zero or all random),
|
|
thus the measurement results do not necessarily reflect performance with real data.
|
|
Also, due to the kind of content used, no compression is used in these benchmarks.
|
|
.INDENT 0.0
|
|
.TP
|
|
.B C\- == borg create (1st archive creation, no compression, do not use files cache)
|
|
C\-Z\- == all\-zero files. full dedup, this is primarily measuring reader/chunker/hasher.
|
|
C\-R\- == random files. no dedup, measuring throughput through all processing stages.
|
|
.TP
|
|
.B R\- == borg extract (extract archive, dry\-run, do everything, but do not write files to disk)
|
|
R\-Z\- == all zero files. Measuring heavily duplicated files.
|
|
R\-R\- == random files. No duplication here, measuring throughput through all processing
|
|
.IP "System Message: ERROR/3 (docs/virtmanpage.rst:, line 56)"
|
|
Unexpected indentation.
|
|
.INDENT 7.0
|
|
.INDENT 3.5
|
|
stages, except writing to disk.
|
|
.UNINDENT
|
|
.UNINDENT
|
|
.TP
|
|
.B U\- == borg create (2nd archive creation of unchanged input files, measure files cache speed)
|
|
The throughput value is kind of virtual here, it does not actually read the file.
|
|
U\-Z\- == needs to check the 2 all\-zero chunks\(aq existence in the repo.
|
|
U\-R\- == needs to check existence of a lot of different chunks in the repo.
|
|
.TP
|
|
.B D\- == borg delete archive (delete last remaining archive, measure deletion + compaction)
|
|
D\-Z\- == few chunks to delete / few segments to compact/remove.
|
|
D\-R\- == many chunks to delete / many segments to compact/remove.
|
|
.UNINDENT
|
|
.sp
|
|
Please note that there might be quite some variance in these measurements.
|
|
Try multiple measurements and having a otherwise idle machine (and network, if you use it).
|
|
.SH OPTIONS
|
|
.sp
|
|
See \fIborg\-common(1)\fP for common options of Borg commands.
|
|
.SS arguments
|
|
.INDENT 0.0
|
|
.TP
|
|
.B REPO
|
|
repo to use for benchmark (must exist)
|
|
.TP
|
|
.B PATH
|
|
path were to create benchmark input data
|
|
.UNINDENT
|
|
.SH SEE ALSO
|
|
.sp
|
|
\fIborg\-common(1)\fP
|
|
.SH AUTHOR
|
|
The Borg Collective
|
|
.\" Generated by docutils manpage writer.
|
|
.
|