Core functionality for the Reactor Netty library 1.1.16 · reactor.netty.Metrics

Field Summary

Modifier and Type	Field and Description
public static final String	ACTIVE_CONNECTIONS The number of the connections that have been successfully acquired and are in active use.
public static final String	ACTIVE_DIRECT_MEMORY The actual bytes consumed by in-use buffers allocated from direct buffer pools.
public static final String	ACTIVE_HEAP_MEMORY The actual bytes consumed by in-use buffers allocated from heap buffer pools.
public static final String	ACTIVE_STREAMS The number of the active HTTP/2 streams.
public static final String	ADDRESS_RESOLVER Time spent for resolving the address.
public static final String	BYTE_BUF_ALLOCATOR_PREFIX Name prefix that will be used for the ByteBufAllocator's metrics registered in Micrometer's global registry.
public static final String	CHUNK_SIZE The chunk size for an arena.
public static final String	CONNECT_TIME Time spent for connecting to the remote address.
public static final String	CONNECTION_PROVIDER_PREFIX Name prefix that will be used for the PooledConnectionProvider's metrics registered in Micrometer's global registry.
public static final String	CONNECTIONS_ACTIVE The number of connections that are currently in use.
public static final String	CONNECTIONS_TOTAL The number of all connections, whether they are active or idle.
pack-priv static final AttributeKey<ContextView>	CONTEXT_VIEW
public static final String	DATA_RECEIVED Amount of the data received, in bytes.
public static final String	DATA_RECEIVED_TIME Time spent in consuming incoming data.
public static final String	DATA_SENT Amount of the data sent, in bytes.
public static final String	DATA_SENT_TIME Time spent in sending outgoing data.
public static final String	DIRECT_ARENAS The number of direct arenas.
public static final String	ERROR
public static final String	ERRORS Number of errors that occurred.
public static final String	EVENT_LOOP_PREFIX Name prefix that will be used for Event Loop Group metrics registered in Micrometer's global registry.
public static final String	HEAP_ARENAS The number of heap arenas.
public static final String	HTTP_CLIENT_PREFIX Name prefix that will be used for the HTTP client's metrics registered in Micrometer's global registry.
public static final String	HTTP_SERVER_PREFIX Name prefix that will be used for the HTTP server's metrics registered in Micrometer's global registry.
public static final String	ID
public static final String	IDLE_CONNECTIONS The number of the idle connections.
public static final String	LOCAL_ADDRESS
public static final String	MAX_CONNECTIONS The maximum number of active connections that are allowed.
public static final String	MAX_PENDING_CONNECTIONS The maximum number of requests that will be queued while waiting for a ready connection.
public static final String	METHOD
public static final String	NAME
public static final String	NORMAL_CACHE_SIZE The size of the normal cache.
public static final String	OBSERVATION_KEY
public static ObservationRegistry	OBSERVATION_REGISTRY
public static final String	PENDING_CONNECTIONS The number of requests that are waiting for a connection.
public static final String	PENDING_STREAMS The number of requests that are waiting for opening HTTP/2 stream.
public static final String	PENDING_TASKS The number of tasks that are pending for processing on an event loop.
public static final io.micrometer.core.instrument.MeterRegistry	REGISTRY
public static final String	REMOTE_ADDRESS
public static final String	RESPONSE_TIME Total time for the request/response.
public static final String	SMALL_CACHE_SIZE The size of the small cache.
public static final String	STATUS
public static final String	STREAMS_ACTIVE The number of active HTTP/2 streams.
public static final String	SUCCESS
public static final String	TCP_CLIENT_PREFIX Name prefix that will be used for the TCP client's metrics registered in Micrometer's global registry.
public static final String	TCP_SERVER_PREFIX Name prefix that will be used for the TCP server's metrics registered in Micrometer's global registry.
public static final String	THREAD_LOCAL_CACHES The number of thread local caches.
public static final String	TLS_HANDSHAKE_TIME Time spent for TLS handshake.
public static final String	TOTAL_CONNECTIONS The number of all connections, active or idle.
public static final String	TYPE
public static final String	UDP_CLIENT_PREFIX Name prefix that will be used for the UDP client's metrics registered in Micrometer's global registry.
public static final String	UDP_SERVER_PREFIX Name prefix that will be used for the UDP server's metrics registered in Micrometer's global registry.
public static final String	UNKNOWN
public static final String	URI
public static final String	USED_DIRECT_MEMORY The number of bytes reserved by direct buffer allocator.
public static final String	USED_HEAP_MEMORY The number of bytes reserved by heap buffer allocator.

