@grnsft/if 0.3.3-beta.0 → 0.4.0-beta.0

package/manifests/examples/pipeline-with-aggregate.yml

@@ -15,18 +15,25 @@ initialize:
     "sci-e":
       path: "@grnsft/if-plugins"
       method: SciE
-    "sci-m":
-      path: "@grnsft/if-plugins"
-      method: SciM
+    "sci-embodied":
+      path: "builtin"
+      method: SciEmbodied
     "sci-o":
       path: "@grnsft/if-plugins"
       method: SciO
     "sci":
-      path: "@grnsft/if-plugins"
+      path: "builtin"
       method: Sci
       global-config:
         functional-unit: "requests"
-        functional-unit-time: "1 minute"
+    "sum-carbon":
+      path: "builtin"
+      method: Sum
+      global-config:
+        input-parameters:
+          - carbon-operational
+          - carbon-embodied
+        output-parameter: carbon
     "time-sync":
       method: TimeSync
       path: "builtin"
@@ -44,8 +51,9 @@ tree:
       pipeline:
         - teads-curve
         - sci-e
-        - sci-m
+        - sci-embodied
         - sci-o
+        - sum-carbon
         - time-sync
         - sci
       config:
@@ -61,34 +69,38 @@ tree:
         device/expected-lifespan: 94608000 # 3 years in seconds
         resources-reserved: 1
         resources-total: 8
-        functional-unit-time: "1 min"
       inputs:
         - timestamp: "2023-12-12T00:00:00.000Z"
           cloud/instance-type: A1
           cloud/region: uk-west
           duration: 1
           cpu/utilization: 10
+          requests: 10
         - timestamp: "2023-12-12T00:00:01.000Z"
           duration: 5
           cpu/utilization: 20
           cloud/instance-type: A1
           cloud/region: uk-west
+          requests: 5
         - timestamp: "2023-12-12T00:00:06.000Z"
           duration: 7
           cpu/utilization: 15
           cloud/instance-type: A1
           cloud/region: uk-west
+          requests: 15
         - timestamp: "2023-12-12T00:00:13.000Z"
           duration: 30
           cloud/instance-type: A1
           cloud/region: uk-west
           cpu/utilization: 15
+          requests: 30
     child-2:
       pipeline:
         - teads-curve
         - sci-e
-        - sci-m
+        - sci-embodied
         - sci-o
+        - sum-carbon
         - time-sync
         - sci
       config:
@@ -104,25 +116,28 @@ tree:
         device/expected-lifespan: 94608000 # 3 years in seconds
         resources-reserved: 1
         resources-total: 8
-        functional-unit-time: "1 min"
       inputs:
         - 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"
           duration: 5
           cpu/utilization: 28
           cloud/instance-type: A1
           cloud/region: uk-west
+          requests: 150
         - timestamp: "2023-12-12T00:00:06.000Z"
           duration: 7
           cpu/utilization: 40
           cloud/instance-type: A1
           cloud/region: uk-west
+          requests: 110
         - timestamp: "2023-12-12T00:00:13.000Z"
           duration: 30
           cpu/utilization: 33
           cloud/instance-type: A1
           cloud/region: uk-west
+          requests: 180

package/manifests/examples/pipeline-with-mocks.yml

@@ -10,7 +10,7 @@ initialize:
     mock-observations:
       kind: plugin
       method: MockObservations
-      path: "@grnsft/if-plugins"
+      path: "builtin"
       global-config:
         timestamp-from: 2023-07-06T00:00
         timestamp-to: 2023-07-06T00:10
@@ -33,18 +33,25 @@ initialize:
     "sci-e":
       path: "@grnsft/if-plugins"
       method: SciE
-    "sci-m":
-      path: "@grnsft/if-plugins"
-      method: SciM
+    "sci-embodied":
+      path: "builtin"
+      method: SciEmbodied
     "sci-o":
       path: "@grnsft/if-plugins"
       method: SciO
