Dump only changed ColumnFamilyOptions to the LOG

mrambacher · Nov 19, 2023 · dfaefb3 · dfaefb3
1 parent 0d12087
commit dfaefb3
Show file tree

Hide file tree

Showing 7 changed files with 54 additions and 20 deletions.
diff --git a/db/column_family.cc b/db/column_family.cc
@@ -635,18 +635,18 @@ ColumnFamilyData::ColumnFamilyData(
       compaction_picker_.reset(
           new LevelCompactionPicker(ioptions_, &internal_comparator_));
     }
-
-    if (column_family_set_->NumberOfColumnFamilies() < 10) {
+    {
+      // Dump the ColumnFamilyOptions that have changed from the default
+      // to the logger.
+      auto cf_cfg = CFOptionsAsConfigurable(ColumnFamilyOptions());
+      ConfigOptions config_options;
+      config_options.SetupForLogging(cf_cfg.get());
+      auto cf_str = initial_cf_options_.ToString(config_options, "Options");
       ROCKS_LOG_HEADER(ioptions_.logger,
-                       "--------------- Options for column family [%s]:\n",
-                       name.c_str());
-      initial_cf_options_.Dump(ioptions_.logger);
-    } else {
-      ROCKS_LOG_INFO(ioptions_.logger,
-                     "\t(skipping printing options of [%s])\n", name.c_str());
+                       "--------------- Options for column family [%s]:%s\n",
+                       name.c_str(), cf_str.c_str());
     }
   }
