SystemCounterDescriptor (Aeron Message Transport)

java.lang.Object
- java.lang.Enum<SystemCounterDescriptor>
- - io.aeron.driver.status.SystemCounterDescriptor

All Implemented Interfaces:

Serializable, Comparable<SystemCounterDescriptor>
```
public enum SystemCounterDescriptor
extends Enum<SystemCounterDescriptor>
```
System wide counters for monitoring. These are separate from counters used for position tracking on streams.

Enum Constant Summary

Enum Constants
Enum Constant and Description
`BYTES_RECEIVED` Running total of bytes received for data over UDP, excluding IP headers.
`BYTES_SENT` Running total of bytes sent for data over UDP, excluding IP headers.
`CLIENT_TIMEOUTS` Count of the Aeron clients that have timed out without a graceful close.
`CONDUCTOR_CYCLE_TIME_THRESHOLD_EXCEEDED` Count of the number of times the cycle time threshold has been exceeded by the conductor in its work cycle.
`CONDUCTOR_MAX_CYCLE_TIME` The maximum time spent by the conductor between work cycles.
`CONDUCTOR_PROXY_FAILS` Failed offers to the driver conductor proxy suggesting back-pressure.
`CONTROLLABLE_IDLE_STRATEGY` Current status of the `ControllableIdleStrategy` if configured.
`ERRORS` Count of errors observed by the driver and an indication to read the distinct error log.
`FLOW_CONTROL_OVER_RUNS` Count of packets received which over-run the current flow control window for images.
`FLOW_CONTROL_UNDER_RUNS` Count of packets received which under-run the current flow control window for images.
`FREE_FAILS` Count of attempts to free log buffers no longer required by the driver which as still held by clients.
`HEARTBEATS_RECEIVED` Count of heartbeat data frames received to indicate liveness in the absence of data to send.
`HEARTBEATS_SENT` Count of heartbeat data frames sent to indicate liveness in the absence of data to send.
`INVALID_PACKETS` Count of invalid packets received.
`LOSS_GAP_FILLS` Count of the times a loss gap has been filled when NAKs have been disabled.
`NAK_MESSAGES_RECEIVED` Count of NAKs received from receivers requesting re-transmits.
`NAK_MESSAGES_SENT` Count of NAKs sent back to senders requesting re-transmits.
`POSSIBLE_TTL_ASYMMETRY` Count of the times the channel endpoint detected a possible TTL asymmetry between its config and new connection.
`RECEIVER_PROXY_FAILS` Failed offers to the receiver proxy suggesting back-pressure.
`RESOLUTION_CHANGES` Count of the times a connection endpoint has be re-resolved resulting in a change.
`RETRANSMITS_SENT` Count of data packets re-transmitted as a result of NAKs.
`SENDER_FLOW_CONTROL_LIMITS` Count of the times a sender has entered the state of being back-pressured when it could have sent faster.
`SENDER_PROXY_FAILS` Failed offers to the sender proxy suggesting back-pressure.
`SHORT_SENDS` Count of socket send operation which resulted in less than the packet length being sent.
`STATUS_MESSAGES_RECEIVED` Count of status messages received from receivers for flow control.
`STATUS_MESSAGES_SENT` Count of status messages sent back to senders for flow control.
`UNBLOCKED_COMMANDS` Count of the times a command has been unblocked after a client failed to complete an offer within a timeout.
`UNBLOCKED_PUBLICATIONS` Count of the times a publication has been unblocked after a client failed to complete an offer within a timeout.

Field Summary

Fields
Modifier and Type Field and Description

static int SYSTEM_COUNTER_TYPE_ID
All system counters have the same type id, i.e.

Fields
Modifier and Type	Field and Description
`static int`	`SYSTEM_COUNTER_TYPE_ID` All system counters have the same type id, i.e.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static SystemCounterDescriptor`	`get(int id)` Get the `SystemCounterDescriptor` for a given id.
`int`	`id()` The unique identity for the system counter.
`String`	`label()` The human readable label to identify a system counter.
`AtomicCounter`	`newCounter(CountersManager countersManager)` Create a new counter for the enumerated descriptor.
`static SystemCounterDescriptor`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static SystemCounterDescriptor[]`	`values()` Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Enum Constant Detail
  - BYTES_SENT
