For the complete documentation index, see llms.txt. This page is also available as Markdown.

Heartbeats

Complete reference of all fields in a container heartbeat message.

For configuring heartbeat emission, see Container Heartbeats (Configuring). For understanding heartbeat output, see Container Heartbeats (Operating).

Heartbeat Message (SrvMonHeartbeatMessage)

The top-level heartbeat message emitted by a container at regular intervals.

Field
Type
Description

xvmHeader

Header information about the source container.

collectionStartWallTime

Long

The collection start time in milliseconds since the Epoch (e.g. System.currentTimeMillis()).

collectionStartTime

Long

The collection start time in nanoseconds (e.g. System.nanoTime()).

collectionEndTime

Long

The collection end time in nanoseconds (e.g. System.nanoTime()).

serverName

String

The name of the container.

serverHostName

String

The container's hostname.

serverPid

String

The container process ID.

loadedTime

Date

The time at which the container loaded.

systemName

String

The name of the system to which the container belongs.

systemVersion

String

The version of the system to which the container belongs.

sysStats

System-level stats such as CPU, disk, and memory usage.

poolStats

Process-wide object pooling stats.

appsInfo

Information about the services configured for this container.

appsStats

Platform and user stats for loaded services.

adminClientStats

Stats related to admin client connections.

heartbeatLoggerStats

Logger stats for the container's binary heartbeat log (if enabled).

Container Header (SrvMonXvmHeader)

Header information supplied on monitoring events originating from a container.

Field
Type
Description

systemName

String

The name of the system.

systemVersion

String

The version of the system.

xvmHeartbeatVersion

Integer

The heartbeat protocol version of the container.

xvmName

String

The name of the container.

System Stats (SrvMonSysStats)

System-level stats related to the JVM and host on which the container is running.

Field
Type
Description

availableProcessors

Integer

The number of processors available to the JVM.

systemLoadAverage

Double

The system load average for the last minute.

processCpuLoad

Double

Recent CPU usage by the process (0.0 to 1.0 scale).

systemCpuLoad

Double

Recent CPU usage by the system (0.0 to 1.0 scale).

memoryStats

Memory-related stats.

gcStats

GC-related stats.

jitStats

JIT compiler stats.

threadStats

Thread-related stats.

diskStats

Disk-related stats.

Memory Stats (SrvMonSysMemoryStats)

Memory statistics. See Memory Stats for interpretation guidance.

Field
Type
Description

processRssBytes

Long

The process RSS (Resident Set Size) in bytes. The amount of physical memory currently occupied by the process including code, stack, heap, and memory-mapped regions.

committedVirtualMemorySize

Long

Virtual memory guaranteed to be available to the process (bytes).

freePhysicalMemorySize

Long

Available physical memory (bytes). On Linux reports MemAvailable from /proc/meminfo (includes reclaimable cache/buffers).

freeSwapSpaceSize

Long

Free swap space (bytes).

totalPhysicalMemorySize

Long

Total physical memory (bytes).

totalSwapSpaceSize

Long

Total swap space (bytes).

heapUsage

Heap memory usage.

nonHeapUsage

Non-heap memory usage.

offHeapUsage

Off-heap memory usage.

nativeCounters

Native memory counters.

iobufCounters

IOBuffer counters.

embeddedEntityCounters

Aggregate embedded entity counters.

embeddedEntityCountersByType

Per-type embedded entity counters.

entityCounters

Aggregate state entity counters.

entityCountersByType

Per-type state entity counters.

messageCounters

Aggregate message counters.

messageCountersByType

Per-type message counters.

collectionCounters

Aggregate collection counters.

collectionCountersByType

Per-type collection counters.

Memory Usage (SrvMonSysMemoryUsage)

Stats for a JVM memory region.

Field
Type
Description

init

Long

Memory initially requested from the OS (bytes). -1 if undefined.

used

Long

Amount of used memory (bytes).

committed

Long

Memory committed for JVM use (bytes).

max

Long

Maximum memory (bytes).

Off-Heap Usage (SrvMonSysMemoryOffHeapUsage)

Summary stats for off-heap memory managed by applications.

Field
Type
Description

usedLive

Long

Off-heap memory in live use by applications (bytes).

usedPooled

Long

Off-heap memory held in pools for reuse (bytes).

Native Memory Counters (SrvMonSysMemoryNativeCounters)

