seqeron 0.18.0
Loading...
Searching...
No Matches
Org.Limitless.Seqeron.Protocol.SeqeronCounters Class Reference

Registry of seqeron's custom Aeron counter type ids (Aeron reserves 0-999). One block per process family, so a range scan (clusterctl counters) finds them all. The ids and key layout match SeqeronCounters.java and SeqeronCounters.hpp. More...

Static Public Member Functions

static Counter AddCounter (Aeron aeron, int typeId, string label, int memberId)
 Allocates an operator counter keyed on memberId , so a reader recovers the member without parsing the label.
 
static Counter AddAppCounter (Aeron aeron, int typeId, string label, int memberId, int clientId)
 Allocates an app counter keyed on {memberId, clientId}, the layout the Java and C++ twins write.
 

Static Public Attributes

const int SequencerTypeIdMin = 5000
 First type id of the sequencer's block.
 
const int SequencerTypeIdMax = 5099
 Last type id of the sequencer's block.
 
const int SequencerClusterSeqNoTypeId = 5000
 The last clusterSeqNo emitted on this node's queue.
 
const int SequencerQueueBackpressureAlertsTypeId = 5001
 Count of times the queue-emit back-pressure alert threshold has fired.
 
const int SequencerRejectedIngressCountTypeId = 5002
 Count of malformed ingress messages the sequencer skipped.
 
const int SequencerLeadershipChangeCountTypeId = 5003
 Count of leadership changes this node has observed and sequenced.
 
const int SequencerCurrentLeaderMemberIdTypeId = 5004
 memberId of the leader last recorded by this node's sequencer.
 
const int SequencerLastClusterHeartbeatTimestampTypeId = 5005
 Consensus timestamp of the last 1 Hz ClusterHeartbeat emitted.
 
const int SequencerGatewayPromotionCountTypeId = 5006
 Count of standby-promotion GatewayActive frames emitted on a gateway session close.
 
const int SequencerBootstrapActivatedTypeId = 5007
 1 once the bootstrap GatewayActive has been emitted in this cluster's log, else 0.
 
const int SequencerQueueStalledTypeId = 5008
 1 while queue back-pressure has lasted past the stall threshold with no recording progress, else 0.
 
const int SequencerIngressMessagesTypeId = 5010
 Count of ingress messages successfully sequenced; rate() over this is ingress throughput.
 
const int SequencerGatewayPromotionFailedCountTypeId = 5011
 Count of gateway session closes that found no standby to promote.
 
const int ReplayerTypeIdMin = 5100
 First type id of the Replayer's block.
 
const int ReplayerTypeIdMax = 5199
 Last type id of the Replayer's block.
 
const int ReplayerReadyTypeId = 5101
 1 once the co-located queue recording is visible and replay requests are being served, else 0.
 
const int ReplayerActiveSlotsTypeId = 5102
 Current count of in-flight replays.
 
const int ReplayerPendingRequestsTypeId = 5103
 Current count of replay requests waiting for a free slot.
 
const int ReplayerReplaysServedCountTypeId = 5104
 Count of replays started since this node came up.
 
const int ReplayerControlRepliesDroppedCountTypeId = 5107
 Count of control replies dropped because an app stopped draining the control stream.
 
const int ReplayerThrottledRequestsCountTypeId = 5110
 Count of replay requests held pending only because the queue recording trailed the queue while a replay ran, resends included.
 
const int ReplayerArchiveErrorsCountTypeId = 5111
 Count of local-archive calls that threw (live delivery is unaffected); a sustained rate means the archive is not serving replays.
 
const int AppTypeIdMin = 5200
 First type id of the app range: core reserves AppRecoveryStalledTypeId, HostedLagTypeId, AppSnapshotRoundTypeId and GatewayConnectionsTypeId and no more.
 
const int AppTypeIdMax = 5299
 Last type id of the app range.
 
const int AppRecoveryStalledTypeId = 5200
 1 while a co-located replica's recovery has dispatched nothing while not caught up, else 0.
 
const int HostedLagTypeId = 5297
 How far a hosted client trails its host: the host's last dispatched position less the client's applied one.
 
