@grnsft/if 0.3.4 → 0.4.0-beta.1

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

package/manifests/plugins/coefficient/failure-output-param-is-null.yaml

@@ -0,0 +1,24 @@
+name: coefficient-demo
+description: value of output-param is missing
+tags:
+initialize:
+  outputs: ['yaml']
+  plugins:
+    coefficient:
+      method: Coefficient
+      path: "builtin"
+      global-config:
+        input-parameter: "carbon"
+        coefficient: 3
+        output-parameter: 
+tree:
+  children:
+    child:
+      pipeline:
+        - coefficient
+      config:
+        sum:
+      inputs:
+        - timestamp: 2023-08-06T00:00
+          duration: 3600
+          carbon: 30

package/manifests/plugins/coefficient/success.yml

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

package/manifests/plugins/csv-lookup/failure-missing-column.yml

@@ -0,0 +1,26 @@
+name: csv-lookup-demo
+description:
+tags:
+initialize:
+  # outputs:
+  #   - yaml
+  plugins:
+    cloud-metadata:
+      method: CSVLookup
+      path: 'builtin'
+      global-config:
+        filepath: https://raw.githubusercontent.com/Green-Software-Foundation/if-data/main/region-metadata.csv
+        query:
+          cloud-provider: "nonexistant"
+          cloud-region: "cloud/region"
+        output: "*"
+tree:
+  children:
+    child:
+      pipeline:
+        - cloud-metadata
+      inputs:
+        - timestamp: 2023-08-06T00:00
+          duration: 3600
+          cloud/provider: Google Cloud
+          cloud/region: asia-east1

package/manifests/plugins/csv-lookup/failure-missing-output.yml

@@ -0,0 +1,26 @@
+name: csv-lookup-demo
+description:
+tags:
+initialize:
+  # outputs:
+  #   - yaml
+  plugins:
+    cloud-metadata:
+      method: CSVLookup
+      path: 'builtin'
+      global-config:
+        filepath: https://raw.githubusercontent.com/Green-Software-Foundation/if-data/main/region-metadata.csv
+        query:
+          cloud-provider: "cloud/provider"
+          cloud-region: "cloud/region"
+        output: "*"
+tree:
+  children:
+    child:
+      pipeline:
+        - cloud-metadata
+      inputs:
+        - timestamp: 2023-08-06T00:00
+          duration: 3600
+          cloud/provider: Google Cloud
+          cloud/region: asia-east1

package/manifests/plugins/csv-lookup/success-renaming.yml

@@ -0,0 +1,26 @@
+name: csv-lookup-demo
+description:
+tags:
+initialize:
+  # outputs:
+  #   - yaml
+  plugins:
+    cloud-metadata:
+      method: CSVLookup
+      path: 'builtin'
+      global-config:
+        filepath: https://raw.githubusercontent.com/Green-Software-Foundation/if-data/main/region-metadata.csv
+        query:
+          cloud-provider: "cloud/provider"
+          cloud-region: "cloud/region"
+        output: ['em-zone-id','renamed-em-zone-data']
+tree:
+  children:
+    child:
+      pipeline:
+        - cloud-metadata
+      inputs:
+        - timestamp: 2023-08-06T00:00
+          duration: 3600
+          cloud/provider: Google Cloud
+          cloud/region: asia-east1

package/manifests/plugins/csv-lookup/success.yml

@@ -0,0 +1,26 @@
+name: csv-lookup-demo
+description:
+tags:
+initialize:
+  # outputs:
+  #   - yaml
+  plugins:
+    cloud-metadata:
+      method: CSVLookup
+      path: 'builtin'
+      global-config:
+        filepath: https://raw.githubusercontent.com/Green-Software-Foundation/if-data/main/region-metadata.csv
+        query:
+          cloud-provider: "cloud/provider"
+          cloud-region: "cloud/region"
+        output: "*"
+tree:
+  children:
+    child:
+      pipeline:
+        - cloud-metadata
+      inputs:
+        - timestamp: 2023-08-06T00:00
+          duration: 3600
+          cloud/provider: Google Cloud
+          cloud/region: asia-east-1

package/manifests/plugins/divide/failure-denominator-equal-zero.yml

@@ -0,0 +1,39 @@
+name: divide
+description: denominator is invalid, denominator is
+tags:
+initialize:
+#  outputs: ['yaml']
+  plugins:
+    cloud-metadata:
+      method: CloudMetadata
+      path: "@grnsft/if-plugins"
+    divide:
+      method: Divide
+      path: "builtin"
+      global-config:
+        numerator: vcpus-allocated
+        denominator: 0
+        output: cpu/number-cores
+    boavizta-cpu:
+      method: BoaviztaCpuOutput
+      path: "@grnsft/if-unofficial-plugins"
+      global-config:
+        allocation: LINEAR
+        verbose: true
+tree:
+  children:
+    child:
+      pipeline:
+        - cloud-metadata
+        - divide
+        - boavizta-cpu
+      config:
+        divide:
+      defaults:
+        cloud/vendor: aws
+        cloud/instance-type: m5n.large
+        cpu/name: Intel® Core™ i7-1185G7
+      inputs:
+        - timestamp: 2023-08-06T00:00
+          duration: 3600
+          cpu/utilization: 80

package/manifests/plugins/divide/failure-invalid-config-denominator.yml

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

package/manifests/plugins/divide/failure-missing-numerator.yml

@@ -0,0 +1,39 @@
+name: divide
+description: success path
+tags:
+initialize:
+#  outputs: ['yaml']
+  plugins:
+    cloud-metadata:
+      method: CloudMetadata
+      path: "@grnsft/if-plugins"
+    divide:
+      method: Divide
+      path: "builtin"
+      global-config:
+        #numerator: vcpus-allocated
+        denominator: 2
+        output: cpu/number-cores
+    boavizta-cpu:
+      method: BoaviztaCpuOutput
+      path: "@grnsft/if-unofficial-plugins"
+      global-config:
+        allocation: LINEAR
+        verbose: true
+tree:
+  children:
+    child:
+      pipeline:
+        - cloud-metadata
+        - divide
+        - boavizta-cpu
+      config:
+        divide:
+      defaults:
+        cloud/vendor: aws
+        cloud/instance-type: m5n.large
+        cpu/name: Intel® Core™ i7-1185G7
+      inputs:
+        - timestamp: 2023-08-06T00:00
+          duration: 3600
+          cpu/utilization: 80

package/manifests/plugins/divide/success.yml

@@ -2,14 +2,14 @@ name: divide
 description: success path
 tags:
 initialize:
-  outputs: ['yaml']
+#  outputs: ['yaml']
   plugins:
     cloud-metadata:
       method: CloudMetadata
       path: "@grnsft/if-plugins"
     divide:
       method: Divide
-      path: "@grnsft/if-plugins"
+      path: "builtin"
       global-config:
         numerator: vcpus-allocated
         denominator: 2

package/manifests/plugins/groupby/failure-missing-cloud-instance-type.yml

@@ -0,0 +1,49 @@
+name: groupby
+description: 
+initialize:
+ # outputs: ['yaml']
+  plugins:
+    group-by:
+      path: "builtin"
+      method: GroupBy
+tree:
+  children:
+    my-app:
+      pipeline:
+        - group-by
+      config:
+        group-by:
+          group:
+            - 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  -- missing value
+          cloud/region: uk-west
+          cpu/utilization: 1

package/manifests/plugins/interpolation/interpolation.yml

@@ -0,0 +1,24 @@
+name: interpolation-demo
+description: simple demo of interpolation plugin
+tags:
+initialize:
+  plugins:
+    interpolation:
+      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: "result"
+
+tree:
+  children:
+    child:
+      pipeline:
+        - interpolation
+      inputs:
+        - timestamp: 2023-07-06T00:00
+          duration: 3600
+          cpu/utilization: 45

package/manifests/plugins/mock-observations/failure-invalid-config-cpu-range.yml

@@ -7,7 +7,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