/usr/share/check_mk/modules/notify.py is in check-mk-server 1.2.8p16-1ubuntu0.1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 | #!/usr/bin/python
# -*- encoding: utf-8; py-indent-offset: 4 -*-
# +------------------------------------------------------------------+
# | ____ _ _ __ __ _ __ |
# | / ___| |__ ___ ___| | __ | \/ | |/ / |
# | | | | '_ \ / _ \/ __| |/ / | |\/| | ' / |
# | | |___| | | | __/ (__| < | | | | . \ |
# | \____|_| |_|\___|\___|_|\_\___|_| |_|_|\_\ |
# | |
# | Copyright Mathias Kettner 2014 mk@mathias-kettner.de |
# +------------------------------------------------------------------+
#
# This file is part of Check_MK.
# The official homepage is at http://mathias-kettner.de/check_mk.
#
# check_mk 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 in version 2. check_mk is distributed
# in the hope that it will be useful, but WITHOUT ANY WARRANTY; with-
# out even the implied warranty of MERCHANTABILITY or FITNESS FOR A
# PARTICULAR PURPOSE. See the GNU General Public License for more de-
# tails. You should have received a copy of the GNU General Public
# License along with GNU Make; see the file COPYING. If not, write
# to the Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
# Boston, MA 02110-1301 USA.
# Please have a look at doc/Notifications.png:
#
# There are two types of contexts:
# 1. Raw contexts (purple)
# -> These come out from the monitoring core. They are not yet
# assinged to a certain plugin. In case of rule based notifictions
# they are not even assigned to a certain contact.
#
# 2. Plugin contexts (cyan)
# -> These already bear all information about the contact, the plugin
# to call and its parameters.
# .--Configuration-------------------------------------------------------.
# | ____ __ _ _ _ |
# | / ___|___ _ __ / _(_) __ _ _ _ _ __ __ _| |_(_) ___ _ __ |
# | | | / _ \| '_ \| |_| |/ _` | | | | '__/ _` | __| |/ _ \| '_ \ |
# | | |__| (_) | | | | _| | (_| | |_| | | | (_| | |_| | (_) | | | | |
# | \____\___/|_| |_|_| |_|\__, |\__,_|_| \__,_|\__|_|\___/|_| |_| |
# | |___/ |
# +----------------------------------------------------------------------+
# | Default values of global configuration variables. |
# '----------------------------------------------------------------------'
# Default settings
notification_logdir = var_dir + "/notify"
notification_spooldir = var_dir + "/notify/spool"
notification_bulkdir = var_dir + "/notify/bulk"
notification_core_log = var_dir + "/notify/nagios.log" # Fallback for history if no CMC running
notification_log = log_dir + "/notify.log"
notification_logging = 1
notification_backlog = 10 # keep the last 10 notification contexts for reference
# Settings for new rule based notifications
enable_rulebased_notifications = False
notification_fallback_email = ""
notification_rules = []
notification_bulk_interval = 10 # Check every 10 seconds for ripe bulks
notification_plugin_timeout = 60
# Notification Spooling.
# Possible values for notification_spooling
# "off" - Direct local delivery without spooling
# "local" - Asynchronous local delivery by notification spooler
# "remote" - Forward to remote site by notification spooler
# "both" - Asynchronous local delivery plus remote forwarding
# False - legacy: sync delivery (and notification_spool_to)
# True - legacy: async delivery (and notification_spool_to)
notification_spooling = "off"
# Legacy setting. The spool target is now specified in the
# configuration of the spooler. notification_spool_to has
# the tuple format (remote_host, tcp_port, also_local)
notification_spool_to = None
notification_log_template = \
u"$CONTACTNAME$ - $NOTIFICATIONTYPE$ - " \
u"$HOSTNAME$ $HOSTSTATE$ - " \
u"$SERVICEDESC$ $SERVICESTATE$ "
notification_mail_command = u"mail -s '$SUBJECT$' '$CONTACTEMAIL$'"
notification_host_subject = u"Check_MK: $HOSTNAME$ - $NOTIFICATIONTYPE$"
notification_service_subject = u"Check_MK: $HOSTNAME$/$SERVICEDESC$ $NOTIFICATIONTYPE$"
notification_common_body = u"""Host: $HOSTNAME$
Alias: $HOSTALIAS$
Address: $HOSTADDRESS$
"""
notification_host_body = u"""State: $LASTHOSTSTATE$ -> $HOSTSTATE$ ($NOTIFICATIONTYPE$)
Command: $HOSTCHECKCOMMAND$
Output: $HOSTOUTPUT$
Perfdata: $HOSTPERFDATA$
$LONGHOSTOUTPUT$
"""
notification_service_body = u"""Service: $SERVICEDESC$
State: $LASTSERVICESTATE$ -> $SERVICESTATE$ ($NOTIFICATIONTYPE$)
Command: $SERVICECHECKCOMMAND$
Output: $SERVICEOUTPUT$
Perfdata: $SERVICEPERFDATA$
$LONGSERVICEOUTPUT$
"""
#.
# .--Main----------------------------------------------------------------.
# | __ __ _ |
# | | \/ | __ _(_)_ __ |
# | | |\/| |/ _` | | '_ \ |
# | | | | | (_| | | | | | |
# | |_| |_|\__,_|_|_| |_| |
# | |
# +----------------------------------------------------------------------+
# | Main code entry point. |
# '----------------------------------------------------------------------'
def notify_usage():
sys.stderr.write("""Usage: check_mk --notify [--keepalive]
check_mk --notify spoolfile <filename>
Normally the notify module is called without arguments to send real
notification. But there are situations where this module is called with
COMMANDS to e.g. support development of notification plugins.
Available commands:
spoolfile <filename> Reads the given spoolfile and creates a
notification out of its data
stdin Read one notification context from stdin instead
of taking variables from environment
replay N Uses the N'th recent notification from the backlog
and sends it again, counting from 0.
send-bulks Send out ripe bulk notifications
""")
# Main function called by cmk --notify. It either starts the
# keepalive mode (used by CMC), sends out one notifications from
# several possible sources or sends out all ripe bulk notifications.
def do_notify(args):
convert_legacy_configuration()
global notify_mode, notification_logging
if notification_logging == 0:
notification_logging = 1 # transform deprecated value 0 to 1
try:
if not os.path.exists(notification_logdir):
os.makedirs(notification_logdir)
if not os.path.exists(notification_spooldir):
os.makedirs(notification_spooldir)
notify_mode = 'notify'
if args:
notify_mode = args[0]
if notify_mode not in [ 'stdin', 'spoolfile', 'replay', 'send-bulks' ]:
sys.stderr.write("ERROR: Invalid call to check_mk --notify.\n\n")
notify_usage()
sys.exit(1)
if len(args) != 2 and notify_mode not in [ "stdin", "replay", "send-bulks" ]:
sys.stderr.write("ERROR: need an argument to --notify %s.\n\n" % notify_mode)
sys.exit(1)
elif notify_mode == 'spoolfile':
filename = args[1]
elif notify_mode == 'replay':
try:
replay_nr = int(args[1])
except:
replay_nr = 0
# If the notify_mode is set to 'spoolfile' we try to parse the given spoolfile
# This spoolfile contains a python dictionary
# { context: { Dictionary of environment variables }, plugin: "Plugin name" }
# Any problems while reading the spoolfile results in returning 2
# -> mknotifyd deletes this file
if notify_mode == "spoolfile":
return handle_spoolfile(filename)
elif opt_keepalive:
notify_keepalive()
elif notify_mode == 'replay':
raw_context = raw_context_from_backlog(replay_nr)
notify_notify(raw_context)
elif notify_mode == 'stdin':
notify_notify(raw_context_from_stdin())
elif notify_mode == "send-bulks":
send_ripe_bulks()
else:
notify_notify(raw_context_from_env())
except Exception, e:
crash_dir = var_dir + "/notify"
if not os.path.exists(crash_dir):
os.makedirs(crash_dir)
file(crash_dir + "/crash.log", "a").write("CRASH (%s):\n%s\n" %
(time.strftime("%Y-%m-%d %H:%M:%S"), format_exception()))
def convert_legacy_configuration():
global notification_spooling
# Convert legacy spooling configuration to new one (see above)
if notification_spooling in (True, False):
if notification_spool_to:
remote_host, tcp_port, also_local = notification_spool_to
if also_local:
notification_spooling = "both"
else:
notification_spooling = "remote"
elif notification_spooling:
notification_spooling = "local"
else:
notification_spooling = "remote"
# This function processes one raw notification and decides wether it
# should be spooled or not. In the latter cased a local delivery
# is being done.
def notify_notify(raw_context, analyse=False):
if not analyse:
store_notification_backlog(raw_context)
notify_log("----------------------------------------------------------------------")
if analyse:
notify_log("Analysing notification (%s) context with %s variables" % (
find_host_service_in_context(raw_context), len(raw_context)))
else:
notify_log("Got raw notification (%s) context with %s variables" % (
find_host_service_in_context(raw_context), len(raw_context)))
# Add some further variable for the conveniance of the plugins
if notification_logging >= 2:
notify_log(render_context_dump(raw_context))
complete_raw_context(raw_context, with_dump = notification_logging >= 2, event_log = notify_log)
# Spool notification to remote host, if this is enabled
if notification_spooling in ("remote", "both"):
create_spoolfile({"context": raw_context, "forward": True})
if notification_spooling != "remote":
return locally_deliver_raw_context(raw_context, analyse=analyse)
# Here we decide which notification implementation we are using.
# Hopefully we can drop a couple of them some day
# 1. Rule Based Notifiations (since 1.2.5i1)
# 2. Flexible Notifications (since 1.2.2)
# 3. Plain email notification (refer to git log if you are really interested)
def locally_deliver_raw_context(raw_context, analyse=False):
contactname = raw_context.get("CONTACTNAME")
try:
# If rule based notifications are enabled then the Micro Core does not set the
# variable CONTACTNAME. In the other cores the CONTACTNAME is being set to
# check-mk-notify.
# We do we not simply check the config variable enable_rulebased_notifications?
# -> Because the core needs are restart in order to reflect this while the
# notification mode of Check_MK not. There are thus situations where the
# setting of the core is different from our global variable. The core must
# have precedence in this situation!
if not contactname or contactname == "check-mk-notify":
# 1. RULE BASE NOTIFICATIONS
notify_log_debug("Preparing rule based notifications")
return notify_rulebased(raw_context, analyse=analyse)
if analyse:
return # Analysis only possible when rule based notifications are enabled
# Now fetch all configuration about that contact (it needs to be configure via
# Check_MK for that purpose). If we do not know that contact then we cannot use
# flexible notifications even if they are enabled.
contact = contacts.get(contactname)
if contact.get("disable_notifications", False):
notify_log("Notifications for %s are disabled in personal settings. Skipping." % contactname)
return
# Get notification settings for the contact in question - if available.
if contact:
method = contact.get("notification_method", "email")
else:
method = "email"
if type(method) == tuple and method[0] == 'flexible':
# 2. FLEXIBLE NOTIFICATIONS
notify_log("Preparing flexible notifications for %s" % contactname)
notify_flexible(raw_context, method[1])
else:
# 3. PLAIN EMAIL NOTIFICATION
notify_log("Preparing plain email notifications for %s" % contactname)
notify_plain_email(raw_context)
except Exception, e:
if opt_debug:
raise
notify_log("ERROR: %s\n%s" % (e, format_exception()))
def notification_replay_backlog(nr):
global notify_mode
notify_mode = "replay"
raw_context = raw_context_from_backlog(nr)
notify_notify(raw_context)
def notification_analyse_backlog(nr):
global notify_mode
notify_mode = "replay"
raw_context = raw_context_from_backlog(nr)
return notify_notify(raw_context, analyse=True)
#.
# .--Keepalive-Mode (Used by CMC)----------------------------------------.
# | _ __ _ _ |
# | | |/ /___ ___ _ __ __ _| (_)_ _____ |
# | | ' // _ \/ _ \ '_ \ / _` | | \ \ / / _ \ |
# | | . \ __/ __/ |_) | (_| | | |\ V / __/ |
# | |_|\_\___|\___| .__/ \__,_|_|_| \_/ \___| |
# | |_| |
# +----------------------------------------------------------------------+
# | Implementation of cmk --notify --keepalive, which is being used |
# | by the Micro Core. |
# '----------------------------------------------------------------------'
# TODO: Make use of the generic do_keepalive() mechanism?
def notify_keepalive():
register_keepalive_sigint_handler()
event_keepalive(
event_function = notify_notify,
log_function = notify_log,
call_every_loop = send_ripe_bulks,
loop_interval = notification_bulk_interval,
)
#.
# .--Rule-Based-Notifications--------------------------------------------.
# | ____ _ _ _ |
# | | _ \ _ _| | ___| |__ __ _ ___ ___ __| | |
# | | |_) | | | | |/ _ \ '_ \ / _` / __|/ _ \/ _` | |
# | | _ <| |_| | | __/ |_) | (_| \__ \ __/ (_| | |
# | |_| \_\\__,_|_|\___|_.__/ \__,_|___/\___|\__,_| |
# | |
# +----------------------------------------------------------------------+
# | Logic for rule based notifications |
# '----------------------------------------------------------------------'
def notify_rulebased(raw_context, analyse=False):
# First step: go through all rules and construct our table of
# notification plugins to call. This is a dict from (user, plugin) to
# a pair if (locked, parameters). If locked is True, then a user
# cannot cancel this notification via his personal notification rules.
# Example:
# notifications = {
# ( "hh", "email" ) : ( False, [] ),
# ( "hh", "sms" ) : ( True, [ "0171737337", "bar" ] ),
# }
notifications = {}
num_rule_matches = 0
rule_info = []
for rule in notification_rules + user_notification_rules():
if "contact" in rule:
notify_log("User %s's rule '%s'..." % (rule["contact"], rule["description"]))
else:
notify_log("Global rule '%s'..." % rule["description"])
why_not = rbn_match_rule(rule, raw_context) # also checks disabling
if why_not:
notify_log(" -> does not match: %s" % why_not)
rule_info.append(("miss", rule, why_not))
else:
notify_log(" -> matches!")
num_rule_matches += 1
contacts = rbn_rule_contacts(rule, raw_context)
# Handle old-style and new-style rules
if "notify_method" in rule: # old-style
plugin = rule["notify_plugin"]
plugin_parameters = rule["notify_method"] # None: do cancel, [ str ]: plugin parameters
else:
plugin, plugin_parameters = rule["notify_plugin"]
bulk = rule.get("bulk")
if plugin_parameters == None: # cancelling
for contact in contacts:
key = contact, plugin
if key in notifications:
locked, plugin_parameters, bulk = notifications[key]
if locked and "contact" in rule:
notify_log(" - cannot cancel notification of %s via %s: it is locked" % key)
else:
notify_log(" - cancelling notification of %s via %s" % key)
del notifications[key]
else:
final_parameters = rbn_finalize_plugin_parameters(raw_context["HOSTNAME"], plugin, plugin_parameters)
for contact in contacts:
key = contact, plugin
plugintxt = plugin or "plain email"
if key in notifications:
locked, previous_parameters, old_bulk = notifications[key]
if locked and "contact" in rule:
notify_log(" - cannot modify notification of %s via %s: it is locked" % (contact, plugintxt))
continue
notify_log(" - modifying notification of %s via %s" % (contact, plugintxt))
else:
notify_log(" - adding notification of %s via %s" % (contact, plugintxt))
notifications[key] = ( not rule.get("allow_disable"), final_parameters, bulk )
rule_info.append(("match", rule, ""))
plugin_info = []
if not notifications:
if num_rule_matches:
notify_log("%d rules matched, but no notification has been created." % num_rule_matches)
else:
if notification_fallback_email and not analyse:
notify_log("No rule matched, falling back to email to %s" % notification_fallback_email)
plugin_context = create_plugin_context(raw_context, [])
contact = rbn_fake_email_contact(notification_fallback_email)
rbn_add_contact_information(plugin_context, contact)
notify_via_email(plugin_context)
else:
# Now do the actual notifications
notify_log("Executing %d notifications:" % len(notifications))
entries = notifications.items()
entries.sort()
for (contact, plugin), (locked, params, bulk) in entries:
if analyse:
verb = "would notify"
else:
verb = "notifying"
notify_log(" * %s %s via %s, parameters: %s, bulk: %s" % (
verb, contact, (plugin or "plain email"), params and ", ".join(params) or "(no parameters)",
bulk and "yes" or "no"))
plugin_info.append((contact, plugin, params, bulk)) # for analysis
try:
plugin_context = create_plugin_context(raw_context, params)
rbn_add_contact_information(plugin_context, contact)
if not analyse:
if bulk:
do_bulk_notify(contact, plugin, params, plugin_context, bulk)
elif notification_spooling in ("local", "both"):
create_spoolfile({"context": plugin_context, "plugin": plugin})
else:
call_notification_script(plugin, plugin_context)
except Exception, e:
if opt_debug:
raise
fe = format_exception()
notify_log(" ERROR: %s" % e)
notify_log(fe)
analysis_info = rule_info, plugin_info
return analysis_info
def rbn_finalize_plugin_parameters(hostname, plugin, rule_parameters):
# Right now we are only able to finalize notification plugins with dict parameters..
if type(rule_parameters) == dict:
parameters = host_extra_conf_merged(hostname, notification_parameters.get(plugin, []))
parameters.update(rule_parameters)
return parameters
else:
return rule_parameters
def add_rulebased_macros(raw_context):
# For the rule based notifications we need the list of contacts
# an object has. The CMC does send this in the macro "CONTACTS"
if "CONTACTS" not in raw_context:
raw_context["CONTACTS"] = livestatus_fetch_contacts(raw_context["HOSTNAME"], raw_context.get("SERVICEDESC"))
# Add a pseudo contact name. This is needed for the correct creation
# of spool files. Spool files are created on a per-contact-base, as in classical
# notifications the core sends out one individual notification per contact.
# In the case of rule based notifications we do not make distinctions between
# the various contacts.
raw_context["CONTACTNAME"] = "check-mk-notify"
# Create a table of all user specific notification rules. Important:
# create deterministic order, so that rule analyses can depend on
# rule indices
def user_notification_rules():
user_rules = []
contactnames = contacts.keys()
contactnames.sort()
for contactname in contactnames:
contact = contacts[contactname]
for rule in contact.get("notification_rules", []):
# Save the owner of the rule for later debugging
rule["contact"] = contactname
# We assume that the "contact_..." entries in the
# rule are allowed and only contain one entry of the
# type "contact_users" : [ contactname ]. This
# is handled by WATO. Contact specific rules are a
# WATO-only feature anyway...
user_rules.append(rule)
notify_log_debug("Found %d user specific rules" % len(user_rules))
return user_rules
def rbn_fake_email_contact(email):
return {
"name" : email,
"alias" : "Explicit email adress " + email,
"email" : email,
"pager" : "",
}
def rbn_add_contact_information(plugin_context, contact):
if type(contact) == dict:
for what in [ "name", "alias", "email", "pager" ]:
plugin_context["CONTACT" + what.upper()] = contact.get(what, "")
for key in contact.keys():
if key[0] == '_':
plugin_context["CONTACT" + key.upper()] = unicode(contact[key])
else:
if contact.startswith("mailto:"): # Fake contact
contact_dict = {
"name" : contact[7:],
"alias" : "Email address " + contact,
"email" : contact[7:],
"pager" : "" }
else:
contact_dict = contacts.get(contact, { "alias" : contact })
contact_dict["name"] = contact
rbn_add_contact_information(plugin_context, contact_dict)
def livestatus_fetch_contacts(host, service):
try:
if service:
query = "GET services\nFilter: host_name = %s\nFilter: service_description = %s\nColumns: contacts\n" % (
host, service)
else:
query = "GET hosts\nFilter: host_name = %s\nColumns: contacts\n" % host
commasepped = livestatus_fetch_query(query).strip()
aslist = commasepped.split(",")
if "check-mk-notify" in aslist: # Remove artifical contact used for rule based notifications
aslist.remove("check-mk-notify")
return ",".join(aslist)
except:
if opt_debug:
raise
return "" # We must allow notifications without Livestatus access
def rbn_match_rule(rule, context):
if rule.get("disabled"):
return "This rule is disabled"
return event_match_rule(rule, context) or \
rbn_match_escalation(rule, context) or \
rbn_match_escalation_throtte(rule, context) or \
rbn_match_host_event(rule, context) or \
rbn_match_service_event(rule, context) or \
rbn_match_notification_comment(rule, context) or \
rbn_match_event_console(rule, context)
def rbn_match_escalation(rule, context):
if "match_escalation" in rule:
from_number, to_number = rule["match_escalation"]
if context["WHAT"] == "HOST":
notification_number = int(context.get("HOSTNOTIFICATIONNUMBER", 1))
else:
notification_number = int(context.get("SERVICENOTIFICATIONNUMBER", 1))
if notification_number < from_number or notification_number > to_number:
return "The notification number %d does not lie in range %d ... %d" % (
notification_number, from_number, to_number)
def rbn_match_escalation_throtte(rule, context):
if "match_escalation_throttle" in rule:
from_number, rate = rule["match_escalation_throttle"]
if context["WHAT"] == "HOST":
notification_number = int(context.get("HOSTNOTIFICATIONNUMBER", 1))
else:
notification_number = int(context.get("SERVICENOTIFICATIONNUMBER", 1))
if notification_number <= from_number:
return
if (notification_number - from_number) % rate != 0:
return "This notification is being skipped due to throttling. The next number will be %d" % \
(notification_number + rate - ((notification_number - from_number) % rate))
def rbn_match_host_event(rule, context):
if "match_host_event" in rule:
if context["WHAT"] != "HOST":
if "match_service_event" not in rule:
return "This is a service notification, but the rule just matches host events"
else:
return # Let this be handled by match_service_event
allowed_events = rule["match_host_event"]
state = context["HOSTSTATE"]
last_state = context["PREVIOUSHOSTHARDSTATE"]
events = { "UP" : 'r', "DOWN" : 'd', "UNREACHABLE" : 'u' }
return rbn_match_event(context, state, last_state, events, allowed_events)
def rbn_match_service_event(rule, context):
if "match_service_event" in rule:
if context["WHAT"] != "SERVICE":
if "match_host_event" not in rule:
return "This is a host notification, but the rule just matches service events"
else:
return # Let this be handled by match_host_event
allowed_events = rule["match_service_event"]
state = context["SERVICESTATE"]
last_state = context["PREVIOUSSERVICEHARDSTATE"]
events = { "OK" : 'r', "WARNING" : 'w', "CRITICAL" : 'c', "UNKNOWN" : 'u' }
return rbn_match_event(context, state, last_state, events, allowed_events)
def rbn_match_event(context, state, last_state, events, allowed_events):
notification_type = context["NOTIFICATIONTYPE"]
if notification_type == "RECOVERY":
event = events.get(last_state, '?') + 'r'
elif notification_type in [ "FLAPPINGSTART", "FLAPPINGSTOP", "FLAPPINGDISABLED" ]:
event = 'f'
elif notification_type in [ "DOWNTIMESTART", "DOWNTIMEEND", "DOWNTIMECANCELLED"]:
event = 's'
elif notification_type == "ACKNOWLEDGEMENT":
event = 'x'
else:
event = events.get(last_state, '?') + events.get(state, '?')
notify_log("Event type is %s" % event)
# Now go through the allowed events. Handle '?' has matching all types!
for allowed in allowed_events:
if event == allowed or \
(allowed[0] == '?' and len(event) > 1 and event[1] == allowed[1]) or \
(event[0] == '?' and len(allowed) > 1 and event[1] == allowed[1]):
return
return "Event type '%s' not handled by this rule. Allowed are: %s" % (
event, ", ".join(allowed_events))
def rbn_rule_contacts(rule, context):
the_contacts = set([])
if rule.get("contact_object"):
the_contacts.update(rbn_object_contacts(context))
if rule.get("contact_all"):
the_contacts.update(rbn_all_contacts())
if rule.get("contact_all_with_email"):
the_contacts.update(rbn_all_contacts(with_email=True))
if "contact_users" in rule:
the_contacts.update(rule["contact_users"])
if "contact_groups" in rule:
the_contacts.update(rbn_groups_contacts(rule["contact_groups"]))
if "contact_emails" in rule:
the_contacts.update(rbn_emails_contacts(rule["contact_emails"]))
all_enabled = []
for contactname in the_contacts:
contact = contacts.get(contactname)
if contact:
if contact.get("disable_notifications", False):
notify_log(" - skipping contact %s: he/she has disabled notifications" % contactname)
continue
reason = rbn_match_contact_macros(rule, contactname, contact) or \
rbn_match_contact_groups(rule, contactname, contact)
if reason:
notify_log(" - skipping contact %s: %s" % (contactname, reason))
continue
else:
notify_log("Warning: cannot get information about contact %s: ignoring restrictions" % contactname)
all_enabled.append(contactname)
return all_enabled
def rbn_match_contact_macros(rule, contactname, contact):
if "contact_match_macros" in rule:
for macro_name, regexp in rule["contact_match_macros"]:
value = contact.get("_" + macro_name, "")
if not regexp.endswith("$"):
regexp = regexp + "$"
if not regex(regexp).match(value):
macro_overview = ", ".join([
"%s=%s" % (varname[1:], val)
for (varname, val)
in contact.items()
if varname.startswith("_")])
return "value '%s' for macro '%s' does not match '%s'. His macros are: %s" % (
value, macro_name, regexp, macro_overview)
def rbn_match_contact_groups(rule, contactname, contact):
if "contact_match_groups" in rule:
if "contactgroups" not in contact:
notify_log("Warning: cannot determine contact groups of %s: skipping restrictions" % contactname)
return
for required_group in rule["contact_match_groups"]:
if required_group not in contact["contactgroups"]:
return "he/she is not member of the contact group %s (his groups are %s)" % (
required_group, ", ".join(contact["contactgroups"] or ["<None>"]))
def rbn_match_notification_comment(rule, context):
if "match_notification_comment" in rule:
r = regex(rule["match_notification_comment"])
notification_comment = context.get("NOTIFICATIONCOMMENT", "")
if not r.match(notification_comment):
return "The beginning of the notification comment '%s' is not matched by the regex '%s'" % (
notification_comment, rule["match_notification_comment"])
def rbn_match_event_console(rule, context):
if "match_ec" in rule:
match_ec = rule["match_ec"]
is_ec_notification = "EC_ID" in context
if match_ec == False and is_ec_notification:
return "Notification has been created by the Event Console."
elif match_ec != False and not is_ec_notification:
return "Notification has not been created by the Event Console."
if match_ec != False:
# Match Event Console rule ID
if "match_rule_id" in match_ec and context["EC_RULE_ID"] not in match_ec["match_rule_id"]:
return "EC Event has rule ID '%s', but '%s' is required" % (
context["EC_RULE_ID"], match_ec["match_rule_id"])
# Match syslog priority of event
if "match_priority" in match_ec:
prio_from, prio_to = match_ec["match_priority"]
if prio_from > prio_to:
prio_to, prio_from = prio_from, prio_to
p = int(context["EC_PRIORITY"])
if p < prio_from or p > prio_to:
return "Event has priority %s, but matched range is %s .. %s" % (
p, prio_from, prio_to)
# Match syslog facility of event
if "match_facility" in match_ec:
if match_ec["match_facility"] != int(context["EC_FACILITY"]):
return "Wrong syslog facility %s, required is %s" % (context["EC_FACILITY"], match_ec["match_facility"])
# Match event comment
if "match_comment" in match_ec:
r = regex(match_ec["match_comment"])
if not r.search(context["EC_COMMENT"]):
return "The event comment '%s' does not match the regular expression '%s'" % (
context["EC_COMMENT"], match_ec["match_comment"])
def rbn_object_contacts(context):
commasepped = context.get("CONTACTS")
if commasepped:
return commasepped.split(",")
else:
return []
def rbn_all_contacts(with_email=None):
if not with_email:
return contacts.keys() # We have that via our main.mk contact definitions!
else:
return [
contact_id
for (contact_id, contact)
in contacts.items()
if contact.get("email")]
def rbn_groups_contacts(groups):
if not groups:
return {}
contacts = set([])
query = "GET contactgroups\nColumns: members\n"
for group in groups:
query += "Filter: name = %s\n" % group
query += "Or: %d\n" % len(groups)
response = livestatus_fetch_query(query)
for line in response.splitlines():
line = line.strip()
if line:
contacts.update(line.split(","))
return contacts
def rbn_emails_contacts(emails):
return [ "mailto:" + e for e in emails ]
#.
# .--Flexible-Notifications----------------------------------------------.
# | _____ _ _ _ _ |
# | | ___| | _____ _(_) |__ | | ___ |
# | | |_ | |/ _ \ \/ / | '_ \| |/ _ \ |
# | | _| | | __/> <| | |_) | | __/ |
# | |_| |_|\___/_/\_\_|_.__/|_|\___| |
# | |
# +----------------------------------------------------------------------+
# | Implementation of the pre 1.2.5, hopelessly outdated flexible |
# | notifications. |
# '----------------------------------------------------------------------'
def notify_flexible(raw_context, notification_table):
for entry in notification_table:
plugin = entry["plugin"]
notify_log(" Notification channel with plugin %s" % (plugin or "plain email"))
if not should_notify(raw_context, entry):
continue
plugin_context = create_plugin_context(raw_context, entry.get("parameters", []))
if notification_spooling in ("local", "both"):
create_spoolfile({"context": plugin_context, "plugin": plugin})
else:
call_notification_script(plugin, plugin_context)
# may return
# 0 : everything fine -> proceed
# 1 : currently not OK -> try to process later on
# >=2: invalid -> discard
def should_notify(context, entry):
# Check disabling
if entry.get("disabled"):
notify_log(" - Skipping: it is disabled for this user")
return False
# Check host, if configured
if entry.get("only_hosts"):
hostname = context.get("HOSTNAME")
skip = True
regex = False
negate = False
for h in entry["only_hosts"]:
if h.startswith("!"): # negate
negate = True
h = h[1:]
elif h.startswith('~'):
regex = True
h = h[1:]
if not regex and hostname == h:
skip = negate
break
elif regex and re.match(h, hostname):
skip = negate
break
if skip:
notify_log(" - Skipping: host '%s' matches none of %s" % (hostname, ", ".join(entry["only_hosts"])))
return False
# Check if the host has to be in a special service_level
if "match_sl" in entry:
from_sl, to_sl = entry['match_sl']
if context['WHAT'] == "SERVICE" and context.get('SVC_SL','').isdigit():
sl = saveint(context.get('SVC_SL'))
else:
sl = saveint(context.get('HOST_SL'))
if sl < from_sl or sl > to_sl:
notify_log(" - Skipping: service level %d not between %d and %d" % (sl, from_sl, to_sl))
return False
# Skip blacklistet serivces
if entry.get("service_blacklist"):
servicedesc = context.get("SERVICEDESC")
if not servicedesc:
notify_log(" - Proceed: blacklist certain services, but this is a host notification")
else:
for s in entry["service_blacklist"]:
if re.match(s, servicedesc):
notify_log(" - Skipping: service '%s' matches blacklist (%s)" % (
servicedesc, ", ".join(entry["service_blacklist"])))
return False
# Check service, if configured
if entry.get("only_services"):
servicedesc = context.get("SERVICEDESC")
if not servicedesc:
notify_log(" - Proceed: limited to certain services, but this is a host notification")
else:
# Example
# only_services = [ "!LOG foo", "LOG", BAR" ]
# -> notify all services beginning with LOG or BAR, but not "LOG foo..."
skip = True
for s in entry["only_services"]:
if s.startswith("!"): # negate
negate = True
s = s[1:]
else:
negate = False
if re.match(s, servicedesc):
skip = negate
break
if skip:
notify_log(" - Skipping: service '%s' matches none of %s" % (
servicedesc, ", ".join(entry["only_services"])))
return False
# Check notification type
event, allowed_events = check_notification_type(context, entry["host_events"], entry["service_events"])
if event not in allowed_events:
notify_log(" - Skipping: wrong notification type %s (%s), only %s are allowed" %
(event, context["NOTIFICATIONTYPE"], ",".join(allowed_events)) )
return False
# Check notification number (in case of repeated notifications/escalations)
if "escalation" in entry:
from_number, to_number = entry["escalation"]
if context["WHAT"] == "HOST":
notification_number = int(context.get("HOSTNOTIFICATIONNUMBER", 1))
else:
notification_number = int(context.get("SERVICENOTIFICATIONNUMBER", 1))
if notification_number < from_number or notification_number > to_number:
notify_log(" - Skipping: notification number %d does not lie in range %d ... %d" %
(notification_number, from_number, to_number))
return False
if "timeperiod" in entry:
timeperiod = entry["timeperiod"]
if timeperiod and timeperiod != "24X7":
if not check_timeperiod(timeperiod):
notify_log(" - Skipping: time period %s is currently not active" % timeperiod)
return False
return True
def check_notification_type(context, host_events, service_events):
notification_type = context["NOTIFICATIONTYPE"]
if context["WHAT"] == "HOST":
allowed_events = host_events
state = context["HOSTSTATE"]
events = { "UP" : 'r', "DOWN" : 'd', "UNREACHABLE" : 'u' }
else:
allowed_events = service_events
state = context["SERVICESTATE"]
events = { "OK" : 'r', "WARNING" : 'w', "CRITICAL" : 'c', "UNKNOWN" : 'u' }
if notification_type == "RECOVERY":
event = 'r'
elif notification_type in [ "FLAPPINGSTART", "FLAPPINGSTOP", "FLAPPINGDISABLED" ]:
event = 'f'
elif notification_type in [ "DOWNTIMESTART", "DOWNTIMEEND", "DOWNTIMECANCELLED"]:
event = 's'
elif notification_type == "ACKNOWLEDGEMENT":
event = 'x'
else:
event = events.get(state, '?')
return event, allowed_events
#.
# .--Plain Email---------------------------------------------------------.
# | ____ _ _ _____ _ _ |
# | | _ \| | __ _(_)_ __ | ____|_ __ ___ __ _(_) | |
# | | |_) | |/ _` | | '_ \ | _| | '_ ` _ \ / _` | | | |
# | | __/| | (_| | | | | | | |___| | | | | | (_| | | | |
# | |_| |_|\__,_|_|_| |_| |_____|_| |_| |_|\__,_|_|_| |
# | |
# +----------------------------------------------------------------------+
# | Plain Email notification, inline implemented. This is also being |
# | used as a pseudo-plugin by Flexible Notification and RBN. |
# '----------------------------------------------------------------------'
def notify_plain_email(raw_context):
plugin_context = create_plugin_context(raw_context, [])
if notification_spooling in ("local", "both"):
create_spoolfile({"context": plugin_context, "plugin" : None})
else:
notify_log("Sending plain email to %s" % plugin_context["CONTACTNAME"])
notify_via_email(plugin_context)
def notify_via_email(plugin_context):
notify_log(substitute_context(notification_log_template, plugin_context))
if plugin_context["WHAT"] == "SERVICE":
subject_t = notification_service_subject
body_t = notification_service_body
else:
subject_t = notification_host_subject
body_t = notification_host_body
subject = substitute_context(subject_t, plugin_context)
plugin_context["SUBJECT"] = subject
body = substitute_context(notification_common_body + body_t, plugin_context)
command = substitute_context(notification_mail_command, plugin_context)
command_utf8 = command.encode("utf-8")
# Make sure that mail(x) is using UTF-8. Otherwise we cannot send notifications
# with non-ASCII characters. Unfortunately we do not know whether C.UTF-8 is
# available. If e.g. nail detects a non-Ascii character in the mail body and
# the specified encoding is not available, it will silently not send the mail!
# Our resultion in future: use /usr/sbin/sendmail directly.
# Our resultion in the present: look with locale -a for an existing UTF encoding
# and use that.
old_lang = os.getenv("LANG", "")
for encoding in os.popen("locale -a 2>/dev/null"):
l = encoding.lower()
if "utf8" in l or "utf-8" in l or "utf.8" in l:
encoding = encoding.strip()
os.putenv("LANG", encoding)
notify_log_debug("Setting locale for mail to %s." % encoding)
break
else:
notify_log("No UTF-8 encoding found in your locale -a! Please provide C.UTF-8 encoding.")
# Important: we must not output anything on stdout or stderr. Data of stdout
# goes back into the socket to the CMC in keepalive mode and garbles the
# handshake signal.
notify_log_debug("Executing command: %s" % command)
p = subprocess.Popen(command_utf8, shell=True, stdout=subprocess.PIPE, stderr=subprocess.PIPE, stdin=subprocess.PIPE)
stdout_txt, stderr_txt = p.communicate(body.encode("utf-8"))
exitcode = p.returncode
os.putenv("LANG", old_lang) # Important: do not destroy our environment
if exitcode != 0:
notify_log("ERROR: could not deliver mail. Exit code of command is %r" % exitcode)
for line in (stdout_txt + stderr_txt).splitlines():
notify_log("mail: %s" % line.rstrip())
return 2
return 0
#.
# .--Plugins-------------------------------------------------------------.
# | ____ _ _ |
# | | _ \| |_ _ __ _(_)_ __ ___ |
# | | |_) | | | | |/ _` | | '_ \/ __| |
# | | __/| | |_| | (_| | | | | \__ \ |
# | |_| |_|\__,_|\__, |_|_| |_|___/ |
# | |___/ |
# +----------------------------------------------------------------------+
# | Code for the actuall calling of notification plugins (scripts). |
# '----------------------------------------------------------------------'
# Exit codes for plugins and also for our functions that call the plugins:
# 0: Notification successfully sent
# 1: Could not send now, please retry later
# 2: Cannot send, retry does not make sense
# Add the plugin parameters to the envinroment. We have two types of parameters:
# - list, the legacy style. This will lead to PARAMETERS_1, ...
# - dict, the new style for scripts with WATO rule. This will lead to
# PARAMETER_FOO_BAR for a dict key named "foo_bar".
def create_plugin_context(raw_context, params):
plugin_context = {}
plugin_context.update(raw_context) # Make a real copy
if type(params) == list:
plugin_context["PARAMETERS"] = " ".join(params)
for nr, param in enumerate(params):
plugin_context["PARAMETER_%d" % (nr + 1)] = param
else:
for key, value in params.items():
plugin_context["PARAMETER_" + key.upper()] = plugin_param_to_string(value)
return plugin_context
def create_bulk_parameter_context(params):
dict_context = create_plugin_context({}, params)
return [ "%s=%s\n" % (varname, value.replace("\r", "").replace("\n", "\1"))
for (varname, value) in dict_context.items() ]
def plugin_param_to_string(value):
if type(value) in ( str, unicode ):
return value
elif type(value) in ( int, float ):
return str(value)
elif value == None:
return ""
elif value == True:
return "yes"
elif value == False:
return ""
elif type(value) in ( tuple, list ):
return "\t".join(value)
else:
return repr(value) # Should never happen
def path_to_notification_script(plugin):
# Call actual script without any arguments
if local_notifications_dir:
path = local_notifications_dir + "/" + plugin
if not os.path.exists(path):
path = notifications_dir + "/" + plugin
else:
path = notifications_dir + "/" + plugin
if not os.path.exists(path):
notify_log("Notification plugin '%s' not found" % plugin)
notify_log(" not in %s" % notifications_dir)
if local_notifications_dir:
notify_log(" and not in %s" % local_notifications_dir)
return None
else:
return path
# This is the function that finally sends the actual notificion.
# It does this by calling an external script are creating a
# plain email and calling bin/mail.
#
# It also does the central logging of the notifications
# that are actually sent out.
#
# Note: this function is *not* being called for bulk notification.
def call_notification_script(plugin, plugin_context):
core_notification_log(plugin, plugin_context)
def plugin_log(s):
notify_log(" %s" % s)
# The "Pseudo"-Plugin None means builtin plain email
if not plugin:
return notify_via_email(plugin_context)
# Call actual script without any arguments
path = path_to_notification_script(plugin)
if not path:
return 2
plugin_log("executing %s" % path)
try:
set_notification_timeout()
p = subprocess.Popen([path], shell=False, stdout=subprocess.PIPE,
stderr=subprocess.STDOUT, env=notification_script_env(plugin_context))
while True:
# read and output stdout linewise to ensure we don't force python to produce
# one - potentially huge - memory buffer
line = p.stdout.readline()
if line != '':
plugin_log("Output: %s" % line.rstrip().decode('utf-8'))
else:
break
# the stdout is closed but the return code may not be available just yet - wait for the
# process to actually finish
exitcode = p.wait()
clear_notification_timeout()
except NotificationTimeout:
plugin_log("Notification plugin did not finish within %d seconds. Terminating." %
notification_plugin_timeout)
# p.kill() requires python 2.6!
os.kill(p.pid, signal.SIGTERM)
exitcode = 1
if exitcode != 0:
plugin_log("Plugin exited with code %d" % exitcode)
return exitcode
# Construct the environment for the notification script
def notification_script_env(plugin_context):
return dict(os.environ.items() + [("NOTIFY_" + k, v.encode("utf-8")) for k, v in plugin_context.items()])
class NotificationTimeout(Exception):
pass
def handle_notification_timeout(signum, frame):
raise NotificationTimeout()
def set_notification_timeout():
signal.signal(signal.SIGALRM, handle_notification_timeout)
signal.alarm(notification_plugin_timeout)
def clear_notification_timeout():
signal.alarm(0)
#.
# .--Spooling------------------------------------------------------------.
# | ____ _ _ |
# | / ___| _ __ ___ ___ | (_)_ __ __ _ |
# | \___ \| '_ \ / _ \ / _ \| | | '_ \ / _` | |
# | ___) | |_) | (_) | (_) | | | | | | (_| | |
# | |____/| .__/ \___/ \___/|_|_|_| |_|\__, | |
# | |_| |___/ |
# +----------------------------------------------------------------------+
# | Some functions dealing with the spooling of notifications. |
# '----------------------------------------------------------------------'
def create_spoolfile(data):
if not os.path.exists(notification_spooldir):
os.makedirs(notification_spooldir)
file_path = "%s/%s" % (notification_spooldir, fresh_uuid())
notify_log("Creating spoolfile: %s" % file_path)
# First write into tempfile that is not handled by mknotifyd
file(file_path + ".new", "w").write(pprint.pformat(data))
os.rename(file_path + ".new", file_path)
# There are three types of spool files:
# 1. Notifications to be forwarded. Contain key "forward"
# 2. Notifications for async local delivery. Contain key "plugin"
# 3. Notifications to *got* forwarded. Contain neither of both.
# Spool files of type 1 are not handled here!
def handle_spoolfile(spoolfile):
notif_uuid = spoolfile.rsplit("/", 1)[-1]
notify_log("----------------------------------------------------------------------")
try:
data = eval(file(spoolfile).read())
if "plugin" in data:
plugin_context = data["context"]
plugin = data["plugin"]
notify_log("Got spool file %s (%s) for local delivery via %s" % (
notif_uuid[:8],
find_host_service_in_context(plugin_context), (plugin or "plain mail")))
return call_notification_script(plugin, plugin_context)
else:
# We received a forwarded raw notification. We need to process
# this with our local notification rules in order to call one,
# several or no actual plugins.
raw_context = data["context"]
notify_log("Got spool file %s (%s) from remote host for local delivery." % (
notif_uuid[:8], find_host_service_in_context(raw_context)))
store_notification_backlog(data["context"])
locally_deliver_raw_context(data["context"])
return 0 # No error handling for async delivery
except Exception, e:
notify_log("ERROR %s\n%s" % (e, format_exception()))
return 2
#.
# .--Bulk-Notifications--------------------------------------------------.
# | ____ _ _ |
# | | __ ) _ _| | | __ |
# | | _ \| | | | | |/ / |
# | | |_) | |_| | | < |
# | |____/ \__,_|_|_|\_\ |
# | |
# +----------------------------------------------------------------------+
# | Store postponed bulk notifications for later delivery. Deliver such |
# | notifications on cmk --notify bulk. |
# '----------------------------------------------------------------------'
def do_bulk_notify(contact, plugin, params, plugin_context, bulk):
# First identify the bulk. The following elements identify it:
# 1. contact
# 2. plugin
# 3. time horizon (interval) in seconds
# 4. max bulked notifications
# 5. elements specified in bulk["groupby"] and bulk["groupby_custom"]
# We first create a bulk path constructed as a tuple of strings.
# Later we convert that to a unique directory name.
# Note: if you have separate bulk rules with exactly the same
# bulking options, then they will use the same bulk.
what = plugin_context["WHAT"]
bulk_path = (contact, plugin, str(bulk["interval"]), str(bulk["count"]))
bulkby = bulk["groupby"]
if "host" in bulkby:
bulk_path += ("host", plugin_context["HOSTNAME"])
elif "folder" in bulkby:
bulk_path += ("folder", find_wato_folder(plugin_context))
if "service" in bulkby:
bulk_path += ("service", plugin_context.get("SERVICEDESC", ""))
if "sl" in bulkby:
sl = plugin_context.get(what + "_SL", "")
bulk_path += ("sl", sl)
if "check_type" in bulkby:
command = plugin_context.get(what + "CHECKCOMMAND", "").split("!")[0]
bulk_path += ("check_type", command)
if "state" in bulkby:
state = plugin_context.get(what + "STATE", "")
bulk_path += ("state", state)
# User might have specified _FOO instead of FOO
bulkby_custom = bulk.get("groupby_custom", [])
for macroname in bulkby_custom:
macroname = macroname.lstrip("_").upper()
value = plugin_context.get(what + "_" + macroname, "")
bulk_path += (macroname.lower(), value)
notify_log(" --> storing for bulk notification %s" % "|".join(bulk_path))
bulk_dirname = create_bulk_dirname(bulk_path)
uuid = fresh_uuid()
filename = bulk_dirname + "/" + uuid
file(filename + ".new", "w").write("%r\n" % ((params, plugin_context),))
os.rename(filename + ".new", filename) # We need an atomic creation!
notify_log(" - stored in %s" % filename)
def find_wato_folder(context):
for tag in context.get("HOSTTAGS", "").split():
if tag.startswith("/wato/"):
return tag[6:].rstrip("/")
return ""
def create_bulk_dirname(bulk_path):
dirname = notification_bulkdir + "/" + bulk_path[0] + "/" + bulk_path[1] + "/"
dirname += ",".join([b.replace("/", "\\") for b in bulk_path[2:]])
# Remove non-Ascii-characters by special %02x-syntax
try:
str(dirname)
except:
new_dirname = ""
for char in dirname:
if ord(char) <= 0 or ord(char) > 127:
new_dirname += "%%%04x" % ord(char)
else:
new_dirname += char
dirname = new_dirname
if not os.path.exists(dirname):
os.makedirs(dirname)
notify_log(" - created bulk directory %s" % dirname)
return dirname
def find_bulks(only_ripe):
if not os.path.exists(notification_bulkdir):
return []
now = time.time()
bulks = []
dir_1 = notification_bulkdir
for contact in os.listdir(dir_1):
if contact.startswith("."):
continue
dir_2 = dir_1 + "/" + contact
for method in os.listdir(dir_2):
if method.startswith("."):
continue
dir_3 = dir_2 + "/" + method
for bulk in os.listdir(dir_3):
parts = bulk.split(',') # e.g. 60,10,host,localhost
try:
interval = int(parts[0])
count = int(parts[1])
except:
notify_log("Skipping invalid bulk directory %s" % dir_3)
continue
dir_4 = dir_3 + "/" + bulk
uuids = []
oldest = time.time()
for uuid in os.listdir(dir_4): # 4ded0fa2-f0cd-4b6a-9812-54374a04069f
if uuid.startswith(".") or uuid.endswith(".new"):
continue
if len(uuid) != 36:
notify_log("Skipping invalid notification file %s/%s" % (dir_4, uuid))
continue
mtime = os.stat(dir_4 + "/" + uuid).st_mtime
uuids.append((mtime, uuid))
oldest = min(oldest, mtime)
uuids.sort()
if not uuids:
dirage = now - os.stat(dir_4).st_mtime
if dirage > 60:
notify_log("Warning: removing orphaned empty bulk directory %s" % dir_4)
try:
os.rmdir(dir_4)
except Exception, e:
notify_log(" -> Error removing it: %s" % e)
continue
age = now - oldest
if age >= interval:
notify_log("Bulk %s is ripe: age %d >= %d" % (dir_4, age, interval))
elif len(uuids) >= count:
notify_log("Bulk %s is ripe: count %d >= %d" % (dir_4, len(uuids), count))
else:
notify_log("Bulk %s is not ripe yet (age: %d, count: %d)!" % (dir_4, age, len(uuids)))
if only_ripe:
continue
bulks.append((dir_4, age, interval, count, uuids))
return bulks
def send_ripe_bulks():
ripe = find_bulks(True)
if ripe:
notify_log("Sending out %d ripe bulk notifications" % len(ripe))
for bulk in ripe:
try:
notify_bulk(bulk[0], bulk[-1])
except Exception, e:
if opt_debug:
raise
notify_log("Error sending bulk %s: %s" % (bulk[0], format_exception()))
def notify_bulk(dirname, uuids):
parts = dirname.split("/")
contact = parts[-3]
plugin = parts[-2]
notify_log(" -> %s/%s %s" % (contact, plugin, dirname))
# If new entries are created in this directory while we are working
# on it, nothing bad happens. It's just that we cannot remove
# the directory after our work. It will be the starting point for
# the next bulk with the same ID, which is completely OK.
bulk_context = []
old_params = None
unhandled_uuids = []
for mtime, uuid in uuids:
try:
params, context = eval(file(dirname + "/" + uuid).read())
except Exception, e:
if opt_debug:
raise
notify_log(" Deleting corrupted or empty bulk file %s/%s: %s" % (dirname, uuid, e))
continue
if old_params == None:
old_params = params
elif params != old_params:
notify_log(" Parameters are different from previous, postponing into separate bulk")
unhandled_uuids.append((mtime, uuid))
continue
part_block = []
part_block.append("\n")
for varname, value in context.items():
part_block.append("%s=%s\n" % (varname, value.replace("\r", "").replace("\n", "\1")))
bulk_context.append(part_block)
# Do not forget to add this to the monitoring log. We create
# a single entry for each notification contained in the bulk.
# It is important later to have this precise information.
plugin_name = "bulk " + (plugin or "plain email")
core_notification_log(plugin_name, context)
if bulk_context: # otherwise: only corrupted files
# Per default the uuids are sorted chronologically from oldest to newest
# Therefore the notification plugin also shows the oldest entry first
# The following configuration option allows to reverse the sorting
if type(old_params) == dict and old_params.get("bulk_sort_order") == "newest_first":
bulk_context.reverse()
# Converts bulk context from [[1,2],[3,4]] to [1,2,3,4]
bulk_context = [x for y in bulk_context for x in y]
parameter_context = create_bulk_parameter_context(old_params)
context_text = "".join(parameter_context + bulk_context)
call_bulk_notification_script(plugin, context_text)
else:
notify_log("No valid notification file left. Skipping this bulk.")
# Remove sent notifications
for mtime, uuid in uuids:
if (mtime, uuid) not in unhandled_uuids:
path = dirname + "/" + uuid
try:
os.remove(path)
except Exception, e:
notify_log("Cannot remove %s: %s" % (path, e))
# Repeat with unhandled uuids (due to different parameters)
if unhandled_uuids:
notify_bulk(dirname, unhandled_uuids)
# Remove directory. Not neccessary if emtpy
try:
os.rmdir(dirname)
except Exception, e:
if not unhandled_uuids:
notify_log("Warning: cannot remove directory %s: %s" % (dirname, e))
def call_bulk_notification_script(plugin, context_text):
path = path_to_notification_script(plugin)
if not path:
raise MKGeneralException("Notification plugin %s not found" % plugin)
stdout_txt = stderr_txt = ""
try:
set_notification_timeout()
# Protocol: The script gets the context on standard input and
# read until that is closed. It is being called with the parameter
# --bulk.
p = subprocess.Popen([path, "--bulk"], shell=False,
stdout = subprocess.PIPE, stderr = subprocess.PIPE,
stdin = subprocess.PIPE)
stdout_txt, stderr_txt = p.communicate(context_text.encode("utf-8"))
exitcode = p.returncode
clear_notification_timeout()
except NotificationTimeout:
notify_log("Notification plugin did not finish within %d seconds. Terminating." %
notification_plugin_timeout)
# p.kill() requires python 2.6!
os.kill(p.pid, signal.SIGTERM)
exitcode = 1
if exitcode:
notify_log("ERROR: script %s --bulk returned with exit code %s" % (path, exitcode))
for line in (stdout_txt + stderr_txt).splitlines():
notify_log("%s: %s" % (plugin, line.rstrip()))
#.
# .--Contexts------------------------------------------------------------.
# | ____ _ _ |
# | / ___|___ _ __ | |_ _____ _| |_ ___ |
# | | | / _ \| '_ \| __/ _ \ \/ / __/ __| |
# | | |__| (_) | | | | || __/> <| |_\__ \ |
# | \____\___/|_| |_|\__\___/_/\_\\__|___/ |
# | |
# +----------------------------------------------------------------------+
# | Functions dealing with loading, storing and converting contexts. |
# '----------------------------------------------------------------------'
# Be aware: The backlog.mk contains the raw context which has not been decoded
# to unicode yet. It contains raw encoded strings e.g. the plugin output provided
# by third party plugins which might be UTF-8 encoded but can also be encoded in
# other ways. Currently the context is converted later by bot, this module
# and the GUI. TODO Maybe we should centralize the encoding here and save the
# backlock already encoded.
def store_notification_backlog(raw_context):
path = notification_logdir + "/backlog.mk"
if not notification_backlog:
if os.path.exists(path):
os.remove(path)
return
try:
backlog = eval(file(path).read())[:notification_backlog-1]
except:
backlog = []
backlog = [ raw_context ] + backlog
file(path, "w").write("%r\n" % backlog)
def raw_context_from_backlog(nr):
try:
backlog = eval(file(notification_logdir + "/backlog.mk").read())
except:
backlog = []
if nr < 0 or nr >= len(backlog):
sys.stderr.write("No notification number %d in backlog.\n" % nr)
sys.exit(2)
notify_log("Replaying notification %d from backlog...\n" % nr)
return backlog[nr]
def raw_context_from_env():
# Information about notification is excpected in the
# environment in variables with the prefix NOTIFY_
return dict([
(var[7:], value)
for (var, value)
in os.environ.items()
if var.startswith("NOTIFY_")
and not dead_nagios_variable(value) ])
def substitute_context(template, context):
# First replace all known variables
for varname, value in context.items():
template = template.replace('$'+varname+'$', value)
# Remove the rest of the variables and make them empty
template = re.sub("\$[A-Z]+\$", "", template)
return template
#.
# .--Helpers-------------------------------------------------------------.
# | _ _ _ |
# | | | | | ___| |_ __ ___ _ __ ___ |
# | | |_| |/ _ \ | '_ \ / _ \ '__/ __| |
# | | _ | __/ | |_) | __/ | \__ \ |
# | |_| |_|\___|_| .__/ \___|_| |___/ |
# | |_| |
# +----------------------------------------------------------------------+
# | Some generic helper functions |
# '----------------------------------------------------------------------'
def livestatus_fetch_query(query):
sock = socket.socket(socket.AF_UNIX, socket.SOCK_STREAM)
sock.connect(livestatus_unix_socket)
sock.send(query)
sock.shutdown(socket.SHUT_WR)
response = sock.recv(10000000)
sock.close()
return response
def livestatus_send_command(command):
try:
message = "COMMAND [%d] %s\n" % (time.time(), command)
sock = socket.socket(socket.AF_UNIX, socket.SOCK_STREAM)
sock.connect(livestatus_unix_socket)
sock.send(message)
sock.close()
except Exception, e:
if opt_debug:
raise
notify_log("WARNING: cannot send livestatus command: %s" % e)
notify_log("Command was: %s" % command)
def format_exception():
import traceback, StringIO, sys
txt = StringIO.StringIO()
t, v, tb = sys.exc_info()
traceback.print_exception(t, v, tb, None, txt)
return txt.getvalue()
def dead_nagios_variable(value):
if len(value) < 3:
return False
if value[0] != '$' or value[-1] != '$':
return False
for c in value[1:-1]:
if not c.isupper() and c != '_':
return False
return True
def notify_log(message):
if notification_logging >= 1:
event_log(notification_log, message)
def notify_log_debug(message):
if notification_logging >= 2:
notify_log(message)
def get_readable_rel_date(timestamp):
try:
change = int(timestamp)
except:
change = 0
rel_time = time.time() - change
seconds = rel_time % 60
rem = rel_time / 60
minutes = rem % 60
hours = (rem % 1440) / 60
days = rem / 1440
return '%dd %02d:%02d:%02d' % (days, hours, minutes, seconds)
def urlencode(s):
return urllib.quote(s)
def fresh_uuid():
try:
return file('/proc/sys/kernel/random/uuid').read().strip()
except IOError:
# On platforms where the above file does not exist we try to
# use the python uuid module which seems to be a good fallback
# for those systems. Well, if got python < 2.5 you are lost for now.
import uuid
return str(uuid.uuid4())
def core_notification_log(plugin, plugin_context):
what = plugin_context["WHAT"]
contact = plugin_context["CONTACTNAME"]
spec = plugin_context["HOSTNAME"]
if what == "HOST":
state = plugin_context["HOSTSTATE"]
output = plugin_context["HOSTOUTPUT"]
if what == "SERVICE":
spec += ";" + plugin_context["SERVICEDESC"]
state = plugin_context["SERVICESTATE"]
output = plugin_context["SERVICEOUTPUT"]
log_message = "%s NOTIFICATION: %s;%s;%s;%s;%s" % (
what, contact, spec, state, plugin or "plain email", output)
if monitoring_core == "cmc":
livestatus_send_command("LOG;" + log_message.encode("utf-8"))
else:
# Nagios and friends do not support logging via an
# external command. We write the files into a help file
# in var/check_mk/notify. If the users likes he can
# replace that file with a symbolic link to the nagios
# log file. But note: Nagios logging might not atomic.
file(notification_core_log, "a").write("[%d] %s\n" % (time.time(), log_message.encode("utf-8")))
|