public final class AeronCounters extends Object
The following ranges are reserved:
0 - 99: for client/driver counters.100 - 199: for archive counters.200 - 299: for cluster counters.| Modifier and Type | Field and Description |
|---|---|
static int |
ARCHIVE_CONTROL_SESSIONS_TYPE_ID
The type id of the
Counter used for keeping track of the count of concurrent control sessions. |
static int |
ARCHIVE_CYCLE_TIME_THRESHOLD_EXCEEDED_TYPE_ID
The type id of the
Counter used for keeping track of the count of cycle time threshold exceeded of
an archive agent. |
static int |
ARCHIVE_ERROR_COUNT_TYPE_ID
The type id of the
Counter used for keeping track of the number of errors that have occurred. |
static int |
ARCHIVE_MAX_CYCLE_TIME_TYPE_ID
The type id of the
Counter used for keeping track of the max duty cycle time of an archive agent. |
static int |
ARCHIVE_RECORDER_MAX_WRITE_TIME_TYPE_ID
The type id of the
Counter used for keeping track of the max time it took recoder to write a block of
data to the storage. |
static int |
ARCHIVE_RECORDER_TOTAL_WRITE_BYTES_TYPE_ID
The type id of the
Counter used for keeping track of the total number of bytes written by the recorder
to the storage. |
static int |
ARCHIVE_RECORDER_TOTAL_WRITE_TIME_TYPE_ID
The type id of the
Counter used for keeping track of the total time the recorder spent writing data to
the storage. |
static int |
ARCHIVE_RECORDING_POSITION_TYPE_ID
The position a recording has reached when being archived.
|
static int |
ARCHIVE_RECORDING_SESSION_COUNT_TYPE_ID
The type id of the
Counter used for tracking the count of active recording sessions. |
static int |
ARCHIVE_REPLAY_SESSION_COUNT_TYPE_ID
The type id of the
Counter used for tracking the count of active replay sessions. |
static int |
ARCHIVE_REPLAYER_MAX_READ_TIME_TYPE_ID
The type id of the
Counter used for keeping track of the max time it took replayer to read a block from
the storage. |
static int |
ARCHIVE_REPLAYER_TOTAL_READ_BYTES_TYPE_ID
The type id of the
Counter used for keeping track of the total number of bytes read by the replayer from
the storage. |
static int |
ARCHIVE_REPLAYER_TOTAL_READ_TIME_TYPE_ID
The type id of the
Counter used for keeping track of the total time the replayer spent reading data from
the storage. |
static int |
CLUSTER_BACKUP_ERROR_COUNT_TYPE_ID
The type id of the
Counter used for keeping track of the number of errors that have occurred. |
static int |
CLUSTER_BACKUP_LIVE_LOG_POSITION_TYPE_ID
The type id of the
Counter used for the live log position counter. |
static int |
CLUSTER_BACKUP_QUERY_DEADLINE_TYPE_ID
The type id of the
Counter used for the next query deadline counter. |
static int |
CLUSTER_BACKUP_STATE_TYPE_ID
The type id of the
Counter used for the backup state. |
static int |
CLUSTER_CLIENT_TIMEOUT_COUNT_TYPE_ID
Counter type id for the number of cluster clients which have been timed out.
|
static int |
CLUSTER_CLUSTERED_SERVICE_CYCLE_TIME_THRESHOLD_EXCEEDED_TYPE_ID
The type id of the
Counter used for keeping track of the count of cycle time threshold exceeded of
the service container. |
static int |
CLUSTER_CLUSTERED_SERVICE_ERROR_COUNT_TYPE_ID
Counter type id for the clustered service error count.
|
static int |
CLUSTER_CLUSTERED_SERVICE_MAX_CYCLE_TIME_TYPE_ID
The type id of the
Counter used for keeping track of the max duty cycle time of the service container. |
static int |
CLUSTER_COMMIT_POSITION_TYPE_ID
Counter type id of the commit position.
|
static int |
CLUSTER_CONSENSUS_MODULE_ERROR_COUNT_TYPE_ID
Counter type id for the consensus module error count.
|
static int |
CLUSTER_CONSENSUS_MODULE_STATE_TYPE_ID
Counter type id for the consensus module state.
|
static int |
CLUSTER_CONTROL_TOGGLE_TYPE_ID
Counter type id for the control toggle.
|
static int |
CLUSTER_CYCLE_TIME_THRESHOLD_EXCEEDED_TYPE_ID
The type id of the
Counter used for keeping track of the count of cycle time threshold exceeded of
the consensus module. |
static int |
CLUSTER_ELECTION_STATE_TYPE_ID
Type id for election state counter.
|
static int |
CLUSTER_INVALID_REQUEST_COUNT_TYPE_ID
Counter type id for the number of invalid requests which the cluster has received.
|
static int |
CLUSTER_MAX_CYCLE_TIME_TYPE_ID
The type id of the
Counter used for keeping track of the max duty cycle time of the consensus module. |
static int |
CLUSTER_NODE_ROLE_TYPE_ID
Counter type id for the cluster node role.
|
static int |
CLUSTER_RECOVERY_STATE_TYPE_ID
Counter representing the Recovery State for the cluster.
|
static int |
CLUSTER_SNAPSHOT_COUNTER_TYPE_ID
Counter type id for count of snapshots taken.
|
static int |
CLUSTER_STANDBY_CONTROL_TOGGLE_TYPE_ID
Standby control toggle type id
|
static int |
CLUSTER_STANDBY_CYCLE_TIME_THRESHOLD_EXCEEDED_TYPE_ID
The type id of the
Counter used for keeping track of the count of cycle time threshold exceeded of
the cluster standby. |
static int |
CLUSTER_STANDBY_ERROR_COUNT_TYPE_ID
Counter type id for the clustered service error count.
|
static int |
CLUSTER_STANDBY_HEARTBEAT_RESPONSE_COUNT_TYPE_ID
Counter type for responses to heartbeat request from the cluster.
|
static int |
CLUSTER_STANDBY_MAX_CYCLE_TIME_TYPE_ID
The type id of the
Counter used for keeping track of the max duty cycle time of the cluster standby. |
static int |
CLUSTER_STANDBY_SNAPSHOT_COUNTER_TYPE_ID
Counter type for count of standby snapshots received.
|
static int |
CLUSTER_STANDBY_SOURCE_MEMBER_ID_TYPE_ID
The type id of the
Counter to make visible the memberId that the cluster standby is currently using to
as a source for the cluster log. |
static int |
CLUSTER_STANDBY_STATE_TYPE_ID
The type id of the
Counter used for the cluster standby state. |
static int |
CLUSTER_TOTAL_MAX_SNAPSHOT_DURATION_TYPE_ID
The type id of the
Counter used for keeping track of the maximum total snapshot duration. |
static int |
CLUSTER_TOTAL_SNAPSHOT_DURATION_THRESHOLD_EXCEEDED_TYPE_ID
The type id of the
Counter used for keeping track of the count total snapshot duration
has exceeded the threshold. |
static int |
DRIVER_HEARTBEAT_TYPE_ID
A counter for tracking the last heartbeat of an entity with a given registration id.
|
static int |
DRIVER_LOCAL_SOCKET_ADDRESS_STATUS_TYPE_ID
Counter used to store the status of a bind address and port for the local end of a channel.
|
static int |
DRIVER_PER_IMAGE_TYPE_ID
A counter per Image indicating presence of the congestion control.
|
static int |
DRIVER_PUBLISHER_LIMIT_TYPE_ID
The limit as a position in bytes applied to publishers on a session-channel-stream tuple.
|
static int |
DRIVER_PUBLISHER_POS_TYPE_ID
The position in bytes a publication has reached appending to the log.
|
static int |
DRIVER_RECEIVE_CHANNEL_STATUS_TYPE_ID
The status of a receive-channel-endpoint represented as a counter value.
|
static int |
DRIVER_RECEIVER_HWM_TYPE_ID
The highest position the Receiver has observed on a session-channel-stream tuple while rebuilding the stream.
|
static int |
DRIVER_RECEIVER_POS_TYPE_ID
The highest position the Receiver has rebuilt up to on a session-channel-stream tuple while rebuilding the
stream.
|
static int |
DRIVER_SEND_CHANNEL_STATUS_TYPE_ID
The status of a send-channel-endpoint represented as a counter value.
|
static int |
DRIVER_SENDER_BPE_TYPE_ID
Count of back-pressure events (BPE)s a sender has experienced on a stream.
|
static int |
DRIVER_SENDER_LIMIT_TYPE_ID
The position the Sender can immediately send up-to on a session-channel-stream tuple.
|
static int |
DRIVER_SENDER_POSITION_TYPE_ID
The position the Sender has reached for sending data to the media on a session-channel-stream tuple.
|
static int |
DRIVER_SUBSCRIBER_POSITION_TYPE_ID
The position an individual Subscriber has reached on a session-channel-stream tuple.
|
static int |
DRIVER_SYSTEM_COUNTER_TYPE_ID
System-wide counters for monitoring.
|
static int |
FLOW_CONTROL_RECEIVERS_COUNTER_TYPE_ID
Count of number of active receivers for flow control strategy.
|
static int |
MDC_DESTINATIONS_COUNTER_TYPE_ID
Count of number of destinations for multi-destination cast channels.
|
static int |
NAME_RESOLVER_CACHE_ENTRIES_COUNTER_TYPE_ID
Count of entries in the name resolver cache.
|
static int |
NAME_RESOLVER_NEIGHBORS_COUNTER_TYPE_ID
Count of media driver neighbors for name resolution.
|
static int |
NODE_CONTROL_TOGGLE_TYPE_ID
The type of the
Counter used for handling node specific operations. |
static int |
TRANSITION_MODULE_CONTROL_TOGGLE_TYPE_ID
Transition module control toggle type id
|
static int |
TRANSITION_MODULE_CYCLE_TIME_THRESHOLD_EXCEEDED_TYPE_ID
The type id of the
Counter used for keeping track of the count of cycle time threshold exceeded of
the transition module. |
static int |
TRANSITION_MODULE_ERROR_COUNT_TYPE_ID
Counter type id for the transition module error count.
|
static int |
TRANSITION_MODULE_MAX_CYCLE_TIME_TYPE_ID
The type id of the
Counter used for keeping track of the max duty cycle time of the transition module. |
static int |
TRANSITION_MODULE_STATE_TYPE_ID
The type if of the
Counter used for transition module state |
| Modifier and Type | Method and Description |
|---|---|
static int |
appendToLabel(AtomicBuffer metaDataBuffer,
int counterId,
String value)
Append specified
value at the end of the counter's label as ASCII encoded value up to the
CountersReader.MAX_LABEL_LENGTH. |
static int |
appendVersionInfo(MutableDirectBuffer tempBuffer,
int offset,
String fullVersion,
String commitHashCode)
Append version information at the end of the counter's label.
|
static String |
formatVersionInfo(String fullVersion,
String commitHash)
Format version information for display purposes.
|
static void |
validateCounterTypeId(Aeron aeron,
Counter counter,
int expectedCounterTypeId)
Convenience overload for
validateCounterTypeId(CountersReader, int, int) |
static void |
validateCounterTypeId(CountersReader countersReader,
int counterId,
int expectedCounterTypeId)
Checks that the counter specified by
counterId has the counterTypeId that matches the specified value. |
public static final int DRIVER_SYSTEM_COUNTER_TYPE_ID
public static final int DRIVER_PUBLISHER_LIMIT_TYPE_ID
public static final int DRIVER_SENDER_POSITION_TYPE_ID
public static final int DRIVER_RECEIVER_HWM_TYPE_ID
public static final int DRIVER_SUBSCRIBER_POSITION_TYPE_ID
public static final int DRIVER_RECEIVER_POS_TYPE_ID
public static final int DRIVER_SEND_CHANNEL_STATUS_TYPE_ID
public static final int DRIVER_RECEIVE_CHANNEL_STATUS_TYPE_ID
public static final int DRIVER_SENDER_LIMIT_TYPE_ID
public static final int DRIVER_PER_IMAGE_TYPE_ID
public static final int DRIVER_HEARTBEAT_TYPE_ID
public static final int DRIVER_PUBLISHER_POS_TYPE_ID
Note: This is a not a real-time value like the other and is updated one per second for monitoring purposes.
public static final int DRIVER_SENDER_BPE_TYPE_ID
public static final int NAME_RESOLVER_NEIGHBORS_COUNTER_TYPE_ID
public static final int NAME_RESOLVER_CACHE_ENTRIES_COUNTER_TYPE_ID
public static final int DRIVER_LOCAL_SOCKET_ADDRESS_STATUS_TYPE_ID
When the value is ChannelEndpointStatus.ACTIVE then the key value and label will be updated with the
socket address and port which is bound.
public static final int FLOW_CONTROL_RECEIVERS_COUNTER_TYPE_ID
public static final int MDC_DESTINATIONS_COUNTER_TYPE_ID
public static final int ARCHIVE_RECORDING_POSITION_TYPE_ID
public static final int ARCHIVE_ERROR_COUNT_TYPE_ID
Counter used for keeping track of the number of errors that have occurred.public static final int ARCHIVE_CONTROL_SESSIONS_TYPE_ID
Counter used for keeping track of the count of concurrent control sessions.public static final int ARCHIVE_MAX_CYCLE_TIME_TYPE_ID
Counter used for keeping track of the max duty cycle time of an archive agent.public static final int ARCHIVE_CYCLE_TIME_THRESHOLD_EXCEEDED_TYPE_ID
Counter used for keeping track of the count of cycle time threshold exceeded of
an archive agent.public static final int ARCHIVE_RECORDER_MAX_WRITE_TIME_TYPE_ID
Counter used for keeping track of the max time it took recoder to write a block of
data to the storage.public static final int ARCHIVE_RECORDER_TOTAL_WRITE_BYTES_TYPE_ID
Counter used for keeping track of the total number of bytes written by the recorder
to the storage.public static final int ARCHIVE_RECORDER_TOTAL_WRITE_TIME_TYPE_ID
Counter used for keeping track of the total time the recorder spent writing data to
the storage.public static final int ARCHIVE_REPLAYER_MAX_READ_TIME_TYPE_ID
Counter used for keeping track of the max time it took replayer to read a block from
the storage.public static final int ARCHIVE_REPLAYER_TOTAL_READ_BYTES_TYPE_ID
Counter used for keeping track of the total number of bytes read by the replayer from
the storage.public static final int ARCHIVE_REPLAYER_TOTAL_READ_TIME_TYPE_ID
Counter used for keeping track of the total time the replayer spent reading data from
the storage.public static final int ARCHIVE_RECORDING_SESSION_COUNT_TYPE_ID
Counter used for tracking the count of active recording sessions.public static final int ARCHIVE_REPLAY_SESSION_COUNT_TYPE_ID
Counter used for tracking the count of active replay sessions.public static final int CLUSTER_CONSENSUS_MODULE_STATE_TYPE_ID
public static final int CLUSTER_NODE_ROLE_TYPE_ID
public static final int CLUSTER_CONTROL_TOGGLE_TYPE_ID
public static final int CLUSTER_COMMIT_POSITION_TYPE_ID
public static final int CLUSTER_RECOVERY_STATE_TYPE_ID
public static final int CLUSTER_SNAPSHOT_COUNTER_TYPE_ID
public static final int CLUSTER_STANDBY_SNAPSHOT_COUNTER_TYPE_ID
public static final int CLUSTER_ELECTION_STATE_TYPE_ID
public static final int CLUSTER_BACKUP_STATE_TYPE_ID
Counter used for the backup state.public static final int CLUSTER_BACKUP_LIVE_LOG_POSITION_TYPE_ID
Counter used for the live log position counter.public static final int CLUSTER_BACKUP_QUERY_DEADLINE_TYPE_ID
Counter used for the next query deadline counter.public static final int CLUSTER_BACKUP_ERROR_COUNT_TYPE_ID
Counter used for keeping track of the number of errors that have occurred.public static final int CLUSTER_CONSENSUS_MODULE_ERROR_COUNT_TYPE_ID
public static final int CLUSTER_CLIENT_TIMEOUT_COUNT_TYPE_ID
public static final int CLUSTER_INVALID_REQUEST_COUNT_TYPE_ID
public static final int CLUSTER_CLUSTERED_SERVICE_ERROR_COUNT_TYPE_ID
public static final int CLUSTER_MAX_CYCLE_TIME_TYPE_ID
Counter used for keeping track of the max duty cycle time of the consensus module.public static final int CLUSTER_CYCLE_TIME_THRESHOLD_EXCEEDED_TYPE_ID
Counter used for keeping track of the count of cycle time threshold exceeded of
the consensus module.public static final int CLUSTER_CLUSTERED_SERVICE_MAX_CYCLE_TIME_TYPE_ID
Counter used for keeping track of the max duty cycle time of the service container.public static final int CLUSTER_CLUSTERED_SERVICE_CYCLE_TIME_THRESHOLD_EXCEEDED_TYPE_ID
Counter used for keeping track of the count of cycle time threshold exceeded of
the service container.public static final int CLUSTER_STANDBY_STATE_TYPE_ID
Counter used for the cluster standby state.public static final int CLUSTER_STANDBY_ERROR_COUNT_TYPE_ID
public static final int CLUSTER_STANDBY_HEARTBEAT_RESPONSE_COUNT_TYPE_ID
public static final int CLUSTER_STANDBY_CONTROL_TOGGLE_TYPE_ID
public static final int CLUSTER_STANDBY_MAX_CYCLE_TIME_TYPE_ID
Counter used for keeping track of the max duty cycle time of the cluster standby.public static final int CLUSTER_STANDBY_CYCLE_TIME_THRESHOLD_EXCEEDED_TYPE_ID
Counter used for keeping track of the count of cycle time threshold exceeded of
the cluster standby.public static final int CLUSTER_STANDBY_SOURCE_MEMBER_ID_TYPE_ID
Counter to make visible the memberId that the cluster standby is currently using to
as a source for the cluster log.public static final int TRANSITION_MODULE_ERROR_COUNT_TYPE_ID
public static final int TRANSITION_MODULE_STATE_TYPE_ID
Counter used for transition module statepublic static final int TRANSITION_MODULE_CONTROL_TOGGLE_TYPE_ID
public static final int TRANSITION_MODULE_MAX_CYCLE_TIME_TYPE_ID
Counter used for keeping track of the max duty cycle time of the transition module.public static final int TRANSITION_MODULE_CYCLE_TIME_THRESHOLD_EXCEEDED_TYPE_ID
Counter used for keeping track of the count of cycle time threshold exceeded of
the transition module.public static final int NODE_CONTROL_TOGGLE_TYPE_ID
Counter used for handling node specific operations.public static final int CLUSTER_TOTAL_MAX_SNAPSHOT_DURATION_TYPE_ID
Counter used for keeping track of the maximum total snapshot duration.public static final int CLUSTER_TOTAL_SNAPSHOT_DURATION_THRESHOLD_EXCEEDED_TYPE_ID
Counter used for keeping track of the count total snapshot duration
has exceeded the threshold.public static void validateCounterTypeId(CountersReader countersReader, int counterId, int expectedCounterTypeId)
counterId has the counterTypeId that matches the specified value.
If not it will throw a ConfigurationException.countersReader - to look up the counter type id.counterId - counter to reference.expectedCounterTypeId - the expected type id for the counter.ConfigurationException - if the type id does not match.IllegalArgumentException - if the counterId is not valid.public static void validateCounterTypeId(Aeron aeron, Counter counter, int expectedCounterTypeId)
validateCounterTypeId(CountersReader, int, int)aeron - to resolve a counters' reader.counter - to be checked for the appropriate counterTypeId.expectedCounterTypeId - the expected type id for the counter.ConfigurationException - if the type id does not match.IllegalArgumentException - if the counterId is not valid.validateCounterTypeId(CountersReader, int, int)public static int appendVersionInfo(MutableDirectBuffer tempBuffer, int offset, String fullVersion, String commitHashCode)
tempBuffer - to append label to.offset - at which current label data ends.fullVersion - of the component.commitHashCode - Git commit SHA.public static int appendToLabel(AtomicBuffer metaDataBuffer, int counterId, String value)
value at the end of the counter's label as ASCII encoded value up to the
CountersReader.MAX_LABEL_LENGTH.metaDataBuffer - containing the counter metadata.counterId - to append version info to.value - to be appended to the label.IllegalArgumentException - if counterId is invalid or points to non-allocated counter.Copyright © 2014-2023 Real Logic Limited. All Rights Reserved.