summaryrefslogtreecommitdiff
path: root/man/taler-exchange-benchmark.1
blob: 50ab5721b161fc3a8268723723287aa176986bc8 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
.\" Man page generated from reStructuredText.
.
.TH "TALER-EXCHANGE-BENCHMARK" "1" "Jul 06, 2022" "0.9" "GNU Taler"
.SH NAME
taler-exchange-benchmark \- measure exchange performance
.
.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
\fBtaler\-exchange\-benchmark\fP
[\fB\-c\fP\ \fICONFIG_FILENAME\fP\ |\ \fB–config=\fP‌\fICONFIG_FILENAME\fP]
[\fB\-F\fP\ |\ \fB–reserves\-first\fP]
[\fB\-f\fP\ |\ \fB–fakebank\fP]
[\fB\-h\fP\ |\ \fB–help\fP]
[\fB\-K\fP\ |\ \fB–linger\fP]
[\fB\-L\fP\ \fILOGLEVEL\fP\ |\ \fB–log\-level=\fP‌\fILOGLEVEL\fP]
[\fB\-l\fP\ \fIFILENAME\fP\ |\ \fB–logfile=\fP‌\fIFILENAME\fP]
[\fB\-m\fP\ \fIMODE\fP\ |\ \fB–mode=\fP\fIMODE\fP]
[\fB\-n\fP\ \fIHOWMANY_COINS\fP\ |\ \fB–coins\-number=\fP‌\fIHOWMANY_COINS\fP]
[\fB\-p\fP\ \fINPROCS\fP\ |\ \fB–parallelism=\fP\fINPROCS\fP]
[\fB\-R\fP\ \fIRATE\fP\ |\ \fB–refresh\-rate=\fP\fIRATE\fP]
[\fB\-r\fP\ \fIN\fP\ |\ \fB–reserves=\fP\fIN\fP]
[\fB\-v\fP\ |\ \fB–version\fP]
.SH DESCRIPTION
.sp
\fBtaler\-exchange\-benchmark\fP is a command\-line tool to measure the time
spent to serve withdrawals/deposits/refreshes. It usually needs a
dedicate configuration file where all the services \- the exchange and
the (fake)bank \- listen to URLs not subject to any reverse proxy, as say
Nginx. Moreover, the benchmark runs on a “volatile” database, that means
that table are always erased during a single benchmark run.
.INDENT 0.0
.TP
\fB\-c\fP \fICONFIG_FILENAME\fP | \fB–config=\fP‌\fICONFIG_FILENAME\fP
(Mandatory) Use CONFIG_FILENAME.
.TP
\fB\-F\fP | \fB–reserves\-first\fP
Create all reserves first, before starting normal operations.
.TP
\fB\-f\fP | \fB–fakebank\fP
Launch a fakebank instead of the Python bank. Only meaningful if the
mode is to launch more than just a client.  Note that using the
fakebank will cause the benchmark application to reset all databases
as the fakebank is stateless and thus previous database state would
inherently cause trouble.
.TP
\fB\-h\fP | \fB–help\fP
Prints a compiled\-in help text.
.TP
\fB\-K\fP | \fB–linger\fP
Linger around until keypress after the benchmark is done.
.TP
\fB\-L\fP \fILOGLEVEL\fP | \fB–log\-level=\fP‌\fILOGLEVEL\fP
Specifies the log level to use. Accepted values are: \fBDEBUG\fP, \fBINFO\fP,
\fBWARNING\fP, \fBERROR\fP\&.
.TP
\fB\-l\fP \fIFILENAME\fP | \fB–logfile=\fP‌\fIFILENAME\fP
Send logging output to \fIFILENAME\fP\&.
.TP
\fB\-m\fP \fIMODE\fP | \fB–mode=\fP\fIMODE\fP
Mode of operation. Accepted values are: \fBexchange\fP, \fBclients\fP, \fBboth\fP\&.
.TP
\fB\-n\fP \fIHOWMANY_COINS\fP | \fB–coins\-number=\fP‌\fIHOWMANY_COINS\fP
Defaults to 1. Specifies how many coins this benchmark should
withdraw and spend. After being spent, each coin will be refreshed
with a probability RATE (see option \fB\-\-refresh\-rate\fP).
.TP
\fB\-p\fP \fINPROCS\fP | \fB–parallelism=\fP\fINPROCS\fP
Run with \fINPROCS\fP client processes.
.TP
\fB\-R\fP \fIRATE\fP | \fB–refresh\-rate=\fP\fIRATE\fP
Defaults to 10.  Probability of refresh per coin (0\-100).
.TP
\fB\-r\fP \fIN\fP | \fB–reserves=\fP\fIN\fP
Create \fIN\fP reserves per client.
.TP
\fB\-v\fP | \fB–version\fP
Print version information.
.UNINDENT
.SH SEE ALSO
.sp
taler\-exchange\-dbinit(1), taler\-exchange\-offline(1), taler\-merchant\-benchmark(1),
taler\-exchange\-httpd(1), taler.conf(5)
.SH BUGS
.sp
Report bugs by using \fI\%https://bugs.taler.net/\fP or by sending electronic
mail to <\fI\%taler@gnu.org\fP>.
.SH AUTHOR
GNU Taler contributors
.SH COPYRIGHT
2014-2022 Taler Systems SA (GPLv3+ or GFDL 1.3+)
.\" Generated by docutils manpage writer.
.