Unified object instantiation (#20)

* sendTimed and sendTagged removed as chained method exist
* remove configuration dependency
* Added UriParser (later to be moved to common)
* Modified cmake to avoid errors (to be reverted)
* Defining new api
* Re-enabled tests
* Split protocol with into backend and transport
* Fixed edit uri
* Allow multiple backend init
* Fixed end of non-void function

Author: awegrzyn

CMakeLists.txt

@@ -132,8 +132,6 @@ include_directories(
         ${CMAKE_CURRENT_BINARY_DIR}/include
 )
 
-configure_file(examples/config-default.ini examples/config-default.ini COPYONLY)
-
 set(LIBRARY_NAME Monitoring)
 set(BUCKET_NAME o2_monitoring_bucket)
 O2_GENERATE_LIBRARY()
@@ -162,7 +160,6 @@ set(EXAMPLES
         examples/3-UserDefinedTimestamp
         examples/4-RateDerivedMetric.cxx
         examples/5-Benchmark.cxx
-        examples/6-DedicatedInstance.cxx
         examples/7-Latency.cxx
         examples/8-Multiple.cxx
         )

README.md

@@ -147,16 +147,11 @@ Monitoring::Create("file://../Monitoring/examples/config-default.ini");
 Metric can be sent by one of the following ways:
 1. By creating and moving metric object:
    + `send(Metric&& metric)`
-
-   In addition, two additional methods can be chained:
+   Two additional methods can be chained:
    + `addTags(std::vector<Tag>&& tags)`
    + `setTimestamp(std::chrono::time_point<std::chrono::system_clock>& timestamp)`
 
-2. By providing metric parameters:
-   + `send(T value, std::string name)`
-   + `sendTagged(T value, std::string name, std::vector<Tag>&& tags)`
-   + `sendTimed(T value, std::string name, std::chrono::time_point<std::chrono::system_clock>& timestamp)`
-3. Sending multiple metrics (only InfluxDB and Zabbix are supported, other backends fallback into sending metrics one by one)
+2. Sending multiple metrics (only InfluxDB and Zabbix are supported, other backends fallback into sending metrics one by one)
    + `void send(std::string name, std::vector<Metric>&& metrics)`
 
 ## Derived metrics
@@ -241,11 +236,6 @@ Monitoring::Configure("file://../examples/config-default.ini");
 // 10 is the value
 // myMetric is the name of the metric
 // then vector of key-value tags
-//  
-// 1. by copying value and name and moving tags
-Monitoring::Get().sendTagged(10, "myMetric", {{"tag1", "value1"}, {"tag2", "value2"}});
-
-// 2. by moving value, name and tags
 Monitoring::Get().send(Metric{10, "myMetric"}.addTags({{"tag1", "value1"}, {"tag2", "value2"}}))
 ```
 
@@ -261,13 +251,6 @@ std::chrono::time_point<std::chrono::system_clock> timestamp = std::chrono::syst
 // now send an application specific metric
 // 10 is the value timestamp
 // myCrazyMetric is the name of the metric
-//  
-// 1. by copying all parameters
-Monitoring::Get().sendTimed(10, "myCrazyMetric", timestamp);
-std::this_thread::sleep_for(std::chrono::seconds(1));
-Monitoring::Get().sendTimed(40, "myCrazyMetric", timestamp);
-  
-  // 2. by moving
 Monitoring::Get().send(Metric{10, "myCrazyMetric"}.setTimestamp(timestamp));
 std::this_thread::sleep_for(std::chrono::seconds(1));
 Monitoring::Get().send(Metric{40, "myCrazyMetric"}.setTimestamp(timestamp));

cmake/FindConfiguration.cmake

@@ -2,7 +2,6 @@ find_package(Boost COMPONENTS unit_test_framework program_options system filesys
 find_package(Git QUIET)
 find_package(APMON)
 find_package(CURL)
-find_package(Configuration REQUIRED)
 
 set(extra_deps "")
 set(extra_deps_include "")
@@ -20,14 +19,12 @@ o2_define_bucket(
     o2_monitoring_bucket
 
     DEPENDENCIES
-    ${Configuration_LIBRARIES}
     ${Boost_SYSTEM_LIBRARY}
     ${Boost_FILESYSTEM_LIBRARY}
     ${Boost_PROGRAM_OPTIONS_LIBRARY}
     ${extra_deps}
 
     SYSTEMINCLUDE_DIRECTORIES
     ${Boost_INCLUDE_DIRS}
-    ${Configuration_INCLUDE_DIRS}
     ${extra_deps_include}
 )

cmake/MonitoringDependencies.cmake

@@ -3,25 +3,25 @@
 /// \author Adam Wegrzynek <[email protected]>
 ///
 
-#include "ExampleBoilerplate.cxx"
 #include "Monitoring/MonitoringFactory.h"
+#include "Monitoring/Collector.h"
 
 using Monitoring = AliceO2::Monitoring::MonitoringFactory;
 
-int main(int argc, char *argv[]) {
-
-  // configure monitoring (once per process), pass configuration path as parameter
-  Monitoring::Configure("file://" + GetConfigFromCmdLine(argc, argv));
-
+int main() {
+  // Configure monitoring
+  // Pass string with list of URLs as parameter
+  auto collector = Monitoring::Get("infologger://");
+  
   // now send an application specific metric
   // 10 is the value
   // myMetric is the name of the metric
   //  
   // 1. by copying values
-  Monitoring::Get().send(10, "myMetricInt");
-  Monitoring::Get().send(10.10, "myMetricFloat");
+  collector->send(10, "myMetricInt");
+  collector->send(10.10, "myMetricFloat");
 
   // 2. by creating and moving metric object
-  Monitoring::Get().send({10, "myMetricInt"});
-  Monitoring::Get().send({10.10, "myMetricFloat"});
+  collector->send({10, "myMetricInt"});
+  collector->send({10.10, "myMetricFloat"});
 }	

examples/1-Basic.cxx

@@ -3,25 +3,20 @@
 /// \author Adam Wegrzynek <[email protected]>
 ///
 
-#include "ExampleBoilerplate.cxx"
 #include "Monitoring/MonitoringFactory.h"
 
 using Monitoring = AliceO2::Monitoring::MonitoringFactory;
 using AliceO2::Monitoring::Metric;
 
-int main(int argc, char *argv[]) {
+int main() {
 
-  // configure monitoring (once per process), pass configuration path as parameter
-  Monitoring::Configure("file://" + GetConfigFromCmdLine(argc, argv));
+  // Configure monitoring
+  // Pass string with list of URLs as parameter
+  auto collector = Monitoring::Get("infologger://");
 
   // now send an application specific metric with additional tags
   // 10 is the value
   // myMetric is the name of the metric
   // then vector of key-value tags
-  //
-  // 1. by copying value and name and moving tags
-  Monitoring::Get().sendTagged(10, "myMetric", {{"tag1", "value1"}, {"tag2", "value2"}});
-
-  // 2. by moving value, name and tags
-  Monitoring::Get().send(Metric{10, "myMetric"}.addTags({{"tag1", "value1"}, {"tag2", "value2"}}));
+  collector->send(Metric{10, "myMetric"}.addTags({{"tag1", "value1"}, {"tag2", "value2"}}));
 }

examples/2-TaggedMetrics.cxx

@@ -3,31 +3,23 @@
 /// \author Adam Wegrzynek <[email protected]>
 ///
 
-#include "ExampleBoilerplate.cxx"
 #include "Monitoring/MonitoringFactory.h"
 
 using Monitoring = AliceO2::Monitoring::MonitoringFactory;
 using AliceO2::Monitoring::Metric;
 
-int main(int argc, char *argv[]) {
-
-  // configure monitoring (once per process), pass configuration path as parameter
-  Monitoring::Configure("file://" + GetConfigFromCmdLine(argc, argv));
+int main() {
+  // Configure monitoring
+  // Pass string with list of URLs as parameter
+  auto collector = Monitoring::Get("infologger://");
 
   // current timestamp
   std::chrono::time_point<std::chrono::system_clock> timestamp = std::chrono::system_clock::now();
 
   // now send an application specific metric
   // 10 is the value timestamp
   // myCrazyMetric is the name of the metric
-  //
-  // 1. by copying all parameters
-  Monitoring::Get().sendTimed(10, "myCrazyMetric", timestamp);
-  std::this_thread::sleep_for(std::chrono::seconds(1));
-  Monitoring::Get().sendTimed(40, "myCrazyMetric", timestamp);
-  
-  // 2. by moving
-  Monitoring::Get().send(Metric{10, "myCrazyMetric"}.setTimestamp(timestamp));
+  collector->send(Metric{10, "myCrazyMetric"}.setTimestamp(timestamp));
   std::this_thread::sleep_for(std::chrono::seconds(1));
-  Monitoring::Get().send(Metric{40, "myCrazyMetric"}.setTimestamp(timestamp));
+  collector->send(Metric{40, "myCrazyMetric"}.setTimestamp(timestamp));
 }

examples/3-UserDefinedTimestamp.cxx

@@ -3,21 +3,21 @@
 /// \author Adam Wegrzynek <[email protected]>
 ///
 
-#include "ExampleBoilerplate.cxx"
 #include "Monitoring/MonitoringFactory.h"
 
 using Monitoring = AliceO2::Monitoring::MonitoringFactory;
 
-int main(int argc, char *argv[]) {
-  // configure monitoring (once per process), pass configuration path as parameter
-  Monitoring::Configure("file://" + GetConfigFromCmdLine(argc, argv));
+int main() {
+  // Configure monitoring
+  // Pass string with list of URLs as parameter
+  auto collector = Monitoring::Get("infologger://");
 
   // derived metric :  rate
-  Monitoring::Get().addDerivedMetric("myMetric", AliceO2::Monitoring::DerivedMetricMode::RATE);
+  collector->addDerivedMetric("myMetric", AliceO2::Monitoring::DerivedMetricMode::RATE);
 
   // now send at least two metrics to see the result
   for (int i = 0; i < 101; i += 10) {
-    Monitoring::Get().send(i, "myMetric");
+    collector->send(i, "myMetric");
     std::this_thread::sleep_for(std::chrono::milliseconds(250));
   }
 }

examples/4-RateDerivedMetric.cxx

@@ -22,7 +22,7 @@ int main(int argc, char *argv[]) {
   boost::program_options::options_description desc("Allowed options");
   desc.add_options()
     ("sleep", boost::program_options::value<int>(), "Thread sleep in microseconds")
-    ("config", boost::program_options::value<std::string>()->required(), "Config file path")
+    ("url", boost::program_options::value<std::string>()->required(), "URL to monitoring backend (or list of comma seperated URLs)")
     ("id", boost::program_options::value<std::string>(), "Instance ID")
     ("count", boost::program_options::value<int>(), "Number of metric bunches (x3)")
     ("multiple", boost::program_options::bool_switch()->default_value(false), "Sends multiple metrics per measurement")
@@ -40,12 +40,7 @@ int main(int argc, char *argv[]) {
     count = vm["count"].as<int>();
   }
 
-  try {
-    Monitoring::Configure("file://" + vm["config"].as<std::string>());
-  } catch (std::string &e) {
-    std::cout << "Configuration file not found.\n" << e << std::endl;
-    std::exit(EXIT_FAILURE);
-  }
+  auto collector = Monitoring::Get(vm["url"].as<std::string>());
 
   int add = 0;
   if (count != 0) {
@@ -55,14 +50,14 @@ int main(int argc, char *argv[]) {
 
   if (!vm["multiple"].as<bool>()) {
     for (int i = 0; i <= count; i += add) {
-      Monitoring::Get().send({"string" + std::to_string(intDist(mt)), "stringMetric"});
-      Monitoring::Get().send({doubleDist(mt), "doubleMetric"});
-      Monitoring::Get().send({intDist(mt), "intMetric"});
+      collector->send({"string" + std::to_string(intDist(mt)), "stringMetric"});
+      collector->send({doubleDist(mt), "doubleMetric"});
+      collector->send({intDist(mt), "intMetric"});
       std::this_thread::sleep_for(std::chrono::microseconds(sleep));
     }
   } else {
     for (int i = 0; i <= count; i += add) {
-      Monitoring::Get().send("benchmarkMeasurement",{
+      collector->send("benchmarkMeasurement",{
         {"string" + std::to_string(intDist(mt)), "stringMetric"},
         {doubleDist(mt), "doubleMetric"},
         {intDist(mt), "intMetric"}