This tutorial presents you how to deploy a hwpc sensor to acquire data relative to docker containers power consumption.


This tutorial assumes that:

  • a mongoDB instance that is remotely accessible from all nodes that are monitored,
  • CPUs of monitored node(s) must have an intel Sandy Bridge architecture or higher,
  • monitored node(s) run a Linux distribution that is not hosted in a virtual environment,
  • Docker is installed on the monitored node(s),
  • Each container must have a different name even if they are not hosted in the same node.

Deploy the sensor

Before deploying the sensor, a MongoDB instance should be available. We assume the instance URI is mongodb://ADDR.

Then, deploy the sensor as a Docker container with the following command:

docker run --net=host --privileged --name powerapi-sensor -d \
           -v /sys:/sys -v /var/lib/docker/containers:/var/lib/docker/containers:ro \
           -v /tmp/powerapi-sensor-reporting:/reporting \
		   powerapi/hwpc-sensor:latest \
		   -n "$NAME" \
		   -r "mongodb" -U "mongodb://ADDR" -D "$DB" -C "$COLLECTION" \
		   -s "rapl" -o -e "RAPL_ENERGY_PKG" \
		   -s "msr" -e "TSC" -e "APERF" -e "MPERF" \
                     -e "LLC_MISSES" -e "INSTRUCTIONS_RETIRED"


  • $NAME : name of the sensor instance, if you use multiple sensors and connect them to one formula, this parameter must be different for each sensor.
  • $DB : name of the mongodb database used to store the collected data
  • $COLLECTION : name of the mongodb collection used to store the collected data

Monitor DRAM domains

The previous command line will only give you data relative to containers power consumption on CPU socket

On Xeon architecture, you can also get data relative to power consumption on DRAM domain. To enable this features, add the parameter -e "RAPL_ENERGY_DRAM" in the previous command line just after -s "rapl" -o -e "RAPL_ENERGY_PKG"

Next step: deploy the formula

Data retrieved by the sensor need to be handle by a smartwatts formula to complete the deployment of the power meter.