io.nats.benchmark

Class Benchmark

java.lang.Object

io.nats.benchmark.Sample

io.nats.benchmark.Benchmark

public class Benchmark
extends Sample

A utility class for collecting and calculating benchmark metrics.

Constructor Summary

Constructors

Constructor and Description
Benchmark()
Benchmark(String name, int subCnt, int pubCnt)
Benchmark(String name, String runId, int subCnt, int pubCnt) Initializes a Benchmark.

Method Summary

Modifier and Type	Method and Description
void	addPubSample(Sample sample)
void	addSubSample(Sample sample)
void	close() Closes this benchmark and calculates totals and times.
List<String>	csv() Returns a list of text lines for output to a CSV file.
String	report() Creates the output report.

Methods inherited from class io.nats.benchmark.Sample

duration, rate, seconds, throughput, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Benchmark

public Benchmark()

Benchmark

public Benchmark(String name,
                 int subCnt,
                 int pubCnt)

Benchmark

public Benchmark(String name,
                 String runId,
                 int subCnt,
                 int pubCnt)

Initializes a Benchmark. After creating a bench call addSubSample/addPubSample. When done collecting samples, call endBenchmark.

Parameters:

name - a descriptive name for this test run

runId - a unique id for this test run (typically a guid)

subCnt - the number of subscribers

pubCnt - the number of publishers

Method Detail

addPubSample

public void addPubSample(Sample sample)

addSubSample

public void addSubSample(Sample sample)

close

public void close()

Closes this benchmark and calculates totals and times.

report

public String report()

Creates the output report.

Returns:

the report as a String.

csv

public List<String> csv()

Returns a list of text lines for output to a CSV file.

Returns:

a list of text lines for output to a CSV file