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
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
|
# -*- perl -*-
package Smokeping;
use strict;
use CGI;
use Getopt::Long;
use Pod::Usage;
use Digest::MD5 qw(md5_base64);
use SNMP_util;
use SNMP_Session;
use POSIX;
use ISG::ParseConfig;
use RRDs;
use Sys::Syslog qw(:DEFAULT setlogsock);
setlogsock('unix')
if grep /^ $^O $/xo, ("linux", "openbsd", "freebsd", "netbsd");
use File::Basename;
use Smokeping::Examples;
# globale persistent variables for speedy
use vars qw($cfg $probes $VERSION $havegetaddrinfo $cgimode);
$VERSION="1.99001";
# we want opts everywhere
my %opt;
BEGIN {
$havegetaddrinfo = 0;
eval 'use Socket6';
$havegetaddrinfo = 1 unless $@;
}
my $DEFAULTPRIORITY = 'info'; # default syslog priority
my $logging = 0; # keeps track of whether we have a logging method enabled
sub find_libdir {
# find the directory where the probe and matcher modules are located
# by looking for 'Smokeping/probes/FPing.pm' in @INC
#
# yes, this is ugly. Suggestions welcome.
for (@INC) {
-f "$_/Smokeping/probes/FPing.pm" or next;
return $_;
}
return undef;
}
sub do_log(@);
sub load_probe($$$$);
sub load_probes ($){
my $cfg = shift;
my %prbs;
foreach my $probe (keys %{$cfg->{Probes}}) {
my @subprobes = grep { ref $cfg->{Probes}{$probe}{$_} eq 'HASH' } keys %{$cfg->{Probes}{$probe}};
if (@subprobes) {
my $modname = $probe;
for my $subprobe (@subprobes) {
$prbs{$subprobe} = load_probe($modname, $cfg->{Probes}{$probe}{$subprobe},$cfg, $subprobe);
}
} else {
$prbs{$probe} = load_probe($probe, $cfg->{Probes}{$probe},$cfg, $probe);
}
}
return \%prbs;
};
sub load_probe ($$$$) {
my $modname = shift;
my $properties = shift;
my $cfg = shift;
my $name = shift;
$name = $modname unless defined $name;
my $rv;
eval '$rv = Smokeping::probes::'.$modname.'->new( $properties,$cfg,$name);';
die "$@\n" if $@;
die "Failed to load Probe $name (module $modname)\n" unless defined $rv;
return $rv;
}
sub snmpget_ident ($) {
my $host = shift;
$SNMP_Session::suppress_warnings = 10; # be silent
my @get = snmpget("${host}::1:1:1", qw(sysContact sysName sysLocation));
return undef unless @get;
my $answer = join "/", grep { defined } @get;
$answer =~ s/\s+//g;
return $answer;
}
sub lnk ($$) {
my ($q, $path) = @_;
if ($q->isa('dummyCGI')) {
return $path . ".html";
} else {
return ($q->script_name() || '') . "?target=" . $path;
}
}
sub update_dynaddr ($$){
my $cfg = shift;
my $q = shift;
my @target = split /\./, $q->param('target');
my $secret = md5_base64($q->param('secret'));
my $address = $ENV{REMOTE_ADDR};
my $targetptr = $cfg->{Targets};
foreach my $step (@target){
return "Error: Unknown Target $step"
unless defined $targetptr->{$step};
$targetptr = $targetptr->{$step};
};
return "Error: Invalid Target"
unless defined $targetptr->{host} and
$targetptr->{host} eq "DYNAMIC/${secret}";
my $file = $cfg->{General}{datadir}."/".(join "/", @target);
my $prevaddress = "?";
my $snmp = snmpget_ident $address;
if (-r "$file.adr" and not -z "$file.adr"){
open(D, "<$file.adr")
or return "Error opening $file.adr: $!\n";
chomp($prevaddress = <D>);
close D;
}
if ( $prevaddress ne $address){
open(D, ">$file.adr.new")
or return "Error writing $file.adr.new: $!";
print D $address,"\n";
close D;
rename "$file.adr.new","$file.adr";
}
if ( $snmp ) {
open (D, ">$file.snmp.new")
or return "Error writing $file.snmp.new: $!";
print D $snmp,"\n";
close D;
rename "$file.snmp.new", "$file.snmp";
} elsif ( -f "$file.snmp") { unlink "$file.snmp" };
}
sub sendmail ($$$){
my $from = shift;
my $to = shift;
$to = $1 if $to =~ /<(.*?)>/;
my $body = shift;
if ($cfg->{General}{mailhost} and
my $smtp = Net::SMTP->new($cfg->{General}{mailhost})){
$smtp->mail($from);
$smtp->to(split(/\s*,\s*/, $to));
$smtp->data();
$smtp->datasend($body);
$smtp->dataend();
$smtp->quit;
} elsif ($cfg->{General}{sendmail} or -x "/usr/lib/sendmail"){
open (M, "|-") || exec (($cfg->{General}{sendmail} || "/usr/lib/sendmail"),"-f",$from,$to);
print M $body;
close M;
} else {
warn "ERROR: not sending mail to $to, as all methodes failed\n";
}
}
sub sendsnpp ($$){
my $to = shift;
my $msg = shift;
if ($cfg->{General}{snpphost} and
my $snpp = Net::SNPP->new($cfg->{General}{snpphost}, Timeout => 60)){
$snpp->send( Pager => $to,
Message => $msg) || do_debuglog("ERROR - ". $snpp->message);
$snpp->quit;
} else {
warn "ERROR: not sending page to $to, as all SNPP setup faild\n";
}
}
sub init_alerts ($){
my $cfg = shift;
foreach my $al (keys %{$cfg->{Alerts}}) {
my $x = $cfg->{Alerts}{$al};
next unless ref $x eq 'HASH';
if ($x->{type} eq 'matcher'){
$x->{pattern} =~ /(\S+)\((.+)\)/
or die "ERROR: Alert $al pattern entry '$_' is invalid\n";
my $matcher = $1;
my $arg = $2;
die "ERROR: matcher $matcher: all matchers start with a capital letter since version 2.0\n"
unless $matcher =~ /^[A-Z]/;
eval 'require Smokeping::matchers::'.$matcher;
die "Matcher '$matcher' could not be loaded: $@\n" if $@;
my $hand;
eval "\$hand = Smokeping::matchers::$matcher->new($arg)";
die "ERROR: Matcher '$matcher' could not be instantiated\nwith arguments $arg:\n$@\n" if $@;
$x->{length} = $hand->Length;
$x->{sub} = sub { $hand->Test(shift) } ;
} else {
my $sub_front = <<SUB;
sub {
my \$d = shift;
my \$y = \$d->{$x->{type}};
for(1){
SUB
my $sub;
my $sub_back = " return 1;\n }\n return 0;\n}\n";
my @ops = split /\s*,\s*/, $x->{pattern};
$x->{length} = scalar grep /^[!=><]/, @ops;
my $multis = scalar grep /^[*]/, @ops;
my $it = "";
for(1..$multis){
my $ind = " " x ($_-1);
$sub .= <<FOR;
$ind my \$i$_;
$ind for(\$i$_=0; \$i$_<\$imax$_;\$i$_++){
FOR
};
my $i = - $x->{length};
my $incr = 0;
for (@ops) {
my $extra = "";
$it = " " x $multis;
for(1..$multis){
$extra .= "-\$i$_";
};
/^(==|!=|<|>|<=|>=|\*)(\d+(?:\.\d*)?|U|S|\d*\*)(%?)$/
or die "ERROR: Alert $al pattern entry '$_' is invalid\n";
my $op = $1;
my $value = $2;
my $perc = $3;
if ($op eq '*') {
if ($value =~ /^([1-9]\d*)\*$/) {
$value = $1;
$x->{length} += $value;
$sub_front .= " my \$imax$multis = $value;\n";
$sub_back .= "\n";
$sub .= <<FOR;
$it last;
$it }
$it return 0 if \$i$multis >= \$imax$multis;
FOR
$multis--;
next;
} else {
die "ERROR: multi-match operator * must be followed by Number* in Alert $al definition\n";
}
} elsif ($value eq 'U') {
if ($op eq '==') {
$sub .= "$it next if defined \$y->[$i$extra];\n";
} elsif ($op eq '!=') {
$sub .= "$it next unless defined \$y->[$i$extra];\n";
} else {
die "ERROR: invalid operator $op in connection U in Alert $al definition\n";
}
} elsif ($value eq 'S') {
if ($op eq '==') {
$sub .= "$it next unless defined \$y->[$i$extra] and \$y->[$i$extra] eq 'S';\n";
} else {
die "ERROR: S is only valid with == operator in Alert $al definition\n";
}
} elsif ($value eq '*') {
if ($op ne '==') {
die "ERROR: operator $op makes no sense with * in Alert $al definition\n";
} # do nothing else ...
} else {
if ( $x->{type} eq 'loss') {
die "ERROR: loss should be specified in % (alert $al pattern)\n" unless $perc eq "%";
} elsif ( $x->{type} eq 'rtt' ) {
$value /= 1000;
} else {
die "ERROR: unknown alert type $x->{type}\n";
}
$sub .= <<IF;
$it next unless defined \$y->[$i$extra]
$it and \$y->[$i$extra] =~ /^\\d/
$it and \$y->[$i$extra] $op $value;
IF
}
$i++;
}
$sub_front .= "$it next if scalar \@\$y < $x->{length} ;\n";
do_debuglog(<<COMP);
### Compiling alert detector pattern '$al'
### $x->{pattern}
$sub_front$sub$sub_back
COMP
$x->{sub} = eval ( $sub_front.$sub.$sub_back );
die "ERROR: compiling alert pattern $al ($x->{pattern}): $@\n" if $@;
}
}
}
sub check_filter ($$) {
my $cfg = shift;
my $name = shift;
# remove the path prefix when filtering and make sure the path again starts with /
my $prefix = $cfg->{General}{datadir};
$name =~ s|^${prefix}/*|/|;
# if there is a filter do neither schedule these nor make rrds
if ($opt{filter} && scalar @{$opt{filter}}){
my $ok = 0;
for (@{$opt{filter}}){
/^\!(.+)$/ && do {
my $rx = $1;
$name !~ /^$rx/ && do{ $ok = 1};
next;
};
/^(.+)$/ && do {
my $rx = $1;
$name =~ /^$rx/ && do {$ok = 1};
next;
};
}
return $ok;
};
return 1;
}
sub init_target_tree ($$$$); # predeclare recursive subs
sub init_target_tree ($$$$) {
my $cfg = shift;
my $probes = shift;
my $tree = shift;
my $name = shift;
if ($tree->{alerts}){
die "ERROR: no Alerts section\n"
unless exists $cfg->{Alerts};
$tree->{alerts} = [ split(/\s*,\s*/, $tree->{alerts}) ] unless ref $tree->{alerts} eq 'ARRAY';
$tree->{fetchlength} = 0;
foreach my $al (@{$tree->{alerts}}) {
die "ERROR: alert $al ($name) is not defined\n"
unless defined $cfg->{Alerts}{$al};
$tree->{fetchlength} = $cfg->{Alerts}{$al}{length}
if $tree->{fetchlength} < $cfg->{Alerts}{$al}{length};
}
};
# fill in menu and title if missing
$tree->{menu} ||= $tree->{host} || "unknown";
$tree->{title} ||= $tree->{host} || "unknown";
foreach my $prop (keys %{$tree}) {
if (ref $tree->{$prop} eq 'HASH'){
if (not -d $name) {
mkdir $name, 0755 or die "ERROR: mkdir $name: $!\n";
};
init_target_tree $cfg, $probes, $tree->{$prop}, "$name/$prop";
}
if ($prop eq 'host' and check_filter($cfg,$name)) {
# print "init $name\n";
die "Error: Invalid Probe: $tree->{probe}" unless defined $probes->{$tree->{probe}};
my $probeobj = $probes->{$tree->{probe}};
my $step = $probeobj->step();
# we have to do the add before calling the _pings method, it won't work otherwise
if($tree->{$prop} =~ /^DYNAMIC/) {
$probeobj->add($tree,$name);
} else {
$probeobj->add($tree,$tree->{$prop});
}
my $pings = $probeobj->_pings($tree);
if (not -f $name.".rrd"){
my @create =
($name.".rrd", "--step",$step,
"DS:uptime:GAUGE:".(2*$step).":0:U",
"DS:loss:GAUGE:".(2*$step).":0:".$pings,
# 180 Seconds is the max rtt we consider valid ...
"DS:median:GAUGE:".(2*$step).":0:180",
(map { "DS:ping${_}:GAUGE:".(2*$step).":0:180" }
1..$pings),
(map { "RRA:".(join ":", @{$_}) } @{$cfg->{Database}{_table}} ));
do_debuglog("Calling RRDs::create(@create)");
RRDs::create(@create);
my $ERROR = RRDs::error();
do_log "RRDs::create ERROR: $ERROR\n" if $ERROR;
}
}
}
};
sub enable_dynamic($$$$);
sub enable_dynamic($$$$){
my $cfg = shift;
my $cfgfile = $cfg->{__cfgfile};
my $tree = shift;
my $path = shift;
my $email = ($tree->{email} || shift);
my $print;
die "ERROR: smokemail property in $cfgfile not specified\n" unless defined $cfg->{General}{smokemail};
die "ERROR: cgiurl property in $cfgfile not specified\n" unless defined $cfg->{General}{cgiurl};
if (defined $tree->{host} and $tree->{host} eq 'DYNAMIC' ) {
if ( not defined $email ) {
warn "WARNING: No email address defined for $path\n";
} else {
my $usepath = $path;
$usepath =~ s/\.$//;
my $secret = int(rand 1000000);
my $md5 = md5_base64($secret);
open C, "<$cfgfile" or die "ERROR: Reading $cfgfile: $!\n";
open G, ">$cfgfile.new" or die "ERROR: Writing $cfgfile.new: $!\n";
my $section ;
my @goal = split /\./, $usepath;
my $indent = "+";
my $done;
while (<C>){
$done && do { print G; next };
/^\s*\Q*** Targets ***\E\s*$/ && do{$section = 'match'};
@goal && $section && /^\s*\Q${indent}\E\s*\Q$goal[0]\E/ && do {
$indent .= "+";
shift @goal;
};
(not @goal) && /^\s*host\s*=\s*DYNAMIC$/ && do {
print G "host = DYNAMIC/$md5\n";
$done = 1;
next;
};
print G;
}
close G;
rename "$cfgfile.new", $cfgfile;
close C;
my $body;
open SMOKE, $cfg->{General}{smokemail} or die "ERROR: can't read $cfg->{General}{smokemail}: $!\n";
while (<SMOKE>){
s/<##PATH##>/$usepath/ig;
s/<##SECRET##>/$secret/ig;
s/<##URL##>/$cfg->{General}{cgiurl}/;
s/<##FROM##>/$cfg->{General}{contact}/;
s/<##OWNER##>/$cfg->{General}{owner}/;
s/<##TO##>/$email/;
$body .= $_;
}
close SMOKE;
my $mail;
print STDERR "Sending smoke-agent for $usepath to $email ... ";
sendmail $cfg->{General}{contact},$email,$body;
print STDERR "DONE\n";
}
}
foreach my $prop ( keys %{$tree}) {
enable_dynamic $cfg, $tree->{$prop},"$path$prop.",$email if ref $tree->{$prop} eq 'HASH';
}
};
sub target_menu($$$;$);
sub target_menu($$$;$){
my $tree = shift;
my $open = shift;
my $path = shift;
my $suffix = shift || '';
my $print;
my $current = shift @{$open} || "";
my @hashes;
foreach my $prop (sort { $tree->{$a}{_order} <=> $tree->{$b}{_order}}
grep { ref $tree->{$_} eq 'HASH' }
keys %{$tree}) {
push @hashes, $prop;
}
return "" unless @hashes;
$print .= "<table width=\"100%\" class=\"menu\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\">\n";
for (@hashes) {
my $class;
if ($_ eq $current ){
if ( @$open ) {
$class = 'menuopen';
} else {
$class = 'menuactive';
}
} else {
$class = 'menuitem';
};
my $menu = $tree->{$_}{menu};
$menu =~ s/ / /g;
my $menuadd ="";
$menuadd = " " x (20 - length($menu)) if length($menu) < 20;
$print .= "<tr><td class=\"$class\" colspan=\"2\"> - <a class=\"menulink\" HREF=\"$path$_$suffix\">$menu</a>$menuadd</td></tr>\n";
if ($_ eq $current){
my $prline = target_menu $tree->{$_}, $open, "$path$_.", $suffix;
$print .= "<tr><td class=\"$class\"> </td><td align=\"left\">$prline</td></tr>"
if $prline;
}
}
$print .= "</table>\n";
return $print;
};
sub fill_template ($$){
my $template = shift;
my $subst = shift;
my $line = $/;
undef $/;
open I, $template or return "<HTML><BODY>ERROR: Reading page template $template: $!</BODY></HTML>";
my $data = <I>;
close I;
$/ = $line;
foreach my $tag (keys %{$subst}) {
$data =~ s/<##${tag}##>/$subst->{$tag}/g;
}
return $data;
}
sub exp2seconds ($) {
my $x = shift;
$x =~/(\d+)m/ && return $1*60;
$x =~/(\d+)h/ && return $1*60*60;
$x =~/(\d+)d/ && return $1*60*60*24;
$x =~/(\d+)w/ && return $1*60*60*24*7;
$x =~/(\d+)y/ && return $1*60*60*24*365;
return $x;
}
sub get_overview ($$$$){
my $cfg = shift;
my $q = shift;
my $tree = shift;
my $open = shift;
my $dir = "";
my $page ="";
for (@$open) {
$dir .= "/$_";
mkdir $cfg->{General}{imgcache}.$dir, 0755
unless -d $cfg->{General}{imgcache}.$dir;
die "ERROR: creating $cfg->{General}{imgcache}$dir: $!\n"
unless -d $cfg->{General}{imgcache}.$dir;
}
my $date = $cfg->{Presentation}{overview}{strftime} ?
POSIX::strftime($cfg->{Presentation}{overview}{strftime},
localtime(time)) : scalar localtime(time);
foreach my $prop (sort {$tree->{$a}{_order} <=> $tree->{$b}{_order}}
grep { ref $tree->{$_} eq 'HASH' and defined $tree->{$_}{host}}
keys %$tree) {
my $rrd = $cfg->{General}{datadir}.$dir."/$prop.rrd";
my $max = $cfg->{Presentation}{overview}{max_rtt} || "100000";
my $medc = $cfg->{Presentation}{overview}{median_color} || "ff0000";
my $probe = $probes->{$tree->{$prop}{probe}};
my $pings = $probe->_pings($tree->{$prop});
my ($graphret,$xs,$ys) = RRDs::graph
($cfg->{General}{imgcache}.$dir."/${prop}_mini.png",
'--lazy',
'--start','-'.exp2seconds($cfg->{Presentation}{overview}{range}),
'--title',$tree->{$prop}{title},
'--height',$cfg->{Presentation}{overview}{height},
'--width',,$cfg->{Presentation}{overview}{width},
'--vertical-label',"Seconds",
'--imgformat','PNG',
'--lower-limit','0',
"DEF:median=${rrd}:median:AVERAGE",
"DEF:loss=${rrd}:loss:AVERAGE",
"CDEF:ploss=loss,$pings,/,100,*",
"CDEF:dm=median,0,$max,LIMIT",
"CDEF:dm2=median,1.5,*,0,$max,LIMIT",
"LINE1:dm2", # this is for kicking things down a bit
"LINE1:dm#$medc:median RTT avg\\: ",
"GPRINT:median:AVERAGE: %0.2lf %ss ",
"GPRINT:median:LAST: latest RTT\\: %0.2lf %ss ",
"GPRINT:ploss:AVERAGE: avg pkg loss\\: %.2lf %% ",
"COMMENT: $date\\j");
my $ERROR = RRDs::error();
$page .= "<div>";
if (defined $ERROR) {
$page .= "ERROR: $ERROR";
} else {
$page.="<A HREF=\"".lnk($q, (join ".", @$open, ${prop}))."\">".
"<IMG BORDER=\"0\" WIDTH=\"$xs\" HEIGHT=\"$ys\" ".
"SRC=\"".$cfg->{General}{imgurl}.$dir."/${prop}_mini.png\"></A>";
}
$page .="</div>"
}
return $page;
}
sub findmax ($$) {
my $cfg = shift;
my $rrd = shift;
# my $pings = "ping".int($cfg->{Database}{pings}/1.1);
my %maxmedian;
my @maxmedian;
for (@{$cfg->{Presentation}{detail}{_table}}) {
my ($desc,$start) = @{$_};
$start = exp2seconds($start);
my ($graphret,$xs,$ys) = RRDs::graph
("dummy", '--start', -$start,
"DEF:maxping=${rrd}:median:AVERAGE",
'PRINT:maxping:MAX:%le' );
my $ERROR = RRDs::error();
do_log $ERROR if $ERROR;
my $val = $graphret->[0];
$val = 1 if $val =~ /nan/i;
$maxmedian{$start} = $val;
push @maxmedian, $val;
}
my $med = (sort @maxmedian)[int(($#maxmedian) / 2 )];
my $max = 0.000001;
foreach my $x ( keys %maxmedian ){
if ( not defined $cfg->{Presentation}{detail}{unison_tolerance} or (
$maxmedian{$x} <= $cfg->{Presentation}{detail}{unison_tolerance} * $med
and $maxmedian{$x} >= $med / $cfg->{Presentation}{detail}{unison_tolerance}) ){
$max = $maxmedian{$x} unless $maxmedian{$x} < $max;
$maxmedian{$x} = undef;
};
}
foreach my $x ( keys %maxmedian ){
if (defined $maxmedian{$x}) {
$maxmedian{$x} *= 1.5;
} else {
$maxmedian{$x} = $max * 1.5;
}
$maxmedian{$x} = $cfg->{Presentation}{detail}{max_rtt}
if $cfg->{Presentation}{detail}{max_rtt} and
$maxmedian{$x} > $cfg->{Presentation}{detail}{max_rtt}
};
return \%maxmedian;
}
sub smokecol ($) {
my $count = ( shift )- 2 ;
return [] unless $count > 0;
my $half = $count/2;
my @items;
for (my $i=$count; $i > $half; $i--){
my $color = int(190/$half * ($i-$half))+50;
push @items, "AREA:cp".($i+2)."#".(sprintf("%02x",$color) x 3);
};
for (my $i=int($half); $i >= 0; $i--){
my $color = int(190/$half * ($half - $i))+64;
push @items, "AREA:cp".($i+2)."#".(sprintf("%02x",$color) x 3);
};
return \@items;
}
sub get_detail ($$$$){
my $cfg = shift;
my $q = shift;
my $tree = shift;
my $open = shift;
return "" unless $tree->{host};
my @dirs = @{$open};
my $file = pop @dirs;
my $dir = "";
die "ERROR: ".(join ".", @dirs)." has no probe defined\n"
unless $tree->{probe};
die "ERROR: ".(join ".", @dirs)." $tree->{probe} is not known\n"
unless $cfg->{__probes}{$tree->{probe}};
my $probe = $cfg->{__probes}{$tree->{probe}};
my $ProbeDesc = $probe->ProbeDesc();
my $step = $probe->step();
my $pings = $probe->_pings($tree);
my $page;
for (@dirs) {
$dir .= "/$_";
mkdir $cfg->{General}{imgcache}.$dir, 0755
unless -d $cfg->{General}{imgcache}.$dir;
die "ERROR: creating $cfg->{General}{imgcache}$dir: $!\n"
unless -d $cfg->{General}{imgcache}.$dir;
}
my $rrd = $cfg->{General}{datadir}."/".(join "/", @dirs)."/${file}.rrd";
my $img = $cfg->{General}{imgcache}."/".(join "/", @dirs)."/${file}.rrd";
my %lasthight;
if (open (HG,"<${img}.maxhight")){
while (<HG>){
chomp;
my @l = split / /;
$lasthight{$l[0]} = $l[1];
}
close HG;
}
my $max = findmax $cfg, $rrd;
if (open (HG,">${img}.maxhight")){
foreach my $s (keys %{$max}){
print HG "$s $max->{$s}\n";
}
close HG;
}
my $smoke = $pings - 3 > 0
? smokecol $pings :
[ 'COMMENT:(Not enough pings to draw any smoke.)\s', 'COMMENT:\s' ];
# one \s doesn't seem to be enough
my @upargs;
my @upsmoke;
my @median;
my $date = $cfg->{Presentation}{detail}{strftime} ?
POSIX::strftime($cfg->{Presentation}{detail}{strftime},
localtime(time)) : scalar localtime(time);
for (@{$cfg->{Presentation}{detail}{_table}}) {
my ($desc,$start) = @{$_};
$start = exp2seconds($start);
do {
@median = ("DEF:median=${rrd}:median:AVERAGE",
"DEF:loss=${rrd}:loss:AVERAGE",
"CDEF:ploss=loss,$pings,/,100,*",
"GPRINT:median:AVERAGE:Median Ping RTT (avg %.1lf %ss) ",
"LINE1:median#202020"
);
my $p = $pings;
my %lc;
my $lastup = 0;
if ( defined $cfg->{Presentation}{detail}{loss_colors}{_table} ) {
for (@{$cfg->{Presentation}{detail}{loss_colors}{_table}}) {
my ($num,$col,$txt) = @{$_};
$lc{$num} = [ $txt, "#".$col ];
}
} else {
%lc = (0 => ['0', '#26ff00'],
1 => ["1/$p", '#00b8ff'],
2 => ["2/$p", '#0059ff'],
3 => ["3/$p", '#5e00ff'],
4 => ["4/$p", '#7e00ff'],
int($p/2) => [int($p/2)."/$p", '#dd00ff'],
$p-1 => [($p-1)."/$p", '#ff0000'],
);
};
my $last = -1;
my $swidth = $max->{$start} / $cfg->{Presentation}{detail}{height};
foreach my $loss (sort {$a <=> $b} keys %lc){
next if $loss >= $pings;
my $lvar = $loss; $lvar =~ s/\./d/g ;
push @median,
(
"CDEF:me$lvar=loss,$last,GT,loss,$loss,LE,*,1,UNKN,IF,median,*",
"CDEF:meL$lvar=me$lvar,$swidth,-",
"CDEF:meH$lvar=me$lvar,0,*,$swidth,2,*,+",
"AREA:meL$lvar",
"STACK:meH$lvar$lc{$loss}[1]:$lc{$loss}[0]"
);
$last = $loss;
}
push @median, ( "GPRINT:ploss:AVERAGE: avg pkg loss\\: %.2lf %%\\l" );
# map {print "$_<br/>"} @median;
};
# if we have uptime draw a colorful background or the graph showing the uptime
my $cdir=$cfg->{General}{datadir}."/".(join "/", @dirs)."/";
if (-f "$cdir/${file}.adr") {
@upsmoke = ();
@upargs = ('COMMENT:Link Up: ',
"DEF:uptime=${rrd}:uptime:AVERAGE",
"CDEF:duptime=uptime,86400,/",
'GPRINT:duptime:LAST: %0.1lf days (');
my %upt;
if ( defined $cfg->{Presentation}{detail}{uptime_colors}{_table} ) {
for (@{$cfg->{Presentation}{detail}{uptime_colors}{_table}}) {
my ($num,$col,$txt) = @{$_};
$upt{$num} = [ $txt, "#".$col];
}
} else {
%upt = ( 3600 => ['<1h', '#FFD3D3'],
2*3600 => ['<2h', '#FFE4C7'],
6*3600 => ['<6h', '#FFF9BA'],
12*3600 => ['<12h','#F3FFC0'],
24*3600 => ['<1d', '#E1FFCC'],
7*24*3600 => ['<1w', '#BBFFCB'],
30*24*3600 => ['<1m', '#BAFFF5'],
'1e100' => ['>1m', '#DAECFF']
);
}
my $lastup = 0;
foreach my $uptime (sort {$a <=> $b} keys %upt){
push @upargs,
(
"CDEF:up$uptime=uptime,$lastup,GE,uptime,$uptime,LE,*,INF,UNKN,IF",
"AREA:up$uptime$upt{$uptime}[1]:$upt{$uptime}[0]"
);
push @upsmoke,
(
"CDEF:ups$uptime=uptime,$lastup,GE,uptime,$uptime,LE,*,cp2,UNKN,IF",
"AREA:ups$uptime$upt{$uptime}[1]"
);
$lastup=$uptime;
}
push @upargs, 'COMMENT:)\l';
# map {print "$_<br/>"} @upargs;
};
my @log = ();
push @log, "--logarithmic" if $cfg->{Presentation}{detail}{logarithmic} and
$cfg->{Presentation}{detail}{logarithmic} eq 'yes';
my @lazy =();
@lazy = ('--lazy') if $lasthight{$start} and $lasthight{$start} == $max->{$start};
my ($graphret,$xs,$ys) = RRDs::graph
($cfg->{General}{imgcache}.$dir."/${file}_last_${start}.png",
@lazy,
'--start','-'.$start,
'--height',$cfg->{Presentation}{detail}{height},
'--width',,$cfg->{Presentation}{detail}{width},
'--title',$desc,
'--rigid',
'--upper-limit', $max->{$start},
@log,
'--lower-limit',(@log ? ($max->{$start} > 0.01) ? '0.001' : '0.0001' : '0'),
'--vertical-label',"Seconds",
'--imgformat','PNG',
'--color', 'SHADEA#ffffff',
'--color', 'SHADEB#ffffff',
'--color', 'BACK#ffffff',
'--color', 'CANVAS#ffffff',
(map {"DEF:ping${_}=${rrd}:ping${_}:AVERAGE"} 1..$pings),
(map {"CDEF:cp${_}=ping${_},0,$max->{$start},LIMIT"} 1..$pings),
@upargs,# draw the uptime bg color
@$smoke,
@upsmoke, # draw the rest of the uptime bg color
@median,
# 'LINE3:median#ff0000:Median RTT in grey '.$cfg->{Database}{pings}.' pings sorted by RTT',
# 'LINE1:median#ff8080',
# Gray background for times when no data was collected, so they can
# be distinguished from network being down.
( $cfg->{Presentation}{detail}{nodata_color} ? (
'CDEF:nodata=loss,UN,INF,UNKN,IF',
"AREA:nodata#$cfg->{Presentation}{detail}{nodata_color}" ):
()),
'HRULE:0#000000',
'COMMENT:\s',
"COMMENT:Probe: $pings $ProbeDesc every $step seconds",
'COMMENT:created on '.$date.'\j' );
my $ERROR = RRDs::error();
$page .= "<div>".
( $ERROR ||
"<IMG BORDER=\"0\" WIDTH=\"$xs\" HEIGHT=\"$ys\" ".
"SRC=\"".$cfg->{General}{imgurl}.$dir."/${file}_last_${start}.png\">" )."</div>";
}
return $page;
}
sub display_webpage($$){
my $cfg = shift;
my $q = shift;
my $open = [ split /\./,( $q->param('target') || '')];
my $tree = $cfg->{Targets};
my $step = $cfg->{__probes}{$tree->{probe}}->step();
for (@$open) {
die "ERROR: Section '$_' does not exist.\n"
unless exists $tree->{$_};
last unless ref $tree->{$_} eq 'HASH';
$tree = $tree->{$_};
}
gen_imgs($cfg); # create logos in imgcache
print fill_template
($cfg->{Presentation}{template},
{
menu => target_menu($cfg->{Targets},
[@$open], #copy this because it gets changed
($q->script_name() || '')."?target="),
title => $tree->{title},
remark => ($tree->{remark} || ''),
overview => get_overview( $cfg,$q,$tree,$open ),
body => get_detail( $cfg,$q,$tree,$open ),
target_ip => ($tree->{host} || ''),
owner => $cfg->{General}{owner},
contact => $cfg->{General}{contact},
author => '<A HREF="http://tobi.oetiker.ch/">Tobi Oetiker</A>',
smokeping => '<A HREF="http://people.ee.ethz.ch/~oetiker/webtools/smokeping/counter.cgi/'.$VERSION.'">SmokePing-'.$VERSION.'</A>',
step => $step,
rrdlogo => '<A HREF="http://people.ee.ethz.ch/~oetiker/webtools/rrdtool/"><img border="0" src="'.$cfg->{General}{imgurl}.'/rrdtool.png"></a>',
smokelogo => '<A HREF="http://people.ee.ethz.ch/~oetiker/webtools/smokeping/counter.cgi/'.$VERSION.'"><img border="0" src="'.$cfg->{General}{imgurl}.'/smokeping.png"></a>',
}
);
}
# fetch all data.
sub run_probes($$) {
my $probes = shift;
my $justthisprobe = shift;
if (defined $justthisprobe) {
$probes->{$justthisprobe}->ping();
} else {
foreach my $probe (keys %{$probes}) {
$probes->{$probe}->ping();
}
}
}
# report probe status
sub report_probes($$) {
my $probes = shift;
my $justthisprobe = shift;
if (defined $justthisprobe) {
$probes->{$justthisprobe}->report();
} else {
foreach my $probe (keys %{$probes}){
$probes->{$probe}->report();
}
}
}
sub update_rrds($$$$$);
sub update_rrds($$$$$) {
my $cfg = shift;
my $probes = shift;
my $tree = shift;
my $name = shift;
my $justthisprobe = shift; # if defined, update only the targets probed by this probe
my $probe = $tree->{probe};
my $probeobj = $probes->{$probe};
foreach my $prop (keys %{$tree}) {
if (ref $tree->{$prop} eq 'HASH'){
update_rrds $cfg, $probes, $tree->{$prop}, $name."/$prop", $justthisprobe;
}
next if defined $justthisprobe and $probe ne $justthisprobe;
if ($prop eq 'host' and check_filter($cfg,$name)) {
#print "update $name\n";
my $updatestring = $probeobj->rrdupdate_string($tree);
my $pings = $probeobj->_pings($tree);
if ( $tree->{rawlog} ){
my $file = POSIX::strftime $tree->{rawlog},localtime(time);
if (open LOG,">>$name.$file.csv"){
print LOG time,"\t",join("\t",split /:/,$updatestring),"\n";
close LOG;
} else {
do_log "Warning: failed to open $file for logging: $!\n";
}
}
my @update = ( $name.".rrd",
'--template',(join ":", "uptime", "loss", "median",
map { "ping${_}" } 1..$pings),
"N:".$updatestring
);
do_debuglog("Calling RRDs::update(@update)");
RRDs::update ( @update );
my $ERROR = RRDs::error();
do_log "RRDs::update ERROR: $ERROR\n" if $ERROR;
# check alerts
# disabled
if ( $tree->{alerts} ) {
$tree->{stack} = {loss=>['S'],rtt=>['S']} unless defined $tree->{stack};
my $x = $tree->{stack};
my ($loss,$rtt) =
(split /:/, $probeobj->rrdupdate_string($tree))[1,2];
$loss = undef if $loss eq 'U';
my $lossprct = $loss * 100 / $pings;
$rtt = undef if $rtt eq 'U';
push @{$x->{loss}}, $lossprct;
push @{$x->{rtt}}, $rtt;
if (scalar @{$x->{loss}} > $tree->{fetchlength}){
shift @{$x->{loss}};
shift @{$x->{rtt}};
}
for (@{$tree->{alerts}}) {
if ( not $cfg->{Alerts}{$_} ) {
do_log "WARNING: Empty alert in ".(join ",", @{$tree->{alerts}})." ($name)\n";
next;
};
if ( ref $cfg->{Alerts}{$_}{sub} ne 'CODE' ) {
do_log "WARNING: Alert '$_' did not resolve to a Sub Ref. Skipping\n";
next;
};
if ( &{$cfg->{Alerts}{$_}{sub}}($x) ){
# we got a match
my $from;
my $line = "$name/$prop";
my $base = $cfg->{General}{datadir};
$line =~ s|^$base/||;
$line =~ s|/host$||;
$line =~ s|/|.|g;
do_log("Alert $_ triggered for $line");
my $urlline = $line;
$urlline = $cfg->{General}{cgiurl}."?target=".$line;
my $loss = "loss: ".join ", ",map {defined $_ ? (/^\d/ ? sprintf "%.0f%%", $_ :$_):"U" } @{$x->{loss}};
my $rtt = "rtt: ".join ", ",map {defined $_ ? (/^\d/ ? sprintf "%.0fms", $_*1000 :$_):"U" } @{$x->{rtt}};
my $stamp = scalar localtime time;
my @to;
foreach my $addr (map {$_ ? (split /\s*,\s*/,$_) : ()} $cfg->{Alerts}{to},$tree->{alertee},$cfg->{Alerts}{$_}{to}){
next unless $addr;
if ( $addr =~ /^\|(.+)/) {
system $1,$_,$line,$loss,$rtt,$tree->{host};
} elsif ( $addr =~ /^snpp:(.+)/ ) {
sendsnpp $1, <<SNPPALERT;
$cfg->{Alerts}{$_}{comment}
$_ on $line
$loss
$rtt
SNPPALERT
} else {
push @to, $addr;
}
};
if (@to){
my $to = join ",",@to;
sendmail $cfg->{Alerts}{from},$to, <<ALERT;
To: $to
From: $cfg->{Alerts}{from}
Subject: [SmokeAlert] $_ on $line
$stamp
Got a match for alert "$_" for $urlline
Pattern
-------
$cfg->{Alerts}{$_}{pattern}
Data (old --> now)
------------------
$loss
$rtt
Comment
-------
$cfg->{Alerts}{$_}{comment}
ALERT
}
}
}
}
}
}
}
sub _deepcopy {
# this handles circular references on consecutive levels,
# but breaks if there are any levels in between
my $what = shift;
return $what unless ref $what;
for (ref $what) {
/^ARRAY$/ and return [ map { $_ eq $what ? $_ : _deepcopy($_) } @$what ];
/^HASH$/ and return { map { $_ => $what->{$_} eq $what ?
$what->{$_} : _deepcopy($what->{$_}) } keys %$what };
/^CODE$/ and return $what; # we don't need to copy the subs
}
die "Cannot _deepcopy reference type @{[ref $what]}";
}
sub get_parser () {
# The _dyn() stuff here is quite confusing, so here's a walkthrough:
# 1 Probe is defined in the Probes section
# 1.1 _dyn is called for the section to add the probe- and target-specific
# vars into the grammar for this section and its subsections (subprobes)
# 1.2 A _dyn sub is installed for all mandatory target-specific variables so
# that they are made non-mandatory in the Targets section if they are
# specified here. The %storedtargetvars hash holds this information.
# 1.3 If a probe section has any subsections (subprobes) defined, the main
# section turns into a template that just offers default values for
# the subprobes. Because of this a _dyn sub is installed for subprobe
# sections that makes any mandatory variables in the main section non-mandatory.
# 1.4 A similar _dyn sub as in 1.2 is installed for the subprobe target-specific
# variables as well.
# 2 Probe is selected in the Targets section top
# 2.1 _dyn is called for the section to add the probe- and target-specific
# vars into the grammar for this section and its subsections. Any _default
# values for the vars are removed, as they will be propagated from the Probes
# section.
# 2.2 Another _dyn sub is installed for the 'probe' variable in target subsections
# that behaves as 2.1
# 2.3 A _dyn sub is installed for the 'host' variable that makes the mandatory
# variables mandatory only in those sections that have a 'host' setting.
# 2.4 A _sub sub is installed for the 'probe' variable in target subsections that
# bombs out if 'probe' is defined after any variables that depend on the
# current 'probe' setting.
my $KEY_RE = '[-_0-9a-zA-Z]+';
my $KEYD_RE = '[-_0-9a-zA-Z.]+';
my $PROBE_RE = '[A-Z][a-zA-Z]+';
my %knownprobes; # the probes encountered so far
# get a list of available probes for _dyndoc sections
my $libdir = find_libdir();
my $probedir = $libdir . "/Smokeping/probes";
my $matcherdir = $libdir . "/Smokeping/matchers";
my $probelist;
my @matcherlist;
die("Can't find probe module directory") unless defined $probedir;
opendir(D, $probedir) or die("opendir $probedir: $!");
for (readdir D) {
next unless s/\.pm$//;
next unless /^$PROBE_RE/;
$probelist->{$_} = "(See the L<separate module documentation|Smokeping::probes::$_> for details about each variable.)";
}
closedir D;
die("Can't find matcher module directory") unless defined $matcherdir;
opendir(D, $matcherdir) or die("opendir $matcherdir: $!");
for (sort readdir D) {
next unless /[A-Z]/;
next unless s/\.pm$//;
push @matcherlist, $_;
}
# The target-specific vars of each probe
# We need to store them to relay information from Probes section to Target section
# see 1.2 above
my %storedtargetvars;
# the part of target section syntax that doesn't depend on the selected probe
my %TARGETCOMMON; # predeclare self-referencing structures
# the common variables
my $TARGETCOMMONVARS = [ qw (probe menu title alerts note email host remark rawlog alertee) ];
%TARGETCOMMON =
(
_vars => $TARGETCOMMONVARS,
_inherited=> [ qw (probe alerts alertee) ],
_sections => [ "/$KEY_RE/" ],
_recursive=> [ "/$KEY_RE/" ],
_sub => sub {
my $val = shift;
return "PROBE_CONF sections are neither needed nor supported any longer. Please see the smokeping_upgrade document."
if $val eq 'PROBE_CONF';
return undef;
},
"/$KEY_RE/" => {},
_order => 1,
_varlist => 1,
_doc => <<DOC,
Each target section can contain information about a host to monitor as
well as further target sections. Most variables have already been
described above. The expression above defines legal names for target
sections.
DOC
alerts => {
_doc => 'Comma separated list of alert names',
_re => '([^\s,]+(,[^\s,]+)*)?',
_re_error => 'Comma separated list of alert names',
},
host =>
{
_doc => <<DOC,
Can either contain the name of a target host or the string B<DYNAMIC>.
In the second case, the target machine has a dynamic IP address and
thus is required to regularly contact the SmokePing server to verify
its IP address. When starting SmokePing with the commandline argument
B<--email> it will add a secret password to each of the B<DYNAMIC>
host lines and send a script to the owner of each host. This script
must be started regularly on the host in question to make sure
SmokePing monitors the right box. If the target machine supports
SNMP SmokePing will also query the hosts
sysContact, sysName and sysLocation properties to make sure it is
still the same host.
DOC
_sub => sub {
for ( shift ) {
m|^DYNAMIC| && return undef;
/^\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}$/ && return undef;
/^[0-9a-f]{0,4}(\:[0-9a-f]{0,4}){0,6}\:[0-9a-f]{0,4}$/i && return undef;
my $addressfound = 0;
my @tried;
if ($havegetaddrinfo) {
my @ai;
@ai = getaddrinfo( $_, "" );
unless ($addressfound = scalar(@ai) > 5) {
do_debuglog("WARNING: Hostname '$_' does currently not resolve to an IPv6 address\n");
@tried = qw{IPv6};
}
}
unless ($addressfound) {
unless ($addressfound = gethostbyname( $_ )) {
do_debuglog("WARNING: Hostname '$_' does currently not resolve to an IPv4 address\n");
push @tried, qw{IPv4};
}
}
unless ($addressfound) {
# do not bomb, as this could be temporary
my $tried = join " or ", @tried;
warn "WARNING: Hostname '$_' does currently not resolve to an $tried address\n" unless $cgimode;
}
return undef;
}
return undef;
},
},
email => { _re => '.+\s<\S+@\S+>',
_re_error =>
"use an email address of the form 'First Last <em\@ail.kg>'",
_doc => <<DOC,
This is the contact address for the owner of the current host. In connection with the B<DYNAMIC> hosts,
the address will be used for sending the belowmentioned script.
DOC
},
note => { _doc => <<DOC },
Some information about this entry which does NOT get displayed on the web.
DOC
rawlog => { _doc => <<DOC,
Log the raw data, gathered for this target, in tab separated format, to a file with the
same basename as the corresponding RRD file. Use posix strftime to format the timestamp to be
put into the file name. The filename is built like this:
basename.strftime.csv
Example:
rawlog=%Y-%m-%d
this would create a new logfile every day with a name like this:
targethost.2004-05-03.csv
DOC
_sub => sub {
eval ( "POSIX::strftime('$_[0]', localtime(time))");
return $@ if $@;
return undef;
},
},
alertee => { _re => '(\|.+|.+@\S+|snpp:)',
_re_error => 'the alertee must be an email address here',
_doc => <<DOC },
If you want to have alerts for this target and all targets below it go to a particular address
on top of the address already specified in the alert, you can add it here. This can be a comma separated list of items.
DOC
probe => {
_sub => sub {
my $val = shift;
my $varlist = shift;
return "probe $val missing from the Probes section"
unless $knownprobes{$val};
my %commonvars;
$commonvars{$_} = 1 for @{$TARGETCOMMONVARS};
delete $commonvars{host};
# see 2.4 above
return "probe must be defined before the host or any probe variables"
if grep { not exists $commonvars{$_} } @$varlist;
return undef;
},
_dyn => sub {
# this generates the new syntax whenever a new probe is selected
# see 2.2 above
my ($name, $val, $grammar) = @_;
my $targetvars = _deepcopy($storedtargetvars{$val});
my @mandatory = @{$targetvars->{_mandatory}};
delete $targetvars->{_mandatory};
my @targetvars = sort keys %$targetvars;
# the default values for targetvars are only used in the Probes section
delete $targetvars->{$_}{_default} for @targetvars;
# we replace the current grammar altogether
%$grammar = ( %TARGETCOMMON, %$targetvars );
$grammar->{_vars} = [ @{$grammar->{_vars}}, @targetvars ];
# the subsections differ only in that they inherit their vars from here
my $g = _deepcopy($grammar);
$grammar->{"/$KEY_RE/"} = $g;
push @{$g->{_inherited}}, @targetvars;
# this makes the variables mandatory only in those sections
# where 'host' is defined. (We must generate this dynamically
# as the mandatory list isn't visible earlier.)
# see 2.3 above
my $mandatorysub = sub {
my ($name, $val, $grammar) = @_;
$grammar->{_mandatory} = [ @mandatory ];
};
$grammar->{host} = _deepcopy($grammar->{host});
$grammar->{host}{_dyn} = $mandatorysub;
$g->{host}{_dyn} = $mandatorysub;
},
},
);
my $INTEGER_SUB = {
_sub => sub {
return "must be an integer >= 1"
unless $_[ 0 ] == int( $_[ 0 ] ) and $_[ 0 ] >= 1;
return undef;
}
};
my $DIRCHECK_SUB = {
_sub => sub {
return "Directory '$_[0]' does not exist" unless -d $_[ 0 ];
return undef;
}
};
my $FILECHECK_SUB = {
_sub => sub {
return "File '$_[0]' does not exist" unless -f $_[ 0 ];
return undef;
}
};
# grammar for the ***Probes*** section
my $PROBES = {
_doc => <<DOC,
Each module can take specific configuration information from this
area. The jumble of letters above is a regular expression defining legal
module names.
See the documentation of each module for details about its variables.
DOC
_sections => [ "/$PROBE_RE/" ],
# this adds the probe-specific variables to the grammar
# see 1.1 above
_dyn => sub {
my ($re, $name, $grammar) = @_;
# load the probe module
my $class = "Smokeping::probes::$name";
eval "require $class";
die "require $class failed: $@\n" if $@;
# modify the grammar
my $probevars = $class->probevars;
my $targetvars = $class->targetvars;
$storedtargetvars{$name} = $targetvars;
my @mandatory = @{$probevars->{_mandatory}};
my @targetvars = sort grep { $_ ne '_mandatory' } keys %$targetvars;
for (@targetvars) {
next if $_ eq '_mandatory';
delete $probevars->{$_};
}
my @probevars = sort grep { $_ ne '_mandatory' } keys %$probevars;
$grammar->{_vars} = [ @probevars , @targetvars ];
$grammar->{_mandatory} = [ @mandatory ];
# do it for probe instances in subsections too
my $g = $grammar->{"/$KEY_RE/"};
for (@probevars) {
$grammar->{$_} = $probevars->{$_};
%{$g->{$_}} = %{$probevars->{$_}};
# this makes the reference manual a bit less cluttered
delete $g->{$_}{_doc};
delete $g->{$_}{_example};
delete $grammar->{$_}{_doc};
delete $grammar->{$_}{_example};
}
# make any mandatory variable specified here non-mandatory in the Targets section
# see 1.2 above
my $sub = sub {
my ($name, $val, $grammar) = shift;
$targetvars->{_mandatory} = [ grep { $_ ne $name } @{$targetvars->{_mandatory}} ];
};
for my $var (@targetvars) {
%{$grammar->{$var}} = %{$targetvars->{$var}};
%{$g->{$var}} = %{$targetvars->{$var}};
# this makes the reference manual a bit less cluttered
delete $grammar->{$var}{_example};
delete $g->{$var}{_doc};
delete $g->{$var}{_example};
# (note: intentionally overwrite _doc)
$grammar->{$var}{_doc} = " (This variable can be overridden target-specifically in the Targets section.)";
$grammar->{$var}{_dyn} = $sub
if grep { $_ eq $var } @{$targetvars->{_mandatory}};
}
$g->{_vars} = [ @probevars, @targetvars ];
$g->{_inherited} = $g->{_vars};
$g->{_mandatory} = [ @mandatory ];
# the special value "_template" means we don't know yet if
# there will be any instances of this probe
$knownprobes{$name} = "_template";
$g->{_dyn} = sub {
# if there is a subprobe, the top-level section
# of this probe turns into a template, and we
# need to delete its _mandatory list.
# Note that ISG::ParseConfig does mandatory checking
# after the whole config tree is read, so we can fiddle
# here with "_mandatory" all we want.
# see 1.3 above
my ($re, $subprobename, $subprobegrammar) = @_;
delete $grammar->{_mandatory};
# the parent section doesn't define a valid probe anymore
delete $knownprobes{$name}
if exists $knownprobes{$name}
and $knownprobes{$name} eq '_template';
# this also keeps track of the real module name for each subprobe,
# should we ever need it
$knownprobes{$subprobename} = $name;
my $subtargetvars = _deepcopy($targetvars);
$storedtargetvars{$subprobename} = $subtargetvars;
# make any mandatory variable specified here non-mandatory in the Targets section
# see 1.4 above
my $sub = sub {
my ($name, $val, $grammar) = shift;
$subtargetvars->{_mandatory} = [ grep { $_ ne $name } @{$subtargetvars->{_mandatory}} ];
};
for my $var (@targetvars) {
$subprobegrammar->{$var}{_dyn} = $sub
if grep { $_ eq $var } @{$subtargetvars->{_mandatory}};
}
}
},
_dyndoc => $probelist, # all available probes
_sections => [ "/$KEY_RE/" ],
"/$KEY_RE/" => {
_doc => <<DOC,
You can define multiple instances of the same probe with subsections.
These instances can have different values for their variables, so you
can eg. have one instance of the FPing probe with packet size 1000 and
step 300 and another instance with packet size 64 and step 30.
The name of the subsection determines what the probe will be called, so
you can write descriptive names for the probes.
If there are any subsections defined, the main section for this probe
will just provide default parameter values for the probe instances, ie.
it will not become a probe instance itself.
The example above would be written like this:
*** Probes ***
+ FPing
# this value is common for the two subprobes
binary = /usr/bin/fping
++ FPingLarge
packetsize = 1000
step = 300
++ FPingSmall
packetsize = 64
step = 30
DOC
},
}; # $PROBES
my $parser = ISG::ParseConfig->new
(
{
_sections => [ qw(General Database Presentation Probes Alerts Targets) ],
_mandatory => [ qw(General Database Presentation Probes Targets) ],
General =>
{
_doc => <<DOC,
General configuration values valid for the whole SmokePing setup.
DOC
_vars =>
[ qw(owner imgcache imgurl datadir pagedir piddir sendmail offset
smokemail cgiurl mailhost contact netsnpp
syslogfacility syslogpriority concurrentprobes changeprocessnames) ],
_mandatory =>
[ qw(owner imgcache imgurl datadir piddir
smokemail cgiurl contact) ],
imgcache =>
{ %$DIRCHECK_SUB,
_doc => <<DOC,
A directory which is visible on your webserver where SmokePing can cache graphs.
DOC
},
imgurl =>
{
_doc => <<DOC,
Either an absolute URL to the B<imgcache> directory or one relative to the directory where you keep the
SmokePing cgi.
DOC
},
pagedir =>
{
%$DIRCHECK_SUB,
_doc => <<DOC,
Directory to store static representations of pages.
DOC
},
owner =>
{
_doc => <<DOC,
Name of the person responsible for this smokeping installation.
DOC
},
mailhost =>
{
_doc => <<DOC,
Instead of using sendmail, you can specify the name of an smtp server
and use perl's Net::SMTP module to send mail to DYNAMIC host owners (see below).
DOC
_sub => sub { require Net::SMTP ||return "ERROR: loading Net::SMTP"; return undef; }
},
snpphost =>
{
_doc => <<DOC,
If you have a SNPP (Simple Network Pager Protocol) server at hand, you can have alerts
sent there too. Use the syntax B<snpp:someaddress> to use a snpp address in any place where you can use a mail address otherwhise.
DOC
_sub => sub { require Net::SNPP ||return "ERROR: loading Net::SNPP"; return undef; }
},
contact =>
{ _re => '\S+@\S+',
_re_error =>
"use an email address of the form 'name\@place.dom'",
_doc => <<DOC,
Mail address of the person responsible for this smokeping installation.
DOC
},
datadir =>
{
%$DIRCHECK_SUB,
_doc => <<DOC,
The directory where SmokePing can keep its rrd files.
DOC
},
piddir =>
{
%$DIRCHECK_SUB,
_doc => <<DOC,
The directory where SmokePing keeps its pid when daemonised.
DOC
},
sendmail =>
{
%$FILECHECK_SUB,
_doc => <<DOC,
Path to your sendmail binary. It will be used for sending mails in connection with the support of DYNAMIC addresses.
DOC
},
smokemail =>
{
%$FILECHECK_SUB,
_doc => <<DOC,
Path to the mail template for DYNAMIC hosts. This mail template
must contain keywords of the form B<E<lt>##>I<keyword>B<##E<gt>>. There is a sample
template included with SmokePing.
DOC
},
cgiurl =>
{
_re => 'https?://\S+',
_re_error =>
"cgiurl must be a http(s)://.... url",
_doc => <<DOC,
Complete URL path of the SmokePing.cgi
DOC
},
syslogfacility =>
{
_re => '\w+',
_re_error =>
"syslogfacility must be alphanumeric",
_doc => <<DOC,
The syslog facility to use, eg. local0...local7.
Note: syslog logging is only used if you specify this.
DOC
},
syslogpriority =>
{
_re => '\w+',
_re_error =>
"syslogpriority must be alphanumeric",
_doc => <<DOC,
The syslog priority to use, eg. debug, notice or info.
Default is $DEFAULTPRIORITY.
DOC
},
offset => {
_re => '(\d+%|random)',
_re_error =>
"Use offset either in % of operation interval or 'random'",
_doc => <<DOC,
If you run many instances of smokeping you may want to prevent them from
hitting your network all at the same time. Using the offset parameter you
can change the point in time when the probes are run. Offset is specified
in % of total interval, or alternatively as 'random'. I recommend to use
'random'. Note that this does NOT influence the rrds itself, it is just a
matter of when data acqusition is initiated. The default offset is 'random'.
DOC
},
concurrentprobes => {
_re => '(yes|no)',
_re_error =>"this must either be 'yes' or 'no'",
_doc => <<DOC,
If you use multiple probes or multiple instances of the same probe and you
want them to run concurrently in separate processes, set this to 'yes'. This
gives you the possibility to specify probe-specific step and offset parameters
(see the 'Probes' section) for each probe and makes the probes unable to block
each other in cases of service outages. The default is 'yes', but if you for
some reason want the old behaviour you can set this to 'no'.
DOC
},
changeprocessnames => {
_re => '(yes|no)',
_re_error =>"this must either be 'yes' or 'no'",
_doc => <<DOC,
When using 'concurrentprobes' (see above), this controls whether the probe
subprocesses should change their argv string to indicate their probe in
the process name. If set to 'yes' (the default), the probe name will
be appended to the process name as '[probe]', eg. '/usr/bin/smokeping
[FPing]'. If you don't like this behaviour, set this variable to 'no'.
If 'concurrentprobes' is not set to 'yes', this variable has no effect.
DOC
},
},
Database =>
{
_vars => [ qw(step pings) ],
_mandatory => [ qw(step pings) ],
_doc => <<DOC,
Describes the properties of the round robin database for storing the
SmokePing data. Note that it is not possible to edit existing RRDs
by changing the entries in the cfg file.
DOC
step =>
{ %$INTEGER_SUB,
_doc => <<DOC,
Duration of the base operation interval of SmokePing in seconds.
SmokePing will venture out every B<step> seconds to ping your target hosts.
If 'concurrent_probes' is set to 'yes' (see above), this variable can be
overridden by each probe. Note that the step in the RRD files is fixed when
they are originally generated, and if you change the step parameter afterwards,
you'll have to delete the old RRD files or somehow convert them.
DOC
},
pings =>
{
%$INTEGER_SUB,
_doc => <<DOC,
How many pings should be sent to each target. Suggested: 20 pings.
This can be overridden by each probe. Some probes (those derived from
basefork.pm, ie. most except the FPing variants) will even let this
be overridden target-specifically. Note that the number of pings in
the RRD files is fixed when they are originally generated, and if you
change this parameter afterwards, you'll have to delete the old RRD
files or somehow convert them.
DOC
},
_table =>
{
_doc => <<DOC,
This section also contains a table describing the setup of the
SmokePing database. Below are reasonable defaults. Only change them if
you know rrdtool and its workings. Each row in the table describes one RRA.
# cons xff steps rows
AVERAGE 0.5 1 1008
AVERAGE 0.5 12 4320
MIN 0.5 12 4320
MAX 0.5 12 4320
AVERAGE 0.5 144 720
MAX 0.5 144 720
MIN 0.5 144 720
DOC
_columns => 4,
0 =>
{
_doc => <<DOC,
Consolidation method.
DOC
_re => '(AVERAGE|MIN|MAX)',
_re_error => "Choose a valid consolidation function",
},
1 =>
{
_doc => <<DOC,
What part of the consolidated intervals must be known to warrant a known entry.
DOC
_sub => sub {
return "Xff must be between 0 and 1"
unless $_[ 0 ] > 0 and $_[ 0 ] <= 1;
return undef;
}
},
2 => {%$INTEGER_SUB,
_doc => <<DOC,
How many B<steps> to consolidate into for each RRA entry.
DOC
},
3 => {%$INTEGER_SUB,
_doc => <<DOC,
How many B<rows> this RRA should have.
DOC
}
}
},
Presentation =>
{
_doc => <<DOC,
Defines how the SmokePing data should be presented.
DOC
_sections => [ qw(overview detail) ],
_mandatory => [ qw(overview template detail) ],
_vars => [ qw (template charset) ],
template =>
{
_doc => <<DOC,
The webpage template must contain keywords of the form
B<E<lt>##>I<keyword>B<##E<gt>>. There is a sample
template included with SmokePing; use it as the basis for your
experiments. Default template contains a pointer to the SmokePing
counter and homepage. I would be glad if you would not remove this as
it gives me an indication as to how widely used the tool is.
DOC
_sub => sub {
return "template '$_[0]' not readable" unless -r $_[ 0 ];
return undef;
}
},
charset => {
_doc => <<DOC,
By default, SmokePing assumes the 'iso-8859-15' character set. If you use
something else, this is the place to speak up.
DOC
},
overview =>
{ _vars => [ qw(width height range max_rtt median_color strftime) ],
_mandatory => [ qw(width height) ],
_doc => <<DOC,
The Overview section defines how the Overview graphs should look.
DOC
max_rtt => { _doc => <<DOC },
Any roundtrip time larger than this value will cropped in the overview graph
DOC
median_color => { _doc => <<DOC,
By default the median line is drawn in red. Override it here with a hex color
in the format I<rrggbb>.
DOC
_re => '[0-9a-f]{6}',
_re_error => 'use rrggbb for color',
},
strftime => { _doc => <<DOC,
Use posix strftime to format the timestamp in the left hand
lower corner of the overview graph
DOC
_sub => sub {
eval ( "POSIX::strftime( '$_[0]', localtime(time))" );
return $@ if $@;
return undef;
},
},
width =>
{
_sub => sub {
return "width must be be an integer >= 10"
unless $_[ 0 ] >= 10
and int( $_[ 0 ] ) == $_[ 0 ];
return undef;
},
_doc => <<DOC,
Width of the Overview Graphs.
DOC
},
height =>
{
_doc => <<DOC,
Height of the Overview Graphs.
DOC
_sub => sub {
return "height must be an integer >= 10"
unless $_[ 0 ] >= 10
and int( $_[ 0 ] ) == $_[ 0 ];
return undef;
},
},
range => { _re => '\d+[smhdwy]',
_re_error =>
"graph range must be a number followed by [smhdwy]",
_doc => <<DOC,
How much time should be depicted in the Overview graph. Time must be specified
as a number followed by a letter which specifies the unit of time. Known units are:
B<s>econds, B<m>inutes, B<h>ours, B<d>days, B<w>eeks, B<y>ears.
DOC
},
},
detail =>
{
_vars => [ qw(width height logarithmic unison_tolerance max_rtt strftime nodata_color) ],
_sections => [ qw(loss_colors uptime_colors) ],
_mandatory => [ qw(width height) ],
_table => { _columns => 2,
_doc => <<DOC,
The detailed display can contain several graphs of different resolution. In this
table you can specify the resolution of each graph.
Example:
"Last 3 Hours" 3h
"Last 30 Hours" 30h
"Last 10 Days" 10d
"Last 400 Days" 400d
DOC
1 =>
{
_doc => <<DOC,
How much time should be depicted. The format is the same as for the B<age> parameter of the Overview section.
DOC
_re => '\d+[smhdwy]',
_re_error =>
"graph age must be a number followed by [smhdwy]",
},
0 =>
{
_doc => <<DOC,
Description of the particular resolution.
DOC
}
},
strftime => { _doc => <<DOC,
Use posix strftime to format the timestamp in the left hand
lower corner of the detail graph
DOC
_sub => sub {
eval ( "
POSIX::strftime('$_[0]', localtime(time)) " );
return $@ if $@;
return undef;
},
},
nodata_color => {
_re => '[0-9a-f]{6}',
_re_error => "color must be defined with in rrggbb syntax",
_doc => "Paint the graph background in a special color when there is no data for this period because smokeping has not been running (#rrggbb)",
},
logarithmic => { _doc => 'should the graphs be shown in a logarithmic scale (yes/no)',
_re => '(yes|no)',
_re_error =>"this must either be 'yes' or 'no'",
},
unison_tolerance => { _doc => "if a graph is more than this factor of the median 'max' it drops out of the unison scaling algorithm. A factor of two would mean that any graph with a max either less than half or more than twice the median 'max' will be dropped from unison scaling",
_sub => sub { return "tolerance must be larger than 1" if $_[0] <= 1; return undef},
},
max_rtt => { _doc => <<DOC },
Any roundtrip time larger than this value will cropped in the detail graph
DOC
width => { _doc => 'How many pixels wide should detail graphs be',
_sub => sub {
return "width must be be an integer >= 10"
unless $_[ 0 ] >= 10
and int( $_[ 0 ] ) == $_[ 0 ];
return undef;
},
},
height => { _doc => 'How many pixels high should detail graphs be',
_sub => sub {
return "height must be an integer >= 10"
unless $_[ 0 ] >= 10
and int( $_[ 0 ] ) == $_[ 0 ];
return undef;
},
},
loss_colors => {
_table => { _columns => 3,
_doc => <<DOC,
In the Detail view, the color of the median line depends
the amount of lost packets. SmokePing comes with a reasonable default setting,
but you may choose to disagree. The table below
lets you specify your own coloring.
Example:
Loss Color Legend
1 00ff00 "<1"
3 0000ff "<3"
100 ff0000 ">=3"
DOC
0 =>
{
_doc => <<DOC,
Activate when the lossrate (in percent) is larger of equal to this number
DOC
_re => '\d+.?\d*',
_re_error =>
"I was expecting a number",
},
1 =>
{
_doc => <<DOC,
Color for this range.
DOC
_re => '[0-9a-f]+',
_re_error =>
"I was expecting a color of the form rrggbb",
},
2 =>
{
_doc => <<DOC,
Description for this range.
DOC
}
}, # table
}, #loss_colors
uptime_colors => {
_table => { _columns => 3,
_doc => <<DOC,
When monitoring a host with DYNAMIC addressing, SmokePing will keep
track of how long the machine is able to keep the same IP
address. This time is plotted as a color in the graphs
background. SmokePing comes with a reasonable default setting, but you
may choose to disagree. The table below lets you specify your own
coloring
Example:
# Uptime Color Legend
3600 00ff00 "<1h"
86400 0000ff "<1d"
604800 ff0000 "<1w"
1000000000000 ffff00 ">1w"
Uptime is in days!
DOC
0 =>
{
_doc => <<DOC,
Activate when uptime in days is larger of equal to this number
DOC
_re => '\d+.?\d*',
_re_error =>
"I was expecting a number",
},
1 =>
{
_doc => <<DOC,
Color for this uptime range range.
DOC
_re => '[0-9a-f]{6}',
_re_error =>
"I was expecting a color of the form rrggbb",
},
2 =>
{
_doc => <<DOC,
Description for this range.
DOC
}
},#table
}, #uptime_colors
}, #detail
}, #present
Probes => { _sections => [ "/$KEY_RE/" ],
_doc => <<DOC,
The Probes Section configures Probe modules. Probe modules integrate
an external ping command into SmokePing. Check the documentation of each
module for more information about it.
DOC
"/$KEY_RE/" => $PROBES,
},
Alerts => {
_doc => <<DOC,
The Alert section lets you setup loss and RTT pattern detectors. After each
round of polling, SmokePing will examine its data and determine which
detectors match. Detectors are enabled per target and get inherited by
the targets children.
Detectors are not just simple thresholds which go off at first sight
of a problem. They are configurable to detect special loss or RTT
patterns. They let you look at a number of past readings to make a
more educated decision on what kind of alert should be sent, or if an
alert should be sent at all.
The patterns are numbers prefixed with an operator indicating the type
of comparison required for a match.
The following RTT pattern detects if a target's RTT goes from constantly
below 10ms to constantly 100ms and more:
old ------------------------------> new
<10,<10,<10,<10,<10,>10,>100,>100,>100
Loss patterns work in a similar way, except that the loss is defined as the
percentage the total number of received packets is of the total number of packets sent.
old ------------------------------> new
==0%,==0%,==0%,==0%,>20%,>20%,>=20%
Apart from normal numbers, patterns can also contain the values B<*>
which is true for all values regardless of the operator. And B<U>
which is true for B<unknown> data together with the B<==> and B<=!> operators.
Detectors normally act on state changes. This has the disadvantage, that
they will fail to find conditions which were already present when launching
smokeping. For this it is possible to write detectors that begin with the
special value B<==S> it is inserted whenever smokeping is started up.
You can write
==S,>20%,>20%
to detect lines that have been losing more than 20% of the packets for two
periods after startup.
Sometimes it may be that conditions occur at irregular intervals. But still
you only want to throw an alert if they occur several times within a certain
amount of times. The operator B<*X*> will ignore up to I<X> values and still
let the pattern match:
>10%,*10*,>10%
will fire if more than 10% of the packets have been losst twice over the
last 10 samples.
A complete example
*** Alerts ***
to = admin\@company.xy,peter\@home.xy
from = smokealert\@company.xy
+lossdetect
type = loss
# in percent
pattern = ==0%,==0%,==0%,==0%,>20%,>20%,>20%
comment = suddenly there is packet loss
+miniloss
type = loss
# in percent
pattern = >0%,*12*,>0%,*12*,>0%
comment = detected loss 3 times over the last two hours
+rttdetect
type = rtt
# in milliseconds
pattern = <10,<10,<10,<10,<10,<100,>100,>100,>100
comment = routing messed up again ?
+rttbadstart
type = rtt
# in milliseconds
pattern = ==S,==U
comment = offline at startup
DOC
_sections => [ '/[^\s,]+/' ],
_vars => [ qw(to from) ],
_mandatory => [ qw(to from)],
to => { doc => <<DOC,
Either an email address to send alerts to, or the name of a program to
execute when an alert matches. To call a program, the first character of the
B<to> value must be a pipe symbol "|". The program will the be called
whenever an alert matches, using the following 5 arguments:
B<name-of-alert>, B<target>, B<loss-pattern>, B<rtt-pattern>, B<hostname>.
You can also provide a comma separated list of addresses and programs.
DOC
_re => '(\|.+|.+@\S+|snpp:)',
_re_error => 'put an email address or the name of a program here',
},
from => { doc => 'who should alerts appear to be coming from ?',
_re => '.+@\S+',
_re_error => 'put an email address here',
},
'/[^\s,]+/' => {
_vars => [ qw(type pattern comment to) ],
_mandatory => [ qw(type pattern comment) ],
to => { doc => 'Similar to the "to" parameter on the top-level except that it will only be used IN ADDITION to the value of the toplevel parameter. Same rules apply.',
_re => '(\|.+|.+@\S+|snpp:)',
_re_error => 'put an email address or the name of a program here',
},
type => {
_doc => <<DOC,
Currently the pattern types B<rtt> and B<loss> and B<matcher> are known.
Matchers are plugin modules that extend the alert conditions. Known
matchers are @{[join (", ", map { "L<$_|Smokeping::matchers::$_>" }
@matcherlist)]}.
See the documentation of the corresponding matcher module
(eg. L<Smokeping::matchers::$matcherlist[0]>) for instructions on
configuring it.
DOC
_re => '(rtt|loss|matcher)',
_re_error => 'Use loss, rtt or matcher'
},
pattern => {
_doc => "a comma separated list of comparison operators and numbers. rtt patterns are in milliseconds, loss patterns are in percents",
_re => '(?:([^,]+)(,[^,]+)*|\S+\(.+\s)',
_re_error => 'Could not parse pattern or matcher',
},
},
},
Targets => {_doc => <<DOC,
The Target Section defines the actual work of SmokePing. It contains a hierarchical list
of hosts which mark the endpoints of the network connections the system should monitor.
Each section can contain one host as well as other sections.
DOC
_vars => [ qw(probe menu title remark alerts) ],
_mandatory => [ qw(probe menu title) ],
_order => 1,
_sections => [ "/$KEY_RE/" ],
_recursive => [ "/$KEY_RE/" ],
"/$KEY_RE/" => \%TARGETCOMMON, # this is just for documentation, _dyn() below replaces it
probe => {
_doc => <<DOC,
The name of the probe module to be used for this host. The value of
this variable gets propagated
DOC
_sub => sub {
my $val = shift;
return "probe $val missing from the Probes section"
unless $knownprobes{$val};
return undef;
},
# create the syntax based on the selected probe.
# see 2.1 above
_dyn => sub {
my ($name, $val, $grammar) = @_;
my $targetvars = _deepcopy($storedtargetvars{$val});
my @mandatory = @{$targetvars->{_mandatory}};
delete $targetvars->{_mandatory};
my @targetvars = sort keys %$targetvars;
for (@targetvars) {
# the default values for targetvars are only used in the Probes section
delete $targetvars->{$_}{_default};
$grammar->{$_} = $targetvars->{$_};
}
push @{$grammar->{_vars}}, @targetvars;
my $g = { %TARGETCOMMON, %{_deepcopy($targetvars)} };
$grammar->{"/$KEY_RE/"} = $g;
$g->{_vars} = [ @{$g->{_vars}}, @targetvars ];
$g->{_inherited} = [ @{$g->{_inherited}}, @targetvars ];
# this makes the reference manual a bit less cluttered
delete $grammar->{$_}{_doc} for @targetvars;
delete $grammar->{$_}{_example} for @targetvars;
delete $g->{$_}{_doc} for @targetvars;
delete $g->{$_}{_example} for @targetvars;
# make the mandatory variables mandatory only in sections
# with 'host' defined
# see 2.3 above
$g->{host}{_dyn} = sub {
my ($name, $val, $grammar) = @_;
$grammar->{_mandatory} = [ @mandatory ];
};
}, # _dyn
_dyndoc => $probelist, # all available probes
}, #probe
menu => { _doc => <<DOC },
Menu entry for this section. If not set this will be set to the hostname.
DOC
alerts => { _doc => <<DOC },
A comma separated list of alerts to check for this target. The alerts have
to be setup in the Alerts section. Alerts are inherited by child nodes. Use
an empty alerts definition to remove inherited alerts from the current target
and its children.
DOC
title => { _doc => <<DOC },
Title of the page when it is displayed. This will be set to the hostname if
left empty.
DOC
remark => { _doc => <<DOC },
An optional remark on the current section. It gets displayed on the webpage.
DOC
}
}
);
return $parser;
}
sub get_config ($$){
my $parser = shift;
my $cfgfile = shift;
return $parser->parse( $cfgfile ) || die "ERROR: $parser->{err}\n";
}
sub kill_smoke ($) {
my $pidfile = shift;
if (defined $pidfile){
if ( -f $pidfile && open PIDFILE, "<$pidfile" ) {
<PIDFILE> =~ /(\d+)/;
my $pid = $1;
kill 2, $pid if kill 0, $pid;
sleep 3; # let it die
die "ERROR: Can not stop running instance of SmokePing ($pid)\n"
if kill 0, $pid;
close PIDFILE;
} else {
die "ERROR: Can not read pid from $pidfile: $!\n";
};
}
}
sub daemonize_me ($) {
my $pidfile = shift;
if (defined $pidfile){
if (-f $pidfile ) {
open PIDFILE, "<$pidfile";
<PIDFILE> =~ /(\d+)/;
close PIDFILE;
my $pid = $1;
die "ERROR: I Quit! Another copy of $0 ($pid) seems to be running.\n".
" Check $pidfile\n"
if kill 0, $pid;
}
}
print "Warning: no logging method specified. Messages will be lost.\n"
unless $logging;
print "Daemonizing $0 ...\n";
defined (my $pid = fork) or die "Can't fork: $!";
if ($pid) {
exit;
} else {
if(open(PIDFILE,">$pidfile")){
print PIDFILE "$$\n";
close PIDFILE;
} else {
warn "creating $pidfile: $!\n";
};
require 'POSIX.pm';
&POSIX::setsid or die "Can't start a new session: $!";
open STDOUT,'>/dev/null' or die "ERROR: Redirecting STDOUT to /dev/null: $!";
open STDIN, '</dev/null' or die "ERROR: Redirecting STDIN from /dev/null: $!";
open STDERR, '>/dev/null' or die "ERROR: Redirecting STDERR to /dev/null: $!";
# send warnings and die messages to log
$SIG{__WARN__} = sub { do_log ((shift)."\n") };
$SIG{__DIE__} = sub { do_log ((shift)."\n"); };
}
}
# pseudo log system object
{
my $use_syslog;
my $use_cgilog;
my $use_debuglog;
my $use_filelog;
my $syslog_facility;
my $syslog_priority = $DEFAULTPRIORITY;
sub initialize_debuglog (){
$use_debuglog = 1;
}
sub initialize_cgilog (){
$use_cgilog = 1;
$logging=1;
}
sub initialize_filelog ($){
$use_filelog = shift;
$logging=1;
}
sub initialize_syslog ($$) {
my $fac = shift;
my $pri = shift;
$use_syslog = 1;
$logging=1;
die "missing facility?" unless defined $fac;
$syslog_facility = $fac if defined $fac;
$syslog_priority = $pri if defined $pri;
print "Note: logging to syslog as $syslog_facility/$syslog_priority.\n";
openlog(basename($0), 'pid', $syslog_facility);
}
sub do_syslog ($){
syslog("$syslog_facility|$syslog_priority", shift);
}
sub do_cgilog ($){
my $str = shift;
print "<p>" , $str, "</p>\n";
print STDERR $str,"\n"; # for the webserver log
}
sub do_debuglog ($){
do_log(shift) if $use_debuglog;
}
sub do_filelog ($){
open X,">>$use_filelog" or return;
print X scalar localtime(time)," - ",shift,"\n";
close X;
}
sub do_log (@){
my $string = join(" ", @_);
chomp $string;
do_syslog($string) if $use_syslog;
do_cgilog($string) if $use_cgilog;
do_filelog($string) if $use_filelog;
print STDERR $string,"\n" unless $logging;
}
}
###########################################################################
# The Main Program
###########################################################################
my $RCS_VERSION = '$Id: Smokeping.pm,v 1.5 2004/10/21 21:10:51 oetiker Exp $';
sub load_cfg ($) {
my $cfgfile = shift;
my $cfmod = (stat $cfgfile)[9] || die "ERROR: calling stat on $cfgfile: $!\n";
# when running under speedy this will prevent reloading on every run
# if cfgfile has been modified we will still run.
if (not defined $cfg or not defined $probes or $cfg->{__last} < $cfmod ){
$cfg = undef;
my $parser = get_parser;
$cfg = get_config $parser, $cfgfile;
$cfg->{__parser} = $parser;
$cfg->{__last} = $cfmod;
$cfg->{__cfgfile} = $cfgfile;
$probes = undef;
$probes = load_probes $cfg;
$cfg->{__probes} = $probes;
init_alerts $cfg if $cfg->{Alerts};
init_target_tree $cfg, $probes, $cfg->{Targets}, $cfg->{General}{datadir};
}
}
sub makepod ($){
my $parser = shift;
my $e='=';
my $retval = <<POD;
${e}head1 NAME
smokeping_config - Reference for the SmokePing Config File
${e}head1 OVERVIEW
SmokePing takes its configuration from a single central configuration file.
Its location must be hardcoded in the smokeping script and smokeping.cgi.
The contents of this manual is generated directly from the configuration
file parser.
The Parser for the Configuration file is written using David Schweikers
ParseConfig module. Read all about it in L<ISG::ParseConfig>.
The Configuration file has a tree-like structure with section headings at
various levels. It also contains variable assignments and tables.
Warning: this manual is rather long. See the smokeping_examples document
for simple configuration examples.
${e}head1 REFERENCE
The text below describes the syntax of the SmokePing configuration file.
POD
$retval .= $parser->makepod;
$retval .= <<POD;
${e}head1 COPYRIGHT
Copyright (c) 2001-2003 by Tobias Oetiker. All right reserved.
${e}head1 LICENSE
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.
You should have received a copy of the GNU General Public
License along with this program; if not, write to the Free
Software Foundation, Inc., 675 Mass Ave, Cambridge, MA
02139, USA.
${e}head1 AUTHOR
Tobias Oetiker E<lt>tobi\@oetiker.chE<gt>
${e}cut
POD
}
sub cgi ($) {
$cgimode = 'yes';
umask 022;
load_cfg shift;
my $q=new CGI;
print $q->header(-type=>'text/html',
-expires=>'+'.($cfg->{Database}{step}).'s',
-charset=> ( $cfg->{Presentation}{charset} || 'iso-8859-15')
);
if ($q->param(-name=>'secret') && $q->param(-name=>'target') ) {
update_dynaddr $cfg,$q;
} else {
display_webpage $cfg,$q;
}
}
sub gen_page ($$$);
sub gen_page ($$$) {
my ($cfg, $tree, $open) = @_;
my ($q, $name, $page);
$q = bless \$q, 'dummyCGI';
$name = @$open ? join('.', @$open) . ".html" : "index.html";
die "Can not open $cfg-{General}{pagedir}/$name for writing: $!" unless
open PAGEFILE, ">$cfg->{General}{pagedir}/$name";
my $step = $probes->{$tree->{probe}}->step();
$page = fill_template
($cfg->{Presentation}{template},
{
menu => target_menu($cfg->{Targets},
[@$open], #copy this because it gets changed
"", ".html"),
title => $tree->{title},
remark => ($tree->{remark} || ''),
overview => get_overview( $cfg,$q,$tree,$open ),
body => get_detail( $cfg,$q,$tree,$open ),
target_ip => ($tree->{host} || ''),
owner => $cfg->{General}{owner},
contact => $cfg->{General}{contact},
author => '<A HREF="http://tobi.oetiker.ch/">Tobi Oetiker</A>',
smokeping => '<A HREF="http://people.ee.ethz.ch/~oetiker/webtools/smokeping/counter.cgi/'.$VERSION.'">SmokePing-'.$VERSION.'</A>',
step => $step,
rrdlogo => '<A HREF="http://people.ee.ethz.ch/~oetiker/webtools/rrdtool/"><img border="0" src="'.$cfg->{General}{imgurl}.'/rrdtool.png"></a>',
smokelogo => '<A HREF="http://people.ee.ethz.ch/~oetiker/webtools/smokeping/counter.cgi/'.$VERSION.'"><img border="0" src="'.$cfg->{General}{imgurl}.'/smokeping.png"></a>',
});
print PAGEFILE $page;
close PAGEFILE;
foreach my $key (keys %$tree) {
my $value = $tree->{$key};
next unless ref($value) eq 'HASH';
gen_page($cfg, $value, [ @$open, $key ]);
}
}
sub makestaticpages ($$) {
my $cfg = shift;
my $dir = shift;
# If directory is given, override current values (pagedir and and
# imgurl) so that all generated data is in $dir. If $dir is undef,
# use values from config file.
if ($dir) {
mkdir $dir, 0755 unless -d $dir;
$cfg->{General}{pagedir} = $dir;
$cfg->{General}{imgurl} = '.';
}
die "ERROR: No pagedir defined for static pages\n"
unless $cfg->{General}{pagedir};
# Logos.
gen_imgs($cfg);
# Iterate over all targets.
my $tree = $cfg->{Targets};
gen_page($cfg, $tree, []);
}
sub pages ($) {
my ($config) = @_;
umask 022;
load_cfg($config);
makestaticpages($cfg, undef);
}
sub pod2man {
my $string = shift;
my $pid = open(P, "-|");
if ($pid) {
pod2usage(-verbose => 2, -input => \*P);
exit 0;
} else {
print $string;
exit 0;
}
}
sub probedoc {
my $class = shift;
my $do_man = shift;
eval "require $class";
die("Failed to load $class: $@") if $@;
if ($do_man) {
pod2man($class->pod);
} else {
print $class->pod;
}
exit 0;
}
sub verify_cfg {
my $cfgfile = shift;
get_config(get_parser, $cfgfile);
print "Configuration file '$cfgfile' syntax OK.\n";
}
sub main (;$) {
$cgimode = 0;
umask 022;
my $defaultcfg = shift;
$opt{filter}=[];
GetOptions(\%opt, 'version', 'email', 'man:s','help','logfile=s','static-pages:s', 'debug-daemon',
'nosleep', 'makepod:s','debug','restart', 'filter=s', 'nodaemon|nodemon',
'config=s', 'check', 'gen-examples') or pod2usage(2);
if($opt{version}) { print "$RCS_VERSION\n"; exit(0) };
if(exists $opt{man}) {
if ($opt{man}) {
if ($opt{man} eq 'smokeping_config') {
pod2man(makepod(get_parser));
} else {
probedoc($opt{man}, 'do_man');
}
} else {
pod2usage(-verbose => 2);
}
exit 0;
}
if($opt{help}) { pod2usage(-verbose => 1); exit 0 };
if(exists $opt{makepod}) {
if ($opt{makepod} and $opt{makepod} ne 'smokeping_config') {
probedoc($opt{makepod});
} else {
print makepod(get_parser);
}
exit 0;
}
if (exists $opt{'gen-examples'}) {
Smokeping::Examples::make($opt{check});
exit 0;
}
initialize_debuglog if $opt{debug} or $opt{'debug-daemon'};
my $cfgfile = $opt{config} || $defaultcfg;
if(defined $opt{'check'}) { verify_cfg($cfgfile); exit 0; }
load_cfg $cfgfile;
if(defined $opt{'static-pages'}) { makestaticpages $cfg, $opt{'static-pages'}; exit 0 };
if($opt{email}) { enable_dynamic $cfg, $cfg->{Targets},"",""; exit 0 };
if($opt{restart}) { kill_smoke $cfg->{General}{piddir}."/smokeping.pid";};
if($opt{logfile}) { initialize_filelog($opt{logfile}) };
if (not keys %$probes) {
do_log("No probes defined, exiting.");
exit 1;
}
unless ($opt{debug} or $opt{nodaemon}) {
if (defined $cfg->{General}{syslogfacility}) {
initialize_syslog($cfg->{General}{syslogfacility},
$cfg->{General}{syslogpriority});
}
daemonize_me $cfg->{General}{piddir}."/smokeping.pid";
}
do_log "Smokeping version $VERSION successfully launched.";
my $myprobe;
my $forkprobes = $cfg->{General}{concurrentprobes} || 'yes';
if ($forkprobes eq "yes" and keys %$probes > 1 and not $opt{debug}) {
my %probepids;
my $pid;
do_log("Entering multiprocess mode.");
for my $p (keys %$probes) {
if ($probes->{$p}->target_count == 0) {
do_log("No targets defined for probe $p, skipping.");
next;
}
my $sleep_count = 0;
do {
$pid = fork;
unless (defined $pid) {
do_log("Fatal: cannot fork: $!");
die "bailing out"
if $sleep_count++ > 6;
sleep 10;
}
} until defined $pid;
$myprobe = $p;
goto KID unless $pid; # child skips rest of loop
do_log("Child process $pid started for probe $myprobe.");
$probepids{$pid} = $myprobe;
}
# parent
do_log("All probe processes started successfully.");
my $exiting = 0;
for my $sig (qw(INT TERM)) {
$SIG{$sig} = sub {
do_log("Got $sig signal, terminating child processes.");
$exiting = 1;
kill $sig, $_ for keys %probepids;
my $now = time;
while(keys %probepids) { # SIGCHLD handler below removes the keys
if (time - $now > 2) {
do_log("Can't terminate all child processes, giving up.");
exit 1;
}
sleep 1;
}
do_log("All child processes successfully terminated, exiting.");
exit 0;
}
};
$SIG{CHLD} = sub {
while ((my $dead = waitpid(-1, WNOHANG)) > 0) {
my $p = $probepids{$dead};
$p = 'unknown' unless defined $p;
do_log("Child process $dead (probe $p) exited unexpectedly with status $?.")
unless $exiting;
delete $probepids{$dead};
}
};
sleep while 1; # just wait for the signals
do_log("Exiting abnormally - this should not happen.");
exit 1; # not reached
} else {
if ($forkprobes ne "yes") {
do_log("Not entering multiprocess mode because the 'concurrentprobes' variable is not set.");
for my $p (keys %$probes) {
for my $what (qw(offset step)) {
do_log("Warning: probe-specific parameter '$what' ignored for probe $p in single-process mode." )
if defined $cfg->{Probes}{$p}{$what};
}
}
} elsif ($opt{debug}) {
do_debuglog("Not entering multiprocess mode with '--debug'. Use '--debug-daemon' for that.")
} elsif (keys %$probes == 1) {
do_log("Not entering multiprocess mode for just a single probe.");
$myprobe = (keys %$probes)[0]; # this way we won't ignore a probe-specific step parameter
}
for my $sig (qw(INT TERM)) {
$SIG{$sig} = sub {
do_log("Got $sig signal, terminating.");
exit 1;
}
}
}
KID:
my $offset;
my $step;
if (defined $myprobe) {
$offset = $probes->{$myprobe}->offset || 'random';
$step = $probes->{$myprobe}->step;
$0 .= " [$myprobe]" unless defined $cfg->{General}{changeprocessnames}
and $cfg->{General}{changeprocessnames} eq "no";
} else {
$offset = $cfg->{General}{offset} || 'random';
$step = $cfg->{Database}{step};
}
if ($offset eq 'random'){
$offset = int(rand($step));
} else {
$offset =~ s/%$//;
$offset = $offset / 100 * $step;
}
for (keys %$probes) {
next if defined $myprobe and $_ ne $myprobe;
# fill this in for report_probes() below
$probes->{$_}->offset_in_seconds($offset); # this is just for humans
if ($opt{debug} or $opt{'debug-daemon'}) {
$probes->{$_}->debug(1) if $probes->{$_}->can('debug');
}
}
report_probes($probes, $myprobe);
while (1) {
unless ($opt{nosleep} or $opt{debug}) {
my $sleeptime = $step - (time-$offset) % $step;
if (defined $myprobe) {
$probes->{$myprobe}->do_debug("Sleeping $sleeptime seconds.");
} else {
do_debuglog("Sleeping $sleeptime seconds.");
}
sleep $sleeptime;
}
my $now = time;
run_probes $probes, $myprobe; # $myprobe is undef if running without 'concurrentprobes'
update_rrds $cfg, $probes, $cfg->{Targets}, $cfg->{General}{datadir}, $myprobe;
exit 0 if $opt{debug};
my $runtime = time - $now;
if ($runtime > $step) {
my $warn = "WARNING: smokeping took $runtime seconds to complete 1 round of polling. ".
"It should complete polling in $step seconds. ".
"You may have unresponsive devices in your setup.\n";
if (defined $myprobe) {
$probes->{$myprobe}->do_log($warn);
} else {
do_log($warn);
}
}
}
}
sub gen_imgs ($){
my $cfg = shift;
if (not -r $cfg->{General}{imgcache}."/rrdtool.png"){
open W, ">".$cfg->{General}{imgcache}."/rrdtool.png"
or do { warn "WARNING: creating $cfg->{General}{imgcache}/rrdtool.png: $!\n"; return 0 };
print W unpack ('u', <<'UUENC');
MB5!.1PT*&@H -24A$4@ '@ B! , !F7P!P +5!,5$44&5T0
M.(L@2)8N6* X9JQ)=+)QC[Q7AL"9J;63KL^SR=[]^\S____K^?S6XN6'_*P9
M &D$E$051XVIV5_T\;YQW'37Z(M"Z+>!XW3B&VQ3U'$ 6&N#L;D9JAF+MK
M:(FB4M\%.C,4DX8HX"%-PK+29M$@0:,CL@H$4F<TBE&:U!VM-&,(433$D>#%
M["Y:VB3J-AOA X97_Z&?1XS;=I^V _[G.\>VWI>S_MY/L_[^9QIYW_%\FZS
M3>_MG>5M>&YO+L_]81/:OZ5G3&O!YB!$(-B<"U7M46595A1%EJ5<B! .0>!Y
M@65YGO#DGX%1E6D]^-]!!Z/#T"L04',APX@>59(E17(ZG;(31A.$HZ:70;7Y
M/]#F8" 0""J2),,T)%55)$41!5GQP%R D"2GX'#\"[X_1Z&/SSX+Y-!=V<'[
M]Z=!,2ZK7IC_X)P(3U$0I[ULCA-<K"#0:6<_O@;$!X'X^3BTZC%54=5 T'OV
M0X]3CDE2@U-JF&Z;$GBALI?O\YIY ;,\^2%" +\,QD^LWPZ^_"80OSAW)JB$
MOFBXF 7-<L73EG7,;@A_=\@N#S]].-3GG:M9;32O"3OO5]:U6'9X4 [<VU3N
M*<^Z>IY^<#>@MMW=K)OY+>3'I<HS7:=GNB8&':*WN'ZVO'_6WE\2\Q[J\W9,
MEV>)JV47OG'K7L]T8T_\G7BSVBBY3EQV09Y<2MUJS>JWCIBW6.PJKM\("5WV
M/B[F#:$-/G0(D_*CYB* GP;B&PJ%6]8"S5ZGJZT?5.5RM>YRS8M8_51CL=AH
MYF8V=S;LO=R4:Q/-[6P<POR!^X0JQ^7X*Y'";T_)JDMRU8$RP)Z&U<+56'&L
MD17+?<53(83LO4S,]<;*1EX>*.?O[P5E]=[FK=^%[C;VS!V;O:R>F)FKO.Q2
M9,FE.&8'Q=G!2UY6J)X=['4-3)7.-L6\*.X:^'VY&9=W_:K*M-8<OB8WW!EM
M4-JD[JN*I_M2]8<-X*$:C]C2[QCX-5LC"%S;.DM"[<Q 4U\IKC8/^$KS2&D6
M%YG6Z+:"E7M4<!*XCX8#;L$IB.#HW$?@B,!BL#5#&)9A$$($YR,",!AXU[U
MRY*ZBXO4PD").3O1,\&RA%X, T>"P"B8W9-3IGW!NR+8SP&BX#]6$"D&O5E"
M6%X ,4+/$Q5%A&IC& 3@=\Z';T3''/*Q.^'KT;%ZASAZKB-\E@!;.M9!HYUE
M#GZ]Y*-ZZ,A6%&%LJ3[9A FL^;L3=_3LYWK"(2]L):_KC_GZQ 6C4W\.=)F^
M/:$OZ1E2>&&Q1A_"#.K<.NU?0HRU1>]E"%]D>O%N^/B(,)[N<3S\2".UZ8S[
M^=4DMNG# ENP:(E6W*S(,'_=QR *V5>>H]?U#+)U'/<1NN;5M\*=(])/4JON
MQ8D%\4WC ??J3)0M,1:)8(\4C)V,6)[80[4(V5(^YL8=#>5O+R';N=:CD+8<
M[!^1?IR:<#_H7G"4 )R]EC0SQK*9KR26L=8(LU)Q8&>/VVYH2/OIGXN9SU/N
M?257?(3DX*OZB&A-G79K6YI08FA<]G@2<]LIJ%?DC2$]@KAH1<*>+C 2EDPJ
M,OG,GQZR'M:;"(:$?5LV,CDBUCYF.>UGFE"HO\_=KDR: 895\9:;_IL$/2U;
MS#=9C&1A^_BG^:;:](K-G6K*;=7JD? OA\GDL,!ISS74NHZY[-A?,+.=&B)5
MG.6+3R*XZ(\CBU=TV5C>_Y%U5$]4I#7;NQ6GP"=4^:O*L:\39H%+>K1O#,1R
MKX:S%/9!2BS7W\X0I*TMFKF]QK+]?/>GQ4QM>M[VF;4IE[ 7;XY.MNMI LH_
MU\93O83)'DE2^!3A&,N$/X.+'IY+%$0+C$>OG?5'.H=;TT]^A+<X\%F1Z4G9
ML#[D3T581IO4K.D%S&0KDJC(2#'L'F*YJ4<(^L2:+(@6IA\>6$E%KD?\*9_-
MHS=AY*;PZ/B0S5ADN?F+\P>-QYBY?3*!D?$G\#"QW&J-$*;"LHS0:[!5#SKG
M$1I/<39Y'*:M%9DR9>&WA@X;*4P6VS6Z5)1M_Q)9C =P[,C!+ZM7&*;@>RM"
MUM0OD/_2 D)&$NWKL#8A6P:4[><N##%;Z0S6PAID8P&MCR:1'>8%RC^X[<\0
MDC\)?2>3>YB]6A+MU3/86GKA/;05 =CZF?Z"J]4?631] >W7]:KOKSPZHG\'
MPIBQ9_5YS# 6_U+W8Q_&Z*2>W4H@LJ]37]9UJGR8,[N)F7?B]Q!/$%0-MW"F
MICTO]R:$UP,'#3+_)EJ%Z)>2K_KS,#&_3DL$!VOFZ7FGM2$7M%+ 8<?DWS])
GK@CL_D-K0>[]"@'[?,KT_\<_ *X%"4UQ:&PM $E%3D2N0F""
UUENC
close W;
}
if (not -r $cfg->{General}{imgcache}."/smokeping.png"){
open W, ">".$cfg->{General}{imgcache}."/smokeping.png"
or do { warn "WARNING: creating $cfg->{General}{imgcache}/smokeping.png: $!\n"; return 0};
print W unpack ('u', <<'UUENC');
MB5!.1PT*&@H````-24A$4@```'@````6"`,````\1*C*```#`%!,5$7___\2
M*FINUAH.Q"X+DD(.<DYFUAX.8E:"GL`.5EH2JCH.3ETB@D9RCK4NJC8.1EXT
MK#)ZVAI&8I+^ID(2/F(^5HJ;ZPXZKC+&>#SRF$"6MM(2.F(R3H(^LBYNCK*Z
MWNY:/DJI\@INBK$2-F:P:CZJSN(R2H+DCCXZ5HJRUNF46CYFPB+"YO52<IXN
M1GY(.E(NECX2,F8J0GHJBD**JLBV^0:>OM>*4CX*AD8IIC;"=CY*SB(X-EDF
M/G@JGCH2+FIFAJXB.G9:=J+*[OHJ1GV^^@)ZFKL-=DYJ1D9:PB:.\@Y*9I87
MCD(>-G(.:E).[A85H3M^WA:BQMPZMBYE@JH>>DI2/DXD,F+"_@*"XA9!MRT;
M+F9".E9.:I8:PBYVEKH+?DHDESZ.KLM>>J6:]@HB/G9*PBINZA(>.G-"7H_*
MZOH6,FX6+FH/7E8R-EY^SAYFWAH6DD*6XA)6RB8>JC9FRB(NIC9*MBH2AD;&
MZO:"HL+2\OX:>$H*GCX:-G(7@4<V4H:^XO*VVNHFRBJ&HL*:NM*>PMK.\OY2
M;IPN-EZF^@;&_@(.2EX.6ED20F*RTN:2LLYB?J<:9E(.4EITX!8,FCX6ED)R
MDK:JRN%GSA\6AD8JO"XF0GIFXAH.;E%*OBHBGCH/9E-:RB*.Z!(^6HT::D[.
M[OS&YO:P]@82?TI^GKXN2G\NGCJB^@86+FY"LBX:,FZ2YA(>@D9&OBINTAZ*
MZA(*>DV6^@J^WN^ZVNXHK#9RRAX6<DZZ^@/.?C[ZGD)>QB9N\A*Q^@:B[@YZ
MEKK"XO(V3H5JAJZ*IL869E(VECZB\PH>AD9BS2(Z4H:VUNJ.JLHNKC90OBIA
M04D22EXNFCIHTAX6BD9VUAH:KC9^FKZ*Y!)2Q"9NW!IVDK9*KBY"6HZNSN.2
MKLX*@DH0BD825EH28E821E]6<IY..DYBOB:6\@ZFQMXJ,EY&NBI&7I*BPMIN
MYA:^_@)*NBJ&IL6Z_@)JBJX2.F8:DD(.ED(JHCF5Z@Z:NM:6LLX.>DM.:II/
M<@=C`````7123E,`0.;89@``!Q=)1$%4>-K%5G]46U<=[W/$D,60+81ZEN00
M-P8+,V0-)M'59C?A!7`^@NN*ZSO#F)&(DI?'%'_4OE33@*3)\4%^'-I"-\9&
MBP1!C[$Z3%3<T9)2K1+6SE;7E15HUQP/MN^DP#EK5X_WO01*Z_[TG'US\NY[
MWW?O_7X_]_OC\[8@'Y%L`1^1;,D[0)+_=TP`?(A*NZ[,&3;/2C"7)@[M6Q16
M3N.V&/,>6:LUU>9X[CX>)SDG2?;/R>9MM:$^*%?E`,A[A')MZ"UY3E]V52@%
MW"C@M_?VR-E[#C&IB>J89;]=8D6LP9D1;K.*:,;,OJ_&3'6>NIE@A1L!UI$:
MFX8D*VP9R80*LT'!2JR;#(=^O^?-HJ*6^KY0^[:?O2=L_$NCE-U"V_>9;7^6
M`FU/8\?S1[]WIF5(J,W'N"W*$(2:2G3[@&7:T-0&5=:,K,X"@'MVS9^.$922
ML5_W(IK^@=N8U]=O8$09^S(G=;X[4=,*WJ6AX%M;ALYG:_?S&_3/#X7@><N'
MOEV[K4<KN'QNBGU?^^#^'I!#K%@A.F\7^A<\)<T^1^+4+*L:3T1*$$155XFF
MRIGR))7LEK@K5JCRC$H4I@Q.+((&8NI4*G)I4P![;]`_?N7@&'VLX%!MMH/?
M@6=_Q8.6Y;Q;JS?[A.<OT+4[W_GZQ3'\F^W:7(Q=LD#8I)#42-K<-@,ZX+0B
MWB"#,C;2.!,>71BOP8)VAE).*WPZ8J%?5!YCHM4C$:++(2HMK1KD`M/,A;CW
M!O[Z#PM>SNJ_>__J:@?_,$[C[TR*H>%?9F^V\_Y!/_SF))_/Z_CT?GC6$#%`
M5#HJL8)9K"3BC58&.CTGD8GI1*#2:77=1BM%OCA,@J9E8CD(YR4/#%",R4*6
MR`BFIGK0R.8!^>)S9Y_8#4?!#?I"P=(_]?K?WL\ASD[A]-'_]$CKH>&AI_13
MNQJE$+_PRENY&"/(X,Q"0"E;<UF!Q9[8%V"J6FT'1O<E^B><8731Q4("BD)U
M0H3IB-$8.K!F04A7!`V/1YU.22M`=GSVL8>VG]W-'C7^^E=?/D@_?.B9J=H"
MB/CG7X*6)WOK;V6??.$,OO6R&`!ISQ6!0"C/(0:^-29&I!U!L\I!$41B&IM7
MHJ/4BFLM0=4-<H5G-J6I\:"#VA=0SY60;'10HJNR,CP^"YH_]=@;Q<6/[@!L
MC'$H4[^H/[R*LXA/W_?Y+'VNX-`M?,_2$7HGKPR1\_]>5%2TK;TL5\>D)N-9
M(-2+6-"@7@C'ED\Q:%=7S!\L3:7FC6PC`-YH.M:=T:&!`.6WP;-W^4?19#I=
MZ5$AS5]XJ+BX>/M7$"T\ZJ]]Z]S3+<.]#3G$I]]?NK9*'[SOBZM%G_L;OK->
M"L2?F,)Q6E\?XA`C;4:SS\2@Z5)16.GQI"FE.GG*T3D0-741<R>YC-78.SOG
M@PXTE8PI/2H2<1G0<)T3'C5L,\_]H;CXC<=?9).+OE@P+.B1BQMJ(>+#V1-+
M?4.[]/@??U/[Y.0-^L1E,2+_R;\^_@U\;%+*(B853I/$J^A.);M7D@/.H)\8
M)60U:VGE(S4'`N5-U=`U<Y6?6(A*%JD%AX$(]T^0$O^H7Q+76MF.MOOLH]L?
M?P(F@N`:_K$A.6R*XH95B+@#/_U3J;3Q`3V.P^1J&5N]Q@N5B8??_Q&]M5[.
MUG$\:$C/14U^JE+GC_DE%KLRT/6()KBL?EMB5U)^TZ63*F=$K=:-P!IBHC/E
MQ$#3($1LL%4;6ZUL!C3OV/'O9JZ<Z%\WPHP%XH:I'.(7I(AT>,\8GGVJG7<$
M']NUU,BO?^88_C1?RR'&_%0J'%:K96\SZA5%W&:(W<;<EV34XB7)7`H-RW21
M\IA:5M6FBE`&FV\^K?9GJ@RCZ<7I.I'-"#88`0B^3Y\;AB6*B,]O(`:@;/BU
ML>Q-H?"E"W3VV-'O7/P3?6NO&&8U7-'JE'6I4\E(4Y-LV61$)NP'9HRP@)2R
MZU:L,$RA!$$E'1DC61*)?8!97:<Z8W/V9_<%J!@%:WZ=;0"B[7N7_AW;E!#Q
M_BG\I?:]^`D>K!N8R:]MA2VS;^\1/6RH>/;!\X)\YT*,6-.\O4EB5#B=LVXD
M+G%"HK!BHJB"U*JBA3*#7V=RF4DPT>0H]0&OK?"#%9''\"QLU4QI1=XJ1Q+#
M?^6)`>O"E>/'!:$KQW_0Q[J!R'N__!Y+$L.7'WCUS"<[>"Q)<+T:(&XK#!?D
M.J^7!/`ZR.:,=[#5#8>VB1'72(69;2-QC6HB#DG*YW*=5%UGZ0GS>0&9XUUX
M)>576?J#=V5B<1EDP9`VYY0V)&5ME8F%`@%+FSD^!F3>97`78W-/9%Z9VYH=
M0&Z$/VB0),%FS@?_R_[Y->O:.TYN?(%L&`?K1I%-ON3-W3T7N?=Y?=VZ`P`@
M=QRZ"U#^"P1\".0[*')SP89]!-SK#-CD]Z:-[IX'[CF(_P)F$_VEE.-5````
*``!)14Y$KD)@@@``
UUENC
close W;
}
}
=head1 NAME
Smokeping.pm - SmokePing Perl Module
=head1 OVERVIEW
Almost all SmokePing functionality sits in this Module.
The programs L<smokeping|smokeping> and L<smokeping.cgi|smokeping.cgi> are merely
figure heads allowing to hardcode some pathnames.
If you feel like documenting what is happening within this library you are
most welcome todo so.
=head1 COPYRIGHT
Copyright (c) 2001 by Tobias Oetiker. All right reserved.
=head1 LICENSE
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.
You should have received a copy of the GNU General Public
License along with this program; if not, write to the Free
Software Foundation, Inc., 675 Mass Ave, Cambridge, MA
02139, USA.
=head1 AUTHOR
Tobias Oetiker E<lt>tobi@oetiker.chE<gt>
Niko Tyni E<lt>ntyni@iki.fiE<gt>
=cut
# Emacs Configuration
#
# Local Variables:
# mode: cperl
# eval: (cperl-set-style "PerlStyle")
# mode: flyspell
# mode: flyspell-prog
# End:
#
# vi: sw=4
|