Interface MetricsCollector

All Known Implementing Classes:

MicrometerMetricsCollector, NoOpMetricsCollector

public interface MetricsCollector

Interface to collect execution data of the client.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	MetricsCollector.ConsumeDisposition	The client-to-broker dispositions.
static enum	MetricsCollector.PublishDisposition	The broker-to-client dispositions.

Method Summary

Modifier and Type	Method	Description
void	closeConnection()	Called when a Connection is closed.
void	closeConsumer()	Called when a Consumer is closed.
void	closePublisher()	Called when a Publisher is closed.
void	consume()	Called when a Message is dispatched to a Consumer.
void	consumeDisposition(MetricsCollector.ConsumeDisposition disposition)	Called when a Message is settled by a Consumer.
void	openConnection()	Called when a new Connection is opened.
void	openConsumer()	Called when a new Consumer is opened.
void	openPublisher()	Called when a new Publisher is opened.
void	publish()	Called when a Message is published.
void	publishDisposition(MetricsCollector.PublishDisposition disposition)	Called when a Message is settled by the broker.
void	readBytes(int readBytes)	Called when a connection reads bytes from its socket.
void	writtenBytes(int writtenBytes)	Called when a connection writes bytes to its socket.

Method Details

openConnection

void openConnection()

Called when a new Connection is opened.

closeConnection

void closeConnection()

Called when a Connection is closed.

openPublisher

void openPublisher()

Called when a new Publisher is opened.

closePublisher

void closePublisher()

Called when a Publisher is closed.

openConsumer

void openConsumer()

Called when a new Consumer is opened.

closeConsumer

void closeConsumer()

Called when a Consumer is closed.

publish

void publish()

Called when a Message is published.

publishDisposition

void publishDisposition(MetricsCollector.PublishDisposition disposition)

Called when a Message is settled by the broker.

Parameters:

disposition - disposition (outcome)

consume

void consume()

Called when a Message is dispatched to a Consumer.

consumeDisposition

void consumeDisposition(MetricsCollector.ConsumeDisposition disposition)

Called when a Message is settled by a Consumer.

Parameters:

disposition -

writtenBytes

void writtenBytes(int writtenBytes)

Called when a connection writes bytes to its socket.

Parameters:

writtenBytes - the number of written bytes

readBytes

void readBytes(int readBytes)

Called when a connection reads bytes from its socket.

Parameters:

readBytes - the number of read bytes