Counters for native memory operations via JNI.

Field
Type
Description

allocCount

Long

Cumulative native memory allocations.

allocBytes

Long

Cumulative bytes allocated.

reallocCount

Long

Cumulative native memory reallocations.

reallocBytes

Long

Cumulative bytes reallocated.

freeCount

Long

Cumulative native memory frees.

freeBytes

Long

Cumulative bytes freed.

IOBuffer Counters (SrvMonSysMemoryIOBufCounters)

Counters for IOBuffer lifecycle management.

Field
Type
Description

bufferAllocCount

Long

IOBuffer creations (new allocations, not from pool).

bufferAllocBytes

Long

Cumulative bytes from IOBuffer creations.

bufferPoolAllocCount

Long

IOBuffers obtained from the pool (reused).

bufferPoolAllocBytes

Long

Cumulative bytes from pool allocations.

bufferReallocCount

Long

IOBuffers reallocated due to size change.

bufferReallocBytes

Long

Cumulative bytes reallocated.

bufferForkCount

Long

IOBuffers forked (copy-on-write).

bufferForkBytes

Long

Cumulative bytes forked.

bufferGCDisposeCount

Long

IOBuffers disposed directly to the garbage collector.

bufferGCDisposeBytes

Long

Cumulative bytes disposed to the garbage collector.

bufferPoolDisposeCount

Long

IOBuffers returned to the pool for reuse.

bufferPoolDisposeBytes

Long

Cumulative bytes returned to the pool.

bufferPoolLeakCount

Long

IOBuffers evicted from the pool and disposed to the garbage collector.

bufferPoolLeakBytes

Long

Cumulative bytes evicted from the pool.

Entity Type Counters (SrvMonSysMemoryEntityTypeCounters)

Counters for entity, message, and collection object lifecycle. Used for embedded entities, state entities, messages, and collections.

Field
Type
Description

entityName

String

The class name of the entity.

entityShortName

String

The short name of the entity.

liveCount

Long

Entities currently allocated and in use.

pooledCount

Long

Entities allocated but held in pool.

createAllocCount

Long

Entities created via new allocation (not from pool).

poolAllocCount

Long

Entities obtained from the entity pool.

GCDisposeCount

Long

Entities disposed directly to the garbage collector.

poolDisposeCount

Long

Entities returned to the pool.

poolLeakCount

Long

Entities evicted from the pool.

pojoLiveCount

Long

Live POJO backing objects.

pojoPooledCount

Long

Pooled POJO backing objects.

pojoCreateAllocCount

Long

POJOs created via new allocation.

pojoPoolAllocCount

Long

POJOs obtained from pool.

pojoGCDisposeCount

Long

POJOs disposed to the garbage collector.

pojoPoolDisposeCount

Long

POJOs returned to pool.

pojoPoolLeakCount

Long

POJOs evicted from pool.

serializerLiveCount

Long

Live serializers.

serializerPooledCount

Long

Pooled serializers.

serializerCreateAllocCount

Long

Serializers created via new allocation.

serializerPoolAllocCount

Long

Serializers obtained from pool.

serializerGCDisposeCount

Long

Serializers disposed to the garbage collector.

serializerPoolDisposeCount

Long

Serializers returned to pool.

serializerPoolLeakCount

Long

Serializers evicted from pool.

deserializerLiveCount

Long

Live deserializers.

deserializerPooledCount

Long

Pooled deserializers.

deserializerCreateAllocCount

Long

Deserializers created via new allocation.

deserializerPoolAllocCount

Long

Deserializers obtained from pool.

deserializerGCDisposeCount

Long

Deserializers disposed to the garbage collector.

deserializerPoolDisposeCount

Long

Deserializers returned to pool.

deserializerPoolLeakCount

Long

Deserializers evicted from pool.

metadataLiveCount

Long

Live metadata objects.

metadataLiveBytes

Long

Bytes in live metadata objects.

metadataAllocCount

Long

Metadata objects created.

metadataAllocBytes

Long

Cumulative metadata bytes allocated.

metadataGCDisposeCount

Long

Metadata objects disposed to the garbage collector.

metadataGCDisposeBytes

Long

Metadata bytes disposed to the garbage collector.

metadataPoolDisposeCount

Long

Metadata objects returned to pool.

metadataPoolDisposeBytes

Long

Metadata bytes returned to pool.

dataLiveCount

Long

Live data buffer objects.

dataLiveBytes

Long

Bytes in live data buffers.

dataAllocCount

Long

Data buffer objects created.

dataAllocBytes

Long

Cumulative data buffer bytes allocated.

dataGCDisposeCount

Long

Data buffer objects disposed to the garbage collector.

dataGCDisposeBytes

Long

Data buffer bytes disposed to the garbage collector.

dataPoolDisposeCount

Long

Data buffer objects returned to pool.

dataPoolDisposeBytes

Long

Data buffer bytes returned to pool.

GC Stats (SrvMonSysGCStats)

Garbage collection statistics.

Field
Type
Description

collectorsStats

List of garbage collections. May include collections from previous intervals; use collectionCount to deduplicate.

GC Collector Stats (SrvMonSysGCCollectorStats)

Stats for a single garbage collector.

Field
Type
Description

collectorName

String

The name of the collector.

collectionCount

Long

Total collections that have occurred. -1 if undefined.

collectionTime

Long

Approximate accumulated collection elapsed time (milliseconds). -1 if undefined.

JIT Stats (SrvMonSysJITStats)

JIT compiler statistics.

Field
Type
Description

name

String

The name of the JIT compiler in use.

totalCompilationTime

Long

Cumulative time spent in JIT compilation (milliseconds).

Thread Stats (SrvMonSysThreadStats)

Thread statistics.

Field
Type
Description

threadCount

Integer

Number of active threads.

daemonThreadCount

Integer

Number of active daemon threads.

peakThreadCount

Integer

Peak number of threads observed.

individualThreadStats

Per-thread stats (if enabled).

Individual Thread Stats (SrvMonSysIndividualThreadStats)

Stats for an individual thread.

Field
Type
Description

id

Long

The thread's ID.

name

String

The thread's name (may be cached).

state

String

The thread's state at the time of the heartbeat.

cpuTime

Long

CPU time used by the thread (nanoseconds).

usrTime

Long

User time used by the thread (nanoseconds).

collectTime

Long

Time just after CPU times were collected (nanoseconds). Use to calculate elapsed time between samples.

affinity

String

Affinitization details (if affinitized).

waitTime

Long

Time spent waiting for events such as I/O spin loops or disruptor waits (nanoseconds). For busy-spinning threads, use to distinguish idle time from CPU time. Only reflects time upon exiting a wait — not while still waiting.

waitCount

Long

Number of times the thread entered a waiting state.

Disk Stats (SrvMonSysDiskStats)

Disk statistics.

Field
Type
Description

rootPath

String

The file system root path for the disk or partition.

totalSpace

Long

Size of the partition (bytes). 0 if not a partition.

usableSpace

Long

Bytes available to the container.

freeSpace

Long

Unallocated bytes in the disk or partition.

Pool Stats (SrvMonPoolStats)

Object pool statistics. Stats for a pool are only included in a heartbeat if there have been pool misses in the last collection interval.

Field
Type
Description

key

String

The name of the pool.

size

Integer

Elements currently available in the pool. A value of 0 doesn't necessarily indicate an issue — elements may be checked out.

capacity

Integer

Current number of slots to hold unused elements.

preallocated

Integer

Elements initially preallocated.

maxCapacity

Integer

Maximum size of the pool.

gets

Long

Times an element has been requested.

hits

Long

Times a request was satisfied without allocating.

misses

Long

Times a request required a new allocation.

puts

Long

Times an element has been returned.

growths

Long

Times the pool capacity was increased.

evicts

Long

Elements evicted because the pool lacked capacity.

detachedWashes

Long

Elements initialized by the detached pool washer thread.

Service Info (SrvMonAppInfo)

Information about a service configured in the container.

Field
Type
Description

name

String

The service's name.

version

Integer

The service version (if specified/known). Typically from @AppVersion.

jarVersionString

String

The jar version of the service (if specified/known).

state

The service's current state.

role

The service's current HA role.

HAPolicy

The service's HA policy.

loadedTime

Date

The time at which the service was last loaded.

clientsInfo

SrvMonAppClientInfo[]

Connected client info. Each entry has a name (String) field.

busBindingsInfo

Message bus binding info.

flowsInfo

SrvMonAppFlowInfo[]

Active message flow info. Each entry has an id (Integer) field.

Bus Binding Info (SrvMonAppBusBindingInfo)

Information about a message bus binding.

Field
Type
Description

name

String

The bus name.

state

The current bus state.

channelsInfo

SrvMonAppBusChannelInfo[]

Channel info. Each entry has name (String) and joined (Boolean).

Service Stats (SrvMonAppStats)

Groups together stats for a service.

Field
Type
Description

appName

String

The service name.

engineStats

The service's AEP engine stats.

eventMultiplexerStats

The service's input event multiplexer stats.

storeBindingStats

The service's replication and persistent disk storage stats.

busBindingStats

Messaging stats for each configured bus.

userStats

The service's user-defined stats.

Engine Stats (SrvMonAppEngineStats)

AEP engine statistics. See AEP Engine Stats for interpretation guidance.

Field
Type
Description

numFlows

Integer

Number of active flows.

numMsgsRcvdBestEffort

Long

Best-effort messages received.

numMsgsRcvdGuaranteed

Long

Guaranteed messages received.

numDupMsgsRcvd

Long

Duplicate messages received.

numMsgsSentBestEffort

Long

Best-effort messages sent.

numMsgsSentGuaranteed

Long

Guaranteed messages sent.

numMsgsResent

Long

Messages retransmitted.

numMsgsSourced

Long

Messages sourced (replicated, recovered from log, or injected). Total messages received = numMsgsRcvdBestEffort + numMsgsRcvdGuaranteed + numMsgsSourced.

numMsgsFiltered

Long

Messages filtered.

numEventsRcvd

Long

Events received by the engine.

numEventsProcessed

Long

Events processed by the engine.

numFlowEventsRcvd

Long

Flow-related events processed.

numFlowEventsProcSuccess

Long

Flow events successfully processed.

numFlowEventsProcFail

Long

Flow events unsuccessfully processed.

numFlowEventsProcComplete

Long

Flow events completely processed.

numTransactions

Long

Transactions created.

numCommitsStarted

Long

Transaction commits started.

numCommitsCompleted

Long

Transaction commits completed.

numSendCommitsStarted

Long

Send (message bus) commits started.

numSendCommitsCompleted

Long

Send commits completed.

sendCommitCompletionQueueSize

Integer

Send commits pending completion.

numStoreCommitsStarted

Long

Store commits started.

numStoreCommitsCompleted

Long

Store commits completed.

storeCommitCompletionQueueSize

Integer

Store commits pending completion.

numRollbacks

Long

Transactions rolled back.

numPartialRollbacks

Long

Partial (savepoint) transaction rollbacks.

outboundSno

Long

Current outbound sequence number for doubt resolution and duplicate detection.

outboundStableSno

Long

Stable outbound sequence number — messages acknowledged downstream that need not be retransmitted.

backupOutboundQueueSize

Long

Messages in the backup outbound queue (not yet stabilized, pending retransmission on failover).

backupOutboundLogQueueSize

Long

Messages in the backup outbound log queue (pending write to an outbound message logger).

msgPreProcLatencies

mpproc — time spent by the engine dispatching the message to a service.

msgProcessingLatencies

mproc — time in the service's EventHandler.

msgFilteringLatencies

mfilt — time in message filter processing.

msgSendLatencies

msend — time spent in AepEngine.sendMessage().

msgSendCoreLatencies

msendc — time spent in AepEngine.sendMessageCore().

commitStartLatencies

cstart — time from first message receipt to transaction commit.

commitPrologueLatencies

cprolo — time from commit start to first send or store commit.

commitSendLatencies

csend — time for send commits to complete (includes ack wait).

commitStoreLatencies

cstore — time for store commit to complete.

commitTransitionLatencies

ctrans — time from first commit completion to start of next stage.

commitEpilogueLatencies

cepilo — time from last commit completion to commit finalization.

commitFullLatencies

cfull — time from first message receipt to full commit completion.

inOutLatencies

inout — time from message receipt to transmission of last outbound message.

inAckLatencies

inack — time from message receipt to stabilization (and upstream ack for Guaranteed).

transactionLeg1ProcessingTimes

tleg1 — first transaction processing leg: receipt to send/store commit submission.

transactionLeg2ProcessingTimes

tleg2 — second leg: first commit completion to second commit submission.

transactionLeg3ProcessingTimes

tleg3 — third leg: second commit completion to transaction finalization.

