PowerAPI is a middleware toolkit for building software-defined power meters. Software-defined power meters are configurable software libraries that can estimate the power consumption of software in real-time. PowerAPI supports the acquisition of raw metrics from a wide diversity of sensors (eg., physical meters, processor interfaces, hardware counters, OS counters) and the delivery of power consumptions via different channels (including file system, network, web, graphical). As a middleware toolkit, PowerAPI offers the capability of assembling power meters «à la carte» to accommodate user requirements.

PowerAPI is an open-source project developed by the Spirals research group (University of Lille 1 and Inria) and fully managed with sbt.

The documentation is available here.

You can follow the latest news and asks questions by subscribing to our mailing list.

If you would like to contribute code you can do so through GitHub by forking the repository and sending a pull request.

When submitting code, please make every effort to follow existing conventions and style in order to keep the code as readable as possible.

• WattsKit: Software-Defined Power Monitoring of Distributed Systems: M. Colmant, P. Felber, R. Rouvoy, L. Seinturier. IEEE/ACM International Symposium on Cluster, Cloud and Grid Computing (CCGrid). April 2017, Spain, France. pp.1-14.
• Process-level Power Estimation in VM-based Systems: M. Colmant, M. Kurpicz, L. Huertas, R. Rouvoy, P. Felber, A. Sobe. European Conference on Computer Systems (EuroSys). April 2015, Bordeaux, France. pp.1-14.
• Monitoring Energy Hotspots in Software: A. Noureddine, R. Rouvoy, L. Seinturier. Journal of Automated Software Engineering, Springer, 2015, pp.1-42.
• Unit Testing of Energy Consumption of Software Libraries: A. Noureddine, R. Rouvoy, L. Seinturier. International Symposium On Applied Computing (SAC), March 2014, Gyeongju, South Korea. pp.1200-1205.
• Informatique : Des logiciels mis au vert: L. Seinturier, R. Rouvoy. J'innove en Nord Pas de Calais, NFID, 2013.
• PowerAPI: A Software Library to Monitor the Energy Consumed at the Process-Level: A. Bourdon, A. Noureddine, R. Rouvoy, L. Seinturier. ERCIM News, Special Theme: Smart Energy Systems, 92, pp.43-44. ERCIM, 2013.
• Mesurer la consommation en énergie des logiciels avec précision: A. Bourdon, R. Rouvoy, L. Seinturier. 01 Business & Technologies, 2013.
• A review of energy measurement approaches: A. Noureddine, R. Rouvoy, L. Seinturier. ACM SIGOPS Operating Systems Review, ACM, 2013, 47 (3), pp.42-49.
• Runtime Monitoring of Software Energy Hotspots: A. Noureddine, A. Bourdon, R. Rouvoy, L. Seinturier. International Conference on Automated Software Engineering (ASE), September 2012, Essen, Germany. pp.160-169.
• A Preliminary Study of the Impact of Software Engineering on GreenIT: A. Noureddine, A. Bourdon, R. Rouvoy, L. Seinturier. International Workshop on Green and Sustainable Software (GREENS), June 2012, Zurich, Switzerland. pp.21-27.

PowerAPI is used in a variety of projects to address key challenges of GreenIT:

• GenPack provides a Docker Swarm strategy to minimize the energy footprint of Docker containers deployed in a cluster
• BitWatts provides process-level power estimation of applications running in virtual machines
• Web Energy Archive ranks popular websites based on the energy footpring they imposes to browsers
• Greenspector optimises the power consumption of software by identifying potential energy leaks in the source code.

We all stand on the shoulders of giants and get by with a little help from our friends. PowerAPI is written in Scala (version 2.12.1 under 3-clause BSD license) and built on top of:

• Akka (version 2.4.14 under Apache 2 license), for asynchronous processing.
• Typesafe Config (version 1.3.1 under Apache 2 license), for reading configuration files.
• scala-logging (version 3.5.0 under Apache 2 license), for Scala wrapping SL4J.
• logback (version 1.1.7 under LGPL 2.1 license), for logging purpose.
• powerspy.scala (version 1.2 under AGPL license), for using the PowerSpy power meter.
• BridJ (version 0.7.0 under 3-clause BSD license), for system or C calls.
• JNA (version 4.2.2 under LGPL 2.1 license), for system or C calls.
• perfmon2 (version 4.7.0 under MIT license), for accessing hardware performance counters.
• JFreeChart (version 1.0.19 under LGPL license), for creation of interactive and animated charts.
• grizzled-scala (version 4.0.0 under 3-clause BSD license), for new utility classes and objects.
• Sigar (version 1.6.5 under Apache 2 license), for providing a portable interface for gathering system information.
• spray-json (version 1.3.2 under Apache 2 license), for (de)serializing JSON.
• scala-influxdb-client (version 0.5.2 under MIT license), for using an asynchronous scala API for InfluxDB.

This software is licensed under the GNU Affero General Public License, quoted below.

Copyright (C) 2011-2017 Inria, University of Lille 1.

PowerAPI is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

PowerAPI is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public License along with PowerAPI. If not, please consult http://www.gnu.org/licenses/agpl-3.0.html.