feat(slo): timeslice target value between 0 and 100% included (elasti…

…c#180948)
PhilippeOberti · Apr 17, 2024 · 873d48c · 873d48c
1 parent 7871110
commit 873d48c
Show file tree

Hide file tree

Showing 6 changed files with 32 additions and 10 deletions.
diff --git a/x-pack/plugins/observability_solution/slo/docs/openapi/slo/bundled.json b/x-pack/plugins/observability_solution/slo/docs/openapi/slo/bundled.json
@@ -1740,11 +1740,17 @@
           "target": {
             "description": "the target objective between 0 and 1 excluded",
             "type": "number",
+            "minimum": 0,
+            "maximum": 100,
+            "exclusiveMinimum": true,
+            "exclusiveMaximum": true,
             "example": 0.99
           },
           "timesliceTarget": {
             "description": "the target objective for each slice when using a timeslices budgeting method",
             "type": "number",
+            "minimum": 0,
+            "maximum": 100,
             "example": 0.995
           },
           "timesliceWindow": {
@@ -2472,4 +2478,4 @@
       }
     }
   }
-}
+}
diff --git a/x-pack/plugins/observability_solution/slo/docs/openapi/slo/bundled.yaml b/x-pack/plugins/observability_solution/slo/docs/openapi/slo/bundled.yaml
@@ -1187,10 +1187,16 @@ components:
         target:
           description: the target objective between 0 and 1 excluded
           type: number
+          minimum: 0
+          maximum: 100
+          exclusiveMinimum: true
+          exclusiveMaximum: true
           example: 0.99
         timesliceTarget:
           description: the target objective for each slice when using a timeslices budgeting method
           type: number
+          minimum: 0
+          maximum: 100
           example: 0.995
         timesliceWindow:
           description: the duration of each slice when using a timeslices budgeting method, as {duraton}{unit}

diff --git a/x-pack/plugins/observability_solution/slo/docs/openapi/slo/components/schemas/objective.yaml b/x-pack/plugins/observability_solution/slo/docs/openapi/slo/components/schemas/objective.yaml
@@ -7,10 +7,16 @@ properties:
   target:
     description: the target objective between 0 and 1 excluded
     type: number
+    minimum: 0
+    maximum: 100
+    exclusiveMinimum: true
+    exclusiveMaximum: true
     example: 0.99
   timesliceTarget:
     description: the target objective for each slice when using a timeslices budgeting method
     type: number
+    minimum: 0
+    maximum: 100
     example: 0.995
   timesliceWindow:
     description: the duration of each slice when using a timeslices budgeting method, as {duraton}{unit}

diff --git a/...ution/slo/public/pages/slo_edit/components/slo_edit_form_objective_section_timeslices.tsx b/...ution/slo/public/pages/slo_edit/components/slo_edit_form_objective_section_timeslices.tsx
@@ -41,8 +41,8 @@ export function SloEditFormObjectiveSectionTimeslices() {
             defaultValue={95}
             rules={{
               required: true,
-              min: 0.001,
-              max: 99.999,
+              min: 0,
+              max: 100,
             }}
             render={({ field: { ref, onChange, ...field }, fieldState }) => (
               <EuiFieldNumber
@@ -52,8 +52,8 @@ export function SloEditFormObjectiveSectionTimeslices() {
                 isInvalid={fieldState.invalid}
                 value={field.value}
                 data-test-subj="sloFormObjectiveTimesliceTargetInput"
-                min={0.001}
-                max={99.999}
+                min={0}
+                max={100}
                 step={0.001}
                 onChange={(event) => onChange(event.target.value)}
               />

diff --git a/x-pack/plugins/observability_solution/slo/server/domain/services/validate_slo.test.ts b/x-pack/plugins/observability_solution/slo/server/domain/services/validate_slo.test.ts
@@ -132,12 +132,12 @@ describe('validateSLO', () => {
       expect(() => validateSLO(slo)).toThrowError('Invalid objective.timeslice_target');
     });
 
-    it("throws when 'objective.timeslice_target' is lte 0", () => {
+    it("throws when 'objective.timeslice_target' is lt 0", () => {
       const slo = createSLO({
         budgetingMethod: 'timeslices',
         objective: {
           target: 0.95,
-          timesliceTarget: 0,
+          timesliceTarget: -0.00001,
           timesliceWindow: new Duration(1, DurationUnit.Minute),
         },
       });

diff --git a/x-pack/plugins/observability_solution/slo/server/domain/services/validate_slo.ts b/x-pack/plugins/observability_solution/slo/server/domain/services/validate_slo.ts
@@ -27,7 +27,7 @@ export function validateSLO(slo: SLODefinition) {
     throw new IllegalArgumentError('Invalid id');
   }
 
-  if (!isValidTargetNumber(slo.objective.target)) {
+  if (!isValidObjectiveTarget(slo.objective.target)) {
     throw new IllegalArgumentError('Invalid objective.target');
   }
 
@@ -48,7 +48,7 @@ export function validateSLO(slo: SLODefinition) {
   if (timeslicesBudgetingMethodSchema.is(slo.budgetingMethod)) {
     if (
       slo.objective.timesliceTarget === undefined ||
-      !isValidTargetNumber(slo.objective.timesliceTarget)
+      !isValidTimesliceTarget(slo.objective.timesliceTarget)
     ) {
       throw new IllegalArgumentError('Invalid objective.timeslice_target');
     }
@@ -80,10 +80,14 @@ function isValidId(id: string): boolean {
   return MIN_ID_LENGTH <= id.length && id.length <= MAX_ID_LENGTH;
 }
 
-function isValidTargetNumber(value: number): boolean {
+function isValidObjectiveTarget(value: number): boolean {
   return value > 0 && value < 1;
 }
 
+function isValidTimesliceTarget(value: number): boolean {
+  return value >= 0 && value <= 1;
+}
+
 function isValidRollingTimeWindowDuration(duration: Duration): boolean {
   // 7, 30 or 90days accepted
   return duration.unit === DurationUnit.Day && [7, 30, 90].includes(duration.value);