-
   RecalculateWriteStallConditions(mutable_cf_options_);
 
   if (cf_options.table_factory->IsInstanceOf(

diff --git a/include/rocksdb/convenience.h b/include/rocksdb/convenience.h
@@ -57,6 +57,9 @@ struct ConfigOptions {
   // the input DBOptions.  Currently constructs a new object registry.
   explicit ConfigOptions(const DBOptions&);
 
+  // Initializes the ConfigOptions for use for Dump/Log formats
+  ConfigOptions& SetupForLogging(const Configurable* compare = nullptr);
+
   // This enum defines the RocksDB options sanity level.
   enum SanityLevel : unsigned char {
     kSanityLevelNone = 0x01,  // Performs no sanity check at all.
@@ -118,7 +121,7 @@ struct ConfigOptions {
   std::shared_ptr<OptionsFormatter> formatter;
 
   // If set, only changes from this reference version will be serialized.
-  Configurable* compare_to = nullptr;
+  const Configurable* compare_to = nullptr;
 
   bool IsShallow() const { return depth == Depth::kDepthShallow; }
   bool IsDetailed() const {

diff --git a/include/rocksdb/options.h b/include/rocksdb/options.h
@@ -367,6 +367,8 @@ struct ColumnFamilyOptions : public AdvancedColumnFamilyOptions {
   explicit ColumnFamilyOptions(const Options& options);
 
   void Dump(Logger* log) const;
+  std::string ToString(ConfigOptions& config_options,
+                       const std::string& prefix) const;
 };
 
 enum class WALRecoveryMode : char {
@@ -1019,6 +1021,8 @@ struct DBOptions {
   explicit DBOptions(const Options& options);
 
   void Dump(Logger* log) const;
+  std::string ToString(ConfigOptions& config_options,
+                       const std::string& prefix) const;
 
   // Allows OS to incrementally sync files to disk while they are being
   // written, asynchronously, in the background. This operation can be used

diff --git a/options/configurable.cc b/options/configurable.cc
@@ -596,6 +596,20 @@ Status ConfigurableHelper::SerializeOptions(const ConfigOptions& config_options,
           } else if (!single.empty()) {
             props->insert_or_assign(opt_name, single);
           }
+        } else if (compare_to != nullptr && opt_info.ShouldSerialize() &&
+                   opt_info.IsCustomizable() && copy.IsPrintable()) {
+          // We decided that this object has no difference
+          // Check if there are any printable options we would otherwise miss
+          const auto custom = opt_info.AsRawPointer<Customizable>(opt_addr);
+          if (custom != nullptr) {
+            OptionProperties printable;
+            auto nested = OptionTypeInfo::MakePrefix(prefix, opt_name);
+            s = custom->SerializePrintableOptions(copy, nested, &printable);
+            if (s.ok() && !printable.empty()) {
+              props->insert_or_assign(opt_name,
+                                      copy.ToString(nested, printable));
+            }
+          }
         }
       }
     }

diff --git a/options/db_options.cc b/options/db_options.cc
@@ -920,8 +920,7 @@ MutableDBOptions::MutableDBOptions(const DBOptions& options)
 
 void MutableDBOptions::Dump(Logger* log) const {
   ConfigOptions config_options;
-  config_options.depth = ConfigOptions::kDepthPrintable;
-  config_options.formatter = OptionsFormatter::GetLogFormatter();
+  config_options.SetupForLogging();
   auto db_cfg = DBOptionsAsConfigurable(*this);
   auto db_str = db_cfg->ToString(config_options, "Options");
   ROCKS_LOG_HEADER(log, "%s", db_str.c_str());

diff --git a/options/options.cc b/options/options.cc
@@ -150,22 +150,29 @@ DBOptions::DBOptions(const Options& options)
 
 void DBOptions::Dump(Logger* log) const {
   ConfigOptions config_options;
-  config_options.depth = ConfigOptions::kDepthPrintable;
-  config_options.formatter = OptionsFormatter::GetLogFormatter();
-  auto db_cfg = DBOptionsAsConfigurable(*this);
-  auto db_str = db_cfg->ToString(config_options, "Options");
+  config_options.SetupForLogging();
+  auto db_str = ToString(config_options, "Options");
   ROCKS_LOG_HEADER(log, "%s", db_str.c_str());
 }  // DBOptions::Dump
 
+std::string DBOptions::ToString(ConfigOptions& config_options,
+                                const std::string& prefix) const {
+  auto db_cfg = DBOptionsAsConfigurable(*this);
+  return db_cfg->ToString(config_options, prefix);
+}
 void ColumnFamilyOptions::Dump(Logger* log) const {
   ConfigOptions config_options;
-  config_options.depth = ConfigOptions::kDepthPrintable;
-  config_options.formatter = OptionsFormatter::GetLogFormatter();
-  auto cf_cfg = CFOptionsAsConfigurable(*this);
-  auto cf_str = cf_cfg->ToString(config_options, "Options");
+  config_options.SetupForLogging();
+  auto cf_str = ToString(config_options, "Options");
   ROCKS_LOG_HEADER(log, "%s", cf_str.c_str());
 }  // ColumnFamilyOptions::Dump
 
+std::string ColumnFamilyOptions::ToString(ConfigOptions& config_options,
+                                          const std::string& prefix) const {
+  auto cf_cfg = CFOptionsAsConfigurable(*this);
+  return cf_cfg->ToString(config_options, prefix);
+}
+
 void Options::Dump(Logger* log) const {
   DBOptions::Dump(log);
   ColumnFamilyOptions::Dump(log);

diff --git a/options/options_helper.cc b/options/options_helper.cc
@@ -55,6 +55,13 @@ ConfigOptions::ConfigOptions(const DBOptions& db_opts) : env(db_opts.env) {
   registry = ObjectRegistry::NewInstance();
 }
 
+ConfigOptions& ConfigOptions::SetupForLogging(const Configurable* compare) {
+  depth = ConfigOptions::kDepthPrintable;
+  formatter = OptionsFormatter::GetLogFormatter();
+  compare_to = compare;
+  return *this;
+}
+
 std::string ConfigOptions::ToString(const std::string& prefix,
                                     const OptionProperties& props) const {
   if (formatter) {