net.openhft.chronicle.jlbh

Class JLBH

java.lang.Object

net.openhft.chronicle.jlbh.JLBH

All Implemented Interfaces:

net.openhft.chronicle.core.util.NanoSampler

public class JLBH
extends Object
implements net.openhft.chronicle.core.util.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.

This class is not thread-safe.

Field Summary

Fields

Modifier and Type	Field and Description
static int	TIME_CALL_NANO_TIME

Constructor Summary

Constructors

Constructor and Description
JLBH(@NotNull JLBHOptions jlbhOptions)
JLBH(@NotNull JLBHOptions jlbhOptions, @NotNull 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()
@NotNull Map<String,List<double[]>>	additionalPercentileRuns()
net.openhft.chronicle.core.util.NanoSampler	addProbe(String name) Add a probe to measure a section of the benchmark.
protected @NotNull net.openhft.chronicle.core.util.Histogram	createHistogram()
void	eventLoopHandler(@NotNull net.openhft.chronicle.core.threads.EventLoop eventLoop) 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, @NotNull List<double[]> percentileRuns, Appendable appendable)
void	sample(long durationNs)
void	sampleNanos(long durationNs)
void	start() Start benchmark

Methods inherited from class java.lang.Object

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

Field Detail

TIME_CALL_NANO_TIME

public static final int TIME_CALL_NANO_TIME

See Also:

Constant Field Values

Constructor Detail

JLBH

public JLBH(@NotNull
            @NotNull JLBHOptions jlbhOptions)

Parameters:

jlbhOptions - Options to run the benchmark

JLBH

public JLBH(@NotNull
            @NotNull JLBHOptions jlbhOptions,
            @NotNull
            @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 net.openhft.chronicle.core.util.NanoSampler addProbe(String name)

Add a probe to measure a section of the benchmark.

Parameters:

name - Name of probe

Returns:

NanoSampler

additionalPercentileRuns

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

abort

public void abort()

start

public void start()

Start benchmark

percentileRuns

public List<double[]> percentileRuns()

eventLoopHandler

public void eventLoopHandler(@NotNull
                             @NotNull net.openhft.chronicle.core.threads.EventLoop eventLoop)

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
                                    @NotNull List<double[]> percentileRuns,
                                    Appendable appendable)

sampleNanos

public void sampleNanos(long durationNs)

Specified by:

sampleNanos in interface net.openhft.chronicle.core.util.NanoSampler

sample

public void sample(long durationNs)

createHistogram

@NotNull
protected @NotNull net.openhft.chronicle.core.util.Histogram createHistogram()