-
-
Notifications
You must be signed in to change notification settings - Fork 445
Expand file tree
/
Copy pathpoller_boost.php
More file actions
1567 lines (1237 loc) · 49.3 KB
/
Copy pathpoller_boost.php
File metadata and controls
1567 lines (1237 loc) · 49.3 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
#!/usr/bin/env php
<?php
/*
+-------------------------------------------------------------------------+
| Copyright (C) 2004-2026 The Cacti Group |
| |
| This program is free software; you can redistribute it and/or |
| modify it under the terms of the GNU General Public License |
| as published by the Free Software Foundation; either version 2 |
| of the License, or (at your option) any later version. |
| |
| This program is distributed in the hope that it will be useful, |
| but WITHOUT ANY WARRANTY; without even the implied warranty of |
| MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
| GNU General Public License for more details. |
+-------------------------------------------------------------------------+
| Cacti: The Complete RRDtool-based Graphing Solution |
+-------------------------------------------------------------------------+
| This code is designed, written, and maintained by the Cacti Group. See |
| about.php and/or the AUTHORS file for specific developer information. |
+-------------------------------------------------------------------------+
| http://www.cacti.net/ |
+-------------------------------------------------------------------------+
*/
if (function_exists('pcntl_async_signals')) {
pcntl_async_signals(true);
} else {
declare(ticks = 100);
}
ini_set('output_buffering', 'Off');
require(__DIR__ . '/include/cli_check.php');
require_once(CACTI_PATH_LIBRARY . '/poller.php');
require_once(CACTI_PATH_LIBRARY . '/boost.php');
require_once(CACTI_PATH_LIBRARY . '/dsstats.php');
require_once(CACTI_PATH_LIBRARY . '/rrdcheck.php');
require_once(CACTI_PATH_LIBRARY . '/rrd.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;
$child = 0;
// for releasing lock on SIGNAL
$current_lock = false;
global $child, $next_run_time, $archive_table, $current_lock;
global $boost_debug, $boost_log, $cacti_log;
// Archive tables that boost_prepare_process_table() assigned to this run. Only
// these may be dropped at the end; tables from a later rotation or an older
// crashed run can still hold unprocessed rows.
global $boost_run_arch_tables;
/** @var array<int, string> $boost_run_arch_tables Populated by boost_prepare_process_table() through the global. */
$boost_run_arch_tables = [];
if (cacti_sizeof($parms)) {
foreach ($parms as $parameter) {
if (str_contains($parameter, '=')) {
[$arg, $value] = explode('=', $parameter, 2);
} else {
$arg = $parameter;
$value = '';
}
switch ($arg) {
case '--child':
$child = intval($value);
break;
case '--archive-table':
if (preg_match('/^poller_output_boost_arch_\d+$/', $value)) {
$archive_table = $value;
}
break;
case '-d':
case '--debug':
$debug = true;
break;
case '-f':
case '--force':
$forcerun = true;
cacti_log('WARNING: Boost Poller forced by command line.', true, 'BOOST');
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);
$start_time = time();
$rrd_updates = -1;
// let's give this script lot of time to run for ever
ini_set('max_execution_time', '0');
boost_memory_limit();
$boost_debug = read_config_option('boost_debug_enabled') == 'on' ? true : false;
$boost_log = read_config_option('path_boost_log');
$cacti_log = read_config_option('path_cactilog');
if ($child == false) {
$current_time = time();
/* find out if it's time to collect device information
* support both old and new formats.
*/
$boost_last_run_time = read_config_option('boost_last_run_time') ?? ($current_time - 3600);
if (!is_numeric($boost_last_run_time)) {
$last_run_time = strtotime($boost_last_run_time);
} elseif (empty($boost_last_run_time)) {
$last_run_time = time() - 3600;
} else {
$last_run_time = $boost_last_run_time;
}
$boost_next_run_time = read_config_option('boost_next_run_time');
if (!empty($boost_next_run_time) && !is_numeric($boost_next_run_time)) {
$next_run_time = strtotime($boost_next_run_time);
} elseif (empty($boost_next_run_time)) {
$next_run_time = time() + 3600;
} else {
$next_run_time = $boost_next_run_time;
}
$seconds_offset = read_config_option('boost_rrd_update_interval') * 60;
$run_now = boost_time_to_run($forcerun, $current_time, $last_run_time, $next_run_time);
if ($run_now) {
/**
* Check to see if the boost log is enabled and the file exists and
* is writable. If it does not exist, create an empty file.
*/
if ($boost_debug && $boost_log != '') {
if (dirname($cacti_log) != dirname($boost_log)) {
cacti_log(sprintf('WARNING: Boost Debug Log location:%s must be in the same directory as the Cacti Log location:%s. Change the path to a correct location', $boost_log, $cacti_log), true, 'BOOST');
} elseif (!file_exists($boost_log)) {
if (is_writable(dirname($boost_log))) {
touch($boost_log);
} else {
cacti_log(sprintf('WARNING: Boost Debug Log %s is not writable. Change the path to a writable location', $boost_log), true, 'BOOST');
}
}
}
/**
* Check to see if there are any poller items to process and if not
* exit cleanly
*/
$poller_items = db_fetch_row('SELECT * FROM poller_output_boost LIMIT 1');
if (!cacti_sizeof($poller_items)) {
cacti_log('INFO: Boost has no items in poller_output_boost to process during this cycle.', true, 'BOOST');
exit(0);
}
// we will warn if the process is taking extra long
if (!register_process_start('boost', 'master', POLLER_ID, read_config_option('boost_rrd_update_max_runtime') * 3)) {
exit(0);
}
boost_debug('Time to Run Boost, Force Run is ' . ($forcerun ? 'true!' : 'false.'));
// Check if processes are running and kill them
boost_kill_running_processes();
// Truncate the rrd_update_counter table
db_execute('TRUNCATE TABLE poller_output_boost_processes');
// Prepare the boost distribution
cacti_log('INFO: Boost preparing tables ...', true, 'BOOST');
$time_start = time();
$continue = boost_prepare_process_table();
$time_end = time();
cacti_log('INFO: Boost prepare tables took ' . ($time_end - $time_start) . ' seconds.', true, 'BOOST');
// prune old memory stats
boost_prune_memstats();
// Launch the boost children
if ($continue) {
cacti_log('INFO: Boost spawning child processes ...', true, 'BOOST');
$expected_children = boost_launch_children();
// exec_background() is non-blocking; children register and finish
// independently. Wait until all launched children are accounted for
// (running or already recorded a completion row) before draining.
// Releasing on the first registration lets a fast child finish, drop
// the running count to 0, and trip the drain exit while siblings are
// still booting -- the parent then drops the archive tables out from
// under them.
$startup_deadline = time() + 30;
while (!boost_all_children_registered($expected_children, boost_processes_running(), boost_completed_children()) && time() < $startup_deadline) {
sleep(1);
}
if (!boost_all_children_registered($expected_children, boost_processes_running(), boost_completed_children())) {
cacti_log(sprintf('WARNING: Boost startup barrier timed out; %d of %d children registered before draining.', boost_processes_running() + boost_completed_children(), $expected_children), true, 'BOOST');
}
// Drain until no child is running and every launched child has
// recorded a completion row, not merely when none are running -- a
// sibling may not have started yet.
while (boost_processes_running() > 0 || boost_completed_children() < $expected_children) {
boost_debug(sprintf('%d Processes Running, %d of %d Completed, Sleeping for 2 seconds.', boost_processes_running(), boost_completed_children(), $expected_children));
sleep(2);
if (boost_processes_running() === 0 && boost_completed_children() < $expected_children) {
// All registered children exited but fewer completion rows than
// expected: a child crashed before recording status. Stop waiting
// so the parent does not spin forever.
cacti_log(sprintf('WARNING: Boost drained with %d of %d completion rows; a child may have crashed.', boost_completed_children(), $expected_children), true, 'BOOST');
break;
}
}
cacti_log('INFO: Boost last child processes ended.', true, 'BOOST');
// tell the main poller that we are done
set_config_option('boost_poller_status', 'complete - end time:' . date('Y-m-d H:i:s'));
// Finish processing post
set_config_option('boost_last_run_time', $current_time);
// output all the rrd data to the rrd files
$rrd_updates = db_fetch_cell('SELECT SUM(status) FROM poller_output_boost_processes');
if ($rrd_updates > 0) {
boost_log_statistics($rrd_updates);
$next_run_time = $current_time + $seconds_offset;
} elseif ($rrd_updates == -1) {
boost_log_statistics(0);
$next_run_time = $current_time + $seconds_offset;
} else { // rollback last run time
set_config_option('boost_last_run_time', $last_run_time);
}
if ($rrd_updates > 0) {
cacti_log('INFO: Boost removing archive tables ...', true, 'BOOST');
// Drop only the tables this run owned. A table created by a later
// rotation, or left by an earlier crashed run, may still hold rows
// that have not been processed; matching on the LIKE pattern would
// destroy those too.
if (cacti_sizeof($boost_run_arch_tables)) {
foreach ($boost_run_arch_tables as $table) {
if (!boost_is_valid_archive_table($table)) {
continue;
}
cacti_log('INFO: Boost removing archive table: ' . $table, true, 'BOOST');
db_execute("DROP TABLE IF EXISTS `$table`");
}
}
dsstats_boost_bottom();
rrdcheck_boost_bottom();
api_plugin_hook('boost_poller_bottom');
}
} else {
// boost_prepare_process_table() set status to 'running' before returning
// false; clear it now so the next run does not trigger a false Overrun warning.
set_config_option('boost_poller_status', 'complete - end time:' . date('Y-m-d H:i:s'));
}
cacti_log('INFO: Boost unregistering master process', true, 'BOOST');
unregister_process('boost', 'master', POLLER_ID, getmypid());
// log the end time of the process
set_config_option('boost_last_end_time', time());
} else {
set_config_option('boost_poller_status', 'complete');
}
// store the next run time so that people understand
if ($rrd_updates > 0 || $rrd_updates == -1) {
if (empty($next_run_time)) {
$next_run_time = time() + $seconds_offset;
}
set_config_option('boost_next_run_time', $next_run_time);
}
boost_purge_cached_png_files($forcerun);
exit(0);
} else {
cacti_log('INFO: Boost register child process ' . $child, true, 'BOOST');
// we will warn if the process is taking extra long
if (!register_process_start('boost', 'child', $child, read_config_option('boost_rrd_update_max_runtime') * 3)) {
exit(0);
}
// output all the rrd data to the rrd files
$rrd_updates = boost_output_rrd_data($child);
db_execute_prepared('INSERT INTO poller_output_boost_processes
(status) VALUES (?)',
[$rrd_updates]);
boost_log_child_statistics($rrd_updates, $child);
unregister_process('boost', 'child', $child);
exit(0);
}
function sig_handler(int $signo) : void {
global $child, $current_lock;
$rrdtool_version = read_config_option('rrdtool_version');
switch ($signo) {
case SIGTERM:
case SIGINT:
cacti_log('WARNING: Boost Poller terminated by user', true, 'BOOST');
// only the parent tracks overall poller status
if (!$child) {
set_config_option('boost_poller_status', 'terminated - end time:' . date('Y-m-d H:i:s'));
}
// release any held GET_LOCK() before exiting; rrdtool >= 1.5 does
// not use these locks, so skip on modern installs
if (cacti_version_compare(get_rrdtool_version(), '1.5', '<')) {
if ($current_lock !== false && $child) {
db_execute_prepared('SELECT RELEASE_LOCK(?)', ["boost.single_ds.$current_lock"]);
} elseif (!$child) {
db_execute_prepared('SELECT RELEASE_ALL_LOCKS()', []);
}
}
if ($child) {
unregister_process('boost', 'child', $child, getmypid());
} else {
unregister_process('boost', 'master', POLLER_ID, getmypid());
}
exit;
default:
// ignore all other signals
}
}
function boost_kill_running_processes() : void {
$processes = db_fetch_assoc_prepared('SELECT *
FROM processes
WHERE tasktype = "boost"
AND pid != ?',
[getmypid()]);
if (cacti_sizeof($processes)) {
foreach ($processes as $p) {
cacti_log(sprintf('WARNING: Killing Boost %s PID %d due to another boost process starting.', ucfirst($p['taskname']), $p['pid']), true, 'BOOST');
posix_kill($p['pid'], SIGTERM);
unregister_process($p['tasktype'], $p['taskname'], $p['taskid'], $p['pid']);
}
}
}
function boost_processes_running() : int {
$running = db_fetch_cell('SELECT COUNT(*)
FROM processes
WHERE tasktype = "boost"
AND taskname = "child"');
return (int) $running;
}
function boost_completed_children() : int {
// Each child inserts one status row when it finishes, so the row count is
// the number of children that have completed this run.
return (int) db_fetch_cell('SELECT COUNT(*) FROM poller_output_boost_processes');
}
function boost_prepare_process_table() : bool {
global $start_time, $archive_table, $max_run_duration, $database_default, $debug, $get_memory, $memory_used;
global $boost_run_arch_tables;
boost_debug('Parallel Process Setup Begins.');
$boost_poller_status = read_config_option('boost_poller_status');
if (!$boost_poller_status) {
$boost_poller_status = 'not started';
}
// 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', true, 'BOOST SVR');
admin_email(__('Cacti System Warning'), __('WARNING: Detected Poller Boost Overrun, Possible Boost Poller Crash', 'BOOST SVR'));
}
}
}
// if the poller is not running, or has never run, start
// mark the boost server as running
set_config_option('boost_poller_status', 'running - start time:' . date('Y-m-d H:i:s'));
$delayed_inserts = db_fetch_row("SHOW STATUS LIKE 'Not_flushed_delayed_rows'");
while (cacti_sizeof($delayed_inserts) && $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'");
}
$time = time();
// split poller_output_boost
$archive_table = 'poller_output_boost_arch_' . $time;
$interim_table = 'poller_output_boost_' . $time;
cacti_log('INFO: Boost rotating poller_output_boost into archive table: ' . $archive_table, true, 'BOOST');
db_execute("CREATE TABLE `{$interim_table}` LIKE poller_output_boost");
db_execute("RENAME TABLE `poller_output_boost` TO `{$archive_table}`, `{$interim_table}` TO `poller_output_boost`");
db_execute("ANALYZE TABLE `{$archive_table}`");
cacti_log('INFO: Boost done rotating poller_output_boost', true, 'BOOST');
$arch_tables = boost_get_arch_table_names($archive_table);
if (!cacti_sizeof($arch_tables)) {
cacti_log('ERROR: Failed to retrieve archive table name - check poller', true, 'BOOST');
return false;
}
// Record the tables this run owns so the end-of-run cleanup drops only
// these, never a table created by a later rotation or left by a prior run.
$boost_run_arch_tables = array_values($arch_tables);
$total_rows = 0;
$per_table_rows = [];
cacti_log('INFO: Boost counting entries in archive tables ...', true, 'BOOST');
foreach ($arch_tables as $table) {
$table_rows = (int) db_fetch_cell("SELECT COUNT(*) FROM `{$table}`");
$total_rows += $table_rows;
$per_table_rows[$table] = $table_rows;
cacti_log('INFO: Boost archive table ' . $table . ' has ' . $table_rows . ' entries.', true, 'BOOST');
}
if ($total_rows == 0) {
boost_debug('ERROR: Failed to retrieve any rows from archive tables');
cacti_log('ERROR: Failed to retrieve any rows from archive tables', true, 'BOOST');
// Drop only confirmed-empty arch tables; skip any whose COUNT(*) was
// non-zero to avoid data loss if boost_get_arch_table_names returned
// a table from a prior run that still holds unprocessed rows.
foreach ($per_table_rows as $table => $rows) {
if ($rows === 0) {
db_execute("DROP TABLE IF EXISTS `{$table}`");
}
}
return false;
} else {
cacti_log('INFO: Boost processing a total of ' . $total_rows . ' entries.', true, 'BOOST');
}
db_execute('CREATE TABLE IF NOT EXISTS poller_output_boost_local_data_ids (
local_data_id int unsigned default "0",
process_handler int unsigned default "0",
PRIMARY KEY (local_data_id),
INDEX process_handler(process_handler))
ENGINE=InnoDB');
db_execute('TRUNCATE poller_output_boost_local_data_ids');
foreach ($arch_tables as $table) {
db_execute("INSERT IGNORE INTO poller_output_boost_local_data_ids
(local_data_id)
SELECT DISTINCT local_data_id
FROM $table");
}
$data_ids = db_fetch_cell('SELECT
COUNT(local_data_id)
FROM poller_output_boost_local_data_ids');
$processes = boost_clamp_parallel(read_config_option('boost_parallel'));
boost_debug("Data Sources:$data_ids, Concurrent Processes:$processes");
$data_ids_per_process = ceil($data_ids / $processes);
$count = 1;
while ($count <= $processes) {
db_execute_prepared('UPDATE poller_output_boost_local_data_ids
SET process_handler = ?
WHERE process_handler = 0
LIMIT ' . $data_ids_per_process,
[$count]);
$count++;
}
boost_debug('Parallel Process Setup Complete. Ready to spawn children.');
return true;
}
function boost_prune_memstats() : void {
$processes = read_config_option('boost_parallel');
db_execute_prepared('DELETE FROM settings
WHERE name LIKE "boost_peak_memory%"
AND REPLACE(name, "boost_peak_memory_", "") > ?',
[$processes]);
}
function boost_launch_children() : int {
global $debug, $archive_table, $boost_log, $boost_debug, $cacti_log;
if (!boost_is_valid_archive_table($archive_table)) {
cacti_log('ERROR: Boost refusing to launch children: archive table not set or invalid', true, 'BOOST');
return 0;
}
$processes = boost_clamp_parallel(read_config_option('boost_parallel'));
$php_binary = read_config_option('path_php_binary');
$redirect_args = '';
if ($boost_debug && $boost_log != '') {
// redirect_args bypasses per-argument escaping, so reject paths with
// shell metacharacters. boost_log_path_is_safe() permits Windows drive
// colons, backslashes, and spaces on win32 without weakening the check.
if (!boost_log_path_is_safe($boost_log)) {
cacti_log('WARNING: Boost log path contains unsafe characters; redirect disabled.', true, 'BOOST');
} elseif (!is_writable($boost_log)) {
boost_debug("WARNING: Boost log '$boost_log' is not writable!");
cacti_log("WARNING: Boost log '$boost_log' is not writable!", true, 'BOOST');
} else {
$redirect_args = '>> ' . $boost_log;
}
}
boost_debug("About to launch $processes processes.");
for ($i = 1; $i <= $processes; $i++) {
boost_debug('Launching Boost Process Number ' . $i);
cacti_log('NOTE: Launching Boost Process Number ' . $i, true, 'BOOST', POLLER_VERBOSITY_MEDIUM);
$child_args = [
CACTI_PATH_BASE . '/poller_boost.php',
'--child=' . $i,
'--archive-table=' . $archive_table,
];
if ($debug) {
$child_args[] = '--debug';
}
exec_background($php_binary, $child_args, $redirect_args);
}
sleep(2);
return $processes;
}
function boost_time_to_run(bool $forcerun, int $current_time, int $last_run_time, int $next_run_time) : bool {
$run_now = false;
boost_debug('Checking if Boost is ready to run.');
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') {
set_config_option('boost_rrd_update_system_enable', 'on');
}
$seconds_offset = read_config_option('boost_rrd_update_interval') * 60;
// Initialize seconds offset, if not set to 2 hours.
// boost_rrd_update_interval is stored in minutes; multiply to get seconds.
if (empty($seconds_offset)) {
set_config_option('boost_rrd_update_interval', 120);
$seconds_offset = 120 * 60;
}
boost_debug('Last Runtime was ' . date('Y-m-d H:i:s', $last_run_time) . " ($last_run_time).");
boost_debug('Next Runtime is ' . date('Y-m-d H:i:s', $next_run_time) . " ($next_run_time).");
// determine the next start 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;
set_config_option('boost_last_run_time', $current_time);
set_config_option('boost_next_run_time', $next_run_time);
$run_now = false;
} else {
$next_run_time = $last_run_time + $seconds_offset;
if ($current_time >= $next_run_time) {
$run_now = true;
set_config_option('boost_next_run_time', $next_run_time);
}
}
// determine if you must output boost table now
$current_records = boost_get_total_rows();
$max_records = read_config_option('boost_rrd_update_max_records');
boost_debug('Records Found:' . $current_records . ', Max Threshold:' . $max_records . '.');
if ($current_records > $max_records) {
$run_now = true;
set_config_option('boost_next_run_time', $next_run_time);
}
if ($forcerun) {
$run_now = true;
set_config_option('boost_next_run_time', $next_run_time);
}
} else {
$pollers = db_fetch_cell('SELECT COUNT(*) FROM pollers WHERE disabled = ""');
if ($pollers > 1) {
boost_debug('Someone attempted to disable boost through there are multiple Data Collectors Defined!');
set_config_option('boost_rrd_update_system_enable', 'on');
} elseif (read_config_option('boost_rrd_update_system_enable') == 'on') {
// turn off the system level updates, we want to disable
set_config_option('boost_rrd_update_system_enable', '');
}
// we are force to run until boost is finished
$rows = boost_get_total_rows();
if ($rows > 0) {
$run_now = true;
}
}
return $run_now;
}
function boost_output_rrd_data(int $child) : mixed {
global $start, $archive_table, $max_run_duration, $database_default, $debug, $get_memory, $memory_used;
$rrd_updates = 0;
$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;
}
boost_debug("Processing RRRtool Output for Boost Process $child");
$arch_tables = boost_get_arch_table_names($archive_table);
if (!cacti_sizeof($arch_tables)) {
cacti_log('ERROR: Failed to retrieve archive table name', true, 'BOOST');
return 0;
}
$total_rows = 0;
foreach ($arch_tables as $table) {
$total_rows += db_fetch_cell_prepared("SELECT COUNT(at.local_data_id)
FROM $table AS at
INNER JOIN poller_output_boost_local_data_ids AS bpt
ON at.local_data_id = bpt.local_data_id
AND bpt.process_handler = ?",
[$child]);
}
if ($total_rows == 0) {
return 0;
}
boost_debug("Processes:$child, TotalRows:$total_rows");
$max_per_select = intval(read_config_option('boost_rrd_update_max_records_per_select'));
if ($max_per_select <= 0) {
$max_per_select = 50000;
}
$data_ids = db_fetch_cell_prepared('SELECT
COUNT(local_data_id)
FROM poller_output_boost_local_data_ids
WHERE process_handler = ?',
[$child]);
$passes = ceil($total_rows / $max_per_select);
$ids_per_pass = ceil($data_ids / $passes);
$curpass = 1;
while ($data_ids > 0) {
boost_debug("Processing $curpass of $passes for Boost Process $child");
$last_id = db_fetch_cell_prepared("SELECT MAX(local_data_id)
FROM (
SELECT local_data_id
FROM poller_output_boost_local_data_ids
WHERE process_handler = ?
ORDER BY local_data_id ASC
LIMIT $ids_per_pass
) AS result",
[$child]);
if (empty($last_id)) {
break;
}
boost_process_local_data_ids($last_id, $child, $rrdtool_pipe);
$curpass++;
$data_ids = db_fetch_cell_prepared('SELECT COUNT(*)
FROM poller_output_boost_local_data_ids
WHERE process_handler = ?',
[$child]);
if (((time() - $start) > $max_run_duration) && (!$runtime_exceeded)) {
cacti_log('WARNING: RRD On Demand Updater Exceeded Runtime Limits. Continuing to Process!!!', true, 'BOOST');
$runtime_exceeded = true;
}
}
boost_debug("Processing Complete for Boost Process $child. It took $curpass passed to complete.");
// log memory usage
if (function_exists('memory_get_peak_usage')) {
set_config_option('boost_peak_memory_' . $child, memory_get_peak_usage());
} else {
set_config_option('boost_peak_memory_' . $child, $memory_used);
}
rrd_close($rrdtool_pipe);
return $total_rows;
}
/**
* boost_process_local_data_ids - grabs data from the 'poller_output' table and feeds the *completed*
* results to RRDTool for processing
*
* @param int $last_id The last id to process
* @param int $child The current process
* @param mixed $rrdtool_pipe The socket that has been opened for the RRDtool operation
*
* @return int The number of processed local_data_ids
*/
function boost_process_local_data_ids(int $last_id, int $child, mixed $rrdtool_pipe) : int {
global $archive_table, $boost_sock, $boost_timeout, $debug, $get_memory, $memory_used, $current_lock;
global $boost_debug, $boost_log;
// cache this call as it takes time
static $archive_tables = false;
static $rrdtool_version = null;
require_once(CACTI_PATH_LIBRARY . '/rrd.php');
// suppress warnings
if (defined('E_DEPRECATED')) {
error_reporting(E_ALL ^ E_DEPRECATED);
} else {
error_reporting(E_ALL);
}
// gather, repair if required and cache the rrdtool version
if ($rrdtool_version === null) {
$rrdtool_ins_version = get_installed_rrdtool_version();
$rrdtool_version = get_rrdtool_version();
if ($rrdtool_ins_version != $rrdtool_version) {
boost_debug('Updating Stored RRDtool version to installed version ' . $rrdtool_ins_version);
cacti_log('NOTE: Updating Stored RRDtool version to installed version ' . $rrdtool_ins_version, true, 'BOOST');
set_config_option('rrdtool_version', $rrdtool_ins_version);
$rrdtool_version = $rrdtool_ins_version;
}
}
// install the boost error handler
set_error_handler('boost_error_handler');
// load system variables needed
$upd_string_len = intval(read_config_option('boost_rrd_update_string_length'));
$rrd_update_interval = intval(read_config_option('boost_rrd_update_interval'));
$data_ids_to_get = intval(read_config_option('boost_rrd_update_max_records_per_select'));
$rrd_field_names = [];
if ($data_ids_to_get <= 0) {
$data_ids_to_get = 50000;
}
if ($archive_tables === false) {
$archive_tables = boost_get_arch_table_names($archive_table);
}
if ($archive_tables === false) {
boost_debug('Failed to determine archive tables');
cacti_log('Failed to determine archive tables', true, 'BOOST');
return 0;
}
if (!cacti_sizeof($rrd_field_names)) {
$rrd_field_names = array_rekey(
db_fetch_assoc_prepared('SELECT ' . SQL_NO_CACHE . '
CONCAT(data_template_id, "_", data_name) AS keyname, data_source_names AS data_source_name
FROM poller_data_template_field_mappings'),
'keyname', ['data_source_name']);
}
$query_string = 'SELECT * FROM (';
$query_string_suffix = 'ORDER BY local_data_id ASC, timestamp ASC, rrd_name ASC';
$sub_query_string = '';
foreach ($archive_tables as $table) {
$sub_query_string .= ($sub_query_string != '' ? ' UNION ALL ' : '') .
" SELECT $table.local_data_id, dl.data_template_id, UNIX_TIMESTAMP(time) AS timestamp, rrd_name, output
FROM $table
INNER JOIN poller_output_boost_local_data_ids AS bpt
ON $table.local_data_id = bpt.local_data_id
INNER JOIN data_local AS dl
ON $table.local_data_id = dl.id
WHERE bpt.local_data_id <= $last_id
AND bpt.process_handler = $child";
}
$query_string = $query_string . $sub_query_string . ') t ' . $query_string_suffix;
boost_timer('get_records', BOOST_TIMER_START);
$results = db_fetch_assoc($query_string);
boost_timer('get_records', BOOST_TIMER_END);
// log memory
if ($get_memory) {
$cur_memory = memory_get_usage();
if ($cur_memory > $memory_used) {
$memory_used = $cur_memory;
}
}
if (cacti_sizeof($results)) {
// create an array keyed off of each .rrd file
$local_data_id = -1;
$time = -1;
$buflen = 0;
$outarray = [];
$locked = false;
$last_update = -1;
$reset_template = true;
$unused_data_source_names = [];
// we are going to blow away all record if ok
$vals_in_buffer = 0;
// initialize some variables
$rrd_tmpl = '';
$rrd_tmplp = [];
$rrd_tmplpts = 0;
$rrd_path = '';
$nt_rrd_field_names = [];
$tv_tmpl = [];
boost_timer('results_cycle', BOOST_TIMER_START);
// go through each poller_output_boost entries and process
foreach ($results as $item) {
if ($local_data_id == $item['local_data_id'] && cacti_sizeof($unused_data_source_names) && isset($unused_data_source_names[$item['rrd_name']])) {
continue;
}
$item['timestamp'] = trim($item['timestamp']);
if (!$locked) {
// acquire lock in order to prevent race conditions, only a problem pre-rrdtool 1.5
if (cacti_version_compare($rrdtool_version, '1.5', '<')) {
while (!db_fetch_cell_prepared('SELECT GET_LOCK(?, 1)', ['boost.single_ds.' . $item['local_data_id']])) {
usleep(50000);
}
}
$current_lock = $item['local_data_id'];
$locked = true;
}
/**
* if the local_data_id changes, we need to flush the buffer
* and discover the template for the next RRDfile.
*/
if ($local_data_id != $item['local_data_id']) {
$unused_data_source_names = array_rekey(
db_fetch_assoc_prepared('SELECT DISTINCT dtr.data_source_name, dtr.data_source_name
FROM data_template_rrd AS dtr
LEFT JOIN graph_templates_item AS gti
ON dtr.id = gti.task_item_id
WHERE dtr.local_data_id = ?
AND gti.task_item_id IS NULL',
[$item['local_data_id']]),
'data_source_name', 'data_source_name'
);
if (cacti_sizeof($unused_data_source_names) && isset($unused_data_source_names[$item['rrd_name']])) {
continue;
}
$reset_template = true;
$nt_rrd_field_names = [];
// release the previous lock
if (cacti_version_compare($rrdtool_version, '1.5', '<')) {
db_execute_prepared('SELECT RELEASE_LOCK(?)', ["boost.single_ds.$local_data_id"]);
}
$current_lock = false;
// acquire lock in order to prevent race conditions, only a problem pre-rrdtool 1.5