inboundMessageLoggerStats

Inbound message logger stats (when enabled).

outboundMessageLoggerStats

Outbound message logger stats (when enabled).

perTransactionStatsLoggerStats

Per-transaction stats logger stats (when enabled).

msgTypeStats

Per-message-type stats (when enabled and included in heartbeats). Only present for message types with activity in the collection interval.

Transaction legs represent the portions of commit processing done on the AEP engine's thread. Their sum determines the maximum transactions per second the service can sustain. Latencies are reported in nanoseconds.

Message Type Stats (SrvMonMsgTypeStats)

Per-message-type statistics, included when captureMessageTypeStats and includeMessageTypeStats are enabled.

Field
Type
Description

messageTypeName

String

The fully qualified name of the message type.

messageFactoryId

Short

The factory ID for the message type.

messageTypeId

Short

The message type ID within its factory.

numMsgsRcvdBestEffort

Long

Best-effort messages received for this type.

numMsgsRcvdGuaranteed

Long

Guaranteed messages received for this type.

numDupMsgsRcvd

Long

Duplicate messages received for this type.

numMsgsSentBestEffort

Long

Best-effort messages sent for this type.

numMsgsSentGuaranteed

Long

Guaranteed messages sent for this type.

numMsgsResent

Long

Messages retransmitted for this type.

numMsgsSourced

Long

Messages sourced for this type.

numMsgsFiltered

Long

Messages filtered for this type.

msgProcessingLatencies

mproc — handler processing latencies.

msgFilteringLatencies

mfilt — filter processing latencies.

msgPreProcessingLatencies

mpproc — engine pre-processing latencies.

msgCreateToOfferLatencies

c2o — create-to-offer latencies.

msgOfferToPollLatencies

o2p — offer-to-poll (input queue time) latencies.

Event Multiplexer Stats (SrvMonAppEventMultiplexerStats)

Stats for the engine's input event multiplexer. Events pass through two levels of queue: a per-thread feeder queue and the engine's input disruptor.

Field
Type
Description

lastDecongested

Integer

The last feeder queue decongested.

maxConcurrency

Integer

Maximum number of feeder queues supported.

scheduleQueueSize

Integer

Number of scheduled events awaiting dispatch.

disruptorStats

Stats for the engine's input disruptor.

feederQueueStats

Per-feeder-queue stats.

Feeder Queue Stats (SrvMonAppEventMultiplexerFeederQueueStats)

Stats for an input multiplexer feeder queue.

Field
Type
Description

owner

String

The owner thread for the feeder queue (source of events).

size

Integer

Current number of events in the queue.

decongestCount

Integer

Times the draining thread has woken up to drain the queue.

offerToPollLatencies

Time elements spend in the feeder queue.

Store Binding Stats (SrvMonAppStoreBindingStats)

Replication and persistence statistics. An application's store provides HA and fault tolerance via replication and persistence.

Field
Type
Description

role

Current HA role for the store.

state

Current state of the store.

ICRRole

Inter-cluster replication role.

size

Integer

Number of objects in the store.

dataSize

Long

Total size of serialized object data held by the store.

numCommitsSent

Long

Committed transactions replicated by the store.

numCommitEntriesSent

Long

Committed entries replicated by the store.

numCommitsReceived

Long

Committed transactions replicated to this store.

numCommitEntriesReceived

Long

Committed entries replicated to this store.

numCommitCompletionsSent

Long

Commit acknowledgements sent to the leader.

numCommitCompletionsReceived

Long

Commit acknowledgements received from followers.

serializeLatencies

s — time serializing transaction entries for replication/persistence.

serializeToWireLatencies

s2w — time from serialization to last entry written to the wire.

serializeToPersistLatencies

s2p — time from serialization to entries passed to the persister (not yet synced).

wireLatencies

w — round-trip wire time (primary: to ack receipt; backup: subject to clock skew).

wireToDeserializeLatencies

w2d — time from commit packet receipt to deserialization start (backup).

deserializeLatencies

d — time spent deserializing transaction entries (backup).

persistLatencies

per — time spent persisting transaction entries to disk.

icrSendLatencies

icr — time spent sending entries through an ICR receiver.

indexLatencies

idx — store object indexing latencies (if enabled).

commitLatencies

c — commit latency from start to stabilization.

commitQueueSize

