io.aeron.samples

Class BacklogStat

java.lang.Object

io.aeron.samples.BacklogStat

public class BacklogStat
extends Object

Tool for taking a snapshot of Aeron streams backlog information and some explanation for the StreamStat counters.

Each stream managed by the MediaDriver will be sampled and printed out on System.out.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BacklogStat.StreamBacklog Represents the backlog information for a particular stream of messages.
static class	BacklogStat.StreamCompositeKey Composite key which identifies an Aeron stream of messages.

Constructor Summary

Constructors

Constructor and Description
BacklogStat(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.
void	print(PrintStream out) Print a snapshot of the stream backlog with some explanation to a PrintStream.
Map<BacklogStat.StreamCompositeKey,BacklogStat.StreamBacklog>	snapshot() Take a snapshot of all the backlog information and group by stream.

Methods inherited from class java.lang.Object

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

Constructor Detail

BacklogStat

public BacklogStat(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<BacklogStat.StreamCompositeKey,BacklogStat.StreamBacklog> snapshot()

Take a snapshot of all the backlog information and group by stream.

Returns:

a snapshot of all the backlog information and group by stream.

print

public void print(PrintStream out)

Print a snapshot of the stream backlog with some explanation to a PrintStream.

Each stream will be printed in its own section.

Parameters:

out - to which the stream backlog will be written.