Constructor Summary

Access	Constructor and Description
public	Metrics()

Method Summary

Modifier and Type	Method and Description
public static Observation	currentObservation(ContextView contextView)
public static String	formatSocketAddress(SocketAddress socketAddress)
public static ObservationRegistry	Returns: the previously configured registry. observationRegistry(ObservationRegistry observationRegistry) Set the `ObservationRegistry` to use in Reactor Netty for tracing related purposes.
public static ContextView	Returns: the previous `Observation` when exists otherwise `null` updateChannelContext(Channel the channel channel, Observation the `Observation` observation) Updates the `ContextView` in the channel attributes with this `Observation`.
public static Context	updateContext(Context context, Object observation)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

ACTIVE_CONNECTIONS	back to summary
public static final String ACTIVE_CONNECTIONS The number of the connections that have been successfully acquired and are in active use.

ACTIVE_DIRECT_MEMORY	back to summary
public static final String ACTIVE_DIRECT_MEMORY The actual bytes consumed by in-use buffers allocated from direct buffer pools.

ACTIVE_HEAP_MEMORY	back to summary
public static final String ACTIVE_HEAP_MEMORY The actual bytes consumed by in-use buffers allocated from heap buffer pools.

ACTIVE_STREAMS	back to summary
public static final String ACTIVE_STREAMS The number of the active HTTP/2 streams.

ADDRESS_RESOLVER	back to summary
public static final String ADDRESS_RESOLVER Time spent for resolving the address.

BYTE_BUF_ALLOCATOR_PREFIX	back to summary
public static final String BYTE_BUF_ALLOCATOR_PREFIX Name prefix that will be used for the ByteBufAllocator's metrics registered in Micrometer's global registry.

CHUNK_SIZE	back to summary
public static final String CHUNK_SIZE The chunk size for an arena.

CONNECT_TIME	back to summary
public static final String CONNECT_TIME Time spent for connecting to the remote address.

CONNECTION_PROVIDER_PREFIX	back to summary
public static final String CONNECTION_PROVIDER_PREFIX Name prefix that will be used for the PooledConnectionProvider's metrics registered in Micrometer's global registry.

CONNECTIONS_ACTIVE	back to summary
public static final String CONNECTIONS_ACTIVE The number of connections that are currently in use.

CONNECTIONS_TOTAL	back to summary
public static final String CONNECTIONS_TOTAL The number of all connections, whether they are active or idle.

CONTEXT_VIEW	back to summary
pack-priv static final AttributeKey<ContextView> CONTEXT_VIEW

DATA_RECEIVED	back to summary
public static final String DATA_RECEIVED Amount of the data received, in bytes.

DATA_RECEIVED_TIME	back to summary
public static final String DATA_RECEIVED_TIME Time spent in consuming incoming data.

DATA_SENT	back to summary
public static final String DATA_SENT Amount of the data sent, in bytes.

DATA_SENT_TIME	back to summary
public static final String DATA_SENT_TIME Time spent in sending outgoing data.

DIRECT_ARENAS	back to summary
public static final String DIRECT_ARENAS The number of direct arenas.

ERROR	back to summary
public static final String ERROR

ERRORS	back to summary
public static final String ERRORS Number of errors that occurred.

EVENT_LOOP_PREFIX	back to summary
public static final String EVENT_LOOP_PREFIX Name prefix that will be used for Event Loop Group metrics registered in Micrometer's global registry.

HEAP_ARENAS	back to summary
public static final String HEAP_ARENAS The number of heap arenas.

HTTP_CLIENT_PREFIX	back to summary
public static final String HTTP_CLIENT_PREFIX Name prefix that will be used for the HTTP client's metrics registered in Micrometer's global registry.

HTTP_SERVER_PREFIX	back to summary
public static final String HTTP_SERVER_PREFIX Name prefix that will be used for the HTTP server's metrics registered in Micrometer's global registry.

ID	back to summary
public static final String ID

IDLE_CONNECTIONS	back to summary
public static final String IDLE_CONNECTIONS The number of the idle connections.

