Merge pull request #70 from sy-c/master

v0.21.0

Author: sy-c

CMakeLists.txt

@@ -26,7 +26,7 @@ endif()
 
 # Define project
 project(ALF
-  VERSION 0.20.0
+  VERSION 0.21.0
   DESCRIPTION "O2 ALF"
   LANGUAGES CXX
 )

README.md

@@ -19,6 +19,11 @@ o2-alf --dim-dns-node thedimdns.cern.ch
 DIM_DNS_NODE=thedimdns.cern.ch
 `
 
+Some extra parameters can be given on the command line (see `o2-alf --help`).
+In particular, the --dim-log-file parameter allows to define a local log file to keep track of all RPC calls received by ALF. A max file size and number of files to rotate can optionnaly be specified (comma-separated list, eg `--dim-log-file=/tmp/alf.log,1000000,4` would limit to max 4 logs file of 1000000 bytes each).
+
+
+
 ### o2-alf-client
 o2-alf-client is the binary of an ALF client used solely for testing purposes. On top of the DIM Nameserver it expects the hostname of the node hosting the ALF server, the card's serial and endpoint, and the link number as command-line arguments. Different arguments to test different types of services are available (run with `--help`).
 

apps/Alf.cxx

@@ -30,6 +30,9 @@
 #include "ReadoutCard/Exception.h"
 #include "ReadoutCard/FirmwareChecker.h"
 
+#include <Common/SimpleLog.h>
+extern SimpleLog alfDebugLog;
+
 namespace ip = boost::asio::ip;
 namespace po = boost::program_options;
 
@@ -55,6 +58,9 @@ class Alf : public AliceO2::Common::Program
     options.add_options()("dim-dns-node",
                           po::value<std::string>(&mOptions.dimDnsNode)->default_value(""),
                           "The DIM DNS node to set the env var if not already set");
+    options.add_options()("dim-log-file",
+                          po::value<std::string>(&mOptions.dimLogFileConfig)->default_value(""),
+                          "Sets the log file to track DIM callbacks: filePath,maxSize,rotateCount");
     options.add_options()("no-fw-check",
                           po::bool_switch(&mOptions.noFirmwareCheck)->default_value(false),
                           "Disable firmware compatibility check");
@@ -73,6 +79,42 @@ class Alf : public AliceO2::Common::Program
     Logger::setFacility("ALF");
     Logger::get() << "ALF server starting..." << LogInfoOps_(5000) << endm;
 
+    if (mOptions.dimLogFileConfig!="") {
+      std::string path;
+      unsigned long maxBytes = 0;    // default if missing
+      unsigned int  maxFiles = 0;   // default if missing
+
+      size_t start = 0;
+      size_t comma = mOptions.dimLogFileConfig.find(',');
+
+      // ---- first (mandatory): path ----
+      if (comma == std::string::npos) {
+        path = mOptions.dimLogFileConfig;
+      } else {
+	path = mOptions.dimLogFileConfig.substr(0, comma);
+	start = comma + 1;
+
+	// ---- second (optional): maxBytes ----
+	comma = mOptions.dimLogFileConfig.find(',', start);
+	if (comma == std::string::npos) {
+	  if (start < mOptions.dimLogFileConfig.size())
+	    maxBytes = std::stoul(mOptions.dimLogFileConfig.substr(start));
+	} else {
+	  maxBytes = std::stoul(mOptions.dimLogFileConfig.substr(start, comma - start));
+	  start = comma + 1;
+
+	  // ---- third (optional): maxFiles ----
+	  if (start < mOptions.dimLogFileConfig.size())
+	    maxFiles = static_cast<unsigned int>(std::stoul(mOptions.dimLogFileConfig.substr(start)));
+	}
+      }
+      alfDebugLog.setLogFile(path.c_str(), maxBytes, maxFiles, 1);
+      alfDebugLog.setOutputFormat(SimpleLog::FormatOption::ShowTimeStamp | SimpleLog::FormatOption::ShowSeveritySymbol | SimpleLog::FormatOption::ShowMessage );
+      alfDebugLog.info("ALF starting");
+    } else {
+      alfDebugLog.setLogFile("/dev/null");
+    }
+
     if (mOptions.dimDnsNode != "") {
       Logger::get() << "Setting DIM_DNS_NODE from argument." << LogDebugDevel_(5001) << endm;
       Logger::get() << "DIM_DNS_NODE=" << mOptions.dimDnsNode << LogDebugDevel_(5001) << endm;
@@ -144,6 +186,8 @@ class Alf : public AliceO2::Common::Program
       alfServer.makeRpcServers(links, mOptions.sequentialRpcs);
     }
 
+    alfDebugLog.info("Ready on DIM DNS %s with ALF id %s", mOptions.dimDnsNode.c_str(), alfId.c_str());
+
     // main thread
     while (!isSigInt()) {
       std::this_thread::sleep_for(std::chrono::seconds(1));
@@ -156,6 +200,7 @@ class Alf : public AliceO2::Common::Program
     bool noFirmwareCheck = false;
     bool sequentialRpcs = false;
     std::string swtWordSize = "low";
+    std::string dimLogFileConfig = "";
   } mOptions;
 };
 

src/DimServices/DimServices.cxx

@@ -23,6 +23,10 @@
 #include "DimServices/DimServices.h"
 #include "Logger.h"
 
+#include <Common/SimpleLog.h>
+SimpleLog alfDebugLog;
+
+
 namespace o2
 {
 namespace alf
@@ -88,16 +92,27 @@ std::string stripPrefix(const std::string& str)
   return str.substr(PREFIX_LENGTH);
 }
 
+// trim a string in place
+inline void rtrim(std::string &s) {
+    s.erase(std::find_if(s.rbegin(), s.rend(), [](unsigned char ch) {
+        return !std::isspace(ch);
+    }).base(), s.end());
+}
+
 void StringRpcServer::rpcHandler()
 {
+  alfDebugLog.info("Request received on %s : %s",mServiceName.c_str(),getString());
   try {
     auto returnValue = mCallback(std::string(getString()));
     setDataString(makeSuccessString(returnValue), *this);
+    rtrim(returnValue);
+    alfDebugLog.info("Request completed: %s", returnValue.c_str());
   } catch (const std::exception& e) {
     if (kDebugLogging) {
       Logger::get() << mServiceName << ": " << e.what() << LogErrorDevel_(5100) << endm;
     }
     setDataString(makeFailureString(e.what()), *this);
+    alfDebugLog.error("Request failure: %s", e.what());
   }
 }