Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
NaniteBased committed Nov 9, 2022
1 parent 7bcce1e commit 733a195
Show file tree
Hide file tree
Showing 4 changed files with 29 additions and 0 deletions.
5 changes: 5 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
**09/11/2022** [Version 3.6.1]
- Allow defining a set of KPIs per TestCase
- Implement `/execution/<id>/kpis` endpoint
- Avoid exception when sending CSVs to InfluxDb on Python 3.11

**10/10/2022** [Version 3.6.0]

- Implemented Child tasks, flow control:
Expand Down
3 changes: 3 additions & 0 deletions docs/2-1_FACILITY_CONFIGURATION.md
Original file line number Diff line number Diff line change
Expand Up @@ -91,6 +91,9 @@ Distributed: False
Dashboard: {}
````

V2 TestCases can also contain an optional `KPIs` field, which can be used to define a sub-set of results that are
considered *of interest*. See [TestCase Parameters](/docs/2-2_TESTCASE_PARAMETERS.md) for more information.

##### - V1 TestCase (`Version: 1` or missing)

TestCases using this format follow the same approach as for UE files. The following is an example V1 TestCase:
Expand Down
13 changes: 13 additions & 0 deletions docs/2-2_TESTCASE_PARAMETERS.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,19 @@ be added to the yaml description. These keys are:
value is set to an empty list ('[]') the test case is considered public and will appear on the list of Custom
experiments for all users of the Portal. If the list contains one or more email addresses, the test case will be
visible only to the users with matching emails.
- `KPIs`: Optional dictionary that can be used for defining a sub-set of results, from all of the generated by the
TestCase, that can be considered *of interest*. The following is an example of the format:
```yaml
"KPIs":
ping: # Each key refers to a 'measurement' (table)
- Success # Each key contains a list of 'kpi' (table columns)
- Delay
iPerf:
- Throughput
```
These values (as (`measurement`, `kpi`) pairs) can be retrieved, per experiment execution, by using the
`execution/<id>/kpis` endpoint. When multiple TestCases are included as part of an experiment the union
of all KPIs (duplicates removed) are returned.
- `Parameters`: Dictionary of dictionaries, where each entry is defined as follows:
```yaml
"<Parameter Name>":
Expand Down
8 changes: 8 additions & 0 deletions docs/A1_ENDPOINTS.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,14 @@ Returns a compressed file that includes the logs and all files generated by the

Returns a copy of the Experiment Descriptor that was used to define the execution.

### [GET] '/execution/<id>/kpis'

Returns a dictionary with a single `KPIs` key, containing a list of pairs (`measurement`, `kpi`) that are considered of
interest.

> These values can be used as part of queries to the [Analytics Module](https://github.com/5genesis/Analytics), in order
> to extract a sub-set of important KPIs from all the generated measurements.
### [DELETE] `/execution/<id>`
> *[GET] `/execution/<id>/cancel` (Deprecated)*
Expand Down

0 comments on commit 733a195

Please sign in to comment.