Merge branch 'main' into migrate-subtract-to-builtin

Signed-off-by: Joseph Cook <33655003+jmcook1186@users.noreply.github.com>
Green-Software-Foundation · May 22, 2024 · 8363396 · 8363396
2 parents fa2bf24 + 6ff5790
commit 8363396
Show file tree

Hide file tree

Showing 57 changed files with 1,935 additions and 68 deletions.
diff --git a/.lintstagedrc.js b/.lintstagedrc.js
@@ -0,0 +1,6 @@
+module.exports = {
+  '*.ts': [
+    'gts lint',
+  ],
+  'package.json': 'fixpack',
+}
diff --git a/Refactor-migration-guide.md b/Refactor-migration-guide.md
@@ -116,9 +116,9 @@ There have also been some changes to the structure of manifest files. Some of th
     For example:
     
     ```yaml
-    "sci-m":
-      path: "@grnsft/if-plugins"
-      method: SciM
+    "sci-embodied":
+      path: "builtin"
+      method: SciEmbodied
     ```
 
 - **Global config**
@@ -150,7 +150,7 @@ There have also been some changes to the structure of manifest files. Some of th
           pipeline:
             - teads-curve
             - sci-e
-            - sci-m
+            - sci-embodied
             - sci-o
             - time-sync
             - sci
@@ -174,7 +174,7 @@ There have also been some changes to the structure of manifest files. Some of th
           pipeline:
             - teads-curve
             - sci-e
-            - sci-m
+            - sci-embodied
             - sci-o
             - time-sync
             - sci
@@ -254,7 +254,7 @@ tree:
       pipeline:
         - teads-curve
         - sci-e
-        - sci-m
+        - sci-embodied
         - sci-o
         - time-sync
         - group-by

diff --git a/manifests/bugs/aggregation-error-wrong-metric.yml b/manifests/bugs/aggregation-error-wrong-metric.yml
@@ -15,14 +15,14 @@ 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"
@@ -44,7 +44,7 @@ tree:
       pipeline:
         - teads-curve
         - sci-e
-        - sci-m
+        - sci-embodied
         - sci-o
         - time-sync
         - sci
@@ -87,7 +87,7 @@ tree:
       pipeline:
         - teads-curve
         - sci-e
-        - sci-m
+        - sci-embodied
         - sci-o
         - time-sync
         - sci

diff --git a/manifests/bugs/azure-importer-ignoring-defaults.yml b/manifests/bugs/azure-importer-ignoring-defaults.yml
@@ -58,4 +58,4 @@ tree:
       inputs:
         - timestamp: "2024-04-04T08:00:00.001Z"
           duration: 3600
-          energy: 100
+          energy: 100
diff --git a/manifests/bugs/mock-observations-failure-duration-is-zero.yml b/manifests/bugs/mock-observations-failure-duration-is-zero.yml
@@ -0,0 +1,34 @@
+name: mock-observation-demo
+description: a manifest demonstrating how to use the mock observations feature
+tags:
+initialize:
+  outputs: ['yaml']
+  plugins:
+    mock-observations:
+      kind: plugin
+      method: MockObservations
+      path: "@grnsft/if-plugins"
+      global-config:
+        timestamp-from: 2023-07-06T00:00
+        timestamp-to: 2023-07-06T00:10
+        duration: 0
+        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
+tree:
+  children:
+    child:
+      pipeline:
+        - mock-observations
+      inputs:
diff --git a/manifests/bugs/pipeline-ordering-error.yml b/manifests/bugs/pipeline-ordering-error.yml
@@ -16,14 +16,14 @@ initialize:
           - cpu/energy
           - network/energy
         output-parameter: energy
-    "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: ""
@@ -43,7 +43,7 @@ tree:
         - teads-curve
         - sci-o
         - sum
-        - sci-m
+        - sci-embodied
         - time-sync
         - sci
       config:

diff --git a/manifests/bugs/sci-m-missing-resources-total.yml b/manifests/bugs/sci-m-missing-resources-total.yml
@@ -0,0 +1,23 @@
+name: sci-embodied
+description: receiving incorrect error message when running sci-embodied without `resources-total` issue #716
+tags:
+initialize:
+  outputs: ['yaml']
+  plugins:
+    "sci-embodied": # a model that calculates m from te, tir, el, rr and rtor
+      method: SciEmbodied
+      path: "builtin"
+tree:
+  children:
+    child:
+      pipeline:
+        - sci-embodied # duration & config -> embodied
+      defaults:
+        device/emissions-embodied: 1533.120 # gCO2eq
+        time-reserved: 3600 # 1hr in seconds
+        device/expected-lifespan: 94608000 # 3 years in seconds
+        resources-reserved: 1
+       # resources-total: 8
+      inputs:
+        - timestamp: 2023-07-06T00:00
+          duration: 3600
diff --git a/manifests/examples/generics.yml b/manifests/examples/generics.yml
@@ -24,7 +24,7 @@ initialize:
         coefficient: 2
         output-parameter: energy-doubled
     "multiply":
-      path: "@grnsft/if-plugins"
+      path: "builtin"
       method: Multiply
       global-config:
         input-parameters: ["cpu/utilization", "duration"]

diff --git a/manifests/examples/mock-cpu-util-to-carbon.yml b/manifests/examples/mock-cpu-util-to-carbon.yml
@@ -7,7 +7,7 @@ initialize:
       path: 'builtin'
       method: GroupBy   
     operational-carbon:
-      path: '@grnsft/if-plugins'
+      path: 'builtin'
       method: Multiply
       global-config:
         input-parameters: ['cpu/energy', 'grid/carbon-intensity']

diff --git a/manifests/examples/nesting.yml b/manifests/examples/nesting.yml
@@ -26,14 +26,14 @@ initialize:
           - cpu/energy
           - network/energy
         output-parameter: energy
-    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"
@@ -60,7 +60,7 @@ tree:
       pipeline:
         - teads-curve
         - sum
-        - sci-m
+        - sci-embodied
         - sci-o
         - time-sync
         - sci
@@ -101,7 +101,7 @@ tree:
       pipeline:
         - teads-curve
         - sum
-        - sci-m
+        - sci-embodied
         - sci-o
         - time-sync
         - sci
@@ -144,7 +144,7 @@ tree:
           pipeline:
             - teads-curve
             - sum
-            - sci-m
+            - sci-embodied
             - sci-o
             - time-sync
             - sci
@@ -185,7 +185,7 @@ tree:
           pipeline:
             - teads-curve
             - sum
-            - sci-m
+            - sci-embodied
             - sci-o
             - time-sync
             - sci

diff --git a/manifests/examples/pipeline-teads-sci.yml b/manifests/examples/pipeline-teads-sci.yml
@@ -16,14 +16,14 @@ initialize:
           - cpu/energy
           - network/energy
         output-parameter: energy
-    "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: ""
@@ -42,7 +42,7 @@ tree:
       pipeline:
         - teads-curve
         - sum
-        - sci-m
+        - sci-embodied
         - sci-o
         - time-sync
         - sci

diff --git a/manifests/examples/pipeline-with-aggregate.yml b/manifests/examples/pipeline-with-aggregate.yml
@@ -15,14 +15,14 @@ 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"
@@ -44,7 +44,7 @@ tree:
       pipeline:
         - teads-curve
         - sci-e
-        - sci-m
+        - sci-embodied
         - sci-o
         - time-sync
         - sci
@@ -87,7 +87,7 @@ tree:
       pipeline:
         - teads-curve
         - sci-e
-        - sci-m
+        - sci-embodied
         - sci-o
         - time-sync
         - sci

diff --git a/manifests/examples/pipeline-with-mocks.yml b/manifests/examples/pipeline-with-mocks.yml
@@ -33,14 +33,14 @@ 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"
@@ -63,7 +63,7 @@ tree:
       pipeline:
         - teads-curve
         - sci-e
-        - sci-m
+        - sci-embodied
         - sci-o
         - time-sync
         - sci
@@ -106,7 +106,7 @@ tree:
       pipeline:
         - teads-curve
         - sci-e
-        - sci-m
+        - sci-embodied
         - sci-o
         - time-sync
         - sci

diff --git a/manifests/features/aggregate-failure-inalid-metrics.yml b/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