Aeron Samples

Here you will find a collection of samples and tools for Aeron.

Each of the Samples can be run with a simple script that can be found in:

aeron-samples/scripts/

Before running any of the samples below the media driver needs to be launched by running one of:

aeron-samples/scripts/media-driver <optional properties file>
aeron-samples/scripts/low-latency-media-driver <optional properties file>

Here is a brief list of the samples and what each tries to do:

BasicSubscriber: A simple subscriber that prints the contents of messages it receives.
BasicPublisher: A simple publisher that sends a number of messages with a one-second pause between them.
RateSubscriber: A subscriber that prints the rate of reception of messages.
StreamingPublisher: A publisher that streams out messages as fast as possible, displaying rate of publication.
Ping: Ping side of Ping/Pong latency testing tool.
Pong: Pong side of Ping/Pong latency testing tool.

Here is a brief list of monitoring and diagnostic tools:

AeronStat: A monitoring tool that prints the labels and values of the counters in use by a media driver.
ErrorStat: A monitoring tool that prints the distinct errors observed by the media driver.
LossStat: A Monitoring tool that prints a report of loss recorded by stream.
BacklogStat: A monitoring tool that prints a report of stream positions to give and indication of backlog for processing on each stream.
LogInspector: A diagnostic tool that prints out the contents of a log buffer for a given stream for debugging.

Also included is some performance tests that can run all in the same process for convenience without a media driver, or across processes for illustration, with variants for throughput or latency measurement:

embedded: Tests tend to run in the same process.
media: Variants for IPC using shared memory or UDP via the network.

Aeron Archive Samples

In the archive sub-directory, or package, you can find samples for recording and replay of streams from an Archive.

aeron-samples/scripts/archive/