Merge pull request #286 from Derecho-Project/config_debug

Added debug log output for derecho.cfg options

Author: etremel

include/derecho/conf/conf.hpp

@@ -27,7 +27,6 @@ class Conf {
     //String constants for config options
     static constexpr const char* DERECHO_CONTACT_IP = "DERECHO/contact_ip";
     static constexpr const char* DERECHO_CONTACT_PORT = "DERECHO/contact_port";
-    static constexpr const char* DERECHO_LEADER_EXTERNAL_PORT = "DERECHO/leader_external_port";
     static constexpr const char* DERECHO_RESTART_LEADERS = "DERECHO/restart_leaders";
     static constexpr const char* DERECHO_RESTART_LEADER_PORTS = "DERECHO/restart_leader_ports";
     static constexpr const char* DERECHO_LOCAL_ID = "DERECHO/local_id";
@@ -85,7 +84,6 @@ class Conf {
             // [DERECHO]
             {DERECHO_CONTACT_IP, "127.0.0.1"},
             {DERECHO_CONTACT_PORT, "23580"},
-            {DERECHO_LEADER_EXTERNAL_PORT, "32645"},
             {DERECHO_RESTART_LEADERS, "127.0.0.1"},
             {DERECHO_RESTART_LEADER_PORTS, "23580"},
             {DERECHO_LOCAL_ID, "0"},
@@ -126,7 +124,7 @@ class Conf {
             {PERS_PRIVATE_KEY_FILE, "private_key.pem"},
             // [LOGGER]
             {LOGGER_DEFAULT_LOG_NAME, "derecho_debug"},
-            {LOGGER_DEFAULT_LOG_LEVEL, "info"},
+            {LOGGER_DEFAULT_LOG_LEVEL, "debug"},
             {LOGGER_LOG_TO_TERMINAL, "true"},
             {LOGGER_LOG_FILE_DEPTH, "3"}};
 
@@ -206,6 +204,8 @@ class Conf {
     const bool hasCustomizedKey(const std::string& key) const {
         return (this->config.find(key) != this->config.end());
     }
+    /** Returns a string representation of all configuration options in the table, for debugging purposes. */
+    std::string getDebugString() const;
     /**
      * Initialize the singleton from the command line and the configuration files.
      * The command line has higher priority than the configuration files, and the

include/derecho/core/detail/group_impl.hpp

@@ -10,10 +10,6 @@
 #include "derecho_internal.hpp"
 #include "make_kind_map.hpp"
 
-#include <spdlog/async.h>
-#include <spdlog/sinks/rotating_file_sink.h>
-#include <spdlog/sinks/stdout_color_sinks.h>
-
 namespace derecho {
 
 template <typename SubgroupType>
@@ -28,7 +24,7 @@ template <typename SubgroupType>
 uint32_t _Group::get_subgroup_max_payload_size(uint32_t subgroup_num) {
     if (auto gptr = dynamic_cast<GroupProjection<SubgroupType>*>(this)) {
         return gptr->get_subgroup_max_payload_size(subgroup_num);
-    } else 
+    } else
         throw derecho_exception("Error: this top-level group contains no subgroups for the selected type.");
 }
 
@@ -205,6 +201,7 @@ Group<ReplicatedTypes...>::Group(const UserMessageCallbacks& callbacks,
 #else
           factories(make_kind_map<Factory>(factories...)) {
 #endif
+    dbg_default_debug("Starting with configuration options:\n{}", Conf::get()->getDebugString());
     bool in_total_restart = view_manager.first_init();
     // State transfer must complete before an initial view can commit, and must retry if the view is aborted
     bool initial_view_confirmed = false;

src/conf/conf.cpp

@@ -7,6 +7,7 @@
 #include <sys/stat.h>
 #include <unistd.h>
 #include <stdexcept>
+#include <sstream>
 
 namespace derecho {
 
@@ -31,7 +32,6 @@ struct option Conf::long_options[] = {
         // [DERECHO]
         MAKE_LONG_OPT_ENTRY(DERECHO_CONTACT_IP),
         MAKE_LONG_OPT_ENTRY(DERECHO_CONTACT_PORT),
-        MAKE_LONG_OPT_ENTRY(DERECHO_LEADER_EXTERNAL_PORT),
         MAKE_LONG_OPT_ENTRY(DERECHO_RESTART_LEADERS),
         MAKE_LONG_OPT_ENTRY(DERECHO_RESTART_LEADER_PORTS),
         MAKE_LONG_OPT_ENTRY(DERECHO_LOCAL_ID),
@@ -182,6 +182,7 @@ Conf::Conf(int argc, char* argv[], std::optional<std::string> group_conf_file,
         loadFromFile(node_conf_file.value());
     }
     // 2 - load configuration from the command line
+    bool command_options_present = false;
     int c;
     while(1) {
         int option_index = 0;
@@ -194,6 +195,7 @@ Conf::Conf(int argc, char* argv[], std::optional<std::string> group_conf_file,
         switch(c) {
             case 0:
                 this->config[long_options[option_index].name] = optarg;
+                command_options_present = true;
                 break;
 
             case '?':
@@ -203,6 +205,10 @@ Conf::Conf(int argc, char* argv[], std::optional<std::string> group_conf_file,
                 std::cerr << "ignore unknown commandline code:" << c << std::endl;
         }
     }
+    // 3 - warn the user if no options were loaded, since this probably indicates an error
+    if(!group_conf_file && !node_conf_file && !command_options_present) {
+        std::cerr << "Warning: derecho.cfg and derecho_node.cfg not found, and no command-line options specified. Falling back to all default configuration options." << std::endl;
+    }
 }
 
 // should we force the user to call Conf::initialize() by throw an expcetion
@@ -247,6 +253,13 @@ void Conf::loadExtraFile(const std::string& default_file_name, const char* env_v
     singleton->loadFromFile(real_file_name);
 }
 
+std::string Conf::getDebugString() const {
+    std::stringstream debug_str;
+    for(const auto& kv_pair : config) {
+        debug_str << "\t" << kv_pair.first << " = " << kv_pair.second << std::endl;
+    }
+    return debug_str.str();
+}
 
 const std::string& getConfString(const std::string& key) {
     return Conf::get()->getString(key);

src/core/git_version.cpp

@@ -13,8 +13,8 @@ namespace derecho {
 const int MAJOR_VERSION = 2;
 const int MINOR_VERSION = 4;
 const int PATCH_VERSION = 1;
-const int COMMITS_AHEAD_OF_VERSION = 2;
+const int COMMITS_AHEAD_OF_VERSION = 4;
 const char* VERSION_STRING = "2.4.1";
-const char* VERSION_STRING_PLUS_COMMITS = "2.4.1+2";
+const char* VERSION_STRING_PLUS_COMMITS = "2.4.1+4";
 
 }