```
public static final SystemCounterDescriptor BYTES_SENT
```
    Running total of bytes sent for data over UDP, excluding IP headers.
  - BYTES_RECEIVED
```
public static final SystemCounterDescriptor BYTES_RECEIVED
```
    Running total of bytes received for data over UDP, excluding IP headers.
  - RECEIVER_PROXY_FAILS
```
public static final SystemCounterDescriptor RECEIVER_PROXY_FAILS
```
    Failed offers to the receiver proxy suggesting back-pressure.
  - SENDER_PROXY_FAILS
```
public static final SystemCounterDescriptor SENDER_PROXY_FAILS
```
    Failed offers to the sender proxy suggesting back-pressure.
  - CONDUCTOR_PROXY_FAILS
```
public static final SystemCounterDescriptor CONDUCTOR_PROXY_FAILS
```
    Failed offers to the driver conductor proxy suggesting back-pressure.
  - NAK_MESSAGES_SENT
```
public static final SystemCounterDescriptor NAK_MESSAGES_SENT
```
    Count of NAKs sent back to senders requesting re-transmits.
  - NAK_MESSAGES_RECEIVED
```
public static final SystemCounterDescriptor NAK_MESSAGES_RECEIVED
```
    Count of NAKs received from receivers requesting re-transmits.
  - STATUS_MESSAGES_SENT
```
public static final SystemCounterDescriptor STATUS_MESSAGES_SENT
```
    Count of status messages sent back to senders for flow control.
  - STATUS_MESSAGES_RECEIVED
```
public static final SystemCounterDescriptor STATUS_MESSAGES_RECEIVED
```
    Count of status messages received from receivers for flow control.
  - HEARTBEATS_SENT
```
public static final SystemCounterDescriptor HEARTBEATS_SENT
```
    Count of heartbeat data frames sent to indicate liveness in the absence of data to send.
  - HEARTBEATS_RECEIVED
```
public static final SystemCounterDescriptor HEARTBEATS_RECEIVED
```
    Count of heartbeat data frames received to indicate liveness in the absence of data to send.
  - RETRANSMITS_SENT
```
public static final SystemCounterDescriptor RETRANSMITS_SENT
```
    Count of data packets re-transmitted as a result of NAKs.
  - FLOW_CONTROL_UNDER_RUNS
```
public static final SystemCounterDescriptor FLOW_CONTROL_UNDER_RUNS
```
    Count of packets received which under-run the current flow control window for images.
  - FLOW_CONTROL_OVER_RUNS
```
public static final SystemCounterDescriptor FLOW_CONTROL_OVER_RUNS
```
    Count of packets received which over-run the current flow control window for images.
  - INVALID_PACKETS
```
public static final SystemCounterDescriptor INVALID_PACKETS
```
    Count of invalid packets received.
  - ERRORS
```
public static final SystemCounterDescriptor ERRORS
```
    Count of errors observed by the driver and an indication to read the distinct error log.
  - SHORT_SENDS
```
public static final SystemCounterDescriptor SHORT_SENDS
```
    Count of socket send operation which resulted in less than the packet length being sent.
  - FREE_FAILS
```
public static final SystemCounterDescriptor FREE_FAILS
```
    Count of attempts to free log buffers no longer required by the driver which as still held by clients.
  - SENDER_FLOW_CONTROL_LIMITS
```
public static final SystemCounterDescriptor SENDER_FLOW_CONTROL_LIMITS
```
    Count of the times a sender has entered the state of being back-pressured when it could have sent faster.
  - UNBLOCKED_PUBLICATIONS
```
public static final SystemCounterDescriptor UNBLOCKED_PUBLICATIONS
```
    Count of the times a publication has been unblocked after a client failed to complete an offer within a timeout.
  - UNBLOCKED_COMMANDS
```
public static final SystemCounterDescriptor UNBLOCKED_COMMANDS
```
    Count of the times a command has been unblocked after a client failed to complete an offer within a timeout.
  - POSSIBLE_TTL_ASYMMETRY
```
public static final SystemCounterDescriptor POSSIBLE_TTL_ASYMMETRY
```
    Count of the times the channel endpoint detected a possible TTL asymmetry between its config and new connection.
  - CONTROLLABLE_IDLE_STRATEGY
