sysio::resource_monitor_plugin_impl Class Reference

Public Member Functions
	resource_monitor_plugin_impl ()
void	set_program_options (options_description &, options_description &cfg)
void	plugin_initialize (const appbase::variables_map &options)
void	plugin_startup ()
void	plugin_shutdown ()
void	monitor_directory (const bfs::path &path)

Detailed Description

Definition at line 40 of file resource_monitor_plugin.cpp.

Constructor & Destructor Documentation

resource_monitor_plugin_impl()

sysio::resource_monitor_plugin_impl::resource_monitor_plugin_impl ( )

inline

Definition at line 42 of file resource_monitor_plugin.cpp.

      :space_handler(system_file_space_provider(), ctx)
      {
      }

Member Function Documentation

monitor_directory()

void sysio::resource_monitor_plugin_impl::monitor_directory ( const bfs::path & path )

inline

Definition at line 132 of file resource_monitor_plugin.cpp.

                                               {
      dlog("${path} registered to be monitored", ("path", path.string()));
      directories_registered.push_back(path);
   }

Here is the call graph for this function:

plugin_initialize()

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

inline

Definition at line 60 of file resource_monitor_plugin.cpp.

                                                               {
      dlog("plugin_initialize");
   
      auto interval = options.at("resource-monitor-interval-seconds").as<uint32_t>();
      SYS_ASSERT(interval >= monitor_interval_min && interval <= monitor_interval_max, chain::plugin_config_exception,
         "\"resource-monitor-interval-seconds\" must be between ${monitor_interval_min} and ${monitor_interval_max}", ("monitor_interval_min", monitor_interval_min) ("monitor_interval_max", monitor_interval_max));
      space_handler.set_sleep_time(interval);
      ilog("Monitoring interval set to ${interval}", ("interval", interval));
   
      auto threshold = options.at("resource-monitor-space-threshold").as<uint32_t>();
      SYS_ASSERT(threshold >= space_threshold_min  && threshold <= space_threshold_max, chain::plugin_config_exception,
         "\"resource-monitor-space-threshold\" must be between ${space_threshold_min} and ${space_threshold_max}", ("space_threshold_min", space_threshold_min) ("space_threshold_max", space_threshold_max));
      space_handler.set_threshold(threshold, threshold - space_threshold_warning_diff);
      ilog("Space usage threshold set to ${threshold}", ("threshold", threshold));
   
      if (options.count("resource-monitor-not-shutdown-on-threshold-exceeded")) {
         // If set, not shutdown
         space_handler.set_shutdown_on_exceeded(false);
         ilog("Shutdown flag when threshold exceeded set to false");
      } else {
         // Default will shut down
         space_handler.set_shutdown_on_exceeded(true);
         ilog("Shutdown flag when threshold exceeded set to true");
      }
 
      auto warning_interval = options.at("resource-monitor-warning-interval").as<uint32_t>();
      SYS_ASSERT(warning_interval >= warning_interval_min && warning_interval <= warning_interval_max, chain::plugin_config_exception,
         "\"resource-monitor-warning-interval\" must be between ${warning_interval_min} and ${warning_interval_max}", ("warning_interval_min", warning_interval_min) ("warning_interval_max", warning_interval_max));
      space_handler.set_warning_interval(warning_interval);
      ilog("Warning interval set to ${warning_interval}", ("warning_interval", warning_interval));
   }

Here is the call graph for this function:

plugin_shutdown()

void sysio::resource_monitor_plugin_impl::plugin_shutdown ( )

inline

Definition at line 121 of file resource_monitor_plugin.cpp.

                          {
      ilog("shutdown...");
   
      ctx.stop();
   
      // Wait for the thread to end
      monitor_thread.join();
   
      ilog("exit shutdown");
   }

plugin_startup()

void sysio::resource_monitor_plugin_impl::plugin_startup ( )

inline

Definition at line 93 of file resource_monitor_plugin.cpp.

                         {
      ilog("Creating and starting monitor thread");
   
      // By now all plugins are initialized.
      // Find out filesystems containing the directories requested
      // so far.
      for ( auto& dir: directories_registered ) {
         space_handler.add_file_system( dir );
   
         // A directory like "data" contains subdirectories like
         // "block". Those subdirectories can mount on different
         // file systems. Make sure they are taken care of.
         for (bfs::directory_iterator itr(dir); itr != bfs::directory_iterator(); ++itr) {
            if (fc::is_directory(itr->path())) {
               space_handler.add_file_system( itr->path() );
            }
         }
      }
   
      monitor_thread = std::thread( [this] {
         fc::set_os_thread_name( "resmon" ); // console_appender uses 9 chars for thread name reporting. 
         space_handler.space_monitor_loop();
   
         ctx.run();
      } );
   }

Here is the call graph for this function:

set_program_options()

void sysio::resource_monitor_plugin_impl::set_program_options ( options_description & , options_description & cfg )

inline

Definition at line 47 of file resource_monitor_plugin.cpp.

                                                                            {
      cfg.add_options()
         ( "resource-monitor-interval-seconds", bpo::value<uint32_t>()->default_value(def_interval_in_secs),
           "Time in seconds between two consecutive checks of resource usage. Should be between 1 and 300" )
         ( "resource-monitor-space-threshold", bpo::value<uint32_t>()->default_value(def_space_threshold),
           "Threshold in terms of percentage of used space vs total space. If used space is above (threshold - 5%), a warning is generated.  Unless resource-monitor-not-shutdown-on-threshold-exceeded is enabled, a graceful shutdown is initiated if used space is above the threshold. The value should be between 6 and 99" )
         ( "resource-monitor-not-shutdown-on-threshold-exceeded",
           "Used to indicate nodeop will not shutdown when threshold is exceeded." )
         ( "resource-monitor-warning-interval", bpo::value<uint32_t>()->default_value(def_monitor_warning_interval),
           "Number of resource monitor intervals between two consecutive warnings when the threshold is hit. Should be between 1 and 450" )
         ;
   }

---

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

• plugins/resource_monitor_plugin/resource_monitor_plugin.cpp