summaryrefslogtreecommitdiff
path: root/manpages/taler-exchange-benchmark.1.rst
blob: 9847b091abeaf875a97b12cf3b40ff8f5a433a30 (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
taler-exchange-benchmark(1)
###########################


.. only:: html

   Name
   ====

   **taler-exchange-benchmark** - measure exchange performance


Synopsis
========

**taler-exchange-benchmark**
[**-c** *CONFIG_FILENAME* | **––config=**\ ‌\ *CONFIG_FILENAME*]
[**-F** | **––reserves-first**]
[**-f** | **––fakebank**]
[**-h** | **––help**]
[**-K** | **––linger**]
[**-L** *LOGLEVEL* | **––log-level=**\ ‌\ *LOGLEVEL*]
[**-l** *FILENAME* | **––logfile=**\ ‌\ *FILENAME*]
[**-m** *MODE* | **––mode=**\ \ *MODE*]
[**-n** *HOWMANY_COINS* | **––coins-number=**\ ‌\ *HOWMANY_COINS*]
[**-v** | **––version**]

Description
===========

**taler-exchange-benchmark** 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.

**-c** *CONFIG_FILENAME* \| **––config=**\ ‌\ *CONFIG_FILENAME*
   (Mandatory) Use CONFIG_FILENAME.

**-F** \| **––reserves-first**
   Create all reserves first, before starting normal operations.

**-f** \| **––fakebank**
   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.

**-h** \| **––help**
   Prints a compiled-in help text.

**-K** \| **––linger**
   Linger around until keypress after the benchmark is done.

**-L** *LOGLEVEL* \| **––log-level=**\ ‌\ *LOGLEVEL*
   Specifies the log level to use. Accepted values are: ``DEBUG``, ``INFO``,
   ``WARNING``, ``ERROR``.

**-l** *FILENAME* \| **––logfile=**\ ‌\ *FILENAME*
   Send logging output to *FILENAME*.

**-m** *MODE* \| **––mode=**\ \ *MODE*
   Mode of operation. Accepted values are: ``exchange``, ``clients``, ``both``.

**-n** *HOWMANY_COINS* \| **––coins-number=**\ ‌\ *HOWMANY_COINS*
   Defaults to 1. Specifies how many coins this benchmark should
   withdraw and spend. After being spent, each coin will be refreshed
   with a REFRESH_PROBABILITY probability, which is (hardcoded as) 0.1;
   future versions of this tool should offer this parameter as a CLI
   option.

**-v** \| **––version**
   Print version information.

See Also
========

taler-exchange-dbinit(1), taler-exchange-keyup(1), taler-merchant-benchmark(1),
taler-exchange-httpd(1), taler.conf(5)

Bugs
====

Report bugs by using https://bugs.taler.net/ or by sending electronic
mail to <taler@gnu.org>.