reactor.netty.channel

Interface ChannelMetricsRecorder

All Known Subinterfaces:

HttpClientMetricsRecorder, HttpMetricsRecorder, HttpServerMetricsRecorder

All Known Implementing Classes:

ContextAwareChannelMetricsRecorder, ContextAwareHttpClientMetricsRecorder, ContextAwareHttpMetricsRecorder, ContextAwareHttpServerMetricsRecorder, MicrometerChannelMetricsRecorder, MicrometerHttpMetricsRecorder

public interface ChannelMetricsRecorder

Interface for recording metrics on protocol level.

Author:

Violeta Georgieva

Method Summary

Modifier and Type	Method and Description
void	incrementErrorsCount(SocketAddress remoteAddress) Increments the number of the errors that have occurred.
default void	incrementErrorsCount(SocketAddress remoteAddress, SocketAddress proxyAddress) Increments the number of the errors that have occurred.
void	recordConnectTime(SocketAddress remoteAddress, Duration time, String status) Records the time that is spent for connecting to the remote address.
default void	recordConnectTime(SocketAddress remoteAddress, SocketAddress proxyAddress, 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.
default void	recordDataReceived(SocketAddress remoteAddress, SocketAddress proxyAddress, 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.
default void	recordDataSent(SocketAddress remoteAddress, SocketAddress proxyAddress, 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.
default void	recordServerConnectionClosed(SocketAddress localAddress) Records a just disconnected server connection.
default void	recordServerConnectionOpened(SocketAddress localAddress) Records a just accepted server connection.
void	recordTlsHandshakeTime(SocketAddress remoteAddress, Duration time, String status) Records the time that is spent for TLS handshake.
default void	recordTlsHandshakeTime(SocketAddress remoteAddress, SocketAddress proxyAddress, Duration time, String status) Records the time that is spent for TLS handshake.

Method Detail

recordDataReceived

void recordDataReceived(SocketAddress remoteAddress,
                        long bytes)

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

Parameters:

remoteAddress - The remote peer

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

recordDataReceived

default void recordDataReceived(SocketAddress remoteAddress,
                                SocketAddress proxyAddress,
                                long bytes)

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

Parameters:

remoteAddress - The remote peer

proxyAddress - The proxy address

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

Since:

1.1.17

recordDataSent

void recordDataSent(SocketAddress remoteAddress,
                    long bytes)

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

Parameters:

remoteAddress - The remote peer

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

recordDataSent

default void recordDataSent(SocketAddress remoteAddress,
                            SocketAddress proxyAddress,
                            long bytes)

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

Parameters:

remoteAddress - The remote peer

proxyAddress - The proxy address

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

Since:

1.1.17

incrementErrorsCount

void incrementErrorsCount(SocketAddress remoteAddress)

Increments the number of the errors that have occurred.

Parameters:

remoteAddress - The remote peer

incrementErrorsCount

default void incrementErrorsCount(SocketAddress remoteAddress,
                                  SocketAddress proxyAddress)

Increments the number of the errors that have occurred.

Parameters:

remoteAddress - The remote peer

proxyAddress - The proxy address

Since:

1.1.17

recordTlsHandshakeTime

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

Records the time that is spent for TLS handshake.

Parameters:

remoteAddress - The remote peer

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

status - the status of the operation

recordTlsHandshakeTime

default void recordTlsHandshakeTime(SocketAddress remoteAddress,
                                    SocketAddress proxyAddress,
                                    Duration time,
                                    String status)

Records the time that is spent for TLS handshake.

Parameters:

remoteAddress - The remote peer

proxyAddress - The proxy address

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

status - the status of the operation

Since:

1.1.17

recordConnectTime

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

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

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

recordConnectTime

default void recordConnectTime(SocketAddress remoteAddress,
                               SocketAddress proxyAddress,
                               Duration time,
                               String status)

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

Parameters:

remoteAddress - The remote peer

proxyAddress - The proxy address

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

status - the status of the operation

Since:

1.1.17

recordResolveAddressTime

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

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

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

default void recordServerConnectionOpened(SocketAddress localAddress)

Records a just accepted server connection.

Parameters:

localAddress - the server local address

Since:

1.0.15

recordServerConnectionClosed

default void recordServerConnectionClosed(SocketAddress localAddress)

Records a just disconnected server connection.

Parameters:

localAddress - the server local address

Since:

1.0.15