refactor(core): add Supervisors, fix bugs, cleaning, a Clock is not automatically created anymore

A Clock for producing periodic ticks is created only when the "every(frequency)" method is called on a PowerMonitoring object.
It allows then to have external ticks when needed.
Sensors, formulae and reporters have now their own Supervisor, and each component actor is now responsible to handle one target at a time.
Two reporters are not refactored yet (Rest, Fuse).

refactor(tests): improve the coverage, and clean tests

Several tests have been rewritten and cleaned.
The coverage is now up to more than 70%.

refactor(examples): change the external dependency to a local one

The examples were written to use PowerAPI as en external dependency. The dependency is now local (PowerAPIBuild), and allows to get the examples up-to-date with the powerapi-core library.

Author: mcolmant

.travis.yml

@@ -1,8 +1,21 @@
+sudo: required
+
+cache:
+  directories:
+    - $HOME/.m2/repository
+    - $HOME/.sbt
+    - $HOME/.ivy2
+
 language: scala
+
 scala:
-- 2.11.6
+- 2.11.7
+
 script:
-- sbt clean "project powerapi-core" coverage test
+- sbt compile test:compile
+- sbt 'set concurrentRestrictions in Global += Tags.limit(Tags.Test, 1)' "project powerapi-core" coverage test
+- find $HOME/.sbt -name "*.lock" | xargs rm
+
 after_success:
 - sbt "project powerapi-core" coverageReport
 - sbt "project powerapi-core" codacyCoverage

README.md

