Add rpc commands to control logging categories and initialization of categories in init

Author: jamescowens

src/Makefile.am

@@ -181,6 +181,7 @@ GRIDCOIN_CORE_CPP = addrdb.cpp \
 	rpcblockchain.cpp \
 	rpcclient.cpp \
 	rpcdump.cpp \
+	rpcmisc.cpp \
 	rpcmining.cpp \
 	rpcnet.cpp \
 	rpcprotocol.cpp \

src/init.cpp

@@ -339,9 +339,9 @@ void InitLogging()
     LogInstance().m_log_time_micros = GetBoolArg("-logtimemicros", DEFAULT_LOGTIMEMICROS);
     LogInstance().m_log_threadnames = GetBoolArg("-logthreadnames", DEFAULT_LOGTHREADNAMES);
 
-    BCLog::LogFlags flags = BCLog::LogFlags::ALL;
+    //BCLog::LogFlags flags = BCLog::LogFlags::ALL;
 
-    LogInstance().EnableCategory(flags);
+    //LogInstance().EnableCategory(flags);
 
     //printf("LogInstance().GetCategoryMask() = %x\n", LogInstance().GetCategoryMask());
 
@@ -357,6 +357,52 @@ void InitLogging()
             LogInstance().ShrinkDebugFile();
         }
     }
+
+    if (IsArgSet("-debug"))
+    {
+        // Special-case: if -debug=0/-nodebug is set, turn off debugging messages
+        std::vector<std::string> categories;
+
+        if (mapArgs.count("-debug") && mapMultiArgs["-debug"].size() > 0)
+        {
+            for (auto const& sSubParam : mapMultiArgs["-debug"])
+            {
+                categories.push_back(sSubParam);
+            }
+        }
+
+        if (std::none_of(categories.begin(), categories.end(),
+            [](std::string cat){return cat == "0" || cat == "none";}))
+        {
+            for (const auto& cat : categories)
+            {
+                if (!LogInstance().EnableCategory(cat))
+                {
+                    InitWarning(strprintf("Unsupported logging category %s=%s.", "-debug", cat));
+                }
+            }
+        }
+    }
+
+    std::vector<std::string> excluded_categories;
+
+    if (mapArgs.count("-debugexclude") && mapMultiArgs["-debugexclude"].size() > 0)
+    {
+        for (auto const& sSubParam : mapMultiArgs["-debugexclude"])
+        {
+            excluded_categories.push_back(sSubParam);
+        }
+    }
+
+    // Now remove the logging categories which were explicitly excluded
+    for (const std::string& cat : excluded_categories)
+    {
+        if (!LogInstance().DisableCategory(cat))
+        {
+            InitWarning(strprintf("Unsupported logging category %s=%s.", "-debugexclude", cat));
+        }
+    }
+
     if (!LogInstance().StartLogging())
     {
        strprintf("Could not open debug log file %s", LogInstance().m_file_path.string());

src/logging.cpp

@@ -175,6 +175,9 @@ const CLogCategoryDesc LogCategories[] =
     {BCLog::COINDB, "coindb"},
     {BCLog::QT, "qt"},
     {BCLog::LEVELDB, "leveldb"},
+    {BCLog::SCRAPER, "scraper"},
+    {BCLog::MANIFEST, "manifest"},
+    {BCLog::SB, "superblock"},
     {BCLog::ALL, "1"},
     {BCLog::ALL, "all"},
 };