+    "sum-carbon":
+      path: "builtin"
+      method: Sum
+      global-config:
+        input-parameters:
+          - carbon-operational
+          - carbon-embodied
+        output-parameter: carbon
     "sci":
-      path: "@grnsft/if-plugins"
+      path: "builtin"
       method: Sci
       global-config:
         functional-unit: "requests"
-        functional-unit-time: "1 minute"
     "time-sync":
       method: TimeSync
       path: "builtin"
@@ -56,15 +63,16 @@ initialize:
     "group-by":
       path: builtin
       method: GroupBy
-  outputs: ['yaml']
+  # outputs: ['yaml']
 tree:
   children:
     child-1:
       pipeline:
         - teads-curve
         - sci-e
-        - sci-m
+        - sci-embodied
         - sci-o
+        - sum-carbon
         - time-sync
         - sci
       config:
@@ -87,27 +95,32 @@ tree:
           cloud/region: uk-west
           duration: 1
           cpu/utilization: 10
+          requests: 30
         - timestamp: "2023-12-12T00:00:01.000Z"
           duration: 5
           cpu/utilization: 20
           cloud/instance-type: A1
           cloud/region: uk-west
+          requests: 40
         - timestamp: "2023-12-12T00:00:06.000Z"
           duration: 7
           cpu/utilization: 15
           cloud/instance-type: A1
           cloud/region: uk-west
+          requests: 30
         - timestamp: "2023-12-12T00:00:13.000Z"
           duration: 30
           cloud/instance-type: A1
           cloud/region: uk-west
           cpu/utilization: 15
+          requests: 50
     child-2:
       pipeline:
         - teads-curve
         - sci-e
-        - sci-m
+        - sci-embodied
         - sci-o
+        - sum-carbon
         - time-sync
         - sci
       config:
@@ -130,18 +143,22 @@ tree:
           cpu/utilization: 30
           cloud/instance-type: A1
           cloud/region: uk-west
+          requests: 30
         - timestamp: "2023-12-12T00:00:01.000Z"
           duration: 5
           cpu/utilization: 28
           cloud/instance-type: A1
           cloud/region: uk-west
+          requests: 40
         - timestamp: "2023-12-12T00:00:06.000Z"
           duration: 7
           cpu/utilization: 40
           cloud/instance-type: A1
           cloud/region: uk-west
+          requests: 50
         - timestamp: "2023-12-12T00:00:13.000Z"
           duration: 30
           cpu/utilization: 33
           cloud/instance-type: A1
           cloud/region: uk-west
+          requests: 60

package/manifests/examples/sci.yml