@@ -56,11 +56,7 @@ We all stand on the shoulders of giants and get by with a little help from our f
 * [Scala IO](http://jesseeichar.github.io/scala-io-doc/0.4.3/index.html#!/overview) (version 0.4.3 under [3-clause BSD license](http://www.scala-lang.org/license.html)), for an extensions of IO.
 * [Saddle](http://saddle.github.io/) (version 1.3.4 under [Apache 2 license](http://www.apache.org/licenses/LICENSE-2.0)), for data manipulation.
 * [Sigar](https://support.hyperic.com/display/SIGAR/Home) (version 1.6.5 under [Apache 2 license](http://www.apache.org/licenses/LICENSE-2.0)), for providing a portable interface for gathering system information.
-* [spray-can](http://spray.io/) (version 1.3.3 under [Apache 2 license](http://www.apache.org/licenses/LICENSE-2.0)), for providing a low-level, low-overhead, high-performance HTTP server and client.
-* [spray-client](http://spray.io/) (version 1.3.3 under [Apache 2 license](http://www.apache.org/licenses/LICENSE-2.0)), for providing high-level HTTP client.
-* [spray-routing](http://spray.io/) (version 1.3.3 under [Apache 2 license](http://www.apache.org/licenses/LICENSE-2.0)), for providing a high-level, very flexible routing DSL for elegantly defining RESTful web services.
-* [spray-json](http://spray.io/) (version 1.2.2 under [Apache 2 license](http://www.apache.org/licenses/LICENSE-2.0)), for (de)serializing JSON.
-* [nscala-time](https://github.com/nscala-time/nscala-time) (version 2.8.0 under [Apache 2 license](http://www.apache.org/licenses/LICENSE-2.0)), for using a scala wrapper for Joda Time (quality replacement for the Java date and time classes).
+* [spray-json](http://spray.io/) (version 1.3.2 under [Apache 2 license](http://www.apache.org/licenses/LICENSE-2.0)), for (de)serializing JSON.
 * [docker-java](https://github.com/docker-java/docker-java) (version 2.1.4 under [Apache 2 license](http://www.apache.org/licenses/LICENSE-2.0)), for using the JAVA Docker API.
 
 # License

powerapi-cli/build.sbt

@@ -1,9 +1,5 @@
 name := "powerapi-cli"
 
-mappings in Universal += downloadBluecove.value -> s"lib/${downloadBluecove.value.name}"
-
-mappings in Universal += downloadBluecoveGpl.value -> s"lib/${downloadBluecoveGpl.value.name}"
-
 mappings in Universal ++= {
   val dir = baseDirectory.value.getParentFile
 

powerapi-cli/src/main/scala/org/powerapi/app/PowerAPI.scala

@@ -23,27 +23,29 @@
 package org.powerapi.app
 
 import java.lang.management.ManagementFactory
-import org.powerapi.core.target._
-import org.powerapi.module.rapl.RAPLModule
-import org.powerapi.reporter.{FileDisplay, JFreeChartDisplay, ConsoleDisplay}
-import org.powerapi.{PowerDisplay, PowerMonitoring, PowerMeter}
-import org.powerapi.core.power._
-import org.powerapi.module.cpu.dvfs.CpuDvfsModule
-import org.powerapi.module.cpu.simple.{SigarCpuSimpleModule, ProcFSCpuSimpleModule}
-import org.powerapi.module.libpfm._
-import org.powerapi.module.extPMeter.powerspy.PowerSpyModule
-import org.powerapi.module.extPMeter.g5k.G5kOmegaWattModule
+
 import scala.concurrent.duration.DurationInt
 import scala.sys
 import scala.sys.process.stringSeqToProcess
 import scala.util.matching.Regex
 
+import org.powerapi.core.power._
+import org.powerapi.core.target._
+import org.powerapi.module.cpu.dvfs.CpuDvfsModule
+import org.powerapi.module.cpu.simple.{ProcFSCpuSimpleModule, SigarCpuSimpleModule}
+import org.powerapi.module.extpowermeter.g5komegawatt.G5kOmegaWattModule
+import org.powerapi.module.extpowermeter.powerspy.PowerSpyModule
+import org.powerapi.module.extpowermeter.rapl.RAPLModule
+import org.powerapi.module.libpfm.{LibpfmCoreModule, LibpfmCoreProcessModule, LibpfmHelper, LibpfmModule, LibpfmProcessModule}
+import org.powerapi.reporter.{ConsoleDisplay, FileDisplay, JFreeChartDisplay}
+import org.powerapi.{PowerDisplay, PowerMeter, PowerMonitoring}
+
 /**
- * PowerAPI CLI.
- *
- * @author <a href="mailto:maxime.colmant@gmail.com">Maxime Colmant</a>
- * @author <a href="mailto:l.huertas.pro@gmail.com">Loïc Huertas</a>
- */
+  * PowerAPI CLI.
+  *
+  * @author <a href="mailto:maxime.colmant@gmail.com">Maxime Colmant</a>
+  * @author <a href="mailto:l.huertas.pro@gmail.com">Loïc Huertas</a>
+  */
 object PowerAPI extends App {
   val modulesR = """(procfs-cpu-simple|sigar-cpu-simple|cpu-dvfs|libpfm|libpfm-process|libpfm-core|libpfm-core-process|powerspy|g5k-omegawatt|rapl)(,(procfs-cpu-simple|sigar-cpu-simple|cpu-dvfs|libpfm|libpfm-process|libpfm-core|libpfm-core-process|powerspy|g5k-omegawatt|rapl))*""".r
   val aggR = """max|min|geomean|logsum|mean|median|stdev|sum|variance""".r
@@ -107,88 +109,116 @@ object PowerAPI extends App {
   }
 
   def cli(options: List[Map[Symbol, Any]], duration: String, args: List[String]): (List[Map[Symbol, Any]], String) = args match {
-    case Nil => (options, duration)
-    case "modules" :: value :: "--prefix" :: prefix :: "monitor" :: tail if validate(modulesR, value) => {
+    case Nil =>
+      (options, duration)
+    case "modules" :: value :: "--prefix" :: prefix :: "monitor" :: tail if validate(modulesR, value) =>
       val (remainingArgs, monitors) = cliMonitorsSubcommand(List(), Map(), tail.map(_.toString))
       cli(options :+ Map('modules -> value, 'prefix -> Some(prefix), 'monitors -> monitors), duration, remainingArgs)
-    }
-    case "modules" :: value :: "monitor" :: tail if validate(modulesR, value) => {
+    case "modules" :: value :: "monitor" :: tail if validate(modulesR, value) =>
       val (remainingArgs, monitors) = cliMonitorsSubcommand(List(), Map(), tail.map(_.toString))
       cli(options :+ Map('modules -> value, 'prefix -> None, 'monitors -> monitors), duration, remainingArgs)
-    }
-    case "duration" :: value :: tail if validate(durationR, value) => cli(options, value, tail)
-    case option :: tail => println(s"unknown cli option $option"); sys.exit(1)
+    case "duration" :: value :: tail if validate(durationR, value) =>
+      cli(options, value, tail)
+    case option :: tail =>
+      println(s"unknown cli option $option")
+      sys.exit(1)
   }
 
   def cliMonitorsSubcommand(options: List[Map[Symbol, Any]], currentMonitor: Map[Symbol, Any], args: List[String]): (List[String], List[Map[Symbol, Any]]) = args match {
-    case Nil => (List(), options :+ currentMonitor)
-    case "modules" :: value :: "--prefix" :: prefix :: "monitor" :: tail if validate(modulesR, value) => (List("modules", value, "--prefix", prefix, "monitor") ++ tail, options :+ currentMonitor)
-    case "modules" :: value :: "monitor" :: tail if validate(modulesR, value) => (List("modules", value, "monitor") ++ tail, options :+ currentMonitor)
-    case "duration" :: value :: tail if validate(durationR, value) => (List("duration", value) ++ tail, options :+ currentMonitor)
-    case "monitor" :: tail => cliMonitorsSubcommand(options :+ currentMonitor, Map(), tail)
-    case "--frequency" :: value :: tail if validate(durationR, value) => cliMonitorsSubcommand(options, currentMonitor ++ Map('frequency -> value), tail)
-    case "--self" :: tail => cliMonitorsSubcommand(options, currentMonitor + ('targets -> (currentMonitor.getOrElse('targets, Set[Any]()).asInstanceOf[Set[Any]] + Process(ManagementFactory.getRuntimeMXBean.getName.split("@")(0).toInt))), tail)
-    case "--pids" :: value :: tail if validate(pidsR, value) => cliMonitorsSubcommand(options, currentMonitor + ('targets -> (currentMonitor.getOrElse('targets, Set[Any]()).asInstanceOf[Set[Any]] ++ value.split(",").map(pid => Process(pid.toInt)))), tail)
-    case "--apps" :: value :: tail if validate(appsR, value) => cliMonitorsSubcommand(options, currentMonitor + ('targets -> (currentMonitor.getOrElse('targets, Set[Any]()).asInstanceOf[Set[Any]] ++ value.split(",").map(app => Application(app)))), tail)
-    case "--containers" :: value :: tail if validate(containersR, value) => cliMonitorsSubcommand(options, currentMonitor + ('targets -> (currentMonitor.getOrElse('targets, Set[Any]()).asInstanceOf[Set[Any]] ++ value.split(",").map(container => Container(container)))), tail)
-    case "--all" :: tail => cliMonitorsSubcommand(options, currentMonitor + ('targets -> (currentMonitor.getOrElse('targets, Set[Any]()).asInstanceOf[Set[Any]] + All)), tail)
-    case "--agg" :: value :: tail if validate(aggR, value) => cliMonitorsSubcommand(options, currentMonitor ++ Map('agg -> value), tail)
-    case "--console" :: tail => cliMonitorsSubcommand(options, currentMonitor + ('displays -> (currentMonitor.getOrElse('displays, Set[Any]()).asInstanceOf[Set[Any]] + new ConsoleDisplay)), tail)
-    case "--file" :: value :: tail => cliMonitorsSubcommand(options, currentMonitor + ('displays -> (currentMonitor.getOrElse('displays, Set[Any]()).asInstanceOf[Set[Any]] + new FileDisplay(value))), tail)
-    case "--chart" :: tail => cliMonitorsSubcommand(options, currentMonitor + ('displays -> (currentMonitor.getOrElse('displays, Set[Any]()).asInstanceOf[Set[Any]] + new JFreeChartDisplay)), tail)
-    case option :: tail => println(s"unknown monitor option $option"); sys.exit(1)
+    case Nil =>
+      (List(), options :+ currentMonitor)
+    case "modules" :: value :: "--prefix" :: prefix :: "monitor" :: tail if validate(modulesR, value) =>
+      (List("modules", value, "--prefix", prefix, "monitor") ++ tail, options :+ currentMonitor)
+    case "modules" :: value :: "monitor" :: tail if validate(modulesR, value) =>
+      (List("modules", value, "monitor") ++ tail, options :+ currentMonitor)
+    case "duration" :: value :: tail if validate(durationR, value) =>
+      (List("duration", value) ++ tail, options :+ currentMonitor)
+    case "monitor" :: tail =>
+      cliMonitorsSubcommand(options :+ currentMonitor, Map(), tail)
+    case "--frequency" :: value :: tail if validate(durationR, value) =>
+      cliMonitorsSubcommand(options, currentMonitor ++ Map('frequency -> value), tail)
+    case "--self" :: tail =>
+      cliMonitorsSubcommand(options, currentMonitor + ('targets -> (currentMonitor.getOrElse('targets, Set[Any]()).asInstanceOf[Set[Any]] + Process(ManagementFactory.getRuntimeMXBean.getName.split("@")(0).toInt))), tail)
+    case "--pids" :: value :: tail if validate(pidsR, value) =>
+      cliMonitorsSubcommand(options, currentMonitor + ('targets -> (currentMonitor.getOrElse('targets, Set[Any]()).asInstanceOf[Set[Any]] ++ value.split(",").map(pid => Process(pid.toInt)))), tail)
+    case "--apps" :: value :: tail if validate(appsR, value) =>
+      cliMonitorsSubcommand(options, currentMonitor + ('targets -> (currentMonitor.getOrElse('targets, Set[Any]()).asInstanceOf[Set[Any]] ++ value.split(",").map(app => Application(app)))), tail)
+    case "--containers" :: value :: tail if validate(containersR, value) =>
+      cliMonitorsSubcommand(options, currentMonitor + ('targets -> (currentMonitor.getOrElse('targets, Set[Any]()).asInstanceOf[Set[Any]] ++ value.split(",").map(container => Container(container)))), tail)
+    case "--all" :: tail =>
+      cliMonitorsSubcommand(options, currentMonitor + ('targets -> (currentMonitor.getOrElse('targets, Set[Any]()).asInstanceOf[Set[Any]] + All)), tail)
+    case "--agg" :: value :: tail if validate(aggR, value) =>
+      cliMonitorsSubcommand(options, currentMonitor ++ Map('agg -> value), tail)
+    case "--console" :: tail =>
+      cliMonitorsSubcommand(options, currentMonitor + ('displays -> (currentMonitor.getOrElse('displays, Set[Any]()).asInstanceOf[Set[Any]] + new ConsoleDisplay)), tail)
+    case "--file" :: value :: tail =>
+      cliMonitorsSubcommand(options, currentMonitor + ('displays -> (currentMonitor.getOrElse('displays, Set[Any]()).asInstanceOf[Set[Any]] + new FileDisplay(value))), tail)
+    case "--chart" :: tail =>
+      cliMonitorsSubcommand(options, currentMonitor + ('displays -> (currentMonitor.getOrElse('displays, Set[Any]()).asInstanceOf[Set[Any]] + new JFreeChartDisplay)), tail)
+    case option :: tail =>
+      println(s"unknown monitor option $option")
+      sys.exit(1)
   }
 
-  if(args.size == 0) {
+  if (args.isEmpty) {
     printHelp()
     sys.exit(1)
   }
 
   else {
-    if(System.getProperty("os.name").toLowerCase.indexOf("nix") >= 0 || System.getProperty("os.name").toLowerCase.indexOf("nux") >= 0) Seq("bash", "scripts/system.bash").!
-    System.setProperty("java.library.path", "lib")
+    if (System.getProperty("os.name").toLowerCase.indexOf("nix") >= 0 || System.getProperty("os.name").toLowerCase.indexOf("nux") >= 0) Seq("bash", "scripts/system.bash").!
 
     val (configuration, duration) = cli(List(), "3600", args.toList)
 
     var libpfmHelper: Option[LibpfmHelper] = None
 
-    if(configuration.count(powerMeterConf => powerMeterConf('modules).toString.contains("libpfm")) != 0) {
+    if (configuration.count(powerMeterConf => powerMeterConf('modules).toString.contains("libpfm")) != 0) {
       libpfmHelper = Some(new LibpfmHelper)
       libpfmHelper.get.init()
     }
 
-    for(powerMeterConf <- configuration) {
-      val modules = (for(module <- powerMeterConf('modules).toString.split(",")) yield {
+    for (powerMeterConf <- configuration) {
+      val modules = (for (module <- powerMeterConf('modules).toString.split(",")) yield {
         module match {
-          case "procfs-cpu-simple" => ProcFSCpuSimpleModule()
-          case "sigar-cpu-simple" => SigarCpuSimpleModule()
-          case "cpu-dvfs" => CpuDvfsModule()
-          case "libpfm" => LibpfmModule(powerMeterConf('prefix).asInstanceOf[Option[String]], libpfmHelper.get)
-          case "libpfm-process" => LibpfmProcessModule(powerMeterConf('prefix).asInstanceOf[Option[String]], libpfmHelper.get)
-          case "libpfm-core" => LibpfmCoreModule(powerMeterConf('prefix).asInstanceOf[Option[String]], libpfmHelper.get)
-          case "libpfm-core-process" => LibpfmCoreProcessModule(powerMeterConf('prefix).asInstanceOf[Option[String]], libpfmHelper.get)
-          case "powerspy" => PowerSpyModule(powerMeterConf('prefix).asInstanceOf[Option[String]])
-          case "g5k-omegawatt" => G5kOmegaWattModule(powerMeterConf('prefix).asInstanceOf[Option[String]])
-          case "rapl" => RAPLModule()
+          case "procfs-cpu-simple" =>
+            ProcFSCpuSimpleModule()
+          case "sigar-cpu-simple" =>
+            SigarCpuSimpleModule()
+          case "cpu-dvfs" =>
+            CpuDvfsModule()
+          case "libpfm" =>
+            LibpfmModule(powerMeterConf('prefix).asInstanceOf[Option[String]], libpfmHelper.get)
+          case "libpfm-process" =>
+            LibpfmProcessModule(powerMeterConf('prefix).asInstanceOf[Option[String]], libpfmHelper.get)
+          case "libpfm-core" =>
+            LibpfmCoreModule(powerMeterConf('prefix).asInstanceOf[Option[String]], libpfmHelper.get)
+          case "libpfm-core-process" =>
+            LibpfmCoreProcessModule(powerMeterConf('prefix).asInstanceOf[Option[String]], libpfmHelper.get)
+          case "powerspy" =>
+            PowerSpyModule(powerMeterConf('prefix).asInstanceOf[Option[String]])
+          case "g5k-omegawatt" =>
+            G5kOmegaWattModule(powerMeterConf('prefix).asInstanceOf[Option[String]])
+          case "rapl" =>
+            RAPLModule()
         }
       }).toSeq
 
       val powerMeter = PowerMeter.loadModule(modules: _*)
       powerMeters :+= powerMeter
 
-      for(monitorConf <- powerMeterConf('monitors).asInstanceOf[List[Map[Symbol, Any]]]) {
+      for (monitorConf <- powerMeterConf('monitors).asInstanceOf[List[Map[Symbol, Any]]]) {
         val frequency = monitorConf.getOrElse('frequency, "1000").toString.toInt.milliseconds
         val targets = {
           val uniqueTargets = monitorConf.getOrElse('targets, Set(Process(ManagementFactory.getRuntimeMXBean.getName.split("@")(0).toInt))).asInstanceOf[Set[Target]].toSeq
-          if(uniqueTargets.contains(All)) Seq(All) else uniqueTargets
+          if (uniqueTargets.contains(All)) Seq(All) else uniqueTargets
         }
         val agg: Seq[Power] => Power = aggStrToAggFunction(monitorConf.getOrElse('agg, "max").toString.toLowerCase)
         val displays = monitorConf.getOrElse('displays, Set(new ConsoleDisplay)).asInstanceOf[Set[PowerDisplay]]
 
-        val monitor = powerMeter.monitor(frequency)(targets: _*)(agg)
+        val monitor = powerMeter.monitor(targets: _*)(agg).every(frequency)
         monitors :+= monitor
 
-        for(display <- displays) {
+        for (display <- displays) {
           monitor.to(display)
         }
       }
@@ -198,7 +228,7 @@ object PowerAPI extends App {
 
     libpfmHelper match {
       case Some(helper) => helper.deinit()
-      case _ => {}
+      case _ =>
     }
   }
 

powerapi-cli/src/universal/conf/application.conf

@@ -1,2 +1,3 @@
 include "akka"
+include "rapl"
 include "powerapi"

powerapi-cli/src/universal/conf/log4j2.xml

@@ -21,7 +21,7 @@
   ~
   ~ If not, please consult http://www.gnu.org/licenses/agpl-3.0.html.
   -->
-<Configuration status="INFO">
+<Configuration shutdownHook="disable" status="INFO">
     <Appenders>
         <Console name="Console" target="SYSTEM_OUT">
             <PatternLayout pattern="[%level] [%d{MM/dd/yyyy HH:mm:ss.SSS}] [%t] [%logger{36}] - %msg%n" />

powerapi-cli/src/universal/conf/logback.xml

@@ -0,0 +1,13 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<configuration scan="true">
+  <appender name="Console" class="ch.qos.logback.core.ConsoleAppender">
+    <encoder>
+      <charset>UTF-8</charset>
+      <Pattern>[%-5level] [d{MM/dd/yyyy HH:mm:ss.SSS}] [%thread] [%logger{36}] - %msg%n</Pattern>
+    </encoder>
+  </appender>
+
+  <root level="ERROR">
+    <appender-ref ref="Console"/>
+  </root>
+</configuration>

powerapi-cli/src/universal/conf/rapl.conf

@@ -0,0 +1,9 @@
+rapl.supported-architectures = [
+  {id = 42, model = "Sandybridge"}
+  {id = 45, model = "Sandybridge-EP"}
+  {id = 58, model = "Ivybridge"}
+  {id = 62, model = "Ivybridge-EP"}
+  {id = 60, model = "Haswell"}
+  {id = 63, model = "Haswell-EP"}
+  {id = 61, model = "Broadwell"}
+]