Skip to content
Snippets Groups Projects
Commit f2d87dee authored by Björn Vonheiden's avatar Björn Vonheiden
Browse files

add documentation to the slo checker factory for the creation of different type of slo checkers

parent 4f0d7926
No related branches found
No related tags found
1 merge request!172Use the properties of the slo checker and add lag trend percent
......@@ -10,12 +10,30 @@ class SloCheckerFactory {
/**
* Creates different [SloChecker]s.
* Supports: lag type.
*
* Supports: `lag trend` and `lag trend percent` as arguments for `sloType`
*
* ### `lag trend`
* Creates an [ExternalSloChecker] with defined parameters.
*
* The properties map needs the following fields:
* - `externalSlopeURL`: Url to the concrete SLO checker service.
* - `threshold`: fixed value used for the slope.
* - `warmup`: time from the beginning to skip in the analysis.
*
*
* ### `lag trend percent`
* Creates an [ExternalSloChecker] with defined parameters.
* The required threshold is computed using a percentage and the load of the experiment.
*
* The properties map needs the following fields:
* - `externalSlopeURL`: Url to the concrete SLO checker service.
* - `percent`: of the executed load that is accepted for the slope.
* - `warmup`: time from the beginning to skip in the analysis.
*
* @param sloType Type of the [SloChecker].
* @param externalSlopeURL Url to the concrete [SloChecker].
* @param threshold for the [SloChecker].
* @param warmup for the [SloChecker].
* @param properties map of properties to use for the SLO checker creation.
* @param load that is executed in the experiment.
*
* @return A [SloChecker]
* @throws IllegalArgumentException If [sloType] not supported.
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment