Database

A database can be used as an input or an output of powerapi formula

For each database the parameters to specify are differents. For each database, its parameters are specified in its section.

MongoDB

If you want to use a mongo database in your formula your have to specify mongodb as the type of a puller or a pusher.

The list of parameters you have to provide :

• uri : The ip address of your mongo database
• db: the name of your database
• collection: the name of the collection inside the database

The default model of mongodb is HWPCReport if used as an input and PowerReport if used as an output.

We provide an example of configuration file.

{
  "type": "mongodb",
  "uri": "mongodb://127.0.0.1",
  "db": "test",
  "collection": "prep"
}

Influx DB 1.8

If you want to use influxdb 1.8 in your formula your have to specify influxedb as the type of a pusher.

The list of parameters you have to provide :

• uri : IP address of the server with the database
• port: port of communication
• db : name of the database

InfluxDB can only be used as an output and its default model is PowerReport.

We provide an example of configuration file :

{
  "tags": "socket",
  "model": "PowerReport",
  "type": "influxdb",
  "uri": "127.0.0.1",
  "port": 8086,
  "db": "test_influxdb"
}

Influx DB 2

If you want to use influxdb 2 in your formula your have to specify influxedb2 as the type of a pusher.

The list of parameters you have to provide :

• uri : IP address of the server with the database
• port: port of communication
• db : name of the bucket (database)
• org : name of the organisation associated to the bucket
• token : token for accesing the database. The token ower must have write/read permissions on the database

InfluxDB2 can only be used as an output and its default model is PowerReport.

We provide an example of configuration file :

{
  "model": "PowerReport",
  "type": "influxdb2",
  "uri": "http://127.0.0.1",
  "port": 8086,
  "db": "influxdb2",
  "org": "org_test",
  "token": "mytoken"
}

CSV

If you want to use a csv file in your formula your have to specify csv as the type of a puller or a pusher.

The list of parameters you have to provide :

• uri : The csv file name

The default model of csv is HWPCReport.

The default model of csv is HWPCReport if used as an input and PowerReport if used as an output.

We provide an example of configuration file.

{
  "type": "csv",
  "uri": "/tmp/sensor_output/"
}

Socket

If you want to use a tcp socket in your formula your have to specify socket as the type of a puller or a pusher. This database is made for stream mode.

The list of parameters you have to provide :

• uri : The IP address of the server
• port: The port to use to communicate with the server

The socket can only be used as an input and its default model is HWPCReport.

We provide an example of configuration file.

{
  "type": "socket",
  "uri": "127.0.0.1",
  "port": 8080
}

File Database

If you want to use a file as database in your formula your have to specify filedb as the type of a puller or a pusher. The database is made for stream mode. It should contain only the last report.

The list of parameters you have to provide :

• filename : The name of the file

This database can only be used as an input and its default model is PowerReport.

We provide an example of configuration file.

{
  "type": "socket",
  "filename": /tmp/database
}

Prometheus

If you want to use a prometheus to expose reports to be scraped, you have to specify prom as the type of a pusher in your formula configuration file.

The list of parameters you have to provide :

• tags : specify report tags
• uri : Server ip address
• port : Server port
• metric_name : The metric name
• metric_description : The metric description. Its default value is energy consumption

Promtheus can only be used as an output that monitors reports but they will be not stored by this service. It has to be configured (via static_configs) by using the uri and port defined by the formula configuration file.

We provide an example of configuration file.

{
  "type": "prom",
  "uri": "127.0.0.1",
  "port": 8080,
  "metric_name": test
}