io.aeron.samples

Class StreamStat

java.lang.Object

io.aeron.samples.StreamStat

public final class StreamStat
extends Object

Tool for taking a snapshot of Aeron streams and relevant position counters.

Each stream managed by the MediaDriver will be sampled and a line of text output per stream with each of the position counters for that stream.

Each counter has the format: <label-name>:<registration-id>:<position value>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	StreamStat.StreamCompositeKey Composite key which identifies an Aeron stream of messages.
static class	StreamStat.StreamPosition Represents a position within a particular stream of messages.

Constructor Summary

Constructors

Constructor and Description
StreamStat(CountersReader counters) Construct by using a CountersReader which can be obtained from Aeron.countersReader().

Method Summary

Modifier and Type	Method and Description
static void	main(String[] args) Main method for launching the process.
int	print(PrintStream out) Print a snapshot of the stream positions to a PrintStream.
Map<StreamStat.StreamCompositeKey,List<StreamStat.StreamPosition>>	snapshot() Take a snapshot of all the counters and group them by streams.

Methods inherited from class java.lang.Object

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

Constructor Detail

StreamStat

public StreamStat(CountersReader counters)

Construct by using a CountersReader which can be obtained from Aeron.countersReader().

Parameters:

counters - to read for tracking positions.

Method Detail

main

public static void main(String[] args)

Main method for launching the process.

Parameters:

args - passed to the process.

snapshot

public Map<StreamStat.StreamCompositeKey,List<StreamStat.StreamPosition>> snapshot()

Take a snapshot of all the counters and group them by streams.

Returns:

a snapshot of all the counters and group them by streams.

print

public int print(PrintStream out)

Print a snapshot of the stream positions to a PrintStream.

Each stream will be printed on its own line.

Parameters:

out - to which the stream snapshot will be written.

Returns:

the number of streams printed.