cqs — number of entries committed per commit.

persisterStats

Persister stats (when configured).

ICRSenderStats

ICR sender stats (when configured).

Persister Stats (SrvMonAppStoreBindingPersisterStats)

Stats for a store's persister.

Field
Type
Description

detachedPersist

Boolean

Whether the persister is operating in detached mode.

numPutsRecorded

Long

Puts recorded.

numUpdatesRecorded

Long

Updates recorded.

numRemovesRecorded

Long

Removes recorded.

numSendsRecorded

Long

Sends recorded.

numCommits

Long

Commits recorded.

numForks

Long

Forked packets persisted.

fileSize

Long

Actual size of the log file on disk (may be preallocated larger).

fileSizeUsed

Long

Space used in the log file.

disruptorStats

Disruptor stats when operating in detached mode.

ICR Sender Stats (SrvMonAppStoreBindingICRSenderStats)

Stats for a store's inter-cluster replication sender.

Field
Type
Description

detachedSend

Boolean

Whether the ICR sender is operating in detached mode.

numPutsRecorded

Long

Puts recorded.

numUpdatesRecorded

Long

Updates recorded.

numRemovesRecorded

Long

Removes recorded.

numSendsRecorded

Long

Sends recorded.

numCommits

Long

Commits recorded.

numForks

Long

Forked packets persisted.

disruptorStats

Disruptor stats when operating in detached mode.

Bus Binding Stats (SrvMonAppBusBindingStats)

Statistics for a message bus binding.

Field
Type
Description

busBindingName

String

The name of the bus.

internal

Boolean

Whether this is an internal bus.

detachedCommit

Boolean

Whether the bus is operating in detached mode.

numMsgsRcvd

Long

Messages received.

numMsgsInBatchesRcvd

Long

Messages received that were part of a batch.

numMsgBatchesRcvd

Long

Batch messages received.

numMsgsEnqueued

Long

Messages enqueued for delivery.

numMsgsSent

Long

Messages actually sent.

numAcksSent

Long

Inbound messages acknowledged.

numStabilityRcvd

Long

Stability events (acks) received.

numStabilityInBatchesRcvd

Long

Stability events that were part of a batch.

numStabilityBatchesRcvd

Long

Batched stability events received.

numPacketsRcvd

Long

Raw packets received.

numCommits

Long

Transactions committed.

numRollbacks

Long

Transactions rolled back.

numPartialRollbacks

Long

Partial (savepoint) transaction rollbacks.

numClients

Integer

Connected clients (if applicable).

numChannelsUp

Integer

Channels brought up.

numBindingFailures

Integer

Binding failures that have occurred.

createToSendLatencies

c2o — time from message creation to when send was called.

sendToPollLatencies

o2p — time from send offer to pickup for send (detached mode).

sendToSerializeLatencies

o2s — time from send start to serialization (excludes o2p in detached mode).

serializeLatencies

s — time spent serializing the MessageView to transport encoding.

serializeToWireLatencies

s2w — time from post-serialization to just before wire write.

wireSendLatencies

ws — time spent by the provider writing the message to the wire (includes flow control time).

wireLatencies

w — time on the wire from sender write to receiver read (subject to clock skew across hosts).

wireToDeserializeLatencies

w2d — time from wire receipt to deserialization start.

deserializeLatencies

d — time spent deserializing and wrapping in a MessageView.

deserializeToReceiveLatencies

d2i — time from deserialization to engine receipt (includes o2p of engine disruptor).

originToReceiveLatencies

o2i — time from message creation to binding receipt.

wireToWireLatencies

w2w — time from inbound wire receipt to outbound wire write.

disruptorStats

Disruptor stats when operating in detached mode.

User Stats (SrvMonUserStats)

Application-defined statistics. See Exposing Application Stats.

Field
Type
Description

counters

Application counter stats.

series

Application series stats.

gauges

Application gauge stats.

Counter Stat (SrvMonUserCounterStat)

A monotonically increasing counter. Sampled periodically, it can be used to derive a rate.

Field
Type
Description

name

String

The name of the statistic.

count

Long

The counter value.

Series Stat (SrvMonUserSeriesStat)

An application-defined series collection statistic.

Field
Type
Description

name

String

The name of the statistic.

seriesType

The data type of the series.

intSeries

The collected data for an INT series. Set when seriesType is INT.