```
public static final SystemCounterDescriptor CONTROLLABLE_IDLE_STRATEGY
```
    Current status of the ControllableIdleStrategy if configured.
  - LOSS_GAP_FILLS
```
public static final SystemCounterDescriptor LOSS_GAP_FILLS
```
    Count of the times a loss gap has been filled when NAKs have been disabled.
  - CLIENT_TIMEOUTS
```
public static final SystemCounterDescriptor CLIENT_TIMEOUTS
```
    Count of the Aeron clients that have timed out without a graceful close.
  - RESOLUTION_CHANGES
```
public static final SystemCounterDescriptor RESOLUTION_CHANGES
```
    Count of the times a connection endpoint has be re-resolved resulting in a change.
  - CONDUCTOR_MAX_CYCLE_TIME
```
public static final SystemCounterDescriptor CONDUCTOR_MAX_CYCLE_TIME
```
    The maximum time spent by the conductor between work cycles.
  - CONDUCTOR_CYCLE_TIME_THRESHOLD_EXCEEDED
```
public static final SystemCounterDescriptor CONDUCTOR_CYCLE_TIME_THRESHOLD_EXCEEDED
```
    Count of the number of times the cycle time threshold has been exceeded by the conductor in its work cycle.
- Field Detail
  - SYSTEM_COUNTER_TYPE_ID
```
public static final int SYSTEM_COUNTER_TYPE_ID
```
    All system counters have the same type id, i.e. system counters are the same type. Other types can exist.
    
    See Also:
    
    Constant Field Values
- Method Detail
  - values
```
public static SystemCounterDescriptor[] values()
```
    Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
```
for (SystemCounterDescriptor c : SystemCounterDescriptor.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static SystemCounterDescriptor valueOf(String name)
```
    Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
    
    Parameters:
    
    name - the name of the enum constant to be returned.
    
    Returns:
    
    the enum constant with the specified name
    
    Throws:
    
    IllegalArgumentException - if this enum type has no constant with the specified name
    
    NullPointerException - if the argument is null
  - get
```
public static SystemCounterDescriptor get(int id)
```
    Get the SystemCounterDescriptor for a given id.
    
    Parameters:
    
    id - for the descriptor.
    
    Returns:
    
    the descriptor if found otherwise null.
  - id
```
public int id()
```
    The unique identity for the system counter.
    
    Returns:
    
    the unique identity for the system counter.
  - label
```
public String label()
```
    The human readable label to identify a system counter.
    
    Returns:
    
    the human readable label to identify a system counter.
  - newCounter
```
public AtomicCounter newCounter(CountersManager countersManager)
```
    Create a new counter for the enumerated descriptor.
    
    Parameters:
    
    countersManager - for managing the underlying storage.
    
    Returns:
    
    a new counter for the enumerated descriptor.

Enum SystemCounterDescriptor

Enum Constant Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

BYTES_SENT

BYTES_RECEIVED

RECEIVER_PROXY_FAILS

SENDER_PROXY_FAILS

CONDUCTOR_PROXY_FAILS

NAK_MESSAGES_SENT

NAK_MESSAGES_RECEIVED

STATUS_MESSAGES_SENT

STATUS_MESSAGES_RECEIVED

HEARTBEATS_SENT

HEARTBEATS_RECEIVED

RETRANSMITS_SENT

FLOW_CONTROL_UNDER_RUNS

FLOW_CONTROL_OVER_RUNS

INVALID_PACKETS

ERRORS

SHORT_SENDS

FREE_FAILS

SENDER_FLOW_CONTROL_LIMITS

UNBLOCKED_PUBLICATIONS

UNBLOCKED_COMMANDS

POSSIBLE_TTL_ASYMMETRY

CONTROLLABLE_IDLE_STRATEGY

LOSS_GAP_FILLS

CLIENT_TIMEOUTS

RESOLUTION_CHANGES

CONDUCTOR_MAX_CYCLE_TIME

CONDUCTOR_CYCLE_TIME_THRESHOLD_EXCEEDED

Field Detail

SYSTEM_COUNTER_TYPE_ID

Method Detail

values

valueOf

get

id

label

newCounter