org.voltdb.client

Class ClientStatsUtil

java.lang.Object

org.voltdb.client.ClientStatsUtil

public final class ClientStatsUtil
extends java.lang.Object

Utility methods for use with ClientStats objects.

Constructor Summary

Constructors

Constructor and Description
ClientStatsUtil()

Method Summary

Modifier and Type	Method and Description
static void	writeSummaryCSV(ClientStats stats, java.lang.String path) Append a single line of comma-separated values to the file specified.
static void	writeSummaryCSV(java.lang.String statsRowName, ClientStats stats, java.lang.String path) Write a single line of comma-separated values to the file specified.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ClientStatsUtil

public ClientStatsUtil()

Method Detail

writeSummaryCSV

public static void writeSummaryCSV(ClientStats stats,
                                   java.lang.String path)
                            throws java.io.IOException

Append a single line of comma-separated values to the file specified. Used mainly for collecting results from benchmarks.

The format of this output is subject to change between versions. As of V11.0 there are 13 fields. The format is:

1. Timestamp (ms) of creation of the given ClientStats instance, stats.
2. Duration from first procedure call within the given ClientStats instance until this call.
3. Count of invocations completed.
4. Minimum round trip latency estimate.
5. Maximum round trip latency estimate.
6. 95-percentile round trip latency estimate.
7. 99-percentile round trip latency estimate.
8. 99.9-percentile round trip latency estimate.
9. 99.99-percentile round trip latency estimate.
10. 99.999-percentile round trip latency estimate.
11. Count of invocation errors.
12. Count of invocation aborts.
13. Count of invocation timeouts.

All times are given in milliseconds.

Parameters:

stats - ClientStats instance with relevant stats

path - path to write to, passed to FileWriter(String)

Throws:

java.io.IOException - on any file write error

writeSummaryCSV

public static void writeSummaryCSV(java.lang.String statsRowName,
                                   ClientStats stats,
                                   java.lang.String path)
                            throws java.io.IOException

Write a single line of comma-separated values to the file specified. Used mainly for collecting results from benchmarks.

The format of this output is subject to change between versions. See writeSummaryCSV(ClientStats, String) for the format.

This variation on writeSummaryCSV inserts an initial column containing a user-specified string; this can be used to identify the row. Users should not use a mix of the two forms of writeSummaryCSV on the same file, since the format will be inconsistent.

Parameters:

statsRowName - name to be inserted as first column

stats - ClientStats instance with relevant stats

path - path to write to, passed to FileWriter(String)

Throws:

java.io.IOException - on any file write error