@@ -0,0 +1,131 @@
+name: pipeline-teads-sci
+description: a full pipeline seeded with some hardcoded input data and yielding an SCI score
+tags:
+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'
+    cpu-factor-to-wattage:
+      method: Multiply
+      path: builtin
+      global-config:
+        input-parameters: ["cpu-factor", "cpu/thermal-design-power"]
+        output-parameter: "cpu-wattage"
+    wattage-times-duration:
+      method: Multiply
+      path: builtin
+      global-config:
+        input-parameters: ["cpu-wattage", "duration"]
+        output-parameter: "cpu-wattage-times-duration"
+    wattage-to-energy-kwh:
+      method: Divide
+      path: "builtin"
+      global-config:
+        numerator: cpu-wattage-times-duration
+        denominator: 3600000
+        output: cpu-energy-raw
+    calculate-vcpu-ratio:
+      method: Divide
+      path: "builtin"
+      global-config:
+        numerator: vcpus-total
+        denominator: vcpus-allocated
+        output: vcpu-ratio
+    correct-cpu-energy-for-vcpu-ratio:
+      method: Divide
+      path: "builtin"
+      global-config:
+        numerator: cpu-energy-raw
+        denominator: vcpu-ratio
+        output: cpu/energy
+    sum-energy-components:
+      path: "builtin"
+      method: Sum
+      global-config:
+        input-parameters:
+          - cpu/energy
+          - network/energy
+        output-parameter: energy
+    "embodied-carbon":
+      path: "builtin"
+      method: SciEmbodied
+    "operational-carbon":
+      method: Multiply
+      path: builtin
+      global-config:
+        input-parameters: ["energy", "grid/carbon-intensity"]
+        output-parameter: "carbon-operational"
+    "sum-carbon":
+      path: "builtin"
+      method: Sum
+      global-config:
+        input-parameters:
+          - carbon-operational
+          - carbon-embodied
+        output-parameter: carbon
+    "sci":
+      path: "builtin"
+      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:
+      defaults:
+        cpu/thermal-design-power: 100
+        vcpus-total: 8
+        vcpus-allocated: 2
+        grid/carbon-intensity: 800
+        device/emissions-embodied: 1533.120 # gCO2eq
+        time-reserved: 3600 # 1hr in seconds
+        device/expected-lifespan: 94608000 # 3 years in seconds
+        resources-reserved: vcpus-allocated
+        resources-total: vcpus-total
+        component: 1
+      inputs:
+        - timestamp: "2023-12-12T00:00:00.000Z"
+          cloud/instance-type: A1
+          cloud/region: uk-west
+          duration: 1
+          cpu/utilization: 50
+          network/energy: 0.000001
+        - timestamp: "2023-12-12T00:00:01.000Z"
+          duration: 5
+          cpu/utilization: 20
+          cloud/instance-type: A1
+          cloud/region: uk-west
+          network/energy: 0.000001
+        - timestamp: "2023-12-12T00:00:06.000Z"
+          duration: 7
+          cpu/utilization: 15
+          cloud/instance-type: A1
+          cloud/region: uk-west
+          network/energy: 0.000001
+        - timestamp: "2023-12-12T00:00:13.000Z"
+          duration: 30
+          cloud/instance-type: A1
+          cloud/region: uk-west
+          cpu/utilization: 15
+          network/energy: 0.000001

package/manifests/examples/teads-curve.yml

@@ -0,0 +1,78 @@
+name: carbon-intensity plugin demo
+description: 
+tags:
+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'
+    cpu-factor-to-wattage:
+      method: Multiply
+      path: builtin
+      global-config:
+        input-parameters: ["cpu-factor", "thermal-design-power"]
+        output-parameter: "cpu-wattage"
+    wattage-times-duration:
+      method: Multiply
+      path: builtin
+      global-config:
+        input-parameters: ["cpu-wattage", "duration"]
+        output-parameter: "cpu-wattage-times-duration"
+    wattage-to-energy-kwh:
+      method: Divide
+      path: "builtin"
+      global-config:
+        numerator: cpu-wattage-times-duration
+        denominator: 3600000
+        output: cpu-energy-raw
+    calculate-vcpu-ratio:
+      method: Divide
+      path: "builtin"
+      global-config:
+        numerator: vcpus-total
+        denominator: vcpus-allocated
+        output: vcpu-ratio
+    correct-cpu-energy-for-vcpu-ratio:
+      method: Divide
+      path: "builtin"
+      global-config:
+        numerator: cpu-energy-raw
+        denominator: vcpu-ratio
+        output: cpu-energy-kwh
+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
+      defaults:
+        thermal-design-power: 100
+        vcpus-total: 8
+        vcpus-allocated: 2
+      inputs:
+        - timestamp: 2023-08-06T00:00
+          duration: 360
+          cpu/utilization: 1
+          carbon: 30
+        - timestamp: 2023-09-06T00:00
+          duration: 360
+          carbon: 30
+          cpu/utilization: 10
+        - timestamp: 2023-10-06T00:00
+          duration: 360
+          carbon: 30
+          cpu/utilization: 50
+        - timestamp: 2023-10-06T00:00
+          duration: 360
+          carbon: 30
+          cpu/utilization: 100

package/manifests/features/aggregate-failure-inalid-metrics.yml

