net.openhft.chronicle.core.jlbh

Class JLBH

java.lang.Object

net.openhft.chronicle.core.jlbh.JLBH

All Implemented Interfaces:

NanoSampler

public class JLBH
extends Object
implements NanoSampler

Java Latency Benchmark Harness The harness is intended to be used for benchmarks where co-ordinated omission is an issue. Typically these would be of the producer/consumer nature where the start time for the benchmark may be on a different thread than the end time.

This tool was inspired by JMH.

Constructor Summary

Constructors

Constructor and Description
JLBH(JLBHOptions jlbhOptions)
JLBH(JLBHOptions jlbhOptions, PrintStream printStream, Consumer<JLBHResult> resultConsumer) Use this constructor if you want to test the latencies in more automated fashion.

Method Summary

Modifier and Type	Method and Description
void	abort()
Map<String,List<double[]>>	additionalPercentileRuns()
NanoSampler	addProbe(String name) Add a probe to measure a section of the benchmark.
protected Histogram	createHistogram()
net.openhft.chronicle.core.jlbh.JLBH.JLBHEventHandler	eventLoopHandler() Call this instead of start if you want to install JLBH as a handler on your event loop thread
List<double[]>	percentileRuns()
void	printPercentilesSummary(String label, List<double[]> percentileRuns, Appendable appendable)
void	sample(long nanoTime)
void	sampleNanos(long nanos)
void	start() Start benchmark

Methods inherited from class java.lang.Object

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

Constructor Detail

JLBH

public JLBH(@NotNull
            JLBHOptions jlbhOptions)

Parameters:

jlbhOptions - Options to run the benchmark

JLBH

public JLBH(@NotNull
            JLBHOptions jlbhOptions,
            @NotNull
            PrintStream printStream,
            Consumer<JLBHResult> resultConsumer)

Use this constructor if you want to test the latencies in more automated fashion. The result is passed to the result consumer after the JLBH::start method returns. You can create you own consumer, or use provided JLBHResultConsumer::newThreadSafeInstance() that allows you to retrieve the result even if the JLBH has been executed in a different thread.

Parameters:

jlbhOptions - Options to run the benchmark

printStream - Used to print text output. Use System.out to show the result on you standard out (e.g. screen)

resultConsumer - If provided, accepts the result data to be retrieved after the latencies have been measured

Method Detail

addProbe

public NanoSampler addProbe(String name)

Add a probe to measure a section of the benchmark.

Parameters:

name - Name of probe

Returns:

NanoSampler

additionalPercentileRuns

@NotNull
public Map<String,List<double[]>> additionalPercentileRuns()

abort

public void abort()

start

public void start()

Start benchmark

percentileRuns

public List<double[]> percentileRuns()

eventLoopHandler

public net.openhft.chronicle.core.jlbh.JLBH.JLBHEventHandler eventLoopHandler()

Call this instead of start if you want to install JLBH as a handler on your event loop thread

printPercentilesSummary

public void printPercentilesSummary(String label,
                                    @NotNull
                                    List<double[]> percentileRuns,
                                    Appendable appendable)

sampleNanos

public void sampleNanos(long nanos)

Specified by:

sampleNanos in interface NanoSampler

sample

public void sample(long nanoTime)

createHistogram

@NotNull
protected Histogram createHistogram()