[taler-docs] branch master updated (c3950e69 -> 3adad886)

[gnunet]

This is an automated email from the git hooks/post-receive script.

grothoff pushed a change to branch master
in repository docs.

    from c3950e69 update benchmarking section in exchange operator manual
     new ce9f808e update description of taler-merchant-benchmark
     new 3adad886 update documentation

The 2 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails.  The revisions
listed as "add" were already present in the repository and have only
been added to this reference.


Summary of changes:
 manpages/taler-bank-benchmark.1.rst     | 22 ++++-----
 manpages/taler-exchange-benchmark.1.rst |  5 +-
 manpages/taler-merchant-benchmark.1.rst | 13 ++---
 taler-exchange-manual.rst               |  2 +
 taler-merchant-manual.rst               | 87 ++++++++++++++-------------------
 5 files changed, 55 insertions(+), 74 deletions(-)

diff --git a/manpages/taler-bank-benchmark.1.rst 
b/manpages/taler-bank-benchmark.1.rst
index 52078fa9..eaf1c542 100644
--- a/manpages/taler-bank-benchmark.1.rst
+++ b/manpages/taler-bank-benchmark.1.rst
@@ -13,18 +13,17 @@ Synopsis
 
 **taler-bank-benchmark**
 [**-c** *FILENAME* | **--config=**\ ‌\ *FILENAME*]
+[**-f** | **--fakebank**]
 [**-h** | **--help**]
-[**-K** | **--linger**]
 [**-L** *LOGLEVEL* | **--loglevel=**\ ‌\ *LOGLEVEL*]
 [**-l** *FILENAME* | **--logfile=**\ ‌\ *FILENAME*]
-[**-m** *MODE* | **--mode=**\ \ *MODE*]
 [**-p** *NPROCS* | **--worker-parallelism=**\ \ *NPROCS*]
 [**-P** *NTHREADS* | **--service-parallelism=**\ \ *NTHREADS*]
 [**-r** *NRESERVES* | **--reserves=**\ \ *NRESERVES*]
-[**-s** *HISTSIZE* | **--size=**\ \ *HISTSIZE*]
+[**-u** *SECTION* | **--exchange-account-section=**\ \ *SECTION*]
 [**-V** | **--verbose**]
 [**-v** | **--version**]
-[**-w** | **--wirewatch**]
+[**-w**_*NPROC* | **--wirewatch=**\ \ *NPROC*]
 
 
 Description
@@ -39,12 +38,12 @@ The options for **taler-bank-benchmark** are:
    Use the configuration and other resources for the merchant to operate
    from *FILENAME*.
 
+**-f** \| **--fakebank**
+   Expect to be run against a fakebank (instead of against libeufin)
+
 **-h** \| **--help**
    Print short help on options.
 
-**-K** \| **--linger**
-   Linger around until key press.
-
 **-L** *LOGLEVEL* \| **--loglevel=**\ ‌\ *LOGLEVEL*
    Specifies the log level to use. Accepted values are: ``DEBUG``, ``INFO``,
    ``WARNING``, ``ERROR``.
@@ -65,8 +64,8 @@ The options for **taler-bank-benchmark** are:
 **-r** *NRESERVES* \| **--reserves=**\ \ *NRESERVES*
    Create *NRESERVES* reserves per client.
 
-**-s** *HISTSIZE* \| **--size=**\ \ *HISTSIZE*
-   Configure the fakebank to keep in memory at most *HISTSIZE* history 
elements.
+**-u** *SECTION* \| **--exchange-account-section=**\ \ *SECTION*
+   Use *SECTION* as the name of the configuration section which specifies the 
exchange bank account.
 
 **-V** \| **--verbose**
    Display more output than usual.
@@ -74,8 +73,9 @@ The options for **taler-bank-benchmark** are:
 **-v** \| **--version**
    Print version information.
 
-**-w** \| **--wirewatch**
-   Run the ``taler-exchange-wirewatch`` tool.
+**-w** *NPROC* \| **--wirewatch=**\ \ *NPROC*
+   Run *NPROC* processes of the ``taler-exchange-wirewatch`` tool.
+
 
 See Also
 ========
diff --git a/manpages/taler-exchange-benchmark.1.rst 
b/manpages/taler-exchange-benchmark.1.rst
index 1c5441d6..694a4b2d 100644
--- a/manpages/taler-exchange-benchmark.1.rst
+++ b/manpages/taler-exchange-benchmark.1.rst
@@ -18,13 +18,13 @@ Synopsis
 [**-F** | **--reserves-first**]
 [**-f** | **--fakebank**]
 [**-h** | **--help**]
-[**-K** | **--linger**]
 [**-L** *LOGLEVEL* | **--log-level=**\ ‌\ *LOGLEVEL*]
 [**-l** *FILENAME* | **--logfile=**\ ‌\ *FILENAME*]
 [**-n** *HOWMANY_COINS* | **--coins-number=**\ ‌\ *HOWMANY_COINS*]
 [**-p** *NPROCS* | **--parallelism=**\ \ *NPROCS*]
 [**-R** *RATE* | **--refresh-rate=**\ \ *RATE*]
 [**-r** *N* | **--reserves=**\ \ *N*]
+[**-u** *SECTION* | **--exchange-account-section=**\ \ *SECTION*]
 [**-v** | **--version**]
 
 Description
@@ -46,9 +46,6 @@ the GNU Taler services must already be running at the 
configured addresses.
 **-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``.
diff --git a/manpages/taler-merchant-benchmark.1.rst 
b/manpages/taler-merchant-benchmark.1.rst
index 2f91634a..7016c9d4 100644
--- a/manpages/taler-merchant-benchmark.1.rst
+++ b/manpages/taler-merchant-benchmark.1.rst
@@ -29,20 +29,16 @@ Subcommands
 ordinary
        Generate normal payments: all the payments are performed (by the
        default instance) and aggregated by the exchange.  Takes the following
-       options.
+       option:
 
        **-p** *PN* \| **--payments-number=**\ \ *PN*
               Perform PN many payments, defaults to 1.
 
 
-       **-t** *TN* \| **--tracks-number=**\ \ *TN*
-              Perform TN many tracking operations, defaults to 1.
-
-
 corner
        Drive the generator to create unusual situations, like for example
        leaving payments unaggregated, or using a non-default merchant
-       instance.  Takes the following options.
+       instance.  Takes the following options:
 
 
        **-t** *TC* \| **--two-coins=**\ \ *TC*
@@ -67,8 +63,7 @@ Common Options
    Use the configuration and other resources for the merchant to
    operate from FILENAME.
 
-**-e** *SECTION* \| **--exchange-account=**\ \ *SECTION*
-   Mandatory.
+**-u** *SECTION* \| **--exchange-account-section=**\ \ *SECTION*
    Configuration *SECTION* specifying the exchange account to use.
 
 **-h** \| **--help**
@@ -88,7 +83,7 @@ Common Options
 See Also
 ========
 
-taler-merchant-dbinit(1), taler-merchant-tip-enable(1), taler.conf(5)
+taler-merchant-dbinit(1), taler.conf(5)
 
 
 Bugs
diff --git a/taler-exchange-manual.rst b/taler-exchange-manual.rst
index 2e6e63b6..a97528f2 100644
--- a/taler-exchange-manual.rst
+++ b/taler-exchange-manual.rst
@@ -2257,6 +2257,8 @@ some options that are determined at runtime by the setup 
logic provided by
 ``taler-unified-setup.sh``.
 
 
+.. _Benchmark-choose-bank:
+
 Choosing a bank
 ---------------
 
diff --git a/taler-merchant-manual.rst b/taler-merchant-manual.rst
index 2685b47c..25c3ae75 100644
--- a/taler-merchant-manual.rst
+++ b/taler-merchant-manual.rst
@@ -1036,64 +1036,57 @@ The database scheme used by the merchant looks as 
follows:
 Benchmarking
 ------------
 
-The merchant codebase offers the ``taler-merchant-benchmark`` tool to
-populate the database with fake payments. This tool is in charge of
-starting a merchant, exchange, and bank processes, and provides them all
-the input to accomplish payments. Note that each component will use its
-own configuration (as they would do in production).
+The merchant codebase offers the ``taler-merchant-benchmark`` tool to populate
+the database with fake payments.  The main goal of the benchmarking tool is to
+serve as a starting point (!) for merchants that are interested in developing
+stress tests to see how far their infrastructure can scale. As is, it
+currently is not actually good at stressing the payment system.
 
-The main goal of the benchmarking tool is to serve as a starting point (!) for
-merchants that are interested in developing stress tests to see how far their
-infrastructure can scale.
+The ``taler-unified-setup.sh`` script can be used to launch all required
+services and clients. However, the resulting deployment is simplistic
+(everything on the local machine, one single-threaded process per service
+type) and not optimized for performance at all. However, this can still be
+useful to assess the performance impact of changes
+to the code or configuration.
 
-The current tool has already a few options, but we expect that to deliver
-*relevant* results it will need to be customized to better reflect the
-workload of a particular merchant.  This customization would at this point
-likely involve writing (C) code.  We welcome contributions to make it easier
-to customize the benchmark and/or to cover more realistic workloads from the
-start.
-
-
-Benchmark setup
-^^^^^^^^^^^^^^^
 
-The ``taler-merchant-benchmark`` tool will automatically launch and configure 
the
-exchange, (Python) bank and other tools required for the benchmark. However,
-the configuration file must be provided and have consistent options set.  The
-options that require special care include the exchange's public key (which
-must match the private key in the file specified by the configuration), the
-currency (which must be consistent across the file), the denomination
-structure (which must enable payments in the range of 100ths of the unit
-currency (often called cents)). Furthermore, the benchmark will set the
-Exchange bank account password to be "x", so the configuration must also
-specify "x" for the passphrase.  Finally, the bank must be configured to allow
-for substantial debt least the transactions by the benchmark run out of
-digital cash.
+Various configuration files that can be used in the code snippets in this
+section can be found in the ``src/merchant-tools/`` directory of the
+merchant. These are generally intended as starting points.  Note that the
+configuration files ending in ``.edited`` are created by
+``taler-unified-setup.sh`` and contain some options that are determined at
+runtime by the setup logic provided by ``taler-unified-setup.sh``.
 
-A relatively minimal configuration could look like this:
+See :ref:`Taler Exchange Manual <Benchmark-choose-bank>` for how to use 
``taler-unified-setup.sh`` to setup the system and in particular on how to 
specify the bank to be used.
 
-.. literalinclude:: merchant-benchmark.conf
+Running taler-merchant-benchmark
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
+You can run the tool as follows:
 
-Note that the public key must match the exchange's
-private key and that the PostgreSQL database must
-exist before launching the benchmark.  You also
-will need to ensure that the Exchange's
-details are set up.
-For details, see the :ref:`Exchange Operator Manual <Bank-account>`.
+.. code-block:: console
 
+    $ CONF=benchmark-rsa.conf
+    $ taler-unified-setup.sh -emwt -c "$CONF" -f -u exchange-account-1
+    $ time taler-merchant-benchmark ordinary -c "$CONF".edited -u 
exchange-account-1 -f -p 20
 
-Running the benchmark command
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+The current tool has already a few options, but we expect that to deliver
+*relevant* results it will need to be customized to better reflect the
+workload of a particular merchant.  This customization would at this point
+likely involve writing (C) code.  We welcome contributions to make it easier
+to customize the benchmark and/or to cover more realistic workloads from the
+start.
 
 The tool takes all of the values it needs from the command line, with
-one of them being mandatory:
+some of them being common to all subcommands:
 
--  ``--exchange-account=SECTION`` Specifies which configuration
+-  ``--exchange-account-section=SECTION`` Specifies which configuration
    section specifies the bank account for the exchange that
    should be used for the benchmark. For the example
    configuration above, the SECTION value provided must be
    ``exchange-account-exchange``.
+-  ``--fakebank`` Specifies that the benchmark should expect to interact
+   with a fakebank (instead of libeufin).
 
 The tool comes with two operation modes: *ordinary*, and *corner*.
 The first just executes normal payments, meaning that it uses the
@@ -1124,17 +1117,11 @@ interesting, there are:
    perform *UN* (one coin) payments that will be left unaggregated.
 
 As for the ``ordinary`` subcommand, it is worth explaining the following
-options:
+option:
 
 -  ``--payments-number=PN`` Instructs the tool to perform *PN* payments.
 
--  ``--tracks-number=TN`` Instructs the tool to perform *TN* tracking
-   operations. Note that the **total** amount of operations will be two
-   times *TN*, since "one" tracking operation accounts for
-   ``/track/transaction`` and ``/track/transfer``. This command should
-   only be used to see if the operation ends without problems, as no
-   actual measurement of performance is provided (despite of the
-   ’benchmark’ word used in the tool’s name).
+
 
 
 

-- 
To stop receiving notification emails like this one, please contact
gnunet@gnunet.org.