Sign inSign up

beetaone/aggregator

By beetaone

Updated almost 2 years ago

Image
0

181

beetaone/aggregator repository overview

Aggregator

NameAggregator
Versionv1.0.2
DockerHubbeetaone/aggregator
authorsJakub Grzelak, Sanyam Arya

Description

Aggregator is a processing module responsible for aggregating data passing through beetaone data services. Aggregator collects data within a time interval specified by a data service developer, and then it applies a chosen aggregation function. This module is containerized using Docker.

Supported functions:

  • mean (mean value that arrived within the specified interval)
  • max (maximum value)
  • spread (maximum - minimum value)
  • median (median value recorded within the interval)
  • sum (sum of all received values)
  • stddv (standard deviation of values)
  • count (number of data that arrived within the interval)
  • first (first recorded data)
  • min (minimum value)
  • last (last recorded data)

Environment Variables

Module Specific

The following module configurations can be provided in a data service designer section on beetaone platform:

NameEnvironment VariablestypeDescription
Interval UnitINTERVAL_UNITstringThe unit for time interval (ms, s, m, h, d)
Interval PeriodINTERVAL_PERIODintegerThe time interval on which aggregation will be applied
FunctionFUNCTIONstringAggregation function to apply (mean, max, spread, median, sum, stddv, count, first, min, last)
Input LabelINPUT_LABELstringThe input label on which anomaly is detected
Output LabelOUTPUT_LABELstringThe output label as which data is dispatched
Set by the beetaone Agent on the edge-node

Other features required for establishing the inter-container communication between modules in a data service are set by beetaone agent.

Environment VariablestypeDescription
MODULE_NAMEstringName of the module
MODULE_TYPEstringType of the module (Input, Processing, Output)
EGRESS_URLstringHTTP ReST endpoint for the next module
INGRESS_HOSTstringHost to which data will be received
INGRESS_PORTstringPort to which data will be received

Dependencies

bottle
requests

Input

Input to this module is JSON body single object:

Example:

{
  temperature: 15,
  input_unit: Celsius
}

Output

Output of this module is JSON body array of objects.

Output of this module is JSON body:

{
    "<OUTPUT_LABEL>": <Processed data>,
}
  • Here OUTPUT_LABEL is specified at the module creation and Processed data is data processed by Module Main function.

Example:

{
  meanTemp: 54.7,
}

Tag summary

Content type

Image

Digest

sha256:ac6482cdd

Size

49.1 MB

Last updated

almost 2 years ago

docker pull beetaone/aggregator:v1.0.2