@grnsft/if 0.5.0 → 0.6.0-beta.0

package/manifests/examples/pipelines/scenario-2.yml

@@ -0,0 +1,52 @@
+name: regroup demo
+description: 
+initialize:
+  plugins:
+    interpolate:
+      method: Interpolation
+      path: "builtin"
+      global-config:
+        method: linear
+        x: [0, 10, 50, 100]
+        y: [0.12, 0.32, 0.75, 1.02]
+        input-parameter: "cpu/utilization"
+        output-parameter: "cpu-factor"
+tree:
+  children:
+    child:
+      pipeline:
+        observe:
+        regroup:
+          - cloud/region
+          - cloud/instance-type
+      inputs:
+        - timestamp: 2023-07-06T00:00
+          duration: 300
+          cloud/instance-type: A1
+          cloud/region: uk-west
+          cpu/utilization: 99
+        - timestamp: 2023-07-06T05:00
+          duration: 300
+          cloud/instance-type: A1
+          cloud/region: uk-west
+          cpu/utilization: 23
+        - timestamp: 2023-07-06T10:00
+          duration: 300
+          cloud/instance-type: A1
+          cloud/region: uk-west
+          cpu/utilization: 12
+        - timestamp: 2023-07-06T00:00 # note this time restarts at the start timstamp
+          duration: 300
+          cloud/instance-type: B1
+          cloud/region: uk-west
+          cpu/utilization: 11
+        - timestamp: 2023-07-06T05:00
+          duration: 300
+          cloud/instance-type: B1
+          cloud/region: uk-west
+          cpu/utilization: 67
+        - timestamp: 2023-07-06T10:00
+          duration: 300
+          cloud/instance-type: B1
+          cloud/region: uk-west
+          cpu/utilization: 1

package/manifests/examples/pipelines/scenario-3.yml

@@ -0,0 +1,86 @@
+name: groupby
+description: successful path
+initialize:
+  plugins:
+    "sum":
+      path: "builtin"
+      method: Sum
+      global-config:
+        input-parameters:
+          - cpu/energy
+          - network/energy
+        output-parameter: energy
+tree:
+  children:
+    my-app:
+      pipeline:
+        observe:
+        regroup:
+          - cloud/instance-type
+          - cloud/region
+        compute:
+      children:
+        uk-west:
+          inputs:
+            - timestamp: 2023-07-06T00:00
+              duration: 300
+              cloud/instance-type: A1
+              cloud/region: uk-west
+              cpu/utilization: 99
+            - timestamp: 2023-07-06T05:00
+              duration: 300
+              cloud/instance-type: A1
+              cloud/region: uk-west
+              cpu/utilization: 23
+            - timestamp: 2023-07-06T10:00
+              duration: 300
+              cloud/instance-type: A1
+              cloud/region: uk-west
+              cpu/utilization: 12
+            - timestamp: 2023-07-06T00:00
+              duration: 300
+              cloud/instance-type: B1
+              cloud/region: uk-west
+              cpu/utilization: 11
+            - timestamp: 2023-07-06T05:00
+              duration: 300
+              cloud/instance-type: B1
+              cloud/region: uk-west
+              cpu/utilization: 67
+            - timestamp: 2023-07-06T10:00
+              duration: 300
+              cloud/instance-type: B1
+              cloud/region: uk-west
+              cpu/utilization: 1
+        uk-east:
+          inputs:
+            - timestamp: 2023-07-06T00:00
+              duration: 300
+              cloud/instance-type: A1
+              cloud/region: uk-east
+              cpu/utilization: 9
+            - timestamp: 2023-07-06T05:00
+              duration: 300
+              cloud/instance-type: A1
+              cloud/region: uk-east
+              cpu/utilization: 23
+            - timestamp: 2023-07-06T10:00
+              duration: 300
+              cloud/instance-type: A1
+              cloud/region: uk-east
+              cpu/utilization: 12
+            - timestamp: 2023-07-06T00:00
+              duration: 300
+              cloud/instance-type: B1
+              cloud/region: uk-east
+              cpu/utilization: 11
+            - timestamp: 2023-07-06T05:00
+              duration: 300
+              cloud/instance-type: B1
+              cloud/region: uk-east
+              cpu/utilization: 67
+            - timestamp: 2023-07-06T10:00
+              duration: 300
+              cloud/instance-type: B1
+              cloud/region: uk-east
+              cpu/utilization: 1

package/manifests/examples/pipelines/scenario-4.yml

@@ -0,0 +1,46 @@
+name: demo
+description: 
+tags:
+initialize:
+  plugins:
+    "sum":
+      path: "builtin"
+      method: Sum
+      global-config:
+        input-parameters:
+          - cpu/energy
+          - network/energy
+        output-parameter: energy-sum
+    "coefficient":
+      path: "builtin"
+      method: Coefficient
+      global-config:
+        input-parameter: energy
+        coefficient: 2
+        output-parameter: energy-doubled
+    "multiply":
+      path: "builtin"
+      method: Multiply
+      global-config:
+        input-parameters: ["cpu/utilization", "duration"]
+        output-parameter: "cpu-times-duration"
+tree:
+  children:
+    child-1:
+      pipeline:
+        observe:
+        compute: 
+          - sum
+          - coefficient
+          - multiply
+      defaults:
+        cpu/thermal-design-power: 100
+      inputs:
+        - timestamp: "2023-12-12T00:00:00.000Z"
+          cloud/instance-type: A1
+          cloud/region: uk-west
+          duration: 1
+          cpu/utilization: 50
+          cpu/energy: 20
+          network/energy: 10
+          energy: 5

package/manifests/examples/pipelines/scenario-5.yml

@@ -0,0 +1,46 @@
+name: demo
+description: 
+tags:
+initialize:
+  plugins:
+    mock-observations:
+      kind: plugin
+      method: MockObservations
+      path: "builtin"
+      global-config:
+        timestamp-from: 2023-07-06T00:00
+        timestamp-to: 2023-07-06T00:01
+        duration: 60
+        components:
+          - cloud/instance-type: A1
+          - cloud/instance-type: B1
+        generators:
+          common:
+            region: uk-west
+            common-key: common-val
+          randint:
+            cpu/utilization:
+              min: 1
+              max: 99
+            memory/utilization:
+              min: 1
+              max: 99
+    sum:
+      path: "builtin"
+      method: Sum
+      global-config:
+        input-parameters:
+          - cpu/utilization
+          - memory/utilization
+        output-parameter: util-sum
+tree:
+  children:
+    child:
+      pipeline:
+        observe:
+          - mock-observations
+        regroup:
+          - cloud/instance-type
+        compute:
+          - sum
+      inputs: null

package/manifests/examples/pipelines/sci.yml

@@ -5,13 +5,13 @@ initialize:
   plugins:
     interpolate:
       method: Interpolation
-      path: 'builtin'
+      path: "builtin"
       global-config:
         method: linear
         x: [0, 10, 50, 100]
         y: [0.12, 0.32, 0.75, 1.02]
-        input-parameter: 'cpu/utilization'
-        output-parameter: 'cpu-factor'
+        input-parameter: "cpu/utilization"
+        output-parameter: "cpu-factor"
     cpu-factor-to-wattage:
       method: Multiply
       path: builtin
@@ -75,24 +75,22 @@ initialize:
       method: Sci
       global-config:
         functional-unit: "component"
-  outputs:
-    - yaml
 tree:
   children:
     child-1:
       pipeline:
-        - interpolate
-        - cpu-factor-to-wattage
-        - wattage-times-duration
-        - wattage-to-energy-kwh
-        - calculate-vcpu-ratio
-        - correct-cpu-energy-for-vcpu-ratio
-        - sum-energy-components
-        - embodied-carbon
-        - operational-carbon
-        - sum-carbon
-        - sci
-      config:
+        compute:
+          - interpolate
+          - cpu-factor-to-wattage
+          - wattage-times-duration
+          - wattage-to-energy-kwh
+          - calculate-vcpu-ratio
+          - correct-cpu-energy-for-vcpu-ratio
+          - sum-energy-components
+          - embodied-carbon
+          - operational-carbon
+          - sum-carbon
+          - sci
       defaults:
         cpu/thermal-design-power: 100
         vcpus-total: 8

package/manifests/examples/pipelines/teads-curve.yml

@@ -49,12 +49,13 @@ tree:
   children:
     child:
       pipeline:
-        - interpolate
-        - cpu-factor-to-wattage
-        - wattage-times-duration
-        - wattage-to-energy-kwh
-        - calculate-vcpu-ratio
-        - correct-cpu-energy-for-vcpu-ratio
+        compute:
+          - interpolate
+          - cpu-factor-to-wattage
+          - wattage-times-duration
+          - wattage-to-energy-kwh
+          - calculate-vcpu-ratio
+          - correct-cpu-energy-for-vcpu-ratio
       defaults:
         thermal-design-power: 100
         vcpus-total: 8

package/manifests/examples/pipelines/zeros.yml

@@ -106,22 +106,21 @@ tree:
   children:
     child-1:
       pipeline:
-        - sum-zero-and-one
-        - sum-zero-and-zero
-        - subtract-one-and-zero
-        - subtract-zero-and-zero
-        - subtract-zero-and-one
-        - coefficient-one-times-zero
-        - coefficient-zero-times-one
-        - coefficient-zero-times-zero
-        - multiply-one-times-zero
-        - multiply-zero-times-one
-        - exponent-one-to-zero
-        - exponent-zero-to-one
-        - exponent-zero-to-zero
-        - sci
-      config:
-      defaults:
+        compute:
+          - sum-zero-and-one
+          - sum-zero-and-zero
+          - subtract-one-and-zero
+          - subtract-zero-and-zero
+          - subtract-zero-and-one
+          - coefficient-one-times-zero
+          - coefficient-zero-times-one
+          - coefficient-zero-times-zero
+          - multiply-one-times-zero
+          - multiply-zero-times-one
+          - exponent-one-to-zero
+          - exponent-zero-to-one
+          - exponent-zero-to-zero
+          - sci
       inputs:
         - timestamp: "2023-12-12T00:00:00.000Z"
           duration: 1

package/manifests/outputs/bugs/aggregation-error-wrong-metric.yaml

@@ -8,8 +8,6 @@ aggregation:
     - dummy-param
   type: both
 initialize:
-  outputs:
-    - yaml
   plugins:
     interpolate:
       method: Interpolation
@@ -21,7 +19,7 @@ initialize:
           - 10
           - 50
           - 100
-        'y':
+        "y":
           - 0.12
           - 0.32
           - 0.75
@@ -85,13 +83,10 @@ initialize:
       method: TimeSync
       path: builtin
       global-config:
-        start-time: '2023-12-12T00:00:00.000Z'
-        end-time: '2023-12-12T00:01:00.000Z'
+        start-time: "2023-12-12T00:00:00.000Z"
+        end-time: "2023-12-12T00:01:00.000Z"
         interval: 5
         allow-padding: true
-    group-by:
-      path: builtin
-      method: GroupBy
 execution:
   status: fail
   command: >-
@@ -102,20 +97,20 @@ execution:
   environment:
     if-version: 0.4.0
     os: macOS
-    os-version: '13.2'
+    os-version: "13.2"
     node-version: 18.14.2
     date-time: 2024-07-01T19:25:34.759Z (UTC)
     dependencies:
-      - '@babel/core@7.22.10'
-      - '@babel/preset-typescript@7.23.3'
-      - '@commitlint/cli@18.6.0'
-      - '@commitlint/config-conventional@18.6.0'
-      - '@grnsft/if-core@0.0.10'
-      - '@jest/globals@29.7.0'
-      - '@types/jest@29.5.8'
-      - '@types/js-yaml@4.0.9'
-      - '@types/luxon@3.4.2'
-      - '@types/node@20.9.0'
+      - "@babel/core@7.22.10"
+      - "@babel/preset-typescript@7.23.3"
+      - "@commitlint/cli@18.6.0"
+      - "@commitlint/config-conventional@18.6.0"
+      - "@grnsft/if-core@0.0.10"
+      - "@jest/globals@29.7.0"
+      - "@types/jest@29.5.8"
+      - "@types/js-yaml@4.0.9"
+      - "@types/luxon@3.4.2"
+      - "@types/node@20.9.0"
       - axios-mock-adapter@1.22.0
       - axios@1.7.2
       - cross-env@7.0.3
@@ -137,27 +132,25 @@ execution:
       - winston@3.11.0
       - zod@3.22.4
   error: >-
-    MissingAggregationParamError: Aggregation metric dummy-param is not found in
-    inputs[0].
+    MissingInputDataError: `functional-unit` value is missing from input data or it is not a positive integer
 tree:
   children:
     child-1:
       pipeline:
-        - interpolate
-        - cpu-factor-to-wattage
-        - wattage-times-duration
-        - wattage-to-energy-kwh
-        - calculate-vcpu-ratio
-        - correct-cpu-energy-for-vcpu-ratio
-        - sci-embodied
-        - operational-carbon
-        - time-sync
-        - sci
-      config:
-        group-by:
-          group:
-            - cloud/region
-            - cloud/instance-type
+        regroup:
+          - cloud/region
+          - cloud/instance-type
+        compute:
+          - interpolate
+          - cpu-factor-to-wattage
+          - wattage-times-duration
+          - wattage-to-energy-kwh
+          - calculate-vcpu-ratio
+          - correct-cpu-energy-for-vcpu-ratio
+          - sci-embodied
+          - operational-carbon
+          - time-sync
+          - sci
       defaults:
         cpu/thermal-design-power: 100
         grid/carbon-intensity: 800
@@ -167,25 +160,25 @@ tree:
         vcpus-allocated: 1
         vcpus-total: 8
       inputs:
-        - timestamp: '2023-12-12T00:00:00.000Z'
+        - timestamp: "2023-12-12T00:00:00.000Z"
           cloud/instance-type: A1
           cloud/region: uk-west
           duration: 1
           cpu/utilization: 10
           requests: 100
-        - timestamp: '2023-12-12T00:00:01.000Z'
+        - timestamp: "2023-12-12T00:00:01.000Z"
           duration: 5
           cpu/utilization: 20
           cloud/instance-type: A1
           cloud/region: uk-west
           requests: 100
-        - timestamp: '2023-12-12T00:00:06.000Z'
+        - timestamp: "2023-12-12T00:00:06.000Z"
           duration: 7
           cpu/utilization: 15
           cloud/instance-type: A1
           cloud/region: uk-west
           requests: 100
-        - timestamp: '2023-12-12T00:00:13.000Z'
+        - timestamp: "2023-12-12T00:00:13.000Z"
           duration: 30
           cloud/instance-type: A1
           cloud/region: uk-west
@@ -193,21 +186,20 @@ tree:
           requests: 100
     child-2:
       pipeline:
-        - interpolate
-        - cpu-factor-to-wattage
-        - wattage-times-duration
-        - wattage-to-energy-kwh
-        - calculate-vcpu-ratio
-        - correct-cpu-energy-for-vcpu-ratio
-        - sci-embodied
-        - operational-carbon
-        - time-sync
-        - sci
-      config:
-        group-by:
-          group:
-            - cloud/region
-            - cloud/instance-type
+        regroup:
+          - cloud/region
+          - cloud/instance-type
+        compute:
+          - interpolate
+          - cpu-factor-to-wattage
+          - wattage-times-duration
+          - wattage-to-energy-kwh
+          - calculate-vcpu-ratio
+          - correct-cpu-energy-for-vcpu-ratio
+          - sci-embodied
+          - operational-carbon
+          - time-sync
+          - sci
       defaults:
         cpu/thermal-design-power: 100
         grid/carbon-intensity: 800
@@ -217,25 +209,25 @@ tree:
         vcpus-allocated: 1
         vcpus-total: 8
       inputs:
-        - timestamp: '2023-12-12T00:00:00.000Z'
+        - timestamp: "2023-12-12T00:00:00.000Z"
           duration: 1
           cpu/utilization: 30
           cloud/instance-type: A1
           cloud/region: uk-west
           requests: 100
-        - timestamp: '2023-12-12T00:00:01.000Z'
+        - timestamp: "2023-12-12T00:00:01.000Z"
           duration: 5
           cpu/utilization: 28
           cloud/instance-type: A1
           cloud/region: uk-west
           requests: 100
-        - timestamp: '2023-12-12T00:00:06.000Z'
+        - timestamp: "2023-12-12T00:00:06.000Z"
           duration: 7
           cpu/utilization: 40
           cloud/instance-type: A1
           cloud/region: uk-west
           requests: 100
-        - timestamp: '2023-12-12T00:00:13.000Z'
+        - timestamp: "2023-12-12T00:00:13.000Z"
           duration: 30
           cpu/utilization: 33
           cloud/instance-type: A1

package/manifests/outputs/bugs/input-error-missing-duration.yaml

@@ -15,15 +15,13 @@ initialize:
           - 10
           - 50
           - 100
-        'y':
+        "y":
           - 0.12
           - 0.32
           - 0.75
           - 1.02
         input-parameter: cpu/utilization
         output-parameter: cpu-factor
-  outputs:
-    - yaml
 execution:
   status: fail
   command: >-
@@ -34,21 +32,20 @@ execution:
   environment:
     if-version: 0.4.0
     os: macOS
-    os-version: '13.2'
+    os-version: "13.2"
     node-version: 18.14.2
     date-time: 2024-07-01T19:59:58.987Z (UTC)
     dependencies:
-      - '@babel/core@7.22.10'
-      - '@babel/preset-typescript@7.23.3'
-      - '@commitlint/cli@18.6.0'
-      - '@commitlint/config-conventional@18.6.0'
-      - '@grnsft/if-core@0.0.10'
-
-      - '@jest/globals@29.7.0'
-      - '@types/jest@29.5.8'
-      - '@types/js-yaml@4.0.9'
-      - '@types/luxon@3.4.2'
-      - '@types/node@20.9.0'
+      - "@babel/core@7.22.10"
+      - "@babel/preset-typescript@7.23.3"
+      - "@commitlint/cli@18.6.0"
+      - "@commitlint/config-conventional@18.6.0"
+      - "@grnsft/if-core@0.0.10"
+      - "@jest/globals@29.7.0"
+      - "@types/jest@29.5.8"
+      - "@types/js-yaml@4.0.9"
+      - "@types/luxon@3.4.2"
+      - "@types/node@20.9.0"
       - axios-mock-adapter@1.22.0
       - axios@1.7.2
       - cross-env@7.0.3
@@ -78,7 +75,8 @@ tree:
       defaults:
         cpu/thermal-design-power: 100
       pipeline:
-        - interpolate
+        compute:
+          - interpolate
       inputs:
         - timestamp: 2023-07-06T00:00
           cpu/utilization: 20

package/manifests/outputs/bugs/mock-observations-failure-duration-is-zero.yaml

@@ -2,8 +2,6 @@ name: mock-observation-demo
 description: a manifest demonstrating how to use the mock observations feature
 tags: null
 initialize:
-  outputs:
-    - yaml
   plugins:
     mock-observations:
       kind: plugin
@@ -37,21 +35,20 @@ execution:
   environment:
     if-version: 0.4.0
     os: macOS
-    os-version: '13.2'
+    os-version: "13.2"
     node-version: 18.14.2
     date-time: 2024-07-01T20:02:22.596Z (UTC)
     dependencies:
-      - '@babel/core@7.22.10'
-      - '@babel/preset-typescript@7.23.3'
-      - '@commitlint/cli@18.6.0'
-      - '@commitlint/config-conventional@18.6.0'
-      - '@grnsft/if-core@0.0.10'
-
-      - '@jest/globals@29.7.0'
-      - '@types/jest@29.5.8'
-      - '@types/js-yaml@4.0.9'
-      - '@types/luxon@3.4.2'
-      - '@types/node@20.9.0'
+      - "@babel/core@7.22.10"
+      - "@babel/preset-typescript@7.23.3"
+      - "@commitlint/cli@18.6.0"
+      - "@commitlint/config-conventional@18.6.0"
+      - "@grnsft/if-core@0.0.10"
+      - "@jest/globals@29.7.0"
+      - "@types/jest@29.5.8"
+      - "@types/js-yaml@4.0.9"
+      - "@types/luxon@3.4.2"
+      - "@types/node@20.9.0"
       - axios-mock-adapter@1.22.0
       - axios@1.7.2
       - cross-env@7.0.3
@@ -72,10 +69,11 @@ execution:
       - typescript@5.2.2
       - winston@3.11.0
       - zod@3.22.4
-  error: 'RangeError: Maximum call stack size exceeded'
+  error: "InputValidationError: \"duration\" parameter is number must be greater than 0. Error code: too_small."
 tree:
   children:
     child:
       pipeline:
-        - mock-observations
+        observe:
+          - mock-observations
       inputs: null