Bisq Network Monitor: Babysteps

monitor/README.md

@@ -0,0 +1,57 @@
+# Bisq Network Monitor Node
+
+The Bisq monitor node collects a set of metrics which are of interest to developers and users alike. These metrics are then made available through reporters.
+
+The *Babysteps* release features these metrics:
+- Tor Startup Time: The time it takes to start Tor starting at a clean system, unpacking the shipped Tor binaries, firing up Tor until Tor is connected to the Tor network and ready to use.
+- Tor Roundtrip Time: Given a bootstrapped Tor, the roundtrip time of connecting to a hidden service is measured.
+- Tor Hidden Service Startup Time: Given a bootstrapped Tor, the time it takes to create and announce a freshly created hidden service.
+
+The *Babysteps* release features these reporters:
+- A reporter that simply writes the findings to `System.err`
+- A reporter that reports the findings to a Graphite/Carbon instance using the [plaintext protocol](https://graphite.readthedocs.io/en/latest/feeding-carbon.html#the-plaintext-protocol)
+
+## Configuration
+
+The *Bisq Network Monitor Node* is to be configured via a Java properties file. The location of the file is to be passed as command line parameter:
+
+```
+./bisq-monitor /path/to/your/config.properties
+```
+
+A sample configuration file looks like follows:
+
+```
+## Each Metric is configured via a set of properties.
+##
+## The minimal set of properties required to run a Metric is:
+##
+## YourMetricName.enabled=true|false
+## YourMetricName.run.interval=10 [seconds]
+
+#Edit and uncomment the lines below for your liking
+
+#TorStartupTime Metric
+TorStartupTime.enabled=true
+TorStartupTime.run.interval=100
+TorStartupTime.run.socksPort=90500 # so that there is no interference with a system Tor
+
+#TorRoundtripTime Metric
+TorRoundtripTime.enabled=true
+TorRoundtripTime.run.interval=100
+TorRoundtripTime.run.sampleSize=5
+TorRoundtripTime.run.hosts=http://expyuzz4wqqyqhjn.onion:80 # torproject.org hidden service
+
+#TorHiddenServiceStartupTime Metric
+TorHiddenServiceStartupTime.enabled=true
+TorHiddenServiceStartupTime.run.interval=100
+TorHiddenServiceStartupTime.run.localPort=90501 # so that there is no interference with a system Tor
+TorHiddenServiceStartupTime.run.servicePort=90511 # so that there is no interference with a system Tor
+
+## Reporters are configured via a set of properties as well.
+##
+## In contrast to Metrics, Reporters do not have a minimal set of properties.
+
+#GraphiteReporter
+GraphiteReporter.serviceUrl=http://yourHiddenService.onion:2003
+```

monitor/src/main/java/bisq/monitor/Configurable.java

@@ -20,20 +20,30 @@
 import java.util.Properties;
 
 /**
- * Configurable is configurable.
+ * Does some precomputation for a configurable class.
  * 
  * @author Florian Reimair
  */
 public abstract class Configurable {
 
+    protected Properties configuration = new Properties();
 
-    protected Properties configuration;
     private String name;
 
     /**
-     * Configure the Configurable.
+     * Filters all java properties starting with {@link Configurable#getName()} of
+     * the class and makes them available. Does <em>NOT</em> parse the content of
+     * the properties!
+     * <p>
+     * For example, if the implementing class sets its name (using
+     * {@link Configurable#setName(String)}) to <code>MyName</code>, the list of
+     * properties is scanned for properties starting with <code>MyName</code>.
+     * Matching lines are made available to the class without the prefix. For
+     * example, a property <code>MyName.answer=42</code> is made available as
+     * <code>configuration.getProperty("answer")</code> resulting in
+     * <code>42</code>.
      * 
-     * @param properties
+     * @param properties a set of configuration properties
      */
     public void configure(final Properties properties) {
         // only configure the Properties which belong to us
@@ -52,6 +62,12 @@ protected String getName() {
         return name;
     }
 
+    /**
+     * Set the name used to filter through configuration properties. See
+     * {@link Configurable#configure(Properties)}.
+     * 
+     * @param name
+     */
     protected void setName(String name) {
         this.name = name;
     }

monitor/src/main/java/bisq/monitor/Metric.java

@@ -22,7 +22,10 @@
 import lombok.extern.slf4j.Slf4j;
 
 /**
- * Metric base class.
+ * Starts a Metric (in its own {@link Thread}), manages its properties and shuts
+ * it down gracefully. Furthermore, configuration updates and execution are done
+ * in a thread-save manner. Implementing classes only have to implement the
+ * {@link Metric#execute()} method.
  * 
  * @author Florian Reimair
  */
@@ -79,11 +82,7 @@ protected boolean enabled() {
         return !shutdown;
     }
 
-    /**
-     * Configures the Metric.
-     * 
-     * @param properties
-     */
+    @Override
     public void configure(final Properties properties) {
         synchronized (this) {
             log.info("{} (re)loading config...", getName());
@@ -113,6 +112,7 @@ else if (!configuration.containsKey(INTERVAL))
         }
     }
 
+    @Override
     public void run() {
         while (!shutdown) {
             // if not, execute all the things

monitor/src/main/java/bisq/monitor/Monitor.java

@@ -65,7 +65,7 @@ private void start() throws Throwable {
 
         // assemble Metrics
         // - create reporters
-        ConsoleReporter consoleReporter = new ConsoleReporter();
+//        ConsoleReporter consoleReporter = new ConsoleReporter();
         Reporter graphiteReporter = new GraphiteReporter();
 
         // - add available metrics with their reporters
@@ -89,6 +89,7 @@ private void start() throws Throwable {
         Runtime.getRuntime().addShutdownHook(new Thread() {
             @Override
             public void run() {
+                // set the name of the Thread for debugging purposes
                 setName("shutdownHook");
 
                 for (Metric current : metrics) {
@@ -99,9 +100,7 @@ public void run() {
                 for (Metric current : metrics)
                     try {
                         current.join();
-                    } catch (InterruptedException e) {
-                        // TODO Auto-generated catch block
-                        e.printStackTrace();
+                    } catch (InterruptedException ignore) {
                     }
 
                 log.info("shutting down tor");

monitor/src/test/java/bisq/monitor/MonitorInfrastructureTests.java

@@ -17,7 +17,6 @@
 
 package bisq.monitor;
 
-
 import java.util.HashMap;
 import java.util.Properties;
 
@@ -47,7 +46,6 @@ public boolean active() {
         protected void execute() {
             // do nothing
         }
-
     }
 
     @ParameterizedTest

monitor/src/test/java/bisq/monitor/TorHiddenServiceStartupTimeTests.java

@@ -17,7 +17,6 @@
 
 package bisq.monitor;
 
-
 import java.io.File;
 import java.util.Map;
 import java.util.Properties;
@@ -34,14 +33,18 @@
 
 public class TorHiddenServiceStartupTimeTests {
 
+    private final static File torWorkingDirectory = new File(TorHiddenServiceStartupTimeTests.class.getSimpleName());
+
+    /**
+     * A dummy Reporter for development purposes.
+     */
     private class DummyReporter extends Reporter {
 
         private long result;
 
         @Override
         public void report(long value) {
             result = value;
-
         }
 
         public long results() {
@@ -62,19 +65,16 @@ public void report(Map<String, String> values, String prefix) {
         public void report(long value, String prefix) {
             report(value);
         }
-
     }
 
-    private final static File torWorkingDirectory = new File(TorHiddenServiceStartupTimeTests.class.getSimpleName());
-
     @BeforeAll
     public static void setup() throws TorCtlException {
+        // simulate the tor instance available to all metrics
         Tor.setDefault(new NativeTor(torWorkingDirectory));
     }
 
     @Test
     public void run() throws Exception {
-
         DummyReporter reporter = new DummyReporter();
 
         // configure

monitor/src/test/java/bisq/monitor/TorRoundtripTimeTests.java

@@ -17,9 +17,7 @@
 
 package bisq.monitor;
 
-
 import java.io.File;
-import java.lang.Thread.State;
 import java.util.Map;
 import java.util.Properties;
 
@@ -34,8 +32,16 @@
 
 import bisq.monitor.metric.TorRoundtripTime;
 
+/**
+ * Test the roundtrip time metric against the hidden service of torproject.org.
+ * 
+ * @author Florian Reimair
+ */
 public class TorRoundtripTimeTests {
 
+    /**
+     * A dummy Reporter for development purposes.
+     */
     private class DummyReporter extends Reporter {
 
         private Map<String, String> results;
@@ -63,20 +69,19 @@ public void report(Map<String, String> values, String prefix) {
         public void report(long value, String prefix) {
             report(value);
         }
-
     }
 
     private static File workingDirectory = new File(TorRoundtripTimeTests.class.getSimpleName());
 
     @BeforeAll
     public static void setup() throws TorCtlException {
+        // simulate the tor instance available to all metrics
         Tor.setDefault(new NativeTor(workingDirectory));
     }
 
     @ParameterizedTest
     @ValueSource(strings = { "default", "3", "4", "10" })
     public void run(String sampleSize) throws Exception {
-
         DummyReporter reporter = new DummyReporter();
 
         // configure

monitor/src/test/java/bisq/monitor/TorStartupTimeTests.java

@@ -17,7 +17,6 @@
 
 package bisq.monitor;
 
-
 import java.util.Map;
 import java.util.Properties;
 
@@ -28,15 +27,18 @@
 
 public class TorStartupTimeTests {
 
+    /**
+     * A dummy Reporter for development purposes.
+     */
     private class DummyReporter extends Reporter {
 
         private long result;
 
         @Override
         public void report(long value) {
             result = value;
-
         }
+
         public long results() {
             return result;
         }
@@ -54,7 +56,6 @@ public void report(Map<String, String> values, String prefix) {
         @Override
         public void report(long value, String prefix) {
             report(value);
-
         }
     }