Skip to content
New issue

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

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

Already on GitHub? # to your account

Adds a more accurate description of container rss metric #19767

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

scottopell
Copy link
Contributor

What does this PR do?

Updates the container.memory.rss description to be more accurate.

Motivation

The container.memory.rss metric reports only the 'anonymous' portion of the container memory.
This is potentially confusing as the term RSS is typically used to describe the combination of RssAnon, RssFile, and RssShmem when looking at a process-view.

However, a container-view will use rss to refer to only the anon portion of the memory.

Review checklist (to be filled by reviewers)

  • Feature or bugfix MUST have appropriate tests (unit, integration, e2e)
  • Add the qa/skip-qa label if the PR doesn't need to be tested during QA.
  • If you need to backport this PR to another branch, you can add the backport/<branch-name> label to the PR and it will automatically open a backport PR once this one is merged

@@ -17,7 +17,7 @@ container.memory.limit,gauge,,byte,,The container memory limit,0,container,mem_l
container.memory.major_page_faults,count,,,,Number of major page faults incurred,0,container,pgmajfault,
container.memory.oom_events,gauge,,,,The number of OOM events triggered by the container,0,container,mem_oom_events,
container.memory.page_faults,count,,,,Total number of page faults incurred,0,container,pgfault,
container.memory.rss,gauge,,byte,,The container RSS usage,0,container,mem_rss,
container.memory.rss,gauge,,byte,,The 'anon' memory used by the container,0,container,mem_rss,
Copy link
Contributor

Choose a reason for hiding this comment

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

We can perhaps improve more with the Kernel description:

Amount of memory used in anonymous mappings such as brk(), sbrk(), and mmap(MAP_ANONYMOUS)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I was hesitant to include more specific linux concepts as this appears to be cross-platform, and I don't know what this reports on windows.

Copy link
Contributor

Choose a reason for hiding this comment

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

It's a Linux-only metric.

# for free to join this conversation on GitHub. Already have an account? # to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants