summaryrefslogtreecommitdiff
path: root/manpages/taler-exchange-benchmark.1.rst
diff options
context:
space:
mode:
authorFlorian Dold <florian.dold@gmail.com>2019-09-18 18:50:34 +0200
committerFlorian Dold <florian.dold@gmail.com>2019-09-18 18:50:34 +0200
commit5c91c3f6c001e37366ad9bf9dfd8835fed9d4d10 (patch)
tree5f75fd693a1d062c7e5702f30c466c24a90e0fe2 /manpages/taler-exchange-benchmark.1.rst
parentaf61db1b78f82241163861a5770d67e2442ef803 (diff)
downloaddocs-5c91c3f6c001e37366ad9bf9dfd8835fed9d4d10.tar.gz
docs-5c91c3f6c001e37366ad9bf9dfd8835fed9d4d10.tar.bz2
docs-5c91c3f6c001e37366ad9bf9dfd8835fed9d4d10.zip
manpages live here now
Diffstat (limited to 'manpages/taler-exchange-benchmark.1.rst')
-rw-r--r--manpages/taler-exchange-benchmark.1.rst63
1 files changed, 63 insertions, 0 deletions
diff --git a/manpages/taler-exchange-benchmark.1.rst b/manpages/taler-exchange-benchmark.1.rst
new file mode 100644
index 0000000..4ea2378
--- /dev/null
+++ b/manpages/taler-exchange-benchmark.1.rst
@@ -0,0 +1,63 @@
+taler-exchange-benchmark(1)
+###########################
+
+
+.. only:: html
+
+ Name
+ ====
+
+ **taler-exchange-benchmark** - measure exchange performance
+
+
+Synopsis
+========
+
+**taler-exchange-benchmark**
+[**-c** *CONFIG_FILENAME* | **--config=**\ ‌\ *CONFIG_FILENAME*]
+[**-b** *BANK_URL* | **—bank-url=**\ ‌\ *BANK_URL*]
+[**-n** *HOWMANY_COINS* | **--coins-number=**\ ‌\ *HOWMANY_COINS*]
+[**-l** *LOGLEVEL* | **--log-level=**\ ‌\ *LOGLEVEL*]
+[**-h** | **--help**]
+
+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.
+
+**-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.
+
+**-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.
+
+**-l** *LOGLEVEL* \| **--log-level=**\ ‌\ *LOGLEVEL*
+ GNUnet-compatible log level, takes values “ERROR/WARNING/INFO/DEBUG”
+
+**-h** \| **--help**
+ Prints a compiled-in help text.
+
+See Also
+========
+
+taler-exchange-dbinit(1), taler-exchange-keyup(1),
+taler-exchange-httpd(1), taler.conf(5)
+
+Bugs
+====
+
+Report bugs by using https://gnunet.org/bugs/ or by sending electronic
+mail to <taler@gnu.org>.