Metrics (reactor-netty 1.1.13)

java.lang.Object
- reactor.netty.Metrics

```
public class Metrics
extends Object
```
Constants and utilities around metrics.

Since:

0.9

Author:

Violeta Georgieva

Field Summary

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

Constructor Summary

Constructors
Constructor and Description

Metrics()

Constructors
Constructor and Description
`Metrics()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static io.micrometer.observation.Observation`	`currentObservation(ContextView contextView)`
`static String`	`formatSocketAddress(SocketAddress socketAddress)`
`static io.micrometer.observation.ObservationRegistry`	`observationRegistry(io.micrometer.observation.ObservationRegistry observationRegistry)` Set the `ObservationRegistry` to use in Reactor Netty for tracing related purposes.
`static ContextView`	`updateChannelContext(Channel channel, io.micrometer.observation.Observation observation)` Updates the `ContextView` in the channel attributes with this `Observation`.
`static Context`	`updateContext(Context context, Object observation)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - REGISTRY
```
public static final io.micrometer.core.instrument.MeterRegistry REGISTRY
```
  - OBSERVATION_KEY
```
public static final String OBSERVATION_KEY
```
    See Also:
    
    Constant Field Values
  - OBSERVATION_REGISTRY
```
public static io.micrometer.observation.ObservationRegistry OBSERVATION_REGISTRY
```
  - HTTP_SERVER_PREFIX
```
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.
    
    See Also:
    
    Constant Field Values
  - HTTP_CLIENT_PREFIX
```
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.
    
    See Also:
    
    Constant Field Values
  - TCP_SERVER_PREFIX
```
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.
    
    See Also:
    
    Constant Field Values
  - TCP_CLIENT_PREFIX
```
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.
    
    See Also:
    
    Constant Field Values
  - UDP_SERVER_PREFIX
```
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.
    
    See Also:
    
    Constant Field Values
  - UDP_CLIENT_PREFIX
```
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.
    
    See Also:
    
    Constant Field Values
  - EVENT_LOOP_PREFIX
```
public static final String EVENT_LOOP_PREFIX
```
    Name prefix that will be used for Event Loop Group metrics registered in Micrometer's global registry.
    
    See Also:
    
    Constant Field Values
  - CONNECTION_PROVIDER_PREFIX
```
public static final String CONNECTION_PROVIDER_PREFIX
```
    Name prefix that will be used for the PooledConnectionProvider's metrics registered in Micrometer's global registry.
    
    See Also:
    
    Constant Field Values
  - BYTE_BUF_ALLOCATOR_PREFIX
```
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.
    
    See Also:
    
    Constant Field Values
  - DATA_RECEIVED
```
public static final String DATA_RECEIVED
```
    Amount of the data received, in bytes.
    
    See Also:
    
    Constant Field Values
  - DATA_SENT
```
public static final String DATA_SENT
```
    Amount of the data sent, in bytes.
    
    See Also:
    
    Constant Field Values
  - ERRORS
```
public static final String ERRORS
```
    Number of errors that occurred.
    
    See Also:
    
    Constant Field Values
  - TLS_HANDSHAKE_TIME
```
public static final String TLS_HANDSHAKE_TIME
```
    Time spent for TLS handshake.
    
    See Also:
    
    Constant Field Values
  - CONNECT_TIME
```
public static final String CONNECT_TIME
```
    Time spent for connecting to the remote address.
    
    See Also:
    
    Constant Field Values
  - DATA_RECEIVED_TIME
```
public static final String DATA_RECEIVED_TIME
```
    Time spent in consuming incoming data.
    
    See Also:
    
    Constant Field Values
  - DATA_SENT_TIME
```
public static final String DATA_SENT_TIME
```
    Time spent in sending outgoing data.
    
    See Also:
    
    Constant Field Values
  - RESPONSE_TIME
```
public static final String RESPONSE_TIME
```
    Total time for the request/response.
    
    See Also:
    
    Constant Field Values
  - CONNECTIONS_TOTAL
