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
|
/* Icinga 2 | (c) 2012 Icinga GmbH | GPLv2+ */
#include "icinga/notification.hpp"
#include "icinga/notification-ti.cpp"
#include "icinga/notificationcommand.hpp"
#include "icinga/service.hpp"
#include "remote/apilistener.hpp"
#include "base/objectlock.hpp"
#include "base/logger.hpp"
#include "base/utility.hpp"
#include "base/convert.hpp"
#include "base/exception.hpp"
#include "base/initialize.hpp"
#include "base/scriptglobal.hpp"
#include <algorithm>
using namespace icinga;
REGISTER_TYPE(Notification);
INITIALIZE_ONCE(&Notification::StaticInitialize);
std::map<String, int> Notification::m_StateFilterMap;
std::map<String, int> Notification::m_TypeFilterMap;
boost::signals2::signal<void (const Notification::Ptr&, const MessageOrigin::Ptr&)> Notification::OnNextNotificationChanged;
boost::signals2::signal<void (const Notification::Ptr&, const String&, uint_fast8_t, const MessageOrigin::Ptr&)> Notification::OnLastNotifiedStatePerUserUpdated;
boost::signals2::signal<void (const Notification::Ptr&, const MessageOrigin::Ptr&)> Notification::OnLastNotifiedStatePerUserCleared;
String NotificationNameComposer::MakeName(const String& shortName, const Object::Ptr& context) const
{
Notification::Ptr notification = dynamic_pointer_cast<Notification>(context);
if (!notification)
return "";
String name = notification->GetHostName();
if (!notification->GetServiceName().IsEmpty())
name += "!" + notification->GetServiceName();
name += "!" + shortName;
return name;
}
Dictionary::Ptr NotificationNameComposer::ParseName(const String& name) const
{
std::vector<String> tokens = name.Split("!");
if (tokens.size() < 2)
BOOST_THROW_EXCEPTION(std::invalid_argument("Invalid Notification name."));
Dictionary::Ptr result = new Dictionary();
result->Set("host_name", tokens[0]);
if (tokens.size() > 2) {
result->Set("service_name", tokens[1]);
result->Set("name", tokens[2]);
} else {
result->Set("name", tokens[1]);
}
return result;
}
void Notification::StaticInitialize()
{
ScriptGlobal::Set("Icinga.OK", "OK");
ScriptGlobal::Set("Icinga.Warning", "Warning");
ScriptGlobal::Set("Icinga.Critical", "Critical");
ScriptGlobal::Set("Icinga.Unknown", "Unknown");
ScriptGlobal::Set("Icinga.Up", "Up");
ScriptGlobal::Set("Icinga.Down", "Down");
ScriptGlobal::Set("Icinga.DowntimeStart", "DowntimeStart");
ScriptGlobal::Set("Icinga.DowntimeEnd", "DowntimeEnd");
ScriptGlobal::Set("Icinga.DowntimeRemoved", "DowntimeRemoved");
ScriptGlobal::Set("Icinga.Custom", "Custom");
ScriptGlobal::Set("Icinga.Acknowledgement", "Acknowledgement");
ScriptGlobal::Set("Icinga.Problem", "Problem");
ScriptGlobal::Set("Icinga.Recovery", "Recovery");
ScriptGlobal::Set("Icinga.FlappingStart", "FlappingStart");
ScriptGlobal::Set("Icinga.FlappingEnd", "FlappingEnd");
m_StateFilterMap["OK"] = StateFilterOK;
m_StateFilterMap["Warning"] = StateFilterWarning;
m_StateFilterMap["Critical"] = StateFilterCritical;
m_StateFilterMap["Unknown"] = StateFilterUnknown;
m_StateFilterMap["Up"] = StateFilterUp;
m_StateFilterMap["Down"] = StateFilterDown;
m_TypeFilterMap["DowntimeStart"] = NotificationDowntimeStart;
m_TypeFilterMap["DowntimeEnd"] = NotificationDowntimeEnd;
m_TypeFilterMap["DowntimeRemoved"] = NotificationDowntimeRemoved;
m_TypeFilterMap["Custom"] = NotificationCustom;
m_TypeFilterMap["Acknowledgement"] = NotificationAcknowledgement;
m_TypeFilterMap["Problem"] = NotificationProblem;
m_TypeFilterMap["Recovery"] = NotificationRecovery;
m_TypeFilterMap["FlappingStart"] = NotificationFlappingStart;
m_TypeFilterMap["FlappingEnd"] = NotificationFlappingEnd;
}
Notification::Notification()
{
// If a notification is created without specifying the "types/states" attribute, the Set* methods won't be called,
// consequently the filter bitset will also be 0. Thus, we need to ensure that the type/state filter are
// initialized to the default values, which are all types and states enabled.
SetTypes(nullptr, false, Empty);
SetStates(nullptr, false, Empty);
}
void Notification::OnAllConfigLoaded()
{
ObjectImpl<Notification>::OnAllConfigLoaded();
Host::Ptr host = Host::GetByName(GetHostName());
if (GetServiceName().IsEmpty())
m_Checkable = host;
else
m_Checkable = host->GetServiceByShortName(GetServiceName());
if (!m_Checkable)
BOOST_THROW_EXCEPTION(ScriptError("Notification object refers to a host/service which doesn't exist.", GetDebugInfo()));
GetCheckable()->RegisterNotification(this);
}
void Notification::Start(bool runtimeCreated)
{
Checkable::Ptr obj = GetCheckable();
if (obj)
obj->RegisterNotification(this);
if (ApiListener::IsHACluster() && GetNextNotification() < Utility::GetTime() + 60)
SetNextNotification(Utility::GetTime() + 60, true);
for (const UserGroup::Ptr& group : GetUserGroups())
group->AddNotification(this);
ObjectImpl<Notification>::Start(runtimeCreated);
}
void Notification::Stop(bool runtimeRemoved)
{
ObjectImpl<Notification>::Stop(runtimeRemoved);
Checkable::Ptr obj = GetCheckable();
if (obj)
obj->UnregisterNotification(this);
for (const UserGroup::Ptr& group : GetUserGroups())
group->RemoveNotification(this);
}
Checkable::Ptr Notification::GetCheckable() const
{
return static_pointer_cast<Checkable>(m_Checkable);
}
NotificationCommand::Ptr Notification::GetCommand() const
{
return NotificationCommand::GetByName(GetCommandRaw());
}
std::set<User::Ptr> Notification::GetUsers() const
{
std::set<User::Ptr> result;
Array::Ptr users = GetUsersRaw();
if (users) {
ObjectLock olock(users);
for (String name : users) {
User::Ptr user = User::GetByName(name);
if (!user)
continue;
result.insert(user);
}
}
return result;
}
std::set<UserGroup::Ptr> Notification::GetUserGroups() const
{
std::set<UserGroup::Ptr> result;
Array::Ptr groups = GetUserGroupsRaw();
if (groups) {
ObjectLock olock(groups);
for (String name : groups) {
UserGroup::Ptr ug = UserGroup::GetByName(name);
if (!ug)
continue;
result.insert(ug);
}
}
return result;
}
TimePeriod::Ptr Notification::GetPeriod() const
{
return TimePeriod::GetByName(GetPeriodRaw());
}
void Notification::UpdateNotificationNumber()
{
SetNotificationNumber(GetNotificationNumber() + 1);
}
void Notification::ResetNotificationNumber()
{
SetNotificationNumber(0);
}
/**
* Check whether the given notification type is a Recovery or FlappingEnd notification and the Checkable object
* has already recovered.
*
* For the latter case, if the Checkable has recovered while it was in a Flapping state, the recovery notification
* will be silently discarded and leave some internal states of the Notification object that depend on it in an
* inconsistent state. So, use this helper function whether to reset one of these states.
*
* @param checkable The checkable object the notification is for
* @param cr The current check result passed to the notification
* @param type The requested notification type
*
* @return bool
*/
static bool IsRecoveryOrFlappingEndAndCheckableIsOK(const Checkable::Ptr& checkable, const CheckResult::Ptr& cr, NotificationType type)
{
if (type == NotificationRecovery) {
return true;
}
// Check whether missed the Checkable recovery because of its Flapping state.
return type == NotificationFlappingEnd && cr && checkable->IsStateOK(cr->GetState());
}
void Notification::BeginExecuteNotification(NotificationType type, const CheckResult::Ptr& cr, bool force, bool reminder, const String& author, const String& text)
{
String notificationName = GetName();
String notificationTypeName = NotificationTypeToString(type);
Log(LogNotice, "Notification")
<< "Attempting to send " << (reminder ? "reminder " : "")
<< "notifications of type '" << notificationTypeName
<< "' for notification object '" << notificationName << "'.";
Checkable::Ptr checkable = GetCheckable();
// Clear the last notified problem state per user if we're sending a recovery notification or if we're sending a
// flapping end notification and the checkable is already in an OK state. This is necessary since we might have
// missed the recovery notification due to the flapping state.
if (IsRecoveryOrFlappingEndAndCheckableIsOK(checkable, cr, type)) {
auto states (GetLastNotifiedStatePerUser());
states->Clear();
OnLastNotifiedStatePerUserCleared(this, nullptr);
}
if (!force) {
TimePeriod::Ptr tp = GetPeriod();
if (tp && !tp->IsInside(Utility::GetTime())) {
Log(LogNotice, "Notification")
<< "Not sending " << (reminder ? "reminder " : "") << "notifications for notification object '" << notificationName
<< "': not in timeperiod '" << tp->GetName() << "'";
if (!reminder) {
switch (type) {
case NotificationProblem:
case NotificationRecovery:
case NotificationFlappingStart:
case NotificationFlappingEnd:
{
/* If a non-reminder notification was suppressed, but just because of its time period,
* stash it into a notification types bitmask for maybe re-sending later.
*/
ObjectLock olock (this);
int suppressedTypesBefore (GetSuppressedNotifications());
int suppressedTypesAfter (suppressedTypesBefore | type);
for (int conflict : {NotificationProblem | NotificationRecovery, NotificationFlappingStart | NotificationFlappingEnd}) {
/* E.g. problem and recovery notifications neutralize each other. */
if ((suppressedTypesAfter & conflict) == conflict) {
suppressedTypesAfter &= ~conflict;
}
}
if (suppressedTypesAfter != suppressedTypesBefore) {
SetSuppressedNotifications(suppressedTypesAfter);
}
}
default:
; // Cheating the compiler on "5 enumeration values not handled in switch"
}
}
return;
}
double now = Utility::GetTime();
Dictionary::Ptr times = GetTimes();
if (times && type == NotificationProblem) {
Value timesBegin = times->Get("begin");
Value timesEnd = times->Get("end");
if (timesBegin != Empty && timesBegin >= 0 && now < checkable->GetLastHardStateChange() + timesBegin) {
Log(LogNotice, "Notification")
<< "Not sending " << (reminder ? "reminder " : "") << "notifications for notification object '"
<< notificationName << "': before specified begin time (" << Utility::FormatDuration(timesBegin) << ")";
/* we need to adjust the next notification time
* delaying the first notification
*/
SetNextNotification(checkable->GetLastHardStateChange() + timesBegin + 1.0);
/*
* We need to set no more notifications to false, in case
* some notifications were sent previously
*/
SetNoMoreNotifications(false);
return;
}
if (timesEnd != Empty && timesEnd >= 0 && now > checkable->GetLastHardStateChange() + timesEnd) {
Log(LogNotice, "Notification")
<< "Not sending " << (reminder ? "reminder " : "") << "notifications for notification object '"
<< notificationName << "': after specified end time (" << Utility::FormatDuration(timesEnd) << ")";
return;
}
}
unsigned long ftype = type;
Log(LogDebug, "Notification")
<< "Type '" << NotificationTypeToString(type)
<< "', TypeFilter: " << NotificationFilterToString(GetTypeFilter(), GetTypeFilterMap())
<< " (FType=" << ftype << ", TypeFilter=" << GetTypeFilter() << ")";
if (!(ftype & GetTypeFilter())) {
Log(LogNotice, "Notification")
<< "Not sending " << (reminder ? "reminder " : "") << "notifications for notification object '"
<< notificationName << "': type '"
<< NotificationTypeToString(type) << "' does not match type filter: "
<< NotificationFilterToString(GetTypeFilter(), GetTypeFilterMap()) << ".";
/* Ensure to reset no_more_notifications on Recovery notifications,
* even if the admin did not configure them in the filter.
*/
{
ObjectLock olock(this);
if (GetInterval() <= 0 && IsRecoveryOrFlappingEndAndCheckableIsOK(checkable, cr, type))
SetNoMoreNotifications(false);
}
return;
}
/* Check state filters for problem notifications. Recovery notifications will be filtered away later. */
if (type == NotificationProblem) {
Host::Ptr host;
Service::Ptr service;
tie(host, service) = GetHostService(checkable);
unsigned long fstate;
String stateStr;
if (service) {
fstate = ServiceStateToFilter(service->GetState());
stateStr = NotificationServiceStateToString(service->GetState());
} else {
fstate = HostStateToFilter(host->GetState());
stateStr = NotificationHostStateToString(host->GetState());
}
Log(LogDebug, "Notification")
<< "State '" << stateStr << "', StateFilter: " << NotificationFilterToString(GetStateFilter(), GetStateFilterMap())
<< " (FState=" << fstate << ", StateFilter=" << GetStateFilter() << ")";
if (!(fstate & GetStateFilter())) {
Log(LogNotice, "Notification")
<< "Not sending " << (reminder ? "reminder " : "") << "notifications for notification object '"
<< notificationName << "': state '" << stateStr
<< "' does not match state filter: " << NotificationFilterToString(GetStateFilter(), GetStateFilterMap()) << ".";
return;
}
}
} else {
Log(LogNotice, "Notification")
<< "Not checking " << (reminder ? "reminder " : "") << "notification filters for notification object '"
<< notificationName << "': Notification was forced.";
}
{
ObjectLock olock(this);
UpdateNotificationNumber();
double now = Utility::GetTime();
SetLastNotification(now);
if (type == NotificationProblem && GetInterval() <= 0)
SetNoMoreNotifications(true);
else if (IsRecoveryOrFlappingEndAndCheckableIsOK(checkable, cr, type))
SetNoMoreNotifications(false);
if (type == NotificationProblem && GetInterval() > 0)
SetNextNotification(now + GetInterval());
if (type == NotificationProblem)
SetLastProblemNotification(now);
}
std::set<User::Ptr> allUsers;
std::set<User::Ptr> users = GetUsers();
std::copy(users.begin(), users.end(), std::inserter(allUsers, allUsers.begin()));
for (const UserGroup::Ptr& ug : GetUserGroups()) {
std::set<User::Ptr> members = ug->GetMembers();
std::copy(members.begin(), members.end(), std::inserter(allUsers, allUsers.begin()));
}
std::set<User::Ptr> allNotifiedUsers;
Array::Ptr notifiedProblemUsers = GetNotifiedProblemUsers();
for (const User::Ptr& user : allUsers) {
String userName = user->GetName();
if (!user->GetEnableNotifications()) {
Log(LogNotice, "Notification")
<< "Notification object '" << notificationName << "': Disabled notifications for user '"
<< userName << "'. Not sending notification.";
continue;
}
if (!CheckNotificationUserFilters(type, user, force, reminder)) {
Log(LogNotice, "Notification")
<< "Notification object '" << notificationName << "': Filters for user '" << userName << "' not matched. Not sending notification.";
continue;
}
/* on acknowledgement/recovery, check if user was notified before */
if (type == NotificationAcknowledgement || type == NotificationRecovery) {
// Do not notify the user about the ACK/recovery of a problem state that they have not been notified
// about, unless they are explicitly configured to receive ACK/recovery notifications but no problem
// ones, or this Notification instance isn't allowed to send problem notifications (doesn't contain
// the 'Problem' type filter).
if (!notifiedProblemUsers->Contains(userName) && NotificationProblem & user->GetTypeFilter() & GetTypeFilter()) {
Log(LogNotice, "Notification")
<< "Notification object '" << notificationName << "': We did not notify user '" << userName
<< "' (Problem types enabled) for a problem before. Not sending "
<< (type == NotificationRecovery ? "Recovery" : "acknowledgement") << " notification.";
continue;
}
}
if (type == NotificationProblem && !reminder && !checkable->GetVolatile()) {
auto [host, service] = GetHostService(checkable);
uint_fast8_t state = service ? static_cast<uint_fast8_t>(service->GetState())
: static_cast<uint_fast8_t>(host->GetState());
if (state == (uint_fast8_t)GetLastNotifiedStatePerUser()->Get(userName)) {
auto stateStr (service ? NotificationServiceStateToString(service->GetState()) : NotificationHostStateToString(host->GetState()));
Log(LogNotice, "Notification")
<< "Notification object '" << notificationName << "': We already notified user '" << userName << "' for a " << stateStr
<< " problem. Likely after that another state change notification was filtered out by config. Not sending duplicate '"
<< stateStr << "' notification.";
continue;
}
}
Log(LogInformation, "Notification")
<< "Sending " << (reminder ? "reminder " : "") << "'" << NotificationTypeToString(type) << "' notification '"
<< notificationName << "' for user '" << userName << "'";
// Explicitly use Notification::Ptr to keep the reference counted while the callback is active
Notification::Ptr notification (this);
Utility::QueueAsyncCallback([notification, type, user, cr, force, author, text]() {
notification->ExecuteNotificationHelper(type, user, cr, force, author, text);
});
/* collect all notified users */
allNotifiedUsers.insert(user);
if (type == NotificationProblem) {
auto [host, service] = GetHostService(checkable);
uint_fast8_t state = service ? static_cast<uint_fast8_t>(service->GetState())
: static_cast<uint_fast8_t>(host->GetState());
if (state != (uint_fast8_t)GetLastNotifiedStatePerUser()->Get(userName)) {
GetLastNotifiedStatePerUser()->Set(userName, state);
OnLastNotifiedStatePerUserUpdated(this, userName, state, nullptr);
}
}
/* store all notified users for later recovery checks */
if (type == NotificationProblem && !notifiedProblemUsers->Contains(userName))
notifiedProblemUsers->Add(userName);
}
/* if this was a recovery notification, reset all notified users */
if (IsRecoveryOrFlappingEndAndCheckableIsOK(checkable, cr, type))
notifiedProblemUsers->Clear();
/* used in db_ido for notification history */
Service::OnNotificationSentToAllUsers(this, checkable, allNotifiedUsers, type, cr, author, text, nullptr);
}
bool Notification::CheckNotificationUserFilters(NotificationType type, const User::Ptr& user, bool force, bool reminder)
{
String notificationName = GetName();
String userName = user->GetName();
if (!force) {
TimePeriod::Ptr tp = user->GetPeriod();
if (tp && !tp->IsInside(Utility::GetTime())) {
Log(LogNotice, "Notification")
<< "Not sending " << (reminder ? "reminder " : "") << "notifications for notification object '"
<< notificationName << " and user '" << userName
<< "': user period not in timeperiod '" << tp->GetName() << "'";
return false;
}
unsigned long ftype = type;
Log(LogDebug, "Notification")
<< "User '" << userName << "' notification '" << notificationName
<< "', Type '" << NotificationTypeToString(type)
<< "', TypeFilter: " << NotificationFilterToString(user->GetTypeFilter(), GetTypeFilterMap())
<< " (FType=" << ftype << ", TypeFilter=" << GetTypeFilter() << ")";
if (!(ftype & user->GetTypeFilter())) {
Log(LogNotice, "Notification")
<< "Not sending " << (reminder ? "reminder " : "") << "notifications for notification object '"
<< notificationName << " and user '" << userName << "': type '"
<< NotificationTypeToString(type) << "' does not match type filter: "
<< NotificationFilterToString(user->GetTypeFilter(), GetTypeFilterMap()) << ".";
return false;
}
/* check state filters it this is not a recovery notification */
if (type != NotificationRecovery) {
Checkable::Ptr checkable = GetCheckable();
Host::Ptr host;
Service::Ptr service;
tie(host, service) = GetHostService(checkable);
unsigned long fstate;
String stateStr;
if (service) {
fstate = ServiceStateToFilter(service->GetState());
stateStr = NotificationServiceStateToString(service->GetState());
} else {
fstate = HostStateToFilter(host->GetState());
stateStr = NotificationHostStateToString(host->GetState());
}
Log(LogDebug, "Notification")
<< "User '" << userName << "' notification '" << notificationName
<< "', State '" << stateStr << "', StateFilter: "
<< NotificationFilterToString(user->GetStateFilter(), GetStateFilterMap())
<< " (FState=" << fstate << ", StateFilter=" << user->GetStateFilter() << ")";
if (!(fstate & user->GetStateFilter())) {
Log(LogNotice, "Notification")
<< "Not " << (reminder ? "reminder " : "") << "sending notifications for notification object '"
<< notificationName << " and user '" << userName << "': state '" << stateStr
<< "' does not match state filter: " << NotificationFilterToString(user->GetStateFilter(), GetStateFilterMap()) << ".";
return false;
}
}
} else {
Log(LogNotice, "Notification")
<< "Not checking " << (reminder ? "reminder " : "") << "notification filters for notification object '"
<< notificationName << "' and user '" << userName << "': Notification was forced.";
}
return true;
}
void Notification::ExecuteNotificationHelper(NotificationType type, const User::Ptr& user, const CheckResult::Ptr& cr, bool force, const String& author, const String& text)
{
String notificationName = GetName();
String userName = user->GetName();
String checkableName = GetCheckable()->GetName();
NotificationCommand::Ptr command = GetCommand();
if (!command) {
Log(LogDebug, "Notification")
<< "No command found for notification '" << notificationName << "'. Skipping execution.";
return;
}
String commandName = command->GetName();
try {
command->Execute(this, user, cr, type, author, text);
/* required by compatlogger */
Service::OnNotificationSentToUser(this, GetCheckable(), user, type, cr, author, text, commandName, nullptr);
Log(LogInformation, "Notification")
<< "Completed sending '" << NotificationTypeToString(type)
<< "' notification '" << notificationName
<< "' for checkable '" << checkableName
<< "' and user '" << userName << "' using command '" << commandName << "'.";
} catch (const std::exception& ex) {
Log(LogWarning, "Notification")
<< "Exception occurred during notification '" << notificationName
<< "' for checkable '" << checkableName
<< "' and user '" << userName << "' using command '" << commandName << "': "
<< DiagnosticInformation(ex, false);
}
}
int icinga::ServiceStateToFilter(ServiceState state)
{
switch (state) {
case ServiceOK:
return StateFilterOK;
case ServiceWarning:
return StateFilterWarning;
case ServiceCritical:
return StateFilterCritical;
case ServiceUnknown:
return StateFilterUnknown;
default:
VERIFY(!"Invalid state type.");
}
}
int icinga::HostStateToFilter(HostState state)
{
switch (state) {
case HostUp:
return StateFilterUp;
case HostDown:
return StateFilterDown;
default:
VERIFY(!"Invalid state type.");
}
}
String Notification::NotificationFilterToString(int filter, const std::map<String, int>& filterMap)
{
std::vector<String> sFilters;
for (auto& kv : filterMap) {
if (filter & kv.second)
sFilters.push_back(kv.first);
}
return Utility::NaturalJoin(sFilters);
}
/*
* Main interface to translate NotificationType values into strings.
*/
String Notification::NotificationTypeToString(NotificationType type)
{
auto typeMap = Notification::m_TypeFilterMap;
auto it = std::find_if(typeMap.begin(), typeMap.end(),
[&type](const std::pair<String, int>& p) {
return p.second == type;
});
if (it == typeMap.end())
return Empty;
return it->first;
}
/*
* Compat interface used in external features.
*/
String Notification::NotificationTypeToStringCompat(NotificationType type)
{
switch (type) {
case NotificationDowntimeStart:
return "DOWNTIMESTART";
case NotificationDowntimeEnd:
return "DOWNTIMEEND";
case NotificationDowntimeRemoved:
return "DOWNTIMECANCELLED";
case NotificationCustom:
return "CUSTOM";
case NotificationAcknowledgement:
return "ACKNOWLEDGEMENT";
case NotificationProblem:
return "PROBLEM";
case NotificationRecovery:
return "RECOVERY";
case NotificationFlappingStart:
return "FLAPPINGSTART";
case NotificationFlappingEnd:
return "FLAPPINGEND";
default:
return "UNKNOWN_NOTIFICATION";
}
}
String Notification::NotificationServiceStateToString(ServiceState state)
{
switch (state) {
case ServiceOK:
return "OK";
case ServiceWarning:
return "Warning";
case ServiceCritical:
return "Critical";
case ServiceUnknown:
return "Unknown";
default:
VERIFY(!"Invalid state type.");
}
}
String Notification::NotificationHostStateToString(HostState state)
{
switch (state) {
case HostUp:
return "Up";
case HostDown:
return "Down";
default:
VERIFY(!"Invalid state type.");
}
}
Array::Ptr Notification::GetTypes() const
{
return m_Types.load();
}
void Notification::SetTypes(const Array::Ptr& value, bool suppress_events, const Value& cookie)
{
m_Types.store(value);
// Ensure that the type filter is updated when the types attribute changes.
SetTypeFilter(FilterArrayToInt(value, GetTypeFilterMap(), ~0));
if (!suppress_events) {
NotifyTypes(cookie);
}
}
Array::Ptr Notification::GetStates() const
{
return m_States.load();
}
void Notification::SetStates(const Array::Ptr& value, bool suppress_events, const Value& cookie)
{
m_States.store(value);
// Ensure that the state filter is updated when the states attribute changes.
SetStateFilter(FilterArrayToInt(value, GetStateFilterMap(), ~0));
if (!suppress_events) {
NotifyStates(cookie);
}
}
void Notification::Validate(int types, const ValidationUtils& utils)
{
ObjectImpl<Notification>::Validate(types, utils);
if (!(types & FAConfig))
return;
Array::Ptr users = GetUsersRaw();
Array::Ptr groups = GetUserGroupsRaw();
if ((!users || users->GetLength() == 0) && (!groups || groups->GetLength() == 0))
BOOST_THROW_EXCEPTION(ValidationError(this, std::vector<String>(), "No users/user_groups specified."));
}
void Notification::ValidateStates(const Lazy<Array::Ptr>& lvalue, const ValidationUtils& utils)
{
ObjectImpl<Notification>::ValidateStates(lvalue, utils);
int filter = FilterArrayToInt(lvalue(), GetStateFilterMap(), 0);
if (GetServiceName().IsEmpty() && (filter == -1 || (filter & ~(StateFilterUp | StateFilterDown)) != 0))
BOOST_THROW_EXCEPTION(ValidationError(this, { "states" }, "State filter is invalid."));
if (!GetServiceName().IsEmpty() && (filter == -1 || (filter & ~(StateFilterOK | StateFilterWarning | StateFilterCritical | StateFilterUnknown)) != 0))
BOOST_THROW_EXCEPTION(ValidationError(this, { "states" }, "State filter is invalid."));
}
void Notification::ValidateTypes(const Lazy<Array::Ptr>& lvalue, const ValidationUtils& utils)
{
ObjectImpl<Notification>::ValidateTypes(lvalue, utils);
int filter = FilterArrayToInt(lvalue(), GetTypeFilterMap(), 0);
if (filter == -1 || (filter & ~(NotificationDowntimeStart | NotificationDowntimeEnd | NotificationDowntimeRemoved |
NotificationCustom | NotificationAcknowledgement | NotificationProblem | NotificationRecovery |
NotificationFlappingStart | NotificationFlappingEnd)) != 0)
BOOST_THROW_EXCEPTION(ValidationError(this, { "types" }, "Type filter is invalid."));
}
void Notification::ValidateTimes(const Lazy<Dictionary::Ptr>& lvalue, const ValidationUtils& utils)
{
ObjectImpl<Notification>::ValidateTimes(lvalue, utils);
Dictionary::Ptr times = lvalue();
if (!times)
return;
double begin;
double end;
try {
begin = Convert::ToDouble(times->Get("begin"));
} catch (const std::exception&) {
BOOST_THROW_EXCEPTION(ValidationError(this, { "times" }, "'begin' is invalid, must be duration or number." ));
}
try {
end = Convert::ToDouble(times->Get("end"));
} catch (const std::exception&) {
BOOST_THROW_EXCEPTION(ValidationError(this, { "times" }, "'end' is invalid, must be duration or number." ));
}
/* Also solve logical errors where begin > end. */
if (begin > 0 && end > 0 && begin > end)
BOOST_THROW_EXCEPTION(ValidationError(this, { "times" }, "'begin' must be smaller than 'end'."));
}
Endpoint::Ptr Notification::GetCommandEndpoint() const
{
return Endpoint::GetByName(GetCommandEndpointRaw());
}
const std::map<String, int>& Notification::GetStateFilterMap()
{
return m_StateFilterMap;
}
const std::map<String, int>& Notification::GetTypeFilterMap()
{
return m_TypeFilterMap;
}
|