Skip to content

IGNITE-28795 Document SizeUsedByData metric#13247

Open
ignitetcbot wants to merge 1 commit into
apache:masterfrom
ignitetcbot:ignite-28795-sizeusedbydata-docs
Open

IGNITE-28795 Document SizeUsedByData metric#13247
ignitetcbot wants to merge 1 commit into
apache:masterfrom
ignitetcbot:ignite-28795-sizeusedbydata-docs

Conversation

@ignitetcbot

Copy link
Copy Markdown
Contributor

Thank you for submitting the pull request to the Apache Ignite.

In order to streamline the review of the contribution
we ask you to ensure the following steps have been taken:

The Contribution Checklist

  • There is a single JIRA ticket related to the pull request.
  • The web-link to the pull request is attached to the JIRA ticket.
  • The JIRA ticket has the Patch Available state.
  • The pull request body describes changes that have been made.
    The description explains WHAT and WHY was made instead of HOW.
  • The pull request title is treated as the final commit message.
    The following pattern must be used: IGNITE-XXXX Change summary where XXXX - number of JIRA issue.
  • A reviewer has been mentioned through the JIRA comments
    (see the Maintainers list)
  • The pull request has been checked by the Teamcity Bot and
    the green visa attached to the JIRA ticket (see tab PR Check at TC.Bot - Instance 1 or TC.Bot - Instance 2)

Notes

If you need any help, please email dev@ignite.apache.org or ask anу advice on http://asf.slack.com #ignite channel.


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.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Previous paragraph is not quite correct. Fill factor is calculated only for used pages. So correct formula will be (total allocated - empty pages) * fill factor. This is exactly how SizeUsedByData is calculated. So this paragraph describes the almost the same entity as previous paragraph but using dedicated metric. I think we can unify both paragraphs (delete previous one and describe what is fill factor and how SizeUsedByData is calculated).

| 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

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

including empty space inside non-empty pages is confusing. Someone may think that empty space is added to this metric too. Maybe taking into account empty space inside non-empty pages?

|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.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Tha same comment for including


| 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

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Lat's also clarify here something like in non-empty pages

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants