@grnsft/if 0.3.2 → 0.3.3-beta.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (105) hide show
  1. package/.commitlintrc.js +3 -0
  2. package/.release-it.json +18 -0
  3. package/CONTRIBUTING.md +77 -4
  4. package/README.md +34 -26
  5. package/build/builtins/export-csv-raw.js +4 -4
  6. package/build/builtins/export-csv.js +5 -5
  7. package/build/builtins/export-log.js +26 -2
  8. package/build/builtins/export-yaml.js +3 -3
  9. package/build/config/config.d.ts +3 -3
  10. package/build/config/config.js +23 -27
  11. package/build/config/strings.d.ts +1 -0
  12. package/build/config/strings.js +8 -3
  13. package/build/index.js +23 -14
  14. package/build/lib/environment.d.ts +5 -0
  15. package/build/lib/environment.js +69 -0
  16. package/build/lib/exhaust.d.ts +2 -1
  17. package/build/lib/exhaust.js +11 -9
  18. package/build/lib/initialize.d.ts +2 -2
  19. package/build/lib/initialize.js +5 -5
  20. package/build/lib/load.d.ts +1 -29
  21. package/build/lib/load.js +2 -5
  22. package/build/types/environment.d.ts +18 -0
  23. package/build/types/environment.js +3 -0
  24. package/build/types/manifest.d.ts +1 -0
  25. package/build/types/manifest.js +1 -1
  26. package/build/types/process-args.d.ts +13 -1
  27. package/build/types/process-args.js +1 -1
  28. package/build/util/args.d.ts +3 -5
  29. package/build/util/args.js +14 -10
  30. package/build/util/errors.d.ts +1 -1
  31. package/build/util/errors.js +2 -3
  32. package/build/util/helpers.d.ts +6 -0
  33. package/build/util/helpers.js +9 -3
  34. package/build/util/os-checker.d.ts +7 -0
  35. package/build/util/os-checker.js +97 -0
  36. package/build/util/validations.d.ts +90 -4
  37. package/build/util/validations.js +14 -2
  38. package/github-processes.md +10 -0
  39. package/{examples/manifests/pipeline-demo-2.yml → manifests/bugs/aggregation-error-wrong-metric.yml} +8 -34
  40. package/manifests/bugs/azure-importer-ignoring-defaults.yml +61 -0
  41. package/manifests/bugs/azure-importer-incorrect-calculation.yml +56 -0
  42. package/manifests/bugs/initialize-error-no-config.yml +27 -0
  43. package/manifests/bugs/initialize-error-no-path.yml +28 -0
  44. package/manifests/bugs/initialize-error-no-plugins.yml +23 -0
  45. package/manifests/bugs/input-error-missing-duration.yml +21 -0
  46. package/manifests/bugs/pipeline-error-naming-mismatch.yml +28 -0
  47. package/manifests/bugs/pipeline-error-uninitialized-plugin.yml +29 -0
  48. package/{examples/manifests/boavizta-pipeline.yml → manifests/bugs/pipeline-ordering-error.yml} +7 -10
  49. package/{examples/manifests → manifests/examples}/basic.yml +3 -2
  50. package/{examples/manifests → manifests/examples}/generics.yml +2 -2
  51. package/{examples/manifests/asim-demo.yml → manifests/examples/mock-cpu-util-to-carbon.yml} +3 -7
  52. package/{examples/manifests → manifests/examples}/nesting.yml +3 -2
  53. package/{examples/manifests → manifests/examples}/pipeline-teads-sci.yml +1 -1
  54. package/{examples/manifests/pipeline-demo.yml → manifests/examples/pipeline-with-aggregate.yml} +2 -2
  55. package/{examples/manifests → manifests/examples}/pipeline-with-mocks.yml +3 -2
  56. package/manifests/features/aggregate-horizontal.yml +44 -0
  57. package/manifests/features/aggregate-vertical.yml +44 -0
  58. package/manifests/features/aggregate.yml +44 -0
  59. package/manifests/integrations/mock-obs-groupby.yml +39 -0
  60. package/manifests/integrations/mock-obs-time-sync.yml +65 -0
  61. package/manifests/plugins/cloud-metadata/failure-invalid-vendor.yaml +21 -0
  62. package/{examples/manifests/cloud-metadata.yml → manifests/plugins/cloud-metadata/success.yml} +2 -1
  63. package/manifests/plugins/coefficient/failure-invalid-config-input-param.yml +24 -0
  64. package/{examples/manifests/coefficient.yml → manifests/plugins/coefficient/success.yml} +2 -1
  65. package/manifests/plugins/divide/failure-invalid-config-denominator.yml +39 -0
  66. package/manifests/plugins/divide/success.yml +39 -0
  67. package/manifests/plugins/groupby/failure-invalid-config-group.yml +47 -0
  68. package/{examples/manifests/group-by.yml → manifests/plugins/groupby/success.yml} +3 -2
  69. package/manifests/plugins/mock-observations/failure-invalid-config-cpu-range.yml +34 -0
  70. package/{examples/manifests/mock-observation.yml → manifests/plugins/mock-observations/success.yml} +2 -1
  71. package/manifests/plugins/multiply/failure-input-parameter-is-missing.yml +24 -0
  72. package/{examples/manifests/multiply.yml → manifests/plugins/multiply/success.yml} +3 -2
  73. package/manifests/plugins/regex/failure-missing-input-param.yml +24 -0
  74. package/{examples/manifests/regex.yml → manifests/plugins/regex/success.yml} +3 -2
  75. package/manifests/plugins/sci/failure-invalid-config-value.yml +28 -0
  76. package/{examples/manifests/sci.yml → manifests/plugins/sci/success.yml} +3 -2
  77. package/manifests/plugins/sci-m/failure-invalid-default-emission-value.yml +24 -0
  78. package/{examples/manifests/sci-m.yml → manifests/plugins/sci-m/success.yml} +2 -1
  79. package/manifests/plugins/shell/failure-invalid-command.yml +21 -0
  80. package/{examples/manifests/shell.yml → manifests/plugins/shell/success.yml} +3 -2
  81. package/manifests/plugins/sum/failure-missing-input-param.yml +24 -0
  82. package/{examples/manifests/sum.yml → manifests/plugins/sum/success.yml} +3 -2
  83. package/manifests/plugins/tdp-finder/failure-missing-input-param.yml +18 -0
  84. package/{examples/manifests/tdp-finder.yml → manifests/plugins/tdp-finder/success.yml} +2 -1
  85. package/manifests/plugins/time-sync/failure-config-start-later-end.yml +34 -0
  86. package/{examples/manifests/time-sync.yml → manifests/plugins/time-sync/success.yml} +4 -2
  87. package/package.json +4 -2
  88. package/examples/manifests/azure-importer.yml +0 -24
  89. package/examples/manifests/basic-demo.yml +0 -70
  90. package/examples/manifests/boavizta-cloud.yml +0 -20
  91. package/examples/manifests/boavizta.yml +0 -26
  92. package/examples/manifests/ccf.yml +0 -20
  93. package/examples/manifests/cloud-metadata-teads.yml +0 -41
  94. package/examples/manifests/co2js.yml +0 -30
  95. package/examples/manifests/csv-export.yml +0 -34
  96. package/examples/manifests/e-mem.yml +0 -21
  97. package/examples/manifests/e-net.yml +0 -22
  98. package/examples/manifests/nesting-demo.yml +0 -89
  99. package/examples/manifests/pipeline-demo-1.yml +0 -85
  100. package/examples/manifests/pipeline-with-generics.yml +0 -152
  101. package/examples/manifests/sci-e.yml +0 -19
  102. package/examples/manifests/sci-o.yml +0 -26
  103. package/examples/manifests/teads-curve.yml +0 -20
  104. package/examples/manifests/watt-time.yml +0 -35
  105. /package/{examples/manifests/divide.yml → manifests/integrations/cloud-metadata-divide-boavizta.yml} +0 -0
@@ -1,34 +0,0 @@
1
- name: csv-export-demo
2
- description: example exporting output to a csv file
3
- tags:
4
- initialize:
5
- plugins:
6
- csv-exporter:
7
- method: CsvExport
8
- path: "@grnsft/if-plugins"
9
- tree:
10
- children:
11
- child:
12
- pipeline:
13
- - csv-exporter
14
- config:
15
- csv-exporter:
16
- output-path: ./examples/outputs/csv-test.csv
17
- headers:
18
- - timestamp
19
- - duration
20
- - carbon
21
- - energy
22
- inputs:
23
- - timestamp: 2023-07-06T00:00
24
- duration: 1
25
- operational-carbon: 0.02
26
- embodied-carbon: 5
27
- energy: 3.5
28
- carbon: 5.02
29
- - timestamp: 2023-07-06T00:10
30
- duration: 1
31
- operational-carbon: 0.03
32
- embodied-carbon: 4
33
- energy: 2.9
34
- carbon: 4.03
@@ -1,21 +0,0 @@
1
- name: e-mem
2
- description:
3
- tags:
4
- initialize:
5
- plugins:
6
- e-mem:
7
- method: EMem
8
- path: "@grnsft/if-plugins"
9
- global-config:
10
- energy-per-gb: 0.002
11
- tree:
12
- children:
13
- child:
14
- pipeline:
15
- - e-mem
16
- config:
17
- inputs:
18
- - timestamp: 2023-08-06T00:00
19
- duration: 3600
20
- memory/utilization: 40
21
- memory/capacity: 1
@@ -1,22 +0,0 @@
1
- name: e-net-demo
2
- description:
3
- tags:
4
- initialize:
5
- plugins:
6
- e-net:
7
- method: ENet
8
- path: "@grnsft/if-plugins"
9
- global-config:
10
- energy-per-gb: 0.02
11
- tree:
12
- children:
13
- child:
14
- pipeline:
15
- - e-net
16
- config:
17
- e-net:
18
- inputs:
19
- - timestamp: 2023-08-06T00:00
20
- duration: 3600
21
- network/data-in: 1
22
- network/data-out: 2
@@ -1,89 +0,0 @@
1
- name: nesting-demo
2
- description: null
3
- tags:
4
- kind: web
5
- complexity: moderate
6
- category: on-premise
7
- params:
8
- aggregation:
9
- type: vertical
10
- metrics:
11
- - "energy"
12
- initialize:
13
- plugins:
14
- teads-curve:
15
- path: "@grnsft/if-unofficial-plugins"
16
- method: TeadsCurve
17
- global-config:
18
- interpolation: spline
19
- sci-e:
20
- path: "@grnsft/if-plugins"
21
- method: SciE
22
- sci-m:
23
- path: "@grnsft/if-plugins"
24
- method: SciM
25
- sci-o:
26
- path: "@grnsft/if-plugins"
27
- method: SciO
28
- "time-sync":
29
- method: TimeSync
30
- path: "builtin"
31
- global-config:
32
- start-time: "2023-12-12T00:00:00.000Z"
33
- end-time: "2023-12-12T00:01:00.000Z"
34
- interval: 5
35
- allow-padding: true
36
- sci:
37
- path: "@grnsft/if-plugins"
38
- method: Sci
39
- global-config:
40
- functional-unit: "requests"
41
- functional-unit-time: "1 minute"
42
- tree:
43
- children:
44
- child-0:
45
- defaults:
46
- cpu/thermal-design-power: 100
47
- grid/carbon-intensity: 800
48
- device/emissions-embodied: 1533.120 # gCO2eq
49
- time-reserved: 3600 # 1hr in seconds
50
- device/expected-lifespan: 94608000 # 3 years in seconds
51
- resources-reserved: 1
52
- resources-total: 8
53
- functional-unit-time: "1 min"
54
- pipeline:
55
- - teads-curve
56
- - sci-e
57
- - sci-m
58
- - sci-o
59
- - time-sync
60
- - sci
61
- inputs:
62
- - timestamp: "2023-12-12T00:00:00.000Z"
63
- duration: 10
64
- cpu/utilization: 50
65
- network/energy: 1
66
- energy: 1
67
- child-1:
68
- defaults:
69
- cpu/thermal-design-power: 100
70
- grid/carbon-intensity: 800
71
- device/emissions-embodied: 1533.120 # gCO2eq
72
- time-reserved: 3600 # 1hr in seconds
73
- device/expected-lifespan: 94608000 # 3 years in seconds
74
- resources-reserved: 1
75
- resources-total: 8
76
- functional-unit-time: "1 min"
77
- pipeline:
78
- - teads-curve
79
- - sci-e
80
- - sci-m
81
- - sci-o
82
- - time-sync
83
- - sci
84
- inputs:
85
- - timestamp: "2023-12-12T00:00:00.000Z"
86
- duration: 10
87
- cpu/utilization: 30
88
- network/energy: 1
89
- energy: 1
@@ -1,85 +0,0 @@
1
- name: pipeline-demo
2
- description:
3
- tags:
4
- initialize:
5
- plugins:
6
- boavizta-cpu:
7
- method: BoaviztaCpuOutput
8
- path: "@grnsft/if-unofficial-plugins"
9
- global-config:
10
- allocation: LINEAR
11
- verbose: true
12
- "sum":
13
- path: "@grnsft/if-plugins"
14
- method: Sum
15
- global-config:
16
- input-parameters:
17
- - cpu/energy
18
- - network/energy
19
- output-parameter: energy
20
- "sci-m":
21
- path: "@grnsft/if-plugins"
22
- method: SciM
23
- "sci-o":
24
- path: "@grnsft/if-plugins"
25
- method: SciO
26
- "sci":
27
- path: "@grnsft/if-plugins"
28
- method: Sci
29
- global-config:
30
- functional-unit: ""
31
- functional-unit-time: "1-day"
32
- "time-sync":
33
- method: TimeSync
34
- path: "builtin"
35
- global-config:
36
- start-time: "2023-12-12T00:00:00.000Z"
37
- end-time: "2023-12-12T00:01:00.000Z"
38
- interval: 5
39
- allow-padding: true
40
- tree:
41
- children:
42
- child-1:
43
- pipeline:
44
- - boavizta-cpu
45
- - sum
46
- - sci-m
47
- - sci-o
48
- - time-sync
49
- - sci
50
- config:
51
- defaults:
52
- cpu/thermal-design-power: 100
53
- grid/carbon-intensity: 800
54
- device/emissions-embodied: 1533.120 # gCO2eq
55
- time-reserved: 3600 # 1hr in seconds
56
- device/expected-lifespan: 94608000 # 3 years in seconds
57
- resources-reserved: 1
58
- resources-total: 8
59
- cpu/number-cores: 24
60
- cpu/name: Intel® Core™ i7-1185G7
61
- inputs:
62
- - timestamp: "2023-12-12T00:00:00.000Z"
63
- cloud/instance-type: A1
64
- cloud/region: uk-west
65
- duration: 1
66
- cpu/utilization: 50
67
- network/energy: 0.000001
68
- - timestamp: "2023-12-12T00:00:01.000Z"
69
- duration: 5
70
- cpu/utilization: 20
71
- cloud/instance-type: A1
72
- cloud/region: uk-west
73
- network/energy: 0.000001
74
- - timestamp: "2023-12-12T00:00:06.000Z"
75
- duration: 7
76
- cpu/utilization: 15
77
- cloud/instance-type: A1
78
- cloud/region: uk-west
79
- network/energy: 0.000001
80
- - timestamp: "2023-12-12T00:00:13.000Z"
81
- duration: 30
82
- cloud/instance-type: A1
83
- cloud/region: uk-west
84
- cpu/utilization: 15
85
- network/energy: 0.000001
@@ -1,152 +0,0 @@
1
- name: pipeline-with-generics-demo
2
- description:
3
- tags:
4
- aggregation:
5
- metrics:
6
- - "carbon"
7
- type: "both"
8
- params:
9
- - name: energy-sum
10
- description: "sum of energies"
11
- unit: "kWh"
12
- aggregation: sum
13
- initialize:
14
- plugins:
15
- "teads-curve":
16
- path: "@grnsft/if-unofficial-plugins"
17
- method: TeadsCurve
18
- global-config:
19
- interpolation: spline
20
- "sum":
21
- path: "@grnsft/if-plugins"
22
- method: Sum
23
- global-config:
24
- input-parameters:
25
- - cpu/energy
26
- - network/energy
27
- output-parameter: energy-sum
28
- "coefficient":
29
- path: "@grnsft/if-plugins"
30
- method: Coefficient
31
- global-config:
32
- input-parameter: energy
33
- coefficient: 2
34
- output-parameter: energy-doubled
35
- "sci-m":
36
- path: "@grnsft/if-plugins"
37
- method: SciM
38
- "sci-o":
39
- path: "@grnsft/if-plugins"
40
- method: SciO
41
- "sci":
42
- path: "@grnsft/if-plugins"
43
- method: Sci
44
- global-config:
45
- functional-unit: "requests"
46
- functional-unit-time: "1 minute"
47
- "time-sync":
48
- method: TimeSync
49
- path: "builtin"
50
- global-config:
51
- start-time: "2023-12-12T00:00:00.000Z"
52
- end-time: "2023-12-12T00:01:00.000Z"
53
- interval: 5
54
- allow-padding: true
55
- tree:
56
- children:
57
- child-1:
58
- pipeline:
59
- - teads-curve
60
- - sum
61
- - sci-m
62
- - sci-o
63
- - time-sync
64
- - coefficient
65
- - sci
66
- config:
67
- defaults:
68
- cpu/thermal-design-power: 100
69
- grid/carbon-intensity: 800
70
- device/emissions-embodied: 1533.120 # gCO2eq
71
- time-reserved: 3600 # 1hr in seconds
72
- device/expected-lifespan: 94608000 # 3 years in seconds
73
- resources-reserved: 1
74
- resources-total: 8
75
- functional-unit-time: "1 min"
76
- inputs:
77
- - timestamp: "2023-12-12T00:00:00.000Z"
78
- cloud/instance-type: A1
79
- cloud/region: uk-west
80
- duration: 1
81
- cpu/utilization: 50
82
- network/energy: 10
83
- energy: 5
84
- - timestamp: "2023-12-12T00:00:01.000Z"
85
- duration: 5
86
- cpu/utilization: 20
87
- cloud/instance-type: A1
88
- cloud/region: uk-west
89
- network/energy: 10
90
- energy: 5
91
- - timestamp: "2023-12-12T00:00:06.000Z"
92
- duration: 7
93
- cpu/utilization: 15
94
- cloud/instance-type: A1
95
- cloud/region: uk-west
96
- network/energy: 10
97
- energy: 5
98
- - timestamp: "2023-12-12T00:00:13.000Z"
99
- duration: 30
100
- cloud/instance-type: A1
101
- cloud/region: uk-west
102
- cpu/utilization: 15
103
- network/energy: 10
104
- energy: 5
105
- child-2:
106
- pipeline:
107
- - teads-curve
108
- - sum
109
- - sci-m
110
- - sci-o
111
- - time-sync
112
- - coefficient
113
- - sci
114
- config:
115
- defaults:
116
- cpu/thermal-design-power: 100
117
- grid/carbon-intensity: 800
118
- device/emissions-embodied: 1533.120 # gCO2eq
119
- time-reserved: 3600 # 1hr in seconds
120
- device/expected-lifespan: 94608000 # 3 years in seconds
121
- resources-reserved: 1
122
- resources-total: 8
123
- functional-unit-time: "1 min"
124
- inputs:
125
- - timestamp: "2023-12-12T00:00:00.000Z"
126
- duration: 1
127
- cpu/utilization: 30
128
- cloud/instance-type: A1
129
- cloud/region: uk-west
130
- network/energy: 10
131
- energy: 5
132
- - timestamp: "2023-12-12T00:00:01.000Z"
133
- duration: 5
134
- cpu/utilization: 28
135
- cloud/instance-type: A1
136
- cloud/region: uk-west
137
- network/energy: 10
138
- energy: 5
139
- - timestamp: "2023-12-12T00:00:06.000Z"
140
- duration: 7
141
- cpu/utilization: 40
142
- cloud/instance-type: A1
143
- cloud/region: uk-west
144
- network/energy: 10
145
- energy: 5
146
- - timestamp: "2023-12-12T00:00:13.000Z"
147
- duration: 30
148
- cpu/utilization: 33
149
- cloud/instance-type: A1
150
- cloud/region: uk-west
151
- network/energy: 10
152
- energy: 5
@@ -1,19 +0,0 @@
1
- name: sci-e-demo
2
- description:
3
- tags:
4
- initialize:
5
- plugins:
6
- "sci-e":
7
- method: SciE
8
- path: "@grnsft/if-plugins"
9
- tree:
10
- children:
11
- child:
12
- pipeline:
13
- - sci-e
14
- config:
15
- sci-e:
16
- inputs:
17
- - timestamp: 2023-08-06T00:00
18
- duration: 3600
19
- cpu/energy: 0.001
@@ -1,26 +0,0 @@
1
- name: sci-o-demo
2
- description:
3
- tags:
4
- initialize:
5
- plugins:
6
- sci-e:
7
- kind: plugin
8
- method: SciE
9
- path: "@grnsft/if-plugins"
10
- sci-o:
11
- verbose: false
12
- method: SciO
13
- path: "@grnsft/if-plugins"
14
- tree:
15
- children:
16
- child:
17
- pipeline:
18
- - sci-e
19
- - sci-o
20
- config:
21
- sci-e:
22
- inputs:
23
- - timestamp: 2023-08-06T00:00
24
- duration: 3600
25
- cpu/energy: 0.001
26
- grid/carbon-intensity: 800
@@ -1,20 +0,0 @@
1
- name: teads-curve
2
- description: simple demo invoking teads-curve
3
- tags:
4
- initialize:
5
- plugins:
6
- teads-curve:
7
- method: TeadsCurve
8
- path: "@grnsft/if-unofficial-plugins"
9
- global-config:
10
- interpolation: spline
11
- tree:
12
- children:
13
- child:
14
- pipeline:
15
- - teads-curve
16
- inputs:
17
- - timestamp: 2023-07-06T00:00
18
- duration: 3600
19
- cpu/utilization: 50
20
- cpu/thermal-design-power: 100
@@ -1,35 +0,0 @@
1
- name: watt-time-demo
2
- description: null
3
- tags: null
4
- initialize:
5
- plugins:
6
- mock-observations:
7
- path: "@grnsft/if-plugins"
8
- method: MockObservations
9
- global-config:
10
- timestamp-from: "2024-03-05T00:00:00.000Z"
11
- timestamp-to: "2024-03-05T00:10:00.000Z"
12
- duration: 60
13
- components:
14
- - cloud/instance-type: Standard_E64_v3
15
- - cloud/instance-type: Standard_E64_v4
16
- generators:
17
- common:
18
- cloud/vendor: azure
19
- cloud/region: westus
20
- cloud/region-wt-id: CAISO_NORTH
21
- randint:
22
- cpu/utilization:
23
- min: 1
24
- max: 99
25
- watttime:
26
- path: "@grnsft/if-unofficial-plugins"
27
- method: WattTimeGridEmissions
28
- tree:
29
- children:
30
- application:
31
- pipeline:
32
- - mock-observations
33
- - watttime
34
- config:
35
- inputs: