summaryrefslogtreecommitdiff
path: root/manpages/taler-exchange-benchmark.1.rst
diff options
context:
space:
mode:
Diffstat (limited to 'manpages/taler-exchange-benchmark.1.rst')
-rw-r--r--manpages/taler-exchange-benchmark.1.rst50
1 files changed, 36 insertions, 14 deletions
diff --git a/manpages/taler-exchange-benchmark.1.rst b/manpages/taler-exchange-benchmark.1.rst
index 1694c353..81b8e614 100644
--- a/manpages/taler-exchange-benchmark.1.rst
+++ b/manpages/taler-exchange-benchmark.1.rst
@@ -15,17 +15,23 @@ Synopsis
**taler-exchange-benchmark**
[**-c** *CONFIG_FILENAME* | **––config=**\ ‌\ *CONFIG_FILENAME*]
-[**-b** *BANK_URL* | **––bank-url=**\ ‌\ *BANK_URL*]
+[**-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*]
-[**-l** *LOGLEVEL* | **––log-level=**\ ‌\ *LOGLEVEL*]
-[**-h** | **––help**]
+[**-p** *NPROCS* | **––parallelism=**\ \ *NPROCS*]
+[**-R** *RATE* | **––refresh-rate=**\ \ *RATE*]
+[**-r** *N* | **––reserves=**\ \ *N*]
+[**-v** | **––version**]
Description
===========
-**taler-exchange-benchmark** is a command line tool to measure the time
+**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
@@ -35,9 +41,8 @@ that table are always erased during a single benchmark run.
**-c** *CONFIG_FILENAME* \| **––config=**\ ‌\ *CONFIG_FILENAME*
(Mandatory) Use CONFIG_FILENAME.
-**-b** *BANK_URL* \| **––bank-url=**\ ‌\ *BANK_URL*
- (Mandatory) The URL where the fakebank listens at. Must match the
- host component in the exchange’s escrow account “payto” URL.
+**-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
@@ -46,21 +51,38 @@ that table are always erased during a single benchmark run.
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.
+ with a probability RATE (see option ``--refresh-rate``).
-**-l** *LOGLEVEL* \| **––log-level=**\ ‌\ *LOGLEVEL*
- GNUnet-compatible log level, takes values “ERROR/WARNING/INFO/DEBUG”
+**-p** *NPROCS* \| **––parallelism=**\ \ *NPROCS*
+ Run with *NPROCS* client processes.
-**-h** \| **––help**
- Prints a compiled-in help text.
+**-R** *RATE* \| **––refresh-rate=**\ \ *RATE*
+ Defaults to 10. Probability of refresh per coin (0-100).
+
+**-r** *N* \| **––reserves=**\ \ *N*
+ Create *N* reserves per client.
+
+**-v** \| **––version**
+ Print version information.
See Also
========