commit 5b3d5245f389a4df56fd040316337e852f629222
parent 5d3a1b0116f439f9ff9601a58cc293be31ea6cf7
Author: MS <ms@taler.net>
Date: Fri, 4 Aug 2023 22:20:14 +0200
LibEuFin performance tutorial
Diffstat:
2 files changed, 12 insertions(+), 13 deletions(-)
diff --git a/libeufin/index.rst b/libeufin/index.rst
@@ -19,3 +19,4 @@ LibEuFin is a project providing free software tooling for European FinTech.
circuit-cli-commands
int-deployment-gv
ebics3-test-tutorial
+ performance
diff --git a/libeufin/performance.rst b/libeufin/performance.rst
@@ -1,5 +1,8 @@
+Performance demonstrators
+#########################
+
This document explains how to prove the following performance
-aspects that involve LibEuFin.
+requirements implemented in LibEuFin.
1. Long-polling offered by Nexus to the Exchange Wirewatch.
2. Reduced database usage of disk space.
@@ -7,9 +10,10 @@ aspects that involve LibEuFin.
4. Participation in the Taler benchmark.
It is worth noting that point 2 and 3 will be proved *via*
-the point 4. In particular, because the benchmark is a resource
+point 4. In particular, because the benchmark is a resource
demanding activity, its impact on the database should be
-enough to reflect a worst case scenario with rerd to points 2 and 3.
+enough to reflect a worst case scenario with regard to points
+2 and 3.
The following two sections will describe how to run
`point 1 <Long-polling>`_, and `points 2, 3, 4 <Benchmark>`_
@@ -79,25 +83,19 @@ and build the Docker image:
$ docker build -t benchmark .
Run the ``benchmark`` image and wait for its completion. At this
-point the demonstrator prints the benchmark information itself
-(without mentioning LibEuFin) and the information concerning the
-database disk usage and the database session duration.
+point, the demonstrator prints the benchmark result regarding all
+the components, and lastly the database disk usage and the LibEuFin
+database session(s) duration(s).
The database disk usage is complessive, therefore it shows how all
the services occupy database disk space. Hence if this quantity is
-acceptable, then also LibEuFin share is.
+acceptable, then also LibEuFin's share is.
On the other hand, the database session duration concerns only LibEuFin,
and compares the *longest* database session with the whole benchmark
duration. In particular, it shows what percentage of the whole benchmark
duration is represented by the longest LibEuFin session.
-
-.. TDB: should another tutorial for time-framed
- bank history be written? That doesn't really
- fit in any larger context, but it is rather an
- isolated feature.
-
..
Clone the following repository:
