#!/usr/bin/php -q This script is only meant to run at the command line.'); } /* we are not talking to the browser */ $no_http_headers = true; $dir = dirname(__FILE__); chdir($dir); if (strpos($dir, 'boost') !== false) { chdir('../../'); } /* include important functions */ include_once('./include/global.php'); include_once($config['base_path'] . '/lib/poller.php'); include_once($config['base_path'] . '/lib/boost.php'); include_once($config['base_path'] . '/lib/dsstats.php'); /* get the boost polling cycle */ $max_run_duration = read_config_option('boost_rrd_update_max_runtime'); /* process calling arguments */ $parms = $_SERVER['argv']; array_shift($parms); $debug = false; $forcerun = false; $verbose = false; if (sizeof($parms)) { foreach($parms as $parameter) { if (strpos($parameter, '=')) { list($arg, $value) = explode('=', $parameter); } else { $arg = $parameter; $value = ''; } switch ($arg) { case '-d': case '--debug': $debug = true; break; case '-f': case '--force': $forcerun = true; break; case '--verbose': $verbose = true; break; case '--version': case '-V': case '-v': display_version(); exit; case '--help': case '-H': case '-h': display_help(); exit; default: print 'ERROR: Invalid Parameter ' . $parameter . "\n\n"; display_help(); exit; } } } /* install signal handlers for UNIX only */ if (function_exists('pcntl_signal')) { pcntl_signal(SIGTERM, 'sig_handler'); pcntl_signal(SIGINT, 'sig_handler'); } /* take time and log performance data */ $start = microtime(true); /* let's give this script lot of time to run for ever */ ini_set('max_execution_time', '0'); boost_memory_limit(); if ((read_config_option('boost_rrd_update_enable') == 'on') || $forcerun) { /* turn on the system level updates as that is what dictates "on/off" */ if ((!$forcerun) && (read_config_option('boost_rrd_update_system_enable') != 'on')) { db_execute("REPLACE INTO settings (name,value) VALUES ('boost_rrd_update_system_enable','on')"); } $seconds_offset = read_config_option('boost_rrd_update_interval') * 60; /* find out if it's time to collect device information */ $last_run_time = strtotime(read_config_option('boost_last_run_time')); $next_run_time = strtotime(read_config_option('boost_next_run_time')); /* determine the next start time */ $current_time = time(); if (empty($last_run_time)) { /* since the poller has never run before, let's fake it out */ $next_run_time = $current_time + $seconds_offset; db_execute("REPLACE INTO settings (name, value) VALUES ('boost_last_run_time', '" . date('Y-m-d G:i:s', $current_time) . "')"); $last_run_time = $current_time; } else { $next_run_time = $last_run_time + $seconds_offset; } $time_till_next_run = $next_run_time - $current_time; /* determine if you must output boost table now */ $max_records = read_config_option('boost_rrd_update_max_records'); $current_records = boost_get_total_rows(); if (($time_till_next_run <= 0) || ($forcerun) || ($current_records >= $max_records) || ($next_run_time <= $current_time)) { db_execute("REPLACE INTO settings (name, value) VALUES ('boost_last_run_time', '" . date('Y-m-d G:i:s', $current_time) . "')"); /* output all the rrd data to the rrd files */ $rrd_updates = output_rrd_data($current_time, $forcerun); if ($rrd_updates != '-1') { log_boost_statistics($rrd_updates); $next_run_time = $current_time + $seconds_offset; } else { /* rollback last run time */ db_execute("REPLACE INTO settings (name, value) VALUES ('boost_last_run_time', '" . date('Y-m-d G:i:s', $last_run_time) . "')"); } dsstats_boost_bottom(); api_plugin_hook('boost_poller_bottom'); } /* store the next run time so that people understand */ db_execute("REPLACE INTO settings (name, value) VALUES ('boost_next_run_time', '" . date('Y-m-d G:i:s', $next_run_time) . "')"); } else { /* turn off the system level updates */ if (read_config_option('boost_rrd_update_system_enable') == 'on') { db_execute("REPLACE INTO settings (name,value) VALUES ('boost_rrd_update_system_enable','')"); } $rows = boost_get_total_rows(); if ($rows > 0) { /* determine the time to clear the table */ $current_time = time(); /* output all the rrd data to the rrd files */ $rrd_updates = output_rrd_data($current_time, $forcerun); if ($rrd_updates != '-1') { log_boost_statistics($rrd_updates); } } } purge_cached_png_files($forcerun); exit(0); function sig_handler($signo) { switch ($signo) { case SIGTERM: case SIGINT: cacti_log('WARNING: Boost Poller terminated by user', false, 'BOOST'); /* tell the main poller that we are done */ db_execute("REPLACE INTO settings (name, value) VALUES ('boost_poller_status', 'terminated - end time:" . date('Y-m-d G:i:s') ."')"); exit; break; default: /* ignore all other signals */ } } function output_rrd_data($start_time, $force = false) { global $start, $max_run_duration, $config, $database_default, $debug, $get_memory, $memory_used; include_once($config['base_path'] . '/lib/rrd.php'); $boost_poller_status = read_config_option('boost_poller_status'); $rrd_updates = 0; /* implement process lock control for boost */ if (!db_fetch_cell("SELECT GET_LOCK('poller_boost', 1)")) { if ($debug){ cacti_log('DEBUG: Found lock, so another boost process is running'); } return -1; } /* detect a process that has overrun it's warning time */ if (substr_count($boost_poller_status, 'running')) { $status_array = explode(':', $boost_poller_status); if (!empty($status_array[1])) { $previous_start_time = strtotime($status_array[1]); /* if the runtime was exceeded, allow the next process to run */ if ($previous_start_time + $max_run_duration < $start_time) { cacti_log('WARNING: Detected Poller Boost Overrun, Possible Boost Poller Crash', false, 'BOOST SVR'); } } } /* if the poller is not running, or has never run, start */ /* mark the boost server as running */ db_execute("REPLACE INTO settings (name, value) VALUES ('boost_poller_status', 'running - start time:" . date('Y-m-d G:i:s') ."')"); $current_time = date('Y-m-d G:i:s', $start_time); $rrdtool_pipe = rrd_init(); $runtime_exceeded = false; /* let's set and track memory usage will we */ if (!function_exists('memory_get_peak_usage')) { $get_memory = true; $memory_used = memory_get_usage(); } else { $get_memory = false; } $delayed_inserts = db_fetch_row("SHOW STATUS LIKE 'Not_flushed_delayed_rows'"); while($delayed_inserts['Value']){ cacti_log('BOOST WAIT: Waiting 1s for delayed inserts are made' , true, 'SYSTEM'); usleep(1000000); $delayed_inserts = db_fetch_row("SHOW STATUS LIKE 'Not_flushed_delayed_rows'"); } /* split poller_output_boost */ $archive_table = 'poller_output_boost_arch_' . time(); db_execute("RENAME TABLE poller_output_boost TO $archive_table"); db_execute("CREATE TABLE poller_output_boost LIKE $archive_table"); $more_arch_tables = db_fetch_assoc_prepared("SELECT table_name AS name FROM information_schema.tables WHERE table_schema = ? AND table_name LIKE 'poller_output_boost_arch_%' AND table_name != ?", array($database_default, $archive_table)); if (count($more_arch_tables)) { foreach($more_arch_tables as $table) { $table_name = $table['name']; $rows = db_fetch_cell("SELECT count(*) FROM $table_name"); if (is_numeric($rows) && intval($rows) > 0) { db_execute("INSERT INTO $archive_table SELECT * FROM $table_name"); db_execute("TRUNCATE TABLE $table_name"); } } } if ($archive_table == '') { cacti_log('ERROR: Failed to retrieve archive table name'); return -1; } while (true) { $rows = db_fetch_cell("SELECT count(*) FROM $archive_table"); if ($rows > 0) { $rrd_updates += boost_process_poller_output('', $rrdtool_pipe, $current_time); if ($get_memory) { $cur_memory = memory_get_usage(); if ($cur_memory > $memory_used) { $memory_used = $cur_memory; } } } else { break; } if (((time()-$start) > $max_run_duration) && (!$runtime_exceeded)) { cacti_log('WARNING: RRD On Demand Updater Exceeded Runtime Limits. Continuing to Process!!!'); $runtime_exceeded = true; } } /* tell the main poller that we are done */ db_execute("REPLACE INTO settings (name, value) VALUES ('boost_poller_status', 'complete - end time:" . date('Y-m-d G:i:s') ."')"); /* log memory usage */ if (function_exists('memory_get_peak_usage')) { db_execute("REPLACE INTO settings (name, value) VALUES ('boost_peak_memory', '" . memory_get_peak_usage() . "')"); } else { db_execute("REPLACE INTO settings (name, value) VALUES ('boost_peak_memory', '" . $memory_used . "')"); } rrd_close($rrdtool_pipe); /* cleanup - remove empty arch tables */ $tables = db_fetch_assoc("SELECT table_name AS name FROM information_schema.tables WHERE table_schema=SCHEMA() AND table_name LIKE 'poller_output_boost_arch_%'"); if (count($tables)) { foreach($tables as $table) { $rows = db_fetch_cell('SELECT count(*) FROM ' . $table['name']); if (is_numeric($rows) && intval($rows) == 0) { db_execute('DROP TABLE ' . $table['name']); } } } db_execute("SELECT RELEASE_LOCK('poller_boost');"); return $rrd_updates; } function log_boost_statistics($rrd_updates) { global $start, $boost_stats_log, $verbose; /* take time and log performance data */ $end = microtime(true); $cacti_stats = sprintf( 'Time:%01.4f ' . 'RRDUpdates:%s', round($end-$start,2), $rrd_updates); /* log to the database */ db_execute_prepared("REPLACE INTO settings (name,value) VALUES ('stats_boost', ?)", array($cacti_stats)); /* log to the logfile */ cacti_log('BOOST STATS: ' . $cacti_stats , true, 'SYSTEM'); if (isset($boost_stats_log)) { $overhead = boost_timer_get_overhead(); $outstr = ''; $timer_cycles = 0; foreach($boost_stats_log as $area => $entry) { if (isset($entry[BOOST_TIMER_TOTAL])) { $outstr .= ($outstr != '' ? ', ' : '') . $area . ':' . round($entry[BOOST_TIMER_TOTAL] - (($overhead * $entry[BOOST_TIMER_CYCLES])/BOOST_TIMER_OVERHEAD_MULTIPLIER), 2); } $timer_cycles += $entry[BOOST_TIMER_CYCLES]; } if ($outstr != '') { $outstr = "RRDUpdates:$rrd_updates, TotalTime:" . round($end - $start, 0) . ', ' . $outstr; $timer_overhead = round((($overhead * $timer_cycles)/BOOST_TIMER_OVERHEAD_MULTIPLIER), 0); if ($timer_overhead > 0) { $outstr .= ", timer_overhead:~$timer_overhead"; } /* log to the database */ db_execute_prepared("REPLACE INTO settings (name,value) VALUES ('stats_detail_boost', ?)", array(str_replace(',', '', $outstr))); /* log to the logfile */ if ($verbose) { cacti_log('BOOST DETAIL STATS: ' . $outstr, true, 'SYSTEM'); } } } } function purge_cached_png_files($forcerun) { /* remove stale png's from the cache. I consider png's stale afer 1 hour */ if ((read_config_option('boost_png_cache_enable') == 'on') || $forcerun) { $cache_directory = read_config_option('boost_png_cache_directory'); $remove_time = time() - 3600; $directory_contents = array(); if (is_dir($cache_directory)) { if ($handle = opendir($cache_directory)) { /* This is the correct way to loop over the directory. */ while (false !== ($file = readdir($handle))) { $directory_contents[] = $file; } closedir($handle); } /* remove age old files */ if (sizeof($directory_contents)) { /* goto the cache directory */ chdir($cache_directory); /* check and fry as applicable */ foreach($directory_contents as $file) { if (is_writable($file)) { $modify_time = filemtime($file); if ($modify_time < $remove_time) { /* only remove jpeg's and png's */ if ((substr_count(strtolower($file), '.png')) || (substr_count(strtolower($file), '.jpg'))) { unlink($file); } } } } } } } } /* do NOT run this script through a web browser */ /* display_version - displays version information */ function display_version() { $version = get_cacti_version(); print "Cacti Boost RRD Update Poller, Version $version " . COPYRIGHT_YEARS . "\n"; } /* display_help - displays the usage of the function */ function display_help () { display_version(); print "\nusage: poller_boost.php [--verbose] [--force] [--debug]\n\n"; print "Cacti's performance boosting poller. This poller will purge the boost cache periodically. You may\n"; print "force the processing of the boost cache by using the --force option.\n\n"; print "Optional:\n"; print " --verbose - Show details logs at the command line\n"; print " --force - Force the execution of a update process\n"; print " --debug - Display verbose output during execution\n\n"; }