github.com/dmaizel/tests@v0.0.0-20210728163746-cae6a2d9cee8/metrics/density/README.md (about)

     1  # Kata Containers density metrics tests
     2  
     3  * [Kata Containers density metrics tests](#kata-containers-density-metrics-tests)
     4     * [memory_usage](#memory_usage)
     5     * [fast_footprint](#fast_footprint)
     6     * [footprint_data](#footprint_data)
     7     * [memory_usage_inside_container](#memory_usage_inside_container)
     8  
     9  This directory contains a number of tests to help measure container
    10  memory footprint. Some measures are based around the
    11  [PSS](https://en.wikipedia.org/wiki/Proportional_set_size) of the runtime
    12  components, and others look at the system level (`free` and `/proc/meminfo`
    13  for instance) impact.
    14  
    15  ## `memory_usage`
    16  
    17  This test measures the PSS footprint of the runtime components whilst
    18  launching a number of small ([BusyBox](https://hub.docker.com/_/busybox/)) containers
    19  using ctr.
    20  
    21  ## `fast_footprint`
    22  
    23  This test takes system level resource measurements after launching a number of
    24  containers in parallel and optionally waiting for KSM to settle its memory
    25  compaction cycles.
    26  
    27  The script is quite configurable via environment variables, including:
    28  
    29  * Which container workload to run.
    30  * How many containers to launch.
    31  * How many containers are launched in parallel.
    32  * How long to wait until taking the measures.
    33  
    34  See the script itself for more details.
    35  
    36  This test shares many config options with the `footprint_data` test. Thus, referring
    37  to the [footprint test documentation](footprint_data.md) may be useful.
    38  
    39  > *Note:* If this test finds KSM is enabled on the host, it will wait for KSM
    40  > to "settle" before taking the final measurement. If your KSM is not configured
    41  > to process all the allocated VM memory fast enough, the test will hit a timeout
    42  > and proceed to take the final measurement anyway.
    43  
    44  ## `footprint_data`
    45  
    46  Similar to the `fast_footprint` test, but this test launches the containers
    47  sequentially and takes a system level measurement between each launch. Thus,
    48  this test provides finer grained information on system scaling, but takes
    49  significantly longer to run than the `fast_footprint` test. If you are only
    50  interested in the final figure or the average impact, you may be better running
    51  the `fast_footprint` test.
    52  
    53  For more details see the [footprint test documentation](footprint_data.md).
    54  
    55  ## `memory_usage_inside_container`
    56  
    57  Measures the memory statistics *inside* the container. This allows evaluation of
    58  the overhead the VM kernel and rootfs are having on the memory that was requested
    59  by the container co-ordination system, and thus supplied to the VM.