longSeries

The collected data for a LONG series. Set when seriesType is LONG.

Gauge Stat (SrvMonUserGaugeStat)

A point-in-time value sampled at each statistics collection.

Field
Type
Description

name

String

The name of the gauge statistic.

guageType

The data type of the gauge value. Determines which typed accessor to use.

booleanValue

Boolean

The value for a BOOLEAN gauge.

byteValue

Byte

The value for a BYTE gauge.

charValue

Char

The value for a CHAR gauge.

shortValue

Short

The value for a SHORT gauge.

intValue

Integer

The value for an INT gauge.

longValue

Long

The value for a LONG gauge.

floatValue

Float

The value for a FLOAT gauge.

doubleValue

Double

The value for a DOUBLE gauge.

stringValue

String

The value for a STRING gauge.

Admin Client Stats (SrvMonAdminClientStats)

Statistics for a connected admin client. The container prioritizes its integrity over reliable delivery to admin clients — it will drop messages to a congested client.

Field
Type
Description

name

String

The name of the admin client.

heartbeatsSent

Long

Heartbeats sent to the client.

heartbeatsDropped

Long

Heartbeats dropped due to congestion.

lifecyclesSent

Long

Lifecycle events sent to the client.

tracesSent

Long

Trace records sent to the client.

tracesDropped

Long

Trace records dropped due to congestion.

outboundQueueCapacity

Integer

Capacity (bytes) of the client's outbound queue.

outboundQueueSize

Integer

Size (bytes) of the client's outbound queue. May exceed capacity when lifecycle events must be sent during congestion.

outboundQueueCount

Integer

Number of elements in the outbound queue.

outboundQueueFlushSize

Long

Bytes flushed from the outbound queue.

outboundQueueFlushCount

Long

Elements flushed from the outbound queue.

flushesScheduled

Long

Outbound queue flushes scheduled.

flushesExecuted

Long

Outbound queue flushes executed.

Message Logger Stats (SrvMonAppMessageLoggerStats)

Statistics for a message logger, used for heartbeat logging, inbound/outbound message logging, and per-transaction stats logging.

Field
Type
Description

detachedPersist

Boolean

Whether the logger is operating in detached mode.

numMessagesRecorded

Long

Messages persisted by the logger.

numCommits

Long

Commits to the logger.

numImplicitFlushes

Long

Flushes performed implicitly.

numExplicitFlushes

Long

Flushes performed explicitly.

numForks

Long

Forked message packets persisted.

fileSize

Long

Actual size of the log file on disk (may be preallocated larger).

fileSizeUsed

Long

Space used in the log file.

disruptorStats

Disruptor stats when operating in detached mode.

Disruptor Stats (SrvMonDisruptorStats)

Statistics for a disruptor.

Field
Type
Description

capacity

Integer

The size of the disruptor's ring buffer.

remaining

Integer

The number of free ring buffer slots.

claimStrategy

The claim strategy used by threads inputting events.

waitStrategy

The wait strategy used by the thread processing events.

offerToPollLatencies

Latency of events passing through the disruptor.

Int Series (SrvMonIntSeries)

Raw and histographical data for a series of integer data points. Frequently used for latency timings.

Field
Type
Description

numDataPoints

Integer

Data points collected in this interval.

lastSequenceNumber

Long

Sequence number of the last data point (0 = none collected). Running count since last reset.

skippedDatapoints

Long

Running count of data points skipped due to undersampling. If growing between heartbeats, intervalStats don't reflect all activity.

dataPoints

Integer[]

Raw data points (when configured to include them). Valid values count = numDataPoints.

intervalStats

Computed stats for this heartbeat's interval.

runningStats

Computed stats over the lifetime of the metric.

Int Histogram (SrvMonIntHistogram)

Computed histographical data. Fields may not be set if sample size is 0.

Field
Type
Description

sampleSize

Long

Number of data points over which results were calculated.

minimum

Integer

Minimum value in the sample set.

maximum

Integer

Maximum value in the sample set.

mean

Integer

Mean value.

median

Integer

Median value.

pct75

Integer

75th percentile.

pct90

Integer

90th percentile.

pct99

Integer

99th percentile.

pct999

Integer

99.9th percentile.

pct9999

Integer

99.99th percentile.

samplesOverMax

Long