LOCAL_ADDRESS	back to summary
public static final String LOCAL_ADDRESS

MAX_CONNECTIONS	back to summary
public static final String MAX_CONNECTIONS The maximum number of active connections that are allowed.

MAX_PENDING_CONNECTIONS	back to summary
public static final String MAX_PENDING_CONNECTIONS The maximum number of requests that will be queued while waiting for a ready connection.

METHOD	back to summary
public static final String METHOD

NAME	back to summary
public static final String NAME

NORMAL_CACHE_SIZE	back to summary
public static final String NORMAL_CACHE_SIZE The size of the normal cache.

OBSERVATION_KEY	back to summary
public static final String OBSERVATION_KEY

OBSERVATION_REGISTRY	back to summary
public static ObservationRegistry OBSERVATION_REGISTRY

PENDING_CONNECTIONS	back to summary
public static final String PENDING_CONNECTIONS The number of requests that are waiting for a connection.

PENDING_STREAMS	back to summary
public static final String PENDING_STREAMS The number of requests that are waiting for opening HTTP/2 stream.

PENDING_TASKS	back to summary
public static final String PENDING_TASKS The number of tasks that are pending for processing on an event loop.

REGISTRY	back to summary
public static final io.micrometer.core.instrument.MeterRegistry REGISTRY

REMOTE_ADDRESS	back to summary
public static final String REMOTE_ADDRESS

RESPONSE_TIME	back to summary
public static final String RESPONSE_TIME Total time for the request/response.

SMALL_CACHE_SIZE	back to summary
public static final String SMALL_CACHE_SIZE The size of the small cache.

STATUS	back to summary
public static final String STATUS

STREAMS_ACTIVE	back to summary
public static final String STREAMS_ACTIVE The number of active HTTP/2 streams.

SUCCESS	back to summary
public static final String SUCCESS

TCP_CLIENT_PREFIX	back to summary
public static final String TCP_CLIENT_PREFIX Name prefix that will be used for the TCP client's metrics registered in Micrometer's global registry.

TCP_SERVER_PREFIX	back to summary
public static final String TCP_SERVER_PREFIX Name prefix that will be used for the TCP server's metrics registered in Micrometer's global registry.

THREAD_LOCAL_CACHES	back to summary
public static final String THREAD_LOCAL_CACHES The number of thread local caches.

TLS_HANDSHAKE_TIME	back to summary
public static final String TLS_HANDSHAKE_TIME Time spent for TLS handshake.

TOTAL_CONNECTIONS	back to summary
public static final String TOTAL_CONNECTIONS The number of all connections, active or idle.

TYPE	back to summary
public static final String TYPE

UDP_CLIENT_PREFIX	back to summary
public static final String UDP_CLIENT_PREFIX Name prefix that will be used for the UDP client's metrics registered in Micrometer's global registry.

UDP_SERVER_PREFIX	back to summary
public static final String UDP_SERVER_PREFIX Name prefix that will be used for the UDP server's metrics registered in Micrometer's global registry.

UNKNOWN	back to summary
public static final String UNKNOWN

URI	back to summary
public static final String URI

USED_DIRECT_MEMORY	back to summary
public static final String USED_DIRECT_MEMORY The number of bytes reserved by direct buffer allocator.

USED_HEAP_MEMORY	back to summary
public static final String USED_HEAP_MEMORY The number of bytes reserved by heap buffer allocator.

Constructor Detail

Metrics	back to summary
public Metrics()

Method Detail

currentObservation	back to summary
public static Observation currentObservation(ContextView contextView) Annotations @Nullable

formatSocketAddress	back to summary
public static String formatSocketAddress(SocketAddress socketAddress) Annotations @Nullable

observationRegistry back to summary

public static ObservationRegistry observationRegistry(ObservationRegistry observationRegistry)

Set the ObservationRegistry to use in Reactor Netty for tracing related purposes.

Returns:ObservationRegistry: the previously configured registry.
Since: 1.1.6

updateChannelContext back to summary

public static ContextView updateChannelContext(Channel channel, Observation observation)

Updates the ContextView in the channel attributes with this Observation. When there is already Observation in the ContextView, then is will be set as a parent to this Observation.

Parameters

channel:Channel: the channel
observation:Observation: the Observation

Returns:ContextView

the previous Observation when exists otherwise null

Annotations

@Nullable

Since

1.1.1