Use internal StdCout backend (#86)

awegrzyn · web-flow · commit 7c947b0d1066 · 2018-10-30T15:54:52.000+01:00
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -67,7 +67,6 @@ set(INCLUDE_OUTPUT_DIRECTORY "${PROJECT_BINARY_DIR}/include")
 set(SRCS
   src/Monitoring.cxx
   src/Metric.cxx
-  src/Backends/InfoLoggerBackend.cxx
   src/Backends/InfluxDB.cxx
   src/Backends/Flume.cxx
   src/Backends/StdOut.cxx
@@ -83,7 +82,7 @@ set(SRCS
 
 # Backends
 message(STATUS "Backends")
-message(STATUS "  Compiling InfoLoggerBackend backend")
+message(STATUS "  Compiling StdCout backend")
 message(STATUS "  Compiling Flume UDP/JSON backend")
 message(STATUS "  Compiling InfluxDB HTTP and UDP backend")
 
diff --git a/README.md b/README.md
@@ -72,12 +72,16 @@ See table below to find out how to create `URI` for each backend:
 | InfluxDB     | HTTP      | `influxdb-http`        | `/write?db=<db>` | `prod`            |
 | InfluxDB     | UDP       | `influxdb-udp`         | -                | `prod`            |
 | ApMon        | UDP       | `apmon`                | -                | `prod`            |
-| Local InfoLogger | -     | `infologger://`        | -                | `debug`           |
-| InfoLogger   | TCP       | `infologger`           | -                | `prod`            |
+| StdOut       | -         | `stdout`, `infologger` | -                | `debug`           |
 | Flume        | UDP       | `flume`                | -                | `prod`            |
 
 Multiple backends may be used at the same time, URLs should be separated by `,` (comma).
 
+#### StdCout output format
+```
+<timestamp/%Y-%m-%d %X> [METRIC] <name>,<type> <value> <timestamp> <tags>
+```
+
 ### Sending metric
 
 ```cpp
diff --git a/examples/1-Basic.cxx b/examples/1-Basic.cxx
@@ -10,7 +10,7 @@ using namespace o2::monitoring;
 int main() {
   // Configure monitoring
   // Pass string with list of URLs as parameter
-  auto monitoring = MonitoringFactory::Get("infologger://");
+  auto monitoring = MonitoringFactory::Get("stdout://");
   
   // now send an application specific metric
   // 10 is the value
diff --git a/examples/10-Buffering.cxx b/examples/10-Buffering.cxx
@@ -10,7 +10,7 @@ using Monitoring = o2::monitoring::MonitoringFactory;
 int main() {
   // Configure monitoring
   // Pass string with list of URLs as parameter
-  auto monitoring = Monitoring::Get("infologger://");
+  auto monitoring = Monitoring::Get("stdout://");
   monitoring->enableBuffering(10);
 
   // now send an application specific metric
diff --git a/examples/11-AutoUpdate.cxx b/examples/11-AutoUpdate.cxx
@@ -8,7 +8,7 @@
 using namespace o2::monitoring;
 
 int main() {
-  auto monitoring = MonitoringFactory::Get("infologger://");
+  auto monitoring = MonitoringFactory::Get("stdout://");
 
   // Enable periodical value pushing (default every 1s)
   monitoring->enableAutoPush();
diff --git a/examples/2-TaggedMetrics.cxx b/examples/2-TaggedMetrics.cxx
@@ -12,7 +12,7 @@ int main() {
 
   // Configure monitoring
   // Pass string with list of URLs as parameter
-  auto monitoring = Monitoring::Get("infologger://");
+  auto monitoring = Monitoring::Get("stdout://");
 
   // now send an application specific metric with additional tags
   // 10 is the value
diff --git a/examples/3-UserDefinedTimestamp.cxx b/examples/3-UserDefinedTimestamp.cxx
@@ -11,7 +11,7 @@ using o2::monitoring::Metric;
 int main() {
   // Configure monitoring
   // Pass string with list of URLs as parameter
-  auto monitoring = Monitoring::Get("infologger://");
+  auto monitoring = Monitoring::Get("stdout://");
 
   // current timestamp
   std::chrono::time_point<std::chrono::system_clock> timestamp = std::chrono::system_clock::now();
diff --git a/examples/4-RateDerivedMetric.cxx b/examples/4-RateDerivedMetric.cxx
@@ -11,7 +11,7 @@ using DerivedMetricMode =  o2::monitoring::DerivedMetricMode;
 int main() {
   // Configure monitoring
   // Pass string with list of URLs as parameter
-  auto monitoring = Monitoring::Get("infologger://");
+  auto monitoring = Monitoring::Get("stdout://");
 
   // now send at least two metrics to see the result
   for (int i = 0; i < 101; i += 10) {
diff --git a/examples/6-Increment.cxx b/examples/6-Increment.cxx
@@ -11,7 +11,7 @@ using DerivedMetricMode = o2::monitoring::DerivedMetricMode;
 int main() {
   // Configure monitoring
   // Pass string with list of URLs as parameter
-  auto monitoring = Monitoring::Get("infologger://");
+  auto monitoring = Monitoring::Get("stdout://");
 
   // Increment values by ..
   monitoring->send({10, "myIncrementMetric"}, DerivedMetricMode::INCREMENT);
diff --git a/examples/8-Multiple.cxx b/examples/8-Multiple.cxx
@@ -10,7 +10,7 @@ using Monitoring = o2::monitoring::MonitoringFactory;
 int main() {
   // Configure monitoring
   // Pass string with list of URLs as parameter
-  auto monitoring = Monitoring::Get("flume://pcald03.cern.ch:8092");
+  auto monitoring = Monitoring::Get("stdout://");
 
   monitoring->sendGrouped("measurementName", {{20, "myMetricIntMultiple"}, {20.30, "myMetricFloatMultple"}});
   monitoring->send({{201, "myMetricIntMultiple"}, {2.34, "myMetricFloatMultple"}});
diff --git a/examples/9-Timer.cxx b/examples/9-Timer.cxx
@@ -11,7 +11,7 @@ using Monitoring = o2::monitoring::MonitoringFactory;
 int main() {
   // Configure monitoring
   // Pass string with list of URLs as parameter
-  auto monitoring = Monitoring::Get("infologger://");
+  auto monitoring = Monitoring::Get("stdout://");
   
   // Time the execution of the code below
   monitoring->startTimer("measureSleep");
diff --git a/src/Backends/InfoLoggerBackend.cxx b/src/Backends/InfoLoggerBackend.cxx
diff --git a/src/Backends/InfoLoggerBackend.h b/src/Backends/InfoLoggerBackend.h
diff --git a/src/Backends/StdOut.h b/src/Backends/StdOut.h
@@ -18,9 +18,7 @@ namespace monitoring
 namespace backends
 {
 
-/// \brief Backend that injects metrics to InfoLogger
-///
-/// InfoLogger does not support std::chrono::time_point therefore timestamps is converted to unsigned long
+/// \brief Prints metrics to standard output via std::cout
 class StdOut final : public Backend
 {
   public:
@@ -30,15 +28,15 @@ class StdOut final : public Backend
     /// Default destructor
     ~StdOut() = default;
 
-    /// Sends metric to InfoLogger library
+    /// Prints metric
     /// \param metric           reference to metric object    
     void send(const Metric& metric) override;
 
-    /// Sends multiple metrics not related to each other
+    /// Prints vector of metrics
     /// \@param metrics  vector of metrics
     void send(std::vector<Metric>&& metrics) override;
 
-    /// Sending multiple metrics is NOT supported by the InfoLogger therefore it falls back to sending metric one by one
+    /// Prints a metric with multiple values (names are prefixed with measurement)
     /// \param measurement   measurement name
     /// \param metrics  list of metrics
     void sendMultiple(std::string measurement, std::vector<Metric>&& metrics) override;
diff --git a/src/Monitoring.cxx b/src/Monitoring.cxx
@@ -17,14 +17,6 @@
 #include "MonLogger.h"
 #include "ProcessDetails.h"
 
-#include "Backends/InfoLoggerBackend.h"
-#include "Backends/Flume.h"
-
-#ifdef _WITH_APPMON
-#include "Backends/ApMonBackend.h"
-#endif
-#include "Backends/InfluxDB.h"
-
 namespace o2 
 {
 /// ALICE O2 Monitoring system
diff --git a/src/MonitoringFactory.cxx b/src/MonitoringFactory.cxx
@@ -10,7 +10,6 @@
 #include "MonLogger.h"
 #include "UriParser/UriParser.h"
 
-#include "Backends/InfoLoggerBackend.h"
 #include "Backends/StdOut.h"
 #include "Backends/Flume.h"
 #include "Backends/Noop.h"
@@ -28,12 +27,8 @@ namespace o2
 namespace monitoring 
 {
 
-std::unique_ptr<Backend> getInfoLogger(http::url uri) {
-  if (uri.host == "") {
-    return std::make_unique<backends::StdOut>();
-  } else {
-    return std::make_unique<backends::InfoLoggerBackend>(uri.host, uri.port);
-  }
+std::unique_ptr<Backend> getStdOut(http::url) {
+  return std::make_unique<backends::StdOut>();
 }
 
 std::unique_ptr<Backend> getInfluxDb(http::url uri) {
@@ -85,7 +80,8 @@ void MonitoringFactory::SetVerbosity(std::string selected, std::unique_ptr<Backe
 
 std::unique_ptr<Backend> MonitoringFactory::GetBackend(std::string& url) {
   static const std::map<std::string, std::function<std::unique_ptr<Backend>(const http::url&)>> map = {
-    {"infologger", getInfoLogger},
+    {"infologger", getStdOut},
+    {"stdout", getStdOut},
     {"influxdb-udp", getInfluxDb},
     {"influxdb-http", getInfluxDb},
     {"apmon", getApMon},
diff --git a/test/testMonitoring.cxx b/test/testMonitoring.cxx
@@ -16,7 +16,7 @@ using Monitoring = o2::monitoring::MonitoringFactory;
 
 BOOST_AUTO_TEST_CASE(createMonitoring)
 {
-  auto monitoring = Monitoring::Get("infologger://");
+  auto monitoring = Monitoring::Get("stdout://");
 
   int intMetric = 10; 
   std::string stringMetric("monitoringString");
@@ -35,7 +35,7 @@ BOOST_AUTO_TEST_CASE(createMonitoring)
 
 BOOST_AUTO_TEST_CASE(buffering)
 {
-  auto monitoring = Monitoring::Get("infologger://,flume://localhost:1234");
+  auto monitoring = Monitoring::Get("stdout://,flume://localhost:1234");
   monitoring->enableBuffering(10);
   for (int i = 0; i < 25; i++) {
     monitoring->send({10, "myMetricInt"});
@@ -45,14 +45,14 @@ BOOST_AUTO_TEST_CASE(buffering)
 
 BOOST_AUTO_TEST_CASE(testTimer)
 {
-  auto monitoring = Monitoring::Get("infologger://");
+  auto monitoring = Monitoring::Get("stdout://");
   monitoring->startTimer("test");
   monitoring->stopAndSendTimer("timer");
 }
 
 BOOST_AUTO_TEST_CASE(testPush)
 {
-  auto monitoring = Monitoring::Get("infologger://");
+  auto monitoring = Monitoring::Get("stdout://");
   monitoring->enableAutoPush();
   auto& qcMetric = monitoring->getAutoPushMetric("qcMetric");
   auto& qcMetric2 = monitoring->getAutoPushMetric("qcMetric2");
diff --git a/test/testMonitoringFactory.cxx b/test/testMonitoringFactory.cxx
@@ -16,13 +16,10 @@ using Monitoring = o2::monitoring::MonitoringFactory;
 
 BOOST_AUTO_TEST_CASE(verbosity)
 {
-   std::string ilUrl = "infologger://";
+   std::string ilUrl = "stdout://";
    auto il = Monitoring::GetBackend(ilUrl);
    BOOST_CHECK_EQUAL(static_cast<std::underlying_type<backend::Verbosity>::type>(il->getVerbosity()), 1); 
 
-   std::string il2Url = "infologger://127.0.0.1:1234";
-   BOOST_CHECK_THROW(Monitoring::GetBackend(il2Url), std::runtime_error);
-
    std::string influxUrl = "influxdb-udp://127.0.0.1:1234";
    auto influx = Monitoring::GetBackend(influxUrl);
    BOOST_CHECK_EQUAL(static_cast<std::underlying_type<backend::Verbosity>::type>(influx->getVerbosity()), 0); 
@@ -34,7 +31,7 @@ BOOST_AUTO_TEST_CASE(verbosity)
    std::string influxHttpUrl = "influxdb-http://127.0.0.1:1234/write?db=test";
    auto influxHttp = Monitoring::GetBackend(influxHttpUrl);
 
-   std::string ilProdUrl = "infologger:///prod";
+   std::string ilProdUrl = "stdout:///prod";
    auto ilProd = Monitoring::GetBackend(ilProdUrl);
    BOOST_CHECK_EQUAL(static_cast<std::underlying_type<backend::Verbosity>::type>(ilProd->getVerbosity()), 0); 
 }
diff --git a/test/testProcessMonitor.cxx b/test/testProcessMonitor.cxx