Samples exceeding the maximum recordable HDRHistogram value (downsampled, skewing percentiles lower).

samplesUnderMin

Long

Samples below 0 (e.g. clock skew; upsampled to 0, skewing results).

Long Series (SrvMonLongSeries)

Raw and histographical data for a series of long data points. Same structure as Int Series but with Long types.

Field
Type
Description

numDataPoints

Integer

Data points collected in this interval.

lastSequenceNumber

Long

Sequence number of the last data point (0 = none collected).

skippedDatapoints

Long

Running count of data points skipped due to undersampling.

dataPoints

Long[]

Raw data points (when configured to include them).

intervalStats

Computed stats for this heartbeat's interval.

runningStats

Computed stats over the lifetime of the metric.

Long Histogram (SrvMonLongHistogram)

Computed histographical data for long series. Fields may not be set if sample size is 0.

Field
Type
Description

sampleSize

Long

Number of data points over which results were calculated.

minimum

Long

Minimum value in the sample set.

maximum

Long

Maximum value in the sample set.

mean

Long

Mean value.

median

Long

Median value.

pct75

Long

75th percentile.

pct90

Long

90th percentile.

pct99

Long

99th percentile.

pct999

Long

99.9th percentile.

pct9999

Long

99.99th percentile.

samplesOverMax

Long

Samples exceeding the maximum recordable value.

samplesUnderMin

Long

Samples below the minimum recordable value.

Enumerations

Service State

SrvMonAppState

Value
Description

Loaded

Service has been loaded but is not yet initialized.

Initialized

Service has been initialized.

Started

Service has been started.

Active

Service has been started and is the primary HA member.

Stopped

Service has been stopped.

Unloaded

Service has been unloaded.

Service HA Role

SrvMonAppRole

Value
Description

Primary

Operating in the primary role with a backup.

Backup

Operating in a backup role for a primary.

Standalone

Configured as a standalone instance without a backup.

Service HA Policy

SrvMonAppHAPolicy

Value
Description

EventSourcing

Recovery by replay of inbound events.

StateReplication

Recovery by replication of state and outbound messages.

Bus Binding State

SrvMonAppBusBindingState

Value
Description

Created

Bus has been created but not yet opened.

Opening

Bus is being opened.

Opened

Bus is opened.

Failed

Bus has failed.

Store Binding Role

SrvMonAppStoreBindingRole

Value
Description

Primary

Store (and service) is the current cluster leader.

Backup

Store (and service) is operating as backup to the leader.

Unknown

Store role is unknown or invalid.

Store Binding State

SrvMonAppStoreBindingState

Value
Description

Opening

Store is opening.

Open

Store is open.

Failed

Store has failed.

Closed

Store has closed.

Unknown

Store is in an unknown or invalid state.

ICR Role

SrvMonAppStoreICRRole

Value
Description

None

Inter-cluster replication is not configured.

Sender

Cluster members serve as inter-cluster replication senders.

StandaloneReceiver

Cluster members serve as standalone inter-cluster replication receivers.

Disruptor Claim Strategy

SrvMonDisruptorClaimStrategy

Value
Description

SingleThreaded

Optimized for a single publisher thread.

MultiThreaded

For multiple publisher threads, forgiving under contention or insufficient CPUs.

MultiThreadedSufficientCores

For multiple publisher threads with sufficient cores and low contention.

Unknown

Claim strategy is invalid or not recognized.

Disruptor Wait Strategy

SrvMonDisruptorWaitStrategy

Value
Description

Blocking

Uses a lock and condition variable. Best when CPU resources are more important than latency.

Sleeping

Spins, then yields, then sleeps for minimum OS/JVM nanos. Good compromise; latency spikes possible after quiet periods.

Yielding

Spins then yields. Good compromise without significant latency spikes.

BusySpin

Busy spin loop. Avoids syscalls and latency jitter. Best with dedicated CPU cores.

Unknown

Wait strategy is invalid or not recognized.

Gauge Type

SrvMonGaugeType

Value
Description

BOOLEAN, BYTE, CHAR, SHORT, INT, LONG, FLOAT, DOUBLE, STRING

Indicates which typed accessor to call on the gauge stat.

Series Type

SrvMonSeriesType

Value
Description

BYTE, SHORT, INT, LONG, FLOAT, DOUBLE

Indicates the data type. Currently only INT is supported; others are reserved.

Last updated