Skip to content

IGNITE-28795 Document SizeUsedByData metric #13247

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

Open
ignitetcbot wants to merge 1 commit into
base: master
Choose a base branch
from
+4 −0
Open

IGNITE-28795 Document SizeUsedByData metric #13247

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
3 changes: 3 additions & 0 deletions docs/_docs/monitoring-metrics/new-metrics-system.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -276,6 +276,8 @@ 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, including the empty space inside non-empty pages. Use this metric 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.


Expand Down Expand Up @@ -323,6 +325,7 @@ 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
| SizeUsedByData | long | The estimated number of bytes occupied by data in this data region, including empty space inside non-empty pages. | Node
| PagesFillFactor| float | The average amount of data in 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
Expand Down
1 change: 1 addition & 0 deletions docs/_docs/monitoring-metrics/new-metrics.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -406,6 +406,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, including empty 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.
Expand Down