const int AppSnapshotRoundTypeId = 5298
 The last snapshot round a participating client confirmed (doc/snapshot.md §4), 0 for none yet.
 
const int GatewayConnectionsTypeId = 5299
 Connections a gateway instance holds open: taken and not yet closed, and 0 while it does not serve.
 
const int ProxyTypeIdMin = 5300
 First type id of the proxy's block.
 
const int ProxyTypeIdMax = 5399
 Last type id of the proxy's block.
 
const int ProxyClientHeartbeatTypeId = 5300
 A client's monotonic clock in ms, written by the client every duty cycle.
 
const int ProxyClientAppliedTypeId = 5301
 The position of the last payload a client applied, written by the client.
 
const int ProxyHeartbeatTypeId = 5302
 A proxy's monotonic clock in ms, written by the proxy every duty cycle.
 
const int ProxyRetiredTypeId = 5303
 Total encoded length of the windowed commands that have left the proxy's queue.
 
const int MinTypeId = SequencerTypeIdMin
 First type id seqeron owns, for a typeId-range scan.
 
const int MaxTypeId = ProxyTypeIdMax
 Last type id seqeron owns.
 
const int KeyMemberIdOffset = 0
 Offset of the memberId int within a counter's key.
 
const int KeyClientIdOffset = sizeof(int)
 Offset of the clientId in an app counter's key, so a node's several replicas render as separate series. Only the app range carries it.
 
const int KeyLength = sizeof(int)
 Length of an operator counter's key: one int, the memberId.
 
const int AppKeyLength = 2 * sizeof(int)
 Length of an app counter's key: memberId, then clientId.
 

Detailed Description

Registry of seqeron's custom Aeron counter type ids (Aeron reserves 0-999). One block per process family, so a range scan (clusterctl counters) finds them all. The ids and key layout match SeqeronCounters.java and SeqeronCounters.hpp.

Member Function Documentation

◆ AddAppCounter()

static Counter Org.Limitless.Seqeron.Protocol.SeqeronCounters.AddAppCounter ( Aeron  aeron,
int  typeId,
string  label,
int  memberId,
int  clientId 
)
inlinestatic

Allocates an app counter keyed on {memberId, clientId}, the layout the Java and C++ twins write.

Parameters
aeronthe client to allocate it through
typeIdits type id, in the app range
labelits label, US-ASCII
memberIdthe replica's node
clientIdthe replica's client id

◆ AddCounter()

static Counter Org.Limitless.Seqeron.Protocol.SeqeronCounters.AddCounter ( Aeron  aeron,
int  typeId,
string  label,
int  memberId 
)
inlinestatic

Allocates an operator counter keyed on memberId , so a reader recovers the member without parsing the label.

Parameters
aeronthe client to allocate it through
typeIdits type id
labelits label, US-ASCII
memberIdthe member it describes

Member Data Documentation

◆ AppKeyLength

const int Org.Limitless.Seqeron.Protocol.SeqeronCounters.AppKeyLength = 2 * sizeof(int)
static

Length of an app counter's key: memberId, then clientId.

◆ AppRecoveryStalledTypeId

const int Org.Limitless.Seqeron.Protocol.SeqeronCounters.AppRecoveryStalledTypeId = 5200
static

1 while a co-located replica's recovery has dispatched nothing while not caught up, else 0.

◆ AppSnapshotRoundTypeId

const int Org.Limitless.Seqeron.Protocol.SeqeronCounters.AppSnapshotRoundTypeId = 5298
static

The last snapshot round a participating client confirmed (doc/snapshot.md §4), 0 for none yet.

◆ AppTypeIdMax

const int Org.Limitless.Seqeron.Protocol.SeqeronCounters.AppTypeIdMax = 5299
static

Last type id of the app range.

◆ AppTypeIdMin

const int Org.Limitless.Seqeron.Protocol.SeqeronCounters.AppTypeIdMin = 5200
static

First type id of the app range: core reserves AppRecoveryStalledTypeId, HostedLagTypeId, AppSnapshotRoundTypeId and GatewayConnectionsTypeId and no more.

◆ GatewayConnectionsTypeId

