sysio::trace_api_common_impl Struct Reference

Public Member Functions
void	plugin_initialize (const appbase::variables_map &options)
void	plugin_startup ()
void	plugin_shutdown ()

Static Public Member Functions
static void	set_program_options (appbase::options_description &cli, appbase::options_description &cfg)

Public Attributes
boost::filesystem::path	trace_dir
uint32_t	slice_stride = 0
std::optional< uint32_t >	minimum_irreversible_history_blocks
std::optional< uint32_t >	minimum_uncompressed_irreversible_history_blocks
std::shared_ptr< store_provider >	store

Static Public Attributes
static constexpr int32_t	manual_slice_file_value = -1
static constexpr uint32_t	compression_seek_point_stride = 6 * 1024 * 1024

Detailed Description

A common source for information shared between the extraction process and the RPC process

Definition at line 103 of file trace_api_plugin.cpp.

Member Function Documentation

plugin_initialize()

void sysio::trace_api_common_impl::plugin_initialize ( const appbase::variables_map & options )

inline

Definition at line 118 of file trace_api_plugin.cpp.

                                                               {
      auto dir_option = options.at("trace-dir").as<bfs::path>();
      if (dir_option.is_relative())
         trace_dir = app().data_dir() / dir_option;
      else
         trace_dir = dir_option;
      if (auto resmon_plugin = app().find_plugin<resource_monitor_plugin>())
        resmon_plugin->monitor_directory(trace_dir);
 
      slice_stride = options.at("trace-slice-stride").as<uint32_t>();
 
      const int32_t blocks = options.at("trace-minimum-irreversible-history-blocks").as<int32_t>();
      SYS_ASSERT(blocks >= -1, chain::plugin_config_exception,
                 "\"trace-minimum-irreversible-history-blocks\" must be greater to or equal to -1.");
      if (blocks > manual_slice_file_value) {
         minimum_irreversible_history_blocks = blocks;
      }
 
      const int32_t uncompressed_blocks = options.at("trace-minimum-uncompressed-irreversible-history-blocks").as<int32_t>();
      SYS_ASSERT(uncompressed_blocks >= -1, chain::plugin_config_exception,
                 "\"trace-minimum-uncompressed-irreversible-history-blocks\" must be greater to or equal to -1.");
 
      if (uncompressed_blocks > manual_slice_file_value) {
         minimum_uncompressed_irreversible_history_blocks = uncompressed_blocks;
      }
 
      store = std::make_shared<store_provider>(
         trace_dir,
         slice_stride,
         minimum_irreversible_history_blocks,
         minimum_uncompressed_irreversible_history_blocks,
         compression_seek_point_stride
      );
   }

Here is the call graph for this function:

plugin_shutdown()

void sysio::trace_api_common_impl::plugin_shutdown ( )

inline

Definition at line 159 of file trace_api_plugin.cpp.

                          {
      store->stop_maintenance_thread();
   }

plugin_startup()

void sysio::trace_api_common_impl::plugin_startup ( )

inline

Definition at line 153 of file trace_api_plugin.cpp.

                         {
      store->start_maintenance_thread([](const std::string& msg ){
         fc_dlog( _log, msg );
      });
   }

set_program_options()

static void sysio::trace_api_common_impl::set_program_options ( appbase::options_description & cli, appbase::options_description & cfg )

inlinestatic

Definition at line 104 of file trace_api_plugin.cpp.

                                                                                                     {
      auto cfg_options = cfg.add_options();
      cfg_options("trace-dir", bpo::value<bfs::path>()->default_value("traces"),
                  "the location of the trace directory (absolute path or relative to application data dir)");
      cfg_options("trace-slice-stride", bpo::value<uint32_t>()->default_value(10'000),
                  "the number of blocks each \"slice\" of trace data will contain on the filesystem");
      cfg_options("trace-minimum-irreversible-history-blocks", boost::program_options::value<int32_t>()->default_value(-1),
                  "Number of blocks to ensure are kept past LIB for retrieval before \"slice\" files can be automatically removed.\n"
                  "A value of -1 indicates that automatic removal of \"slice\" files will be turned off.");
      cfg_options("trace-minimum-uncompressed-irreversible-history-blocks", boost::program_options::value<int32_t>()->default_value(-1),
                  "Number of blocks to ensure are uncompressed past LIB. Compressed \"slice\" files are still accessible but may carry a performance loss on retrieval\n"
                  "A value of -1 indicates that automatic compression of \"slice\" files will be turned off.");
   }

Here is the caller graph for this function:

Member Data Documentation

compression_seek_point_stride

uint32_t sysio::trace_api_common_impl::compression_seek_point_stride = 6 * 1024 * 1024

staticconstexpr

Definition at line 171 of file trace_api_plugin.cpp.

manual_slice_file_value

int32_t sysio::trace_api_common_impl::manual_slice_file_value = -1

staticconstexpr

Definition at line 170 of file trace_api_plugin.cpp.

minimum_irreversible_history_blocks

std::optional<uint32_t> sysio::trace_api_common_impl::minimum_irreversible_history_blocks

Definition at line 167 of file trace_api_plugin.cpp.

minimum_uncompressed_irreversible_history_blocks

std::optional<uint32_t> sysio::trace_api_common_impl::minimum_uncompressed_irreversible_history_blocks

Definition at line 168 of file trace_api_plugin.cpp.

slice_stride

uint32_t sysio::trace_api_common_impl::slice_stride = 0

Definition at line 165 of file trace_api_plugin.cpp.

store

std::shared_ptr<store_provider> sysio::trace_api_common_impl::store

Definition at line 173 of file trace_api_plugin.cpp.

trace_dir

boost::filesystem::path sysio::trace_api_common_impl::trace_dir

Definition at line 164 of file trace_api_plugin.cpp.

---

The documentation for this struct was generated from the following file:

• plugins/trace_api_plugin/trace_api_plugin.cpp