github.com/kata-containers/tests@v0.0.0-20240307153542-772105b56064/metrics/report/report_dockerfile/metrics_report.Rmd (about)

     1  ---
     2  # Copyright (c) 2018-2019 Intel Corporation
     3  #
     4  # SPDX-License-Identifier: Apache-2.0
     5  ---
     6  \pagebreak
     7  
     8  # Introduction
     9  This report compares the metrics between multiple sets of data generated from
    10  the [Kata Containers report generation scripts](https://github.com/kata-containers/tests/tree/main/metrics/report/README.md).
    11  
    12  This report was generated using the data from the **`r resultdirs`** results directories.
    13  
    14  \pagebreak
    15  
    16  # Container scaling system footprint
    17  This [test](https://github.com/kata-containers/tests/blob/main/metrics/density/footprint_data.sh)
    18  measures the system memory footprint impact whilst running an increasing number
    19  of containers. For this test, [KSM](https://en.wikipedia.org/wiki/Kernel_same-page_merging)
    20   is enabled. The results show how system memory is consumed for different sized
    21  containers, and their average system memory footprint cost and density (how many
    22  containers you can fit per Gb) is calculated.
    23  
    24  ```{r footprint-density, echo=FALSE, fig.cap="System Memory density"}
    25  test_name_extra="-ksm"
    26  source('footprint-density.R')
    27  rm(test_name_extra)
    28  ```
    29  \pagebreak
    30  
    31  # Memory used inside container
    32  This [test](https://github.com/kata-containers/tests/blob/main/metrics/density/memory_usage_inside_container.sh)
    33  measures the memory inside a container taken by the container runtime. It shows the difference between the amount of memory requested for the container, and the amount the container can actually 'see'.
    34  
    35  The *% Consumed* is the key row in the table, which compares the *Requested* against *Total* values.
    36  
    37  
    38  ```{r mem-in-cont, echo=FALSE, fig.cap="System Memory density"}
    39  source('mem-in-cont.R')
    40  ```
    41  \pagebreak
    42  
    43  
    44  # Container boot lifecycle times
    45  This [test](https://github.com/kata-containers/tests/blob/main/metrics/time/launch_times.sh)
    46  uses the `date` command on the host and in the container, as well as data from the container
    47  kernel `dmesg`, to ascertain how long different phases of the create/boot/run/delete
    48  Docker container lifecycle take for the first launched container.
    49  
    50  To decode the stats table, the prefixes are 'to(`2`)' and '`i`n'. The suffixes are '`k`ernel', '`w`orkload' and '`q`uit'. 'tot' is the total time for a complete container start-to-finished cycle.
    51  
    52  ```{r lifecycle-time, echo=FALSE, fig.cap="Execution lifecycle times"}
    53  source('lifecycle-time.R')
    54  ```
    55  \pagebreak
    56  
    57  # Test setup details
    58  
    59  This table describes the test system details, as derived from the information contained
    60  in the test results files.
    61  
    62  
    63  ```{r dut, echo=FALSE, fig.cap="System configuration details"}
    64  source('dut-details.R')
    65  ```