@@ -456,7 +459,7 @@ bool BCLog::Logger::archive(bool fImmediate, fs::path pfile_out)
 
         if (fDeleteOldLogArchives)
         {
-            unsigned int nRetention = (unsigned int)GetArg("-logarchiveretainnumfiles", 14);
+            unsigned int nRetention = (unsigned int)GetArg("-logarchiveretainnumfiles", 30);
             LogPrintf ("INFO: Logger: nRetention %i.", nRetention);
 
             std::set<fs::directory_entry, std::greater <fs::directory_entry>> SortedDirEntries;

src/logging.h

@@ -76,6 +76,9 @@ namespace BCLog {
         COINDB      = (1 << 18),
         QT          = (1 << 19),
         LEVELDB     = (1 << 20),
+        SCRAPER     = (1 << 21),
+        MANIFEST    = (1 << 22),
+        SB          = (1 << 23),
         ALL         = ~(uint32_t)0,
     };
 

src/rpcmisc.cpp

@@ -0,0 +1,84 @@
+// Copyright (c) 2012-2019 The Bitcoin developers
+// Copyright (c) 2019 The Gridcoin developers.
+// Distributed under the MIT/X11 software license, see the accompanying
+// file COPYING or http://www.opensource.org/licenses/mit-license.php.
+
+#include "rpcprotocol.h"
+#include "util.h"
+
+#include <univalue.h>
+
+using namespace std;
+
+static void EnableOrDisableLogCategories(UniValue cats, bool enable) {
+
+    std::vector<std::string> vcats;
+
+    // The below is to allow non-array parameters. The current front-end for Gridcoin does not
+    // understand JSON parameters. This will handle that when it does, and deal with single
+    // parameters too.
+    if (cats.isArray())
+    {
+        for (unsigned int i = 0; i < cats.size(); ++i)
+        {
+            vcats.push_back(cats[i].get_str());
+        }
+    }
+    else
+    {
+        vcats.push_back(cats.get_str());
+    }
+
+    for (const auto& cat : vcats)
+    {
+        bool success;
+        if (enable) {
+            LogPrintf("INFO: EnableOrDisableLogCategories: enabling category %s", cat);
+            success = LogInstance().EnableCategory(cat);
+        } else {
+            LogPrintf("INFO: EnableOrDisableLogCategories: disabling category %s", cat);
+            success = LogInstance().DisableCategory(cat);
+        }
+
+        if (!success) {
+            throw JSONRPCError(RPC_INVALID_PARAMETER, "unknown logging category " + cat);
+        }
+    }
+}
+
+UniValue logging(const UniValue& params, bool fHelp)
+{
+    if (fHelp || params.size() > 2)
+    {
+        throw runtime_error(
+           "logging [json array category adds] [json array category removes]\n"
+            "Gets and sets the logging configuration.\n"
+            "When called without an argument, returns the list of categories with status that are currently being debug logged or not.\n"
+            "When called with arguments, adds or removes categories from debug logging and return the lists above.\n"
+            "The arguments are evaluated in order \"include\", \"exclude\".\n"
+            "If an item is both included and excluded, it will thus end up being excluded.\n"
+            "The valid logging categories are: " + ListLogCategories() + "\n"
+            "In addition, the following are available as category names with special meanings:\n"
+            "all or 1: represent all logging categories.\n"
+            "none or 0: even if other logging categories are specified, ignore all of them.\n\n"
+            "Examples:\n"
+            "logging all net: enables all and disables net.\n"
+            "logging none: disables all.\n\n"
+            "Note that unlike Bitcoin, we don't process JSON arrays correctly as arguments yet for the command line,\n"
+            "so, for the rpc cli, it is limited to one enable and/or one disable category.\n"
+            );
+    }
+
+    if (params.size() >= 1) EnableOrDisableLogCategories(params[0], true);
+
+    if (params.size() == 2) EnableOrDisableLogCategories(params[1], false);
+
+    UniValue result(UniValue::VOBJ);
+    std::vector<CLogCategoryActive> vLogCatActive = ListActiveLogCategories();
+    for (const auto& logCatActive : vLogCatActive) {
+        result.pushKV(logCatActive.category, logCatActive.active);
+    }
+
+    return result;
+}
+

src/rpcserver.cpp

@@ -371,6 +371,7 @@ static const CRPCCommand vRPCCommands[] =
     { "getsupervotes",           &rpc_getsupervotes,       cat_developer     },
     { "listdata",                &listdata,                cat_developer     },
     { "listprojects",            &listprojects,            cat_developer     },
+    { "logging",                 &logging,                 cat_developer     },
     { "memorizekeys",            &memorizekeys,            cat_developer     },
     { "network",                 &network,                 cat_developer     },
     { "projects",                &projects,                cat_developer     },

src/rpcserver.h

@@ -189,6 +189,7 @@ extern UniValue rpc_getblockstats(const UniValue& params, bool fHelp);
 extern UniValue getlistof(const UniValue& params, bool fHelp);
 extern UniValue listdata(const UniValue& params, bool fHelp);
 extern UniValue listprojects(const UniValue& params, bool fHelp);
+extern UniValue logging(const UniValue& params, bool fHelp);
 extern UniValue memorizekeys(const UniValue& params, bool fHelp);
 extern UniValue network(const UniValue& params, bool fHelp);
 extern UniValue projects(const UniValue& params, bool fHelp);

src/scraper/scraper.cpp

@@ -310,7 +310,7 @@ class ScraperLogger
 
             if (fDeleteOldLogArchives)
             {
-                unsigned int nRetention = (unsigned int)GetArg("-logarchiveretainnumfiles", 14);
+                unsigned int nRetention = (unsigned int)GetArg("-logarchiveretainnumfiles", 30);
                 LogPrintf ("INFO: ScraperLogger: nRetention %i.", nRetention);
 
                 std::set<fs::directory_entry, std::greater <fs::directory_entry>> SortedDirEntries;

src/util.cpp

@@ -435,6 +435,11 @@ bool GetBoolArg(const std::string& strArg, bool fDefault)
     return fDefault;
 }
 
+bool IsArgSet(const std::string& strArg)
+{
+    return !(GetArg(strArg, "never_used_as_argument") == "never_used_as_argument");
+}
+
 bool IsArgNegated(const std::string& strArg)
 {
     return GetArg(strArg, "true") == "false";

src/util.h

@@ -327,6 +327,20 @@ int64_t GetArg(const std::string& strArg, int64_t nDefault);
  */
 bool GetBoolArg(const std::string& strArg, bool fDefault=false);
 
+/**
+ * Return true if argument is set
+ *
+ * @param strArg Argument to get (e.g. "-foo")
+ * @return boolean
+ */
+bool IsArgSet(const std::string& strArg);
+
+/**
+ * Return true if argument is negated
+ *
+ * @param strArg Argument to get (e.g. "-foo")
+ * @return boolean
+ */
 bool IsArgNegated(const std::string& strArg);
 
 /**