Skip to content

Document missing metrics [CTT-942] #2091

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
JamesHazelcast merged 5 commits into from
Feb 20, 2026
Merged

Document missing metrics [CTT-942] #2091

Changes from 3 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
40359e9
Document missing metrics [CTT-942]
JamesHazelcast Feb 3, 2026
9b9cd33
fix table
Rob-Hazelcast Feb 5, 2026
60d8a65
fix formatting error
Rob-Hazelcast Feb 9, 2026
930f897
Clarify client vs member vs subsystem metrics
JamesHazelcast Feb 19, 2026
9847ead
Update docs/modules/ROOT/pages/list-of-metrics.adoc
JamesHazelcast Feb 20, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
82 changes: 77 additions & 5 deletions docs/modules/ROOT/pages/list-of-metrics.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,9 +25,9 @@ NOTE: If you use Management Center to export cluster-wide metrics to Prometheus,

|blockingWorkerCount
|Number of non-cooperative workers employed.
.6+|_none_
.7+|_none_

Each Hazelcast member will have one instance of this metric.
Each Hazelcast member will have one instance of each of these metrics.

|jobs.submitted
|Number of computational jobs submitted.
Expand All @@ -40,14 +40,17 @@ Each Hazelcast member will have one instance of this metric.

|jobs.executionStarted
|Number of computational job executions started. Each job can
execute multiple times, for example when it’s restarted or
execute multiple times, for example when it's restarted or
suspended and then resumed.

|jobs.executionTerminated
|Number of computational job executions finished. Each job can
execute multiple times, for example when it’s restarted or
execute multiple times, for example when it's restarted or
suspended and then resumed.

|jobs.executionCompleted
|Number of computational job executions completed (successfully or otherwise).

|iterationCount
|The total number of iterations the driver of tasklets in
cooperative thread N made. It should increase by at least 250
Expand All @@ -57,9 +60,10 @@ if there are many tasklets assigned to the processor. Lower
value affects the latency.
.2+|_cooperativeWorker_

Each Hazelcast member will have one of this metric for each of its
Each Hazelcast member will have one instance of each of these metrics for each of its
cooperative worker threads.


|taskletCount
|The number of assigned tasklets to cooperative thread N.

Expand Down Expand Up @@ -284,6 +288,11 @@ The Reset column shows the reset behavior of the metrics. There are two types of
|Number of updated but not persisted yet entries, dirty entries, that the member owns
| N

|`map.entrySetCount`
|count
|Number of entry set operations on this member
| N

|`map.evictionCount`
|count
|Number of evictions happened on locally owned entries, backups are not included
Expand Down Expand Up @@ -374,6 +383,11 @@ The Reset column shows the reset behavior of the metrics. There are two types of
|Number of queries executed on the map (it may be imprecise for queries involving partition predicates (PartitionPredicate) on the off-heap storage)
| N

|`map.queryLimiterHitCount`
|count
|Number of times the query result size limiter was hit on this member
| N

|`map.removeCount`
|count
|Number of local remove operations on the map
Expand Down Expand Up @@ -424,6 +438,16 @@ The Reset column shows the reset behavior of the metrics. There are two types of
|Total latency of local set operations on the map
| N

|`map.valuesCount`
|count
|Number of values operations on this member
| N

|`map.store.offloaded.operations.waitingToBeProcessedCount`
|count
|Number of offloaded map store operations waiting to be processed
| N

4+a|
The above `*latency` metrics are only measured for the members and they do not represent the overall performance of the cluster.
Hazelcast recommends monitoring the average latency for each operation, for example, `map.totalGetLatency` / `map.getCount` and `map.totalSetLatency` / `map.setCount`.
Expand Down Expand Up @@ -748,6 +772,18 @@ This is because the cluster has to communicate with more members, which can add
|count
|Number of dirty (updated but not persisted yet) entries that the member owns

|`multiMap.entrySetCount`
|count
|Number of entry set operations on this member

|`multiMap.evictionCount`
|count
|Number of evictions completed on locally owned entries, backups are not included

|`multiMap.expirationCount`
|count
|Number of expirations completed on locally owned entries, backups are not included

|`multiMap.getCount`
|count
|Number of local get operations on the multimap
Expand All @@ -764,6 +800,14 @@ This is because the cluster has to communicate with more members, which can add
|count
|Total number of indexed local queries performed on the multimap

|`multiMap.indexesSkippedQueryCount`
|count
|Total number of local queries performed on the multimap which cannot use indexes

|`multiMap.noMatchingIndexQueryCount`
|count
|Total number of local queries performed on the multimap which had no matching index

|`multiMap.lastAccessTime`
|ms
|Last access (read) time of the locally owned entries
Expand Down Expand Up @@ -804,6 +848,10 @@ This is because the cluster has to communicate with more members, which can add
|count
|Number of local queries executed on the multimap (it may be imprecise for queries involving partition predicates (PartitionPredicate) on the off-heap storage)

|`multiMap.queryLimiterHitCount`
|count
|Number of times the query result size limiter was hit on this member

|`multiMap.removeCount`
|count
|Number of local remove operations on the multimap
Expand Down Expand Up @@ -843,6 +891,10 @@ This is because the cluster has to communicate with more members, which can add
|`multiMap.totalSetLatency`
|ms
|Total latency of local set operations

|`multiMap.valuesCount`
|count
|Number of values operations on this member
|===
====

Expand All @@ -859,6 +911,10 @@ This is because the cluster has to communicate with more members, which can add
|ms
|Creation time of this replicated map on this member

|`replicatedMap.entrySetCount`
|count
|Number of entry set operations on this member

|`replicatedMap.getCount`
|count
|Number of get operations on this member
Expand Down Expand Up @@ -926,6 +982,10 @@ This is because the cluster has to communicate with more members, which can add
|`replicatedMap.total`
|count
|Total number of operations on this member

|`replicatedMap.valuesCount`
|count
|Number of values operations on this member
|===
====

Expand Down Expand Up @@ -1785,6 +1845,10 @@ The **normal** operations are the ones that manipulate the data, for example `ma
|count
|Number of current executing async operations on the operation service of the member

|`operation.callTimeoutCount`
|count
|Number of operation call timeouts on the member

|`operation.completedCount`
|count
|Number of completed operations
Expand Down Expand Up @@ -2463,6 +2527,10 @@ Based on your latency tolerance in your business use case, you can define a thre
|count
|Number of times that I/O exceptions are thrown during selection

|`tcp.inputThread/outputThread.selectorRebuildCount`
|count
|Number of times the selector was recreated on this NioThread

|`tcp.inputThread/outputThread.taskQueueSize`
|count
|Number of pending tasks on the queue of NioThread
Expand Down Expand Up @@ -2576,6 +2644,10 @@ Based on your latency tolerance in your business use case, you can define a thre
|count
|Total number of WAN events currently placed in the WAN queues of primary partitions on this member

|`wan.queueFillPercent`
|percent
|Percentage of the WAN replication queue that is filled

|`wan.removeCount`
|count
|Number of entry remove events
Expand Down