reactor.netty.channel

Class MicrometerChannelMetricsRecorder

java.lang.Object

reactor.netty.channel.MicrometerChannelMetricsRecorder

All Implemented Interfaces:

ChannelMetricsRecorder

Direct Known Subclasses:

MicrometerHttpMetricsRecorder

public class MicrometerChannelMetricsRecorder
extends Object
implements ChannelMetricsRecorder

A ChannelMetricsRecorder implementation for integration with Micrometer.

Since:

0.9

Author:

Violeta Georgieva

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	BYTES_UNIT
protected static String	DATA_RECEIVED_DESCRIPTION
protected static String	DATA_SENT_DESCRIPTION
protected static String	ERRORS_DESCRIPTION

Constructor Summary

Constructors

Constructor and Description
MicrometerChannelMetricsRecorder(String name, String protocol)

Method Summary

Modifier and Type	Method and Description
protected static <M extends io.micrometer.core.instrument.Meter> M	filter(M meter)
void	incrementErrorsCount(SocketAddress remoteAddress) Increments the number of the errors that are occurred.
protected String	name()
protected String	protocol()
void	recordConnectTime(SocketAddress remoteAddress, Duration time, String status) Records the time that is spent for connecting to the remote address.
void	recordDataReceived(SocketAddress remoteAddress, long bytes) Records the amount of the data that is received, in bytes.
void	recordDataSent(SocketAddress remoteAddress, long bytes) Records the amount of the data that is sent, in bytes.
void	recordResolveAddressTime(SocketAddress remoteAddress, Duration time, String status) Records the time that is spent for resolving the remote address.
void	recordServerConnectionClosed(SocketAddress serverAddress) Records a just disconnected server connection.
void	recordServerConnectionOpened(SocketAddress serverAddress) Records a just accepted server connection.
void	recordTlsHandshakeTime(SocketAddress remoteAddress, Duration time, String status) Records the time that is spent for TLS handshake.

Methods inherited from class java.lang.Object

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

Field Detail

BYTES_UNIT

protected static final String BYTES_UNIT

See Also:

Constant Field Values

DATA_RECEIVED_DESCRIPTION

protected static final String DATA_RECEIVED_DESCRIPTION

See Also:

Constant Field Values

DATA_SENT_DESCRIPTION

protected static final String DATA_SENT_DESCRIPTION

See Also:

Constant Field Values

ERRORS_DESCRIPTION

protected static final String ERRORS_DESCRIPTION

See Also:

Constant Field Values

Constructor Detail

MicrometerChannelMetricsRecorder

public MicrometerChannelMetricsRecorder(String name,
                                        String protocol)

Method Detail

recordDataReceived

public void recordDataReceived(SocketAddress remoteAddress,
                               long bytes)

Description copied from interface: ChannelMetricsRecorder

Records the amount of the data that is received, in bytes.

Specified by:

recordDataReceived in interface ChannelMetricsRecorder

Parameters:

remoteAddress - The remote peer

bytes - The amount of the data that is received, in bytes

recordDataSent

public void recordDataSent(SocketAddress remoteAddress,
                           long bytes)

Description copied from interface: ChannelMetricsRecorder

Records the amount of the data that is sent, in bytes.

Specified by:

recordDataSent in interface ChannelMetricsRecorder

Parameters:

remoteAddress - The remote peer

bytes - The amount of the data that is sent, in bytes

incrementErrorsCount

public void incrementErrorsCount(SocketAddress remoteAddress)

Description copied from interface: ChannelMetricsRecorder

Increments the number of the errors that are occurred.

Specified by:

incrementErrorsCount in interface ChannelMetricsRecorder

Parameters:

remoteAddress - The remote peer

recordTlsHandshakeTime

public void recordTlsHandshakeTime(SocketAddress remoteAddress,
                                   Duration time,
                                   String status)

Description copied from interface: ChannelMetricsRecorder

Records the time that is spent for TLS handshake.

Specified by:

recordTlsHandshakeTime in interface ChannelMetricsRecorder

Parameters:

remoteAddress - The remote peer

time - the time in nanoseconds that is spent for TLS handshake

status - the status of the operation

recordConnectTime

public void recordConnectTime(SocketAddress remoteAddress,
                              Duration time,
                              String status)

Description copied from interface: ChannelMetricsRecorder

Records the time that is spent for connecting to the remote address. Relevant only when on the client

Specified by:

recordConnectTime in interface ChannelMetricsRecorder

Parameters:

remoteAddress - The remote peer

time - the time in nanoseconds that is spent for connecting to the remote address

status - the status of the operation

recordResolveAddressTime

public void recordResolveAddressTime(SocketAddress remoteAddress,
                                     Duration time,
                                     String status)

Description copied from interface: ChannelMetricsRecorder

Records the time that is spent for resolving the remote address. Relevant only when on the client.

Specified by:

recordResolveAddressTime in interface ChannelMetricsRecorder

Parameters:

remoteAddress - The remote peer

time - the time in nanoseconds that is spent for resolving to the remote address

status - the status of the operation

recordServerConnectionOpened

public void recordServerConnectionOpened(SocketAddress serverAddress)

Description copied from interface: ChannelMetricsRecorder

Records a just accepted server connection.

Specified by:

recordServerConnectionOpened in interface ChannelMetricsRecorder

Parameters:

serverAddress - the server local address

recordServerConnectionClosed

public void recordServerConnectionClosed(SocketAddress serverAddress)

Description copied from interface: ChannelMetricsRecorder

Records a just disconnected server connection.

Specified by:

recordServerConnectionClosed in interface ChannelMetricsRecorder

Parameters:

serverAddress - the server local address

filter

@Nullable
protected static <M extends io.micrometer.core.instrument.Meter> M filter(M meter)

name

protected String name()

protocol

protected String protocol()