This is an automated email from the ASF dual-hosted git repository.
dspavlov pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/ignite.git
The following commit(s) were added to refs/heads/master by this push:
new 548f36cbbd7 IGNITE-28795 Document SizeUsedByData metric (#13247)
548f36cbbd7 is described below
commit 548f36cbbd717d1ddfe14eddeb1449787524b6b3
Author: ignitetcbot <[email protected]>
AuthorDate: Wed Jul 15 10:08:58 2026 +0300
IGNITE-28795 Document SizeUsedByData metric (#13247)
Codex co-authored-by: Dmitriy Pavlov <[email protected]>
---
docs/_docs/monitoring-metrics/new-metrics-system.adoc | 8 ++++++--
docs/_docs/monitoring-metrics/new-metrics.adoc | 3 ++-
2 files changed, 8 insertions(+), 3 deletions(-)
diff --git a/docs/_docs/monitoring-metrics/new-metrics-system.adoc
b/docs/_docs/monitoring-metrics/new-metrics-system.adoc
index 0c0a49e204b..2e34bd6d299 100644
--- a/docs/_docs/monitoring-metrics/new-metrics-system.adoc
+++ b/docs/_docs/monitoring-metrics/new-metrics-system.adoc
@@ -274,7 +274,10 @@ It is reused when new entries need to be added to the
storage on subsequent writ
The allocated size is available at the level of data storage, data region, and
cache group metrics.
The metric is called `TotalAllocatedSize`.
-You can also get an estimate of the actual size of data by multiplying the
number of link:memory-architecture#data-pages[data pages] in use by the fill
factor. The fill factor is the ratio of the size of data in a page to the page
size, averaged over all pages. The number of pages in use and the fill factor
are available at the level of data <<Data Region Size,region metrics>>.
+For link:memory-configuration/data-regions[data region] metrics, Ignite also
exposes the `SizeUsedByData` metric.
+It estimates how many bytes are currently occupied by data in the region.
+The metric is calculated as `(TotalAllocatedPages - EmptyDataPages) * pageSize
* PagesFillFactor`. `PagesFillFactor` is the average ratio of data bytes to
page size in non-empty data pages.
+Use `SizeUsedByData` when you need a more direct estimate of how much data is
stored in the region, and use `TotalAllocatedSize` when you need to monitor how
much space has already been allocated for that region.
Add up the estimated size of all data regions to get the estimated total
amount of data on the node.
@@ -323,7 +326,8 @@ The size of the data region on a node comprises the size of
all partitions (incl
| Attribute | Type | Description | Scope
| TotalAllocatedSize | long | The size of the space allocated for this data
region (in bytes). {allocsize_note} | Node
-| PagesFillFactor| float | The average amount of data in pages as a ratio of
the page size. | Node
+| SizeUsedByData | long | The estimated number of bytes occupied by data in
this data region, taking into account free space inside non-empty pages. | Node
+| PagesFillFactor| float | The average amount of data in non-empty pages as a
ratio of the page size. | Node
| TotalUsedPages | long | The number of data pages that are currently in use.
| Node
| PhysicalMemoryPages |long |The number of data pages in this data region held
in RAM. | Node
| PhysicalMemorySize | long |The size of the allocated space in RAM in bytes.|
Node
diff --git a/docs/_docs/monitoring-metrics/new-metrics.adoc
b/docs/_docs/monitoring-metrics/new-metrics.adoc
index 30c78bd62f5..7b749d7d212 100644
--- a/docs/_docs/monitoring-metrics/new-metrics.adoc
+++ b/docs/_docs/monitoring-metrics/new-metrics.adoc
@@ -401,7 +401,7 @@ Register name: `io.dataregion.{data_region_name}`
|LargeEntriesPagesCount| long| Count of pages that fully ocupied by large
entries that go beyond page size
|OffHeapSize| long| Offheap size in bytes.
|OffheapUsedSize| long| Offheap used size in bytes.
-|PagesFillFactor| double| The percentage of the used space.
+|PagesFillFactor| double| The average amount of data in non-empty pages as a
ratio of the page size.
|PagesRead| long| Number of pages read from last restart.
|PagesReplaceAge| hitrate| Average age at which pages in memory are
replaced with pages from persistent storage (milliseconds).
|PagesReplaceRate| hitrate| Rate at which pages in memory are replaced
with pages from persistent storage (pages per second).
@@ -409,6 +409,7 @@ Register name: `io.dataregion.{data_region_name}`
|PagesWritten| long| Number of pages written from last restart.
|PhysicalMemoryPages| long| Number of pages residing in physical RAM.
|PhysicalMemorySize | long| Gets total size of pages loaded to the RAM, in
bytes
+|SizeUsedByData| long| Estimated number of bytes occupied by data in the
region, taking into account free space inside non-empty pages.
|TotalAllocatedPages |long| Total number of allocated pages.
|TotalAllocatedSize| long | Gets a total size of memory allocated in the
data region, in bytes
|TotalThrottlingTime| long| Total throttling threads time in milliseconds.
The Ignite throttles threads that generate dirty pages during the ongoing
checkpoint.