```
public static final String CONNECTIONS_TOTAL
```
    The number of all connections, whether they are active or idle.
    
    See Also:
    
    Constant Field Values
  - CONNECTIONS_ACTIVE
```
public static final String CONNECTIONS_ACTIVE
```
    The number of connections that are currently in use.
    
    See Also:
    
    Constant Field Values
  - ADDRESS_RESOLVER
```
public static final String ADDRESS_RESOLVER
```
    Time spent for resolving the address.
    
    See Also:
    
    Constant Field Values
  - TOTAL_CONNECTIONS
```
public static final String TOTAL_CONNECTIONS
```
    The number of all connections, active or idle.
    
    See Also:
    
    Constant Field Values
  - ACTIVE_CONNECTIONS
```
public static final String ACTIVE_CONNECTIONS
```
    The number of the connections that have been successfully acquired and are in active use.
    
    See Also:
    
    Constant Field Values
  - MAX_CONNECTIONS
```
public static final String MAX_CONNECTIONS
```
    The maximum number of active connections that are allowed.
    
    See Also:
    
    Constant Field Values
  - IDLE_CONNECTIONS
```
public static final String IDLE_CONNECTIONS
```
    The number of the idle connections.
    
    See Also:
    
    Constant Field Values
  - PENDING_CONNECTIONS
```
public static final String PENDING_CONNECTIONS
```
    The number of requests that are waiting for a connection.
    
    See Also:
    
    Constant Field Values
  - MAX_PENDING_CONNECTIONS
```
public static final String MAX_PENDING_CONNECTIONS
```
    The maximum number of requests that will be queued while waiting for a ready connection.
    
    See Also:
    
    Constant Field Values
  - ACTIVE_STREAMS
```
public static final String ACTIVE_STREAMS
```
    The number of the active HTTP/2 streams.
    
    See Also:
    
    Constant Field Values
  - PENDING_STREAMS
```
public static final String PENDING_STREAMS
```
    The number of requests that are waiting for opening HTTP/2 stream.
    
    See Also:
    
    Constant Field Values
  - USED_HEAP_MEMORY
```
public static final String USED_HEAP_MEMORY
```
    The number of bytes reserved by heap buffer allocator.
    
    See Also:
    
    Constant Field Values
  - USED_DIRECT_MEMORY
```
public static final String USED_DIRECT_MEMORY
```
    The number of bytes reserved by direct buffer allocator.
    
    See Also:
    
    Constant Field Values
  - ACTIVE_HEAP_MEMORY
```
public static final String ACTIVE_HEAP_MEMORY
```
    The actual bytes consumed by in-use buffers allocated from heap buffer pools.
    
    See Also:
    
    Constant Field Values
  - ACTIVE_DIRECT_MEMORY
```
public static final String ACTIVE_DIRECT_MEMORY
```
    The actual bytes consumed by in-use buffers allocated from direct buffer pools.
    
    See Also:
    
    Constant Field Values
  - HEAP_ARENAS
```
public static final String HEAP_ARENAS
```
    The number of heap arenas.
    
    See Also:
    
    Constant Field Values
  - DIRECT_ARENAS
```
public static final String DIRECT_ARENAS
```
    The number of direct arenas.
    
    See Also:
    
    Constant Field Values
  - THREAD_LOCAL_CACHES
```
public static final String THREAD_LOCAL_CACHES
```
    The number of thread local caches.
    
    See Also:
    
    Constant Field Values
  - SMALL_CACHE_SIZE
```
public static final String SMALL_CACHE_SIZE
```
    The size of the small cache.
    
    See Also:
    
    Constant Field Values
  - NORMAL_CACHE_SIZE
```
public static final String NORMAL_CACHE_SIZE
```
    The size of the normal cache.
    
    See Also:
    
    Constant Field Values
  - CHUNK_SIZE
```
public static final String CHUNK_SIZE
```
    The chunk size for an arena.
    
    See Also:
    
    Constant Field Values
  - PENDING_TASKS
```
public static final String PENDING_TASKS
```
    The number of tasks that are pending for processing on an event loop.
    
    See Also:
    
    Constant Field Values
  - STREAMS_ACTIVE
```
public static final String STREAMS_ACTIVE
```
    The number of active HTTP/2 streams.
    
    See Also:
    
    Constant Field Values
  - LOCAL_ADDRESS
```
public static final String LOCAL_ADDRESS
```
    See Also:
    
    Constant Field Values
  - REMOTE_ADDRESS
```
public static final String REMOTE_ADDRESS
```
    See Also:
    
    Constant Field Values
  - URI
```
public static final String URI
```
    See Also:
    
    Constant Field Values
  - STATUS
```
public static final String STATUS
```
    See Also:
    
    Constant Field Values
  - METHOD
```
public static final String METHOD
```
    See Also:
    
    Constant Field Values
  - ID
```
public static final String ID
```
    See Also:
    
    Constant Field Values
  - NAME
```
public static final String NAME
```
    See Also:
    
    Constant Field Values
  - TYPE
```
public static final String TYPE
```
    See Also:
    
    Constant Field Values
  - SUCCESS
```
public static final String SUCCESS
```
    See Also:
    
    Constant Field Values
  - ERROR
```
public static final String ERROR
```
    See Also:
    
    Constant Field Values
  - UNKNOWN
```
public static final String UNKNOWN
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Metrics
```
public Metrics()
```
- Method Detail
  - currentObservation
```
@Nullable
public static io.micrometer.observation.Observation currentObservation(ContextView contextView)
```
  - formatSocketAddress
```
@Nullable
public static String formatSocketAddress(@Nullable
                                                   SocketAddress socketAddress)
```
  - observationRegistry
```
public static io.micrometer.observation.ObservationRegistry observationRegistry(io.micrometer.observation.ObservationRegistry observationRegistry)
```
    Set the ObservationRegistry to use in Reactor Netty for tracing related purposes.
    
    Returns:
    
    the previously configured registry.
    
    Since:
    
    1.1.6
  - updateContext
```
public static Context updateContext(Context context,
                                    Object observation)
```
  - updateChannelContext
```
@Nullable
public static ContextView updateChannelContext(Channel channel,
                                                         io.micrometer.observation.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 - the channel
    
    observation - the Observation
    
    Returns:
    
    the previous Observation when exists otherwise null
    
    Since:
    
    1.1.1

Class Metrics

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

REGISTRY

OBSERVATION_KEY

OBSERVATION_REGISTRY

HTTP_SERVER_PREFIX

HTTP_CLIENT_PREFIX

TCP_SERVER_PREFIX

TCP_CLIENT_PREFIX

UDP_SERVER_PREFIX

UDP_CLIENT_PREFIX

EVENT_LOOP_PREFIX

CONNECTION_PROVIDER_PREFIX

BYTE_BUF_ALLOCATOR_PREFIX

DATA_RECEIVED

DATA_SENT

ERRORS

TLS_HANDSHAKE_TIME

CONNECT_TIME

DATA_RECEIVED_TIME

DATA_SENT_TIME

RESPONSE_TIME

CONNECTIONS_TOTAL

CONNECTIONS_ACTIVE

ADDRESS_RESOLVER

TOTAL_CONNECTIONS

ACTIVE_CONNECTIONS

MAX_CONNECTIONS

IDLE_CONNECTIONS

PENDING_CONNECTIONS

MAX_PENDING_CONNECTIONS

ACTIVE_STREAMS

PENDING_STREAMS

USED_HEAP_MEMORY

USED_DIRECT_MEMORY

ACTIVE_HEAP_MEMORY

ACTIVE_DIRECT_MEMORY

HEAP_ARENAS

DIRECT_ARENAS

THREAD_LOCAL_CACHES

SMALL_CACHE_SIZE

NORMAL_CACHE_SIZE

CHUNK_SIZE

PENDING_TASKS

STREAMS_ACTIVE

LOCAL_ADDRESS

REMOTE_ADDRESS

URI

STATUS

METHOD

ID

NAME

TYPE

SUCCESS

ERROR

UNKNOWN

Constructor Detail

Metrics

Method Detail

currentObservation

formatSocketAddress

observationRegistry

updateContext

updateChannelContext