kubernetes/website

Visually Document Container Memory Metrics and their Relationships

Open

#25,388 opened on Dec 3, 2020

View on GitHub
 (22 comments) (7 reactions) (0 assignees)HTML (13,918 forks)batch import
help wantedkind/featurelanguage/enlifecycle/frozenpriority/backlogsig/instrumentationtriage/accepted

Repository metrics

Stars
 (4,127 stars)
PR merge metrics
 (Avg merge 16d 13h) (160 merged PRs in 30d)

Description

This is a Feature Request

What would you like to be added A document that explains what all the different container memory metrics mean and how they are interrelated.

Why is this needed Today, the following metrics exist for container memory:

  • container_memory_cache
  • container_memory_mapped_file
  • container_memory_max_usage_bytes
  • container_memory_rss
  • container_memory_swap
  • container_memory_usage_bytes
  • container_memory_working_set_bytes

I would like to see a document that explains what they are, how they are different or similar to each other, how they nest, what container="" and container="POD" mean, which metric(s) are used by the kubelet to evict, why usage_bytes and max_usage_bytes might differ, the effects of quantized sampling, etc.

Comments A visual description would be amazing here, as there are hierarchical relationships that would benefit from such a view.

Contributor guide

Research direction
Investigate the container memory metrics listed in the issue, understand their definitions and relationships, and create a visual document explaining their hierarchy and usage.
Tech stack
None
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Kubernetes container memory concepts
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60