@@ -0,0 +1,43 @@
+name: Aggregation
+description: Apply both `horizontal` and `vertical` aggregations
+aggregation:
+  metrics:
+    - 'test'
+  type: 'both'
+initialize:
+  plugins:
+    cloud-metadata:
+      method: CloudMetadata
+      path: "@grnsft/if-plugins"              
+tree:
+  children:
+    application:
+      pipeline:
+        - cloud-metadata
+      children:
+        uk-west:
+          children:
+            server-1:
+              inputs:
+                - timestamp: '2024-02-26 00:00:00'
+                  duration: 300
+                  cloud/instance-type: m5n.large
+                  cloud/vendor: aws
+                  cpu/utilization: 89
+                - timestamp: '2024-02-26 00:05:00'
+                  duration: 300
+                  cloud/instance-type: m5n.large
+                  cloud/vendor: aws
+                  cpu/utilization: 59
+            server-2:
+              inputs:
+                - timestamp: '2024-02-26 00:00:00'
+                  duration: 300
+                  cloud/instance-type: m5n.large
+                  cloud/vendor: aws
+                  cpu/utilization: 24
+                - timestamp: '2024-02-26 00:05:00'
+                  duration: 300
+                  cloud/instance-type: m5n.large
+                  cloud/vendor: aws
+                  cpu/utilization: 27

package/manifests/features/aggregate-failure-missing-metric-in-inputs.yml

@@ -0,0 +1,43 @@
+name: Aggregation
+description: Apply both `horizontal` and `vertical` aggregations
+aggregation:
+  metrics:
+    - 'cpu/utilization'
+  type: 'both'
+initialize:
+  plugins:
+    cloud-metadata:
+      method: CloudMetadata
+      path: "@grnsft/if-plugins"              
+tree:
+  children:
+    application:
+      pipeline:
+        - cloud-metadata
+      children:
+        uk-west:
+          children:
+            server-1:
+              inputs:
+                - timestamp: '2024-01-26 00:00:00'
+                  duration: 300
+                  cloud/instance-type: m5n.large
+                  cloud/vendor: aws
+                  cpu/utilization: 89
+                - timestamp: '2024-02-26 00:05:00'
+                  duration: 300
+                  cloud/instance-type: m5n.large
+                  cloud/vendor: aws
+                  cpu/utilization: 59
+            server-2:
+              inputs:
+                - timestamp: '2024-02-26 00:00:00'
+                  duration: 300
+                  cloud/instance-type: m5n.large
+                  cloud/vendor: aws
+                #  cpu/utilization: 110
+                - timestamp: '2024-02-26 00:15:00'
+                  duration: 300
+                  cloud/instance-type: m5n.large
+                  cloud/vendor: aws
+                  cpu/utilization: 27

package/manifests/integrations/cloud-metadata-divide-boavizta.yml

@@ -8,7 +8,7 @@ initialize:
       path: "@grnsft/if-plugins"
     divide:
       method: Divide
-      path: "@grnsft/if-plugins"
+      path: "builtin"
       global-config:
         numerator: vcpus-allocated
         denominator: 2

package/manifests/integrations/mock-obs-group-by-cloud-meta.yml

@@ -0,0 +1,51 @@
+name: My Manifest File
+description: integration of mock observations, group by and cloud metadata
+aggregation:
+  metrics:
+    - 'cpu/utilization'
+  type: 'both'
+initialize:
+ # outputs: ['yaml']
+  plugins: 
+    group-by: 
+      path: 'builtin'
+      method: GroupBy  
+      global-config:
+        input-parameters: ['cpu/energy', 'grid/carbon-intensity']
+        output-parameter: 'carbon'       
+    cloud-metadata:
+      method: CloudMetadata
+      path: "@grnsft/if-plugins"   
+    mock-observations:
+      path: 'builtin'
+      method: MockObservations
+      global-config:
+        timestamp-from: 2024-03-05T00:00
+        timestamp-to: 2024-03-05T01:00
+        duration: 300
+        components:
+          - name: server-1
+            cloud/instance-type: Standard_E64_v3
+            cloud/region: eastus
+          - name: server-2
+            cloud/instance-type: Standard_E64_v3
+            cloud/region: france            
+        generators:
+          common:
+            geolocation: 37.7749,-122.4194
+            cloud/vendor: azure
+          randint:
+            cpu/utilization:
+              min: 1
+              max: 99               
+tree: 
+  pipeline:
+    - mock-observations
+    - group-by
+    - cloud-metadata
+  config:
+    group-by:
+      group:
+        - name
+        - cloud/instance-type
+  inputs: null

package/manifests/integrations/mock-obs-groupby.yml

@@ -3,7 +3,7 @@ description: Integration of `mock observations` + `groupby plugins`
 initialize: 
   plugins: 
     mock-observations:
-      path: '@grnsft/if-plugins'
+      path: 'builtin'
       method: MockObservations
       global-config:
         timestamp-from: '2024-03-05T00:00:00.000Z'
@@ -36,4 +36,4 @@ tree:
       group:
         - cloud/region
         - name
-  inputs: null
+  inputs: null

package/manifests/integrations/mock-obs-time-sync.yml

@@ -6,7 +6,7 @@ initialize:
     mock-observations:
       kind: plugin
       method: MockObservations
-      path: "@grnsft/if-plugins"
+      path: "builtin"
       global-config:
         timestamp-from: 2023-07-06T00:00
         timestamp-to: 2023-07-06T00:10

package/manifests/plugins/cloud-metadata/failure-invalid-instance-type.yaml

@@ -0,0 +1,21 @@
+name: cloud-metadata
+description: cloud/instance-type instance type is not supported in the cloud vendor
+tags:
+initialize:
+  outputs: ['yaml']
+  plugins:
+    cloud-metadata:
+      method: CloudMetadata
+      path: "@grnsft/if-plugins"
+tree:
+  children:
+    child:
+      pipeline:
+        - cloud-metadata
+      config:
+      inputs:
+        - timestamp: 2023-07-06T00:00 # [KEYWORD] [NO-SUBFIELDS] time when measurement occurred
+          cloud/vendor: aws
+          cloud/instance-type: m6
+          duration: 100
+          cpu/utilization: 10

package/manifests/plugins/cloud-metadata/failure-invalid-vendor.yaml

@@ -2,7 +2,7 @@ name: cloud-metadata
 description: failure with invalid `inputs.cloud/vendor`
 tags:
 initialize:
-  outputs: ['yaml']
+  #outputs: ['yaml']
   plugins:
     cloud-metadata:
       method: CloudMetadata

package/manifests/plugins/cloud-metadata/failure-missing-cloud-vendor.yml

@@ -0,0 +1,21 @@
+name: cloud-metadata
+description: failing because cloud/vendor is not provided
+tags:
+initialize:
+  outputs: ['yaml']
+  plugins:
+    cloud-metadata:
+      method: CloudMetadata
+      path: "@grnsft/if-plugins"
+tree:
+  children:
+    child:
+      pipeline:
+        - cloud-metadata
+      config:
+      inputs:
+        - timestamp: 2023-07-06T00:00 # [KEYWORD] [NO-SUBFIELDS] time when measurement occurred
+          #cloud/vendor: aws
+          cloud/instance-type: m5n.large
+          duration: 100
+          cpu/utilization: 10

package/manifests/plugins/cloud-metadata/success.yml

@@ -2,7 +2,7 @@ name: cloud-metadata
 description: successful path
 tags:
 initialize:
-  outputs: ['yaml']
+ # outputs: ['yaml']
   plugins:
     cloud-metadata:
       method: CloudMetadata

package/manifests/plugins/coefficient/failure-invalid-config-input-param.yml

@@ -6,7 +6,7 @@ initialize:
   plugins:
     coefficient:
       method: Coefficient
-      path: "@grnsft/if-plugins"
+      path: "builtin"
       global-config:
         input-parameter: 4
         coefficient: 3