From f2d87dee5c64715f1c2267a895165ecdc97158ec Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Bj=C3=B6rn=20Vonheiden?= <bjoern.vonheiden@hotmail.de>
Date: Fri, 27 Aug 2021 10:33:23 +0200
Subject: [PATCH] add documentation to the slo checker factory for the creation
of different type of slo checkers
---
.../evaluation/SloCheckerFactory.kt | 26 ++++++++++++++++---
1 file changed, 22 insertions(+), 4 deletions(-)
diff --git a/theodolite/src/main/kotlin/theodolite/evaluation/SloCheckerFactory.kt b/theodolite/src/main/kotlin/theodolite/evaluation/SloCheckerFactory.kt
index 3a00b8ab5..76b158a58 100644
--- a/theodolite/src/main/kotlin/theodolite/evaluation/SloCheckerFactory.kt
+++ b/theodolite/src/main/kotlin/theodolite/evaluation/SloCheckerFactory.kt
@@ -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.
--
GitLab