README.md

Sum

sum is a generic plugin for doing arithmetic sums of two or more values in an input array.

You provide the names of the values you want to sum, and a name to use to add the sum to the output array.

For example, you could add cpu/energy and network/energy and name the result energy. energy would then be added to every observation in your input array as the sum of cpu/energy and network/energy.

Parameters

Plugin config

Two parameters are required in global config: input-parameters and output-parameter.

input-parameters: an array of strings. Each string should match an existing key in the inputs array output-parameter: a string defining the name to use to add the result of summing the input parameters to the output array.

Inputs

All of input-parameters must be available in the input array.

Returns

• output-parameter: the sum of all input-parameters with the parameter name defined by output-parameter in global config.

Calculation

output = input0 + input1 + input2 ... inputN

Implementation

To run the plugin, you must first create an instance of Sum. Then, you can call execute().

import {Sum} from '@grnsft/if-plugins';

const config = {
  inputParameters: ['cpu/energy', 'network/energy'],
  outputParameter: 'energy',
};

const sum = Sum(config);
const result = await sum.execute([
  {
    duration: 3600,
    timestamp: '2021-01-01T00:00:00Z',
    'cpu/energy': 0.001,
    'memory/energy': 0.0005,
  },
]);

Example manifest

IF users will typically call the plugin as part of a pipeline defined in a manifest file. In this case, instantiating the plugin is handled by and does not have to be done explicitly by the user. The following is an example manifest that calls sum:

name: sum demo
description:
tags:
initialize:
  plugins:
    sum:
      method: Sum
      path: '@grnsft/if-plugins'
      global-config:
        input-parameters: ['cpu/energy', 'network/energy']
        output-parameter: 'energy'
tree:
  children:
    child:
      pipeline:
        - sum
      config:
        sum:
      inputs:
        - timestamp: 2023-08-06T00:00
          duration: 3600
          cpu/energy: 0.001
          network/energy: 0.001

You can run this example by saving it as ./examples/manifests/test/sum.yml and executing the following command from the project root:

npm i -g @grnsft/if
npm i -g @grnsft/if-plugins
ie --manifest ./examples/manifests/test/sum.yml --output ./examples/outputs/sum.yml

The results will be saved to a new yaml file in ./examples/outputs.