const int Org.Limitless.Seqeron.Protocol.SeqeronCounters.GatewayConnectionsTypeId = 5299
static

Connections a gateway instance holds open: taken and not yet closed, and 0 while it does not serve.

◆ HostedLagTypeId

const int Org.Limitless.Seqeron.Protocol.SeqeronCounters.HostedLagTypeId = 5297
static

How far a hosted client trails its host: the host's last dispatched position less the client's applied one.

◆ KeyClientIdOffset

const int Org.Limitless.Seqeron.Protocol.SeqeronCounters.KeyClientIdOffset = sizeof(int)
static

Offset of the clientId in an app counter's key, so a node's several replicas render as separate series. Only the app range carries it.

◆ KeyLength

const int Org.Limitless.Seqeron.Protocol.SeqeronCounters.KeyLength = sizeof(int)
static

Length of an operator counter's key: one int, the memberId.

◆ KeyMemberIdOffset

const int Org.Limitless.Seqeron.Protocol.SeqeronCounters.KeyMemberIdOffset = 0
static

Offset of the memberId int within a counter's key.

◆ MaxTypeId

const int Org.Limitless.Seqeron.Protocol.SeqeronCounters.MaxTypeId = ProxyTypeIdMax
static

Last type id seqeron owns.

◆ MinTypeId

const int Org.Limitless.Seqeron.Protocol.SeqeronCounters.MinTypeId = SequencerTypeIdMin
static

First type id seqeron owns, for a typeId-range scan.

◆ ProxyClientAppliedTypeId

const int Org.Limitless.Seqeron.Protocol.SeqeronCounters.ProxyClientAppliedTypeId = 5301
static

The position of the last payload a client applied, written by the client.

◆ ProxyClientHeartbeatTypeId

const int Org.Limitless.Seqeron.Protocol.SeqeronCounters.ProxyClientHeartbeatTypeId = 5300
static

A client's monotonic clock in ms, written by the client every duty cycle.

◆ ProxyHeartbeatTypeId

const int Org.Limitless.Seqeron.Protocol.SeqeronCounters.ProxyHeartbeatTypeId = 5302
static

A proxy's monotonic clock in ms, written by the proxy every duty cycle.

◆ ProxyRetiredTypeId

const int Org.Limitless.Seqeron.Protocol.SeqeronCounters.ProxyRetiredTypeId = 5303
static

Total encoded length of the windowed commands that have left the proxy's queue.

◆ ProxyTypeIdMax

const int Org.Limitless.Seqeron.Protocol.SeqeronCounters.ProxyTypeIdMax = 5399
static

Last type id of the proxy's block.

◆ ProxyTypeIdMin

const int Org.Limitless.Seqeron.Protocol.SeqeronCounters.ProxyTypeIdMin = 5300
static

First type id of the proxy's block.

◆ ReplayerActiveSlotsTypeId

const int Org.Limitless.Seqeron.Protocol.SeqeronCounters.ReplayerActiveSlotsTypeId = 5102
static

Current count of in-flight replays.

◆ ReplayerArchiveErrorsCountTypeId

const int Org.Limitless.Seqeron.Protocol.SeqeronCounters.ReplayerArchiveErrorsCountTypeId = 5111
static

Count of local-archive calls that threw (live delivery is unaffected); a sustained rate means the archive is not serving replays.

◆ ReplayerControlRepliesDroppedCountTypeId

const int Org.Limitless.Seqeron.Protocol.SeqeronCounters.ReplayerControlRepliesDroppedCountTypeId = 5107
static

Count of control replies dropped because an app stopped draining the control stream.

◆ ReplayerPendingRequestsTypeId

const int Org.Limitless.Seqeron.Protocol.SeqeronCounters.ReplayerPendingRequestsTypeId = 5103
static

Current count of replay requests waiting for a free slot.

◆ ReplayerReadyTypeId

const int Org.Limitless.Seqeron.Protocol.SeqeronCounters.ReplayerReadyTypeId = 5101
static

1 once the co-located queue recording is visible and replay requests are being served, else 0.

◆ ReplayerReplaysServedCountTypeId

const int Org.Limitless.Seqeron.Protocol.SeqeronCounters.ReplayerReplaysServedCountTypeId = 5104
static

Count of replays started since this node came up.

◆ ReplayerThrottledRequestsCountTypeId

const int Org.Limitless.Seqeron.Protocol.SeqeronCounters.ReplayerThrottledRequestsCountTypeId = 5110
static

Count of replay requests held pending only because the queue recording trailed the queue while a replay ran, resends included.

◆ ReplayerTypeIdMax

const int Org.Limitless.Seqeron.Protocol.SeqeronCounters.ReplayerTypeIdMax = 5199
static

Last type id of the Replayer's block.

◆ ReplayerTypeIdMin

const int Org.Limitless.Seqeron.Protocol.SeqeronCounters.ReplayerTypeIdMin = 5100
static

First type id of the Replayer's block.

◆ SequencerBootstrapActivatedTypeId

const int Org.Limitless.Seqeron.Protocol.SeqeronCounters.SequencerBootstrapActivatedTypeId = 5007
static

1 once the bootstrap GatewayActive has been emitted in this cluster's log, else 0.

◆ SequencerClusterSeqNoTypeId

const int Org.Limitless.Seqeron.Protocol.SeqeronCounters.SequencerClusterSeqNoTypeId = 5000
static

The last clusterSeqNo emitted on this node's queue.

◆ SequencerCurrentLeaderMemberIdTypeId

const int Org.Limitless.Seqeron.Protocol.SeqeronCounters.SequencerCurrentLeaderMemberIdTypeId = 5004
static

memberId of the leader last recorded by this node's sequencer.

◆ SequencerGatewayPromotionCountTypeId

const int Org.Limitless.Seqeron.Protocol.SeqeronCounters.SequencerGatewayPromotionCountTypeId = 5006
static

Count of standby-promotion GatewayActive frames emitted on a gateway session close.

◆ SequencerGatewayPromotionFailedCountTypeId

const int Org.Limitless.Seqeron.Protocol.SeqeronCounters.SequencerGatewayPromotionFailedCountTypeId = 5011
static

Count of gateway session closes that found no standby to promote.

◆ SequencerIngressMessagesTypeId

const int Org.Limitless.Seqeron.Protocol.SeqeronCounters.SequencerIngressMessagesTypeId = 5010
static

Count of ingress messages successfully sequenced; rate() over this is ingress throughput.

◆ SequencerLastClusterHeartbeatTimestampTypeId

const int Org.Limitless.Seqeron.Protocol.SeqeronCounters.SequencerLastClusterHeartbeatTimestampTypeId = 5005
static

Consensus timestamp of the last 1 Hz ClusterHeartbeat emitted.

◆ SequencerLeadershipChangeCountTypeId

const int Org.Limitless.Seqeron.Protocol.SeqeronCounters.SequencerLeadershipChangeCountTypeId = 5003
static

Count of leadership changes this node has observed and sequenced.

◆ SequencerQueueBackpressureAlertsTypeId

const int Org.Limitless.Seqeron.Protocol.SeqeronCounters.SequencerQueueBackpressureAlertsTypeId = 5001
static

Count of times the queue-emit back-pressure alert threshold has fired.

◆ SequencerQueueStalledTypeId

const int Org.Limitless.Seqeron.Protocol.SeqeronCounters.SequencerQueueStalledTypeId = 5008
static

1 while queue back-pressure has lasted past the stall threshold with no recording progress, else 0.

◆ SequencerRejectedIngressCountTypeId

const int Org.Limitless.Seqeron.Protocol.SeqeronCounters.SequencerRejectedIngressCountTypeId = 5002
static

Count of malformed ingress messages the sequencer skipped.

◆ SequencerTypeIdMax

const int Org.Limitless.Seqeron.Protocol.SeqeronCounters.SequencerTypeIdMax = 5099
static

Last type id of the sequencer's block.

◆ SequencerTypeIdMin

const int Org.Limitless.Seqeron.Protocol.SeqeronCounters.SequencerTypeIdMin = 5000
static

First type id of the sequencer's block.


The documentation for this class was generated from the following file: