github/kata-containers
1
0
Fork 1
mirror of https://github.com/kata-containers/kata-containers.git synced 2025-04-29 20:24:31 +00:00
Code Issues Projects Releases Wiki Activity

docs: Add general README

Browse Source 
This PR adds link to the unreference docs in the cmd path to make
them more discoverable.

Signed-off-by: Gabriela Cervantes <gabriela.cervantes.tellez@intel.com>
This commit is contained in:
Gabriela Cervantes 2023-06-26 17:49:11 +00:00
parent aa7946de47
commit 415578cf3b
2 changed files with 22 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
tests/metrics/README.md
View File

@ -190,3 +190,7 @@ happen if `JSON_URL` is set. The settings are not mutually exclusive, and both c
set if necessary.
`JSON_TX_ONELINE` applies to both types of transmission.
## `checkmetrics`
`checkmetrics` is a CLI tool to check a metrics CI results file. For further reference see the [`checkmetrics`](cmd/checkmetrics).

34
tests/metrics/cmd/checkmetrics/README.md
View File

@ -2,12 +2,12 @@
## Overview
The checkmetrics tool is used to check the metrics results files in
The `checkmetrics` tool is used to check the metrics results files in
JSON format. Results files are checked against configs stored in a TOML
file that contains baseline expectations for the results.
`checkmetrics` checks for a matching results file for each entry in the
TOML file with an appropriate json file extension. Failure to find a matching
TOML file with an appropriate `json` file extension. Failure to find a matching
file is classified as a failure for that individual TOML entry.
`checkmetrics` continues to process all entries in the TOML file and prints its
@ -29,26 +29,26 @@ Each section contains a number of parameters, some optional:
```
|name | type | description |
|----------------------------------------------------------------------------
|name | string | Filename containing results (minus .json ext.)|
|type | string | json (optional, json is the default) |
|description | string | Description of test (optional) |
|checkvar | string | jq query string to extract results from JSON |
|checktype | string | Property to check ("mean", "max" etc.) |
|minval | float | Minimum value the checked property should be |
|maxval | float | Maximum value the checked property should be |
|midval | float | Middle value used for percentage range check |
|minpercent | float | Minimum percentage from midval check boundary |
|maxpercent | float | Maximum percentage from midval check boundary |
|`name` | string | Filename containing results (minus .json ext.)|
|`type` | string | json (optional, json is the default) |
|`description` | string | Description of test (optional) |
|`checkvar` | string | jq query string to extract results from JSON |
|`checktype` | string | Property to check ("mean", "max" etc.) |
|`minval` | float | Minimum value the checked property should be |
|`maxval` | float | Maximum value the checked property should be |
|`midval` | float | Middle value used for percentage range check |
|`minpercent` | float | Minimum percentage from midval check boundary |
|`maxpercent` | float | Maximum percentage from midval check boundary |
```
### Supported file types
At this time only JSON formatted results files are supported.
### Supported checktypes
### Supported `checktypes`
The following checktypes are supported. All are tested to fall within the bounds set by the minval
and maxval. That is:
The following `checktypes` are supported. All are tested to fall within the bounds set by the `minval`
and `maxval`. That is:
> `minval <= Result <= maxval`
@ -110,7 +110,7 @@ and maxval. That is:
## Output
The checkmetrics tool outputs a summary table after processing all metrics sections, and returns
The `checkmetrics` tool outputs a summary table after processing all metrics sections, and returns
a non-zero return code if any of the metrics checks fail.
Example output:
@ -161,7 +161,7 @@ Fails: 2, Passes 1
## Example invocation
For example, to invoke the checkmetrics tool, enter the following:
For example, to invoke the `checkmetrics` tool, enter the following:
```
BASEFILE=`pwd`/../../metrics/baseline/baseline.toml