aboutsummaryrefslogtreecommitdiffstats
path: root/fbench/README
diff options
context:
space:
mode:
authorHenning Baldersheim <balder@yahoo-inc.com>2022-09-16 16:48:24 +0000
committerHenning Baldersheim <balder@yahoo-inc.com>2022-09-16 16:48:24 +0000
commit76a24d977c3ca1526561d3a6ab2c36652b668522 (patch)
treec7d4750db6e5966d099f0fab6e63f7f34defe408 /fbench/README
parent1d62389c5d66d88df6d7389a8270611059eb351d (diff)
Clean up remaining fbench perl scripts no longer used.
Diffstat (limited to 'fbench/README')
-rw-r--r--fbench/README95
1 files changed, 0 insertions, 95 deletions
diff --git a/fbench/README b/fbench/README
index 8d217ad0dc5..17807cb3931 100644
--- a/fbench/README
+++ b/fbench/README
@@ -20,16 +20,8 @@ The above installation provides the follwing vespa-fbench executables:
/opt/vespa/bin/vespa-fbench
/opt/vespa/bin/vespa-fbench-filter-file
/opt/vespa/bin/vespa-fbench-geturl
- /opt/vespa/bin/vespa-fbench-result-filter.pl
/opt/vespa/bin/vespa-fbench-split-file
-Additional utilities referenced in this document can be fetched from
-https://github.com/vespa-engine/vespa/tree/master/fbench/util:
- plot.pl
- pretest.sh
- runtests.sh
- separate.pl
-
It is also possible to use Docker to directly execute vespa-fbench by
using the pre-built Vespa docker image:
docker run --entrypoint /opt/vespa/bin/vespa-fbench \
@@ -251,90 +243,3 @@ results. This section will explain what each of these numbers mean.
utilization will drop since the client has
'wasted' the time spent on the failed
request.
-
-
-6 Running test series
----------------------
-
-For more complete benchmarking you will want to combine the results
-from several test runs and present them together in a graph or maybe a
-spreadsheet. The perl script vespa-fbench-result-filter.pl may be used to convert
-the output from vespa-fbench into a single line of numbers. Lines of numbers
-produced from several test runs may then be concatenated into the same
-text file and used to plot a graph with gnuplot or imported into an
-application accepting structured text files (like Excel).
-
-The task described above is performed by the runtests.sh script. It
-runs vespa-fbench several times with varying client count and cycle
-time. Between each test run, the script pretest.sh (located in the bin
-directory) is run. The pretest.sh script should make sure that the
-server you want to benchmark is in the same state before each of the
-test runs. This typically means that the caches should be cleared. The
-supplied pretest.sh file does nothing, and should therefore be
-modified to fit your needs before you start benchmarking with the
-runtests.sh script. NOTE: 'runtests.sh' must be run from the vespa-fbench
-install directory in order to find the scripts and programs it depends
-on. (vespa-fbench is run as 'bin/vespa-fbench' etc.).
-
-| usage: runtests.sh [-o] [-l] <minClients> <maxClients> <deltaClients>
-| <minCycle> <maxCycle> <deltaCycle> [vespa-fbench options] <hostname> <port>
-|
-| The number of clients varies from <minClients> to <maxClients> with
-| <deltaClients> increments. For each client count, the cycle time will
-| vary in the same way according to <minCycle>, <maxCycle> and <deltaCycle>.
-| vespa-fbench is run with each combination of client count and cycle time, and
-| the result output is filtered with the 'vespa-fbench-result-filter.pl' script.
-| If you want to save the results you should redirect stdout to a file.
-|
-| -o : change the order in which the tests are performed so that client
-| count varies for each cycle time.
-| -l : output a blank line between test subseries. If -o is not specified this
-| will output a blank line between test series using different client count.
-| If -o was specified this will output blank lines between test series
-| using different cycle time.
-|
-| [vespa-fbench options] <hostname> <port>: These arguments are passed to vespa-fbench.
-| There are 2 things to remember: first; do not specify either of the -n
-| or -c options since they will override the values for client count and
-| cycle time generated by this script. secondly; make sure you specify
-| the correct host and port number. See the vespa-fbench usage (run vespa-fbench
-| without parameters) for more info on how to invoke vespa-fbench.
-
-Example: You want to see how well fastserver performs with varying
-client count and cycle time. Assume that you have already prepared 200
-query files. To test with client count
-from 10 to 200 with intervals of 10 clients and cycle time from 0 to
-5000 milliseconds with 500 ms intervals you may do the following:
-
-$ bin/runtests.sh 10 200 10 0 5000 500 <host> <port>
-
-The duration of each test run will be 60 seconds (the default). This
-may be a little short. You will also get all results written directly
-to your console. Say you want to run each test run for 5 minutes and
-you want to collect the results in the file 'results.txt'. You may
-then do the following:
-
-$ bin/runtests.sh 10 200 10 0 5000 500 -s 300 <host> <port> > result.txt
-
-The '-s 300' option will be given to vespa-fbench causing each test run to
-have a duration of 300 seconds = 5 minutes. The standard output is
-simply redirected to a file to collect the results for future use.
-
-The perl utility scripts separate.pl and plot.pl may be used to create
-graphs using gnuplot.
-
-| usage: separate.pl <sepcol>
-| Separate a tabular numeric file into chunks using a blank
-| line whenever the value in column 'sepcol' changes.
-
-| usage: plot.pl [-h] [-x] <plotno>
-| Plot the contents of 'result.txt'.
-| -h This help
-| -x Output to X11 window (default PS-file 'graph.ps')
-| plotno: 1: Response Time Percentiles by NumCli
-| 2: Rate by NumCli
-| 3: Response Time Percentiles by Rate
-
-Note that the separate.pl script does the same thing as the -l option
-of runtests.sh; it inserts blank lines into the result to let gnuplot
-interpret each chunk as a separate dataseries.