icinga2/lib/icinga/notification.cpp

381 lines
11 KiB
C++
Raw Normal View History

2013-02-09 11:42:22 +01:00
/******************************************************************************
* Icinga 2 *
* Copyright (C) 2012 Icinga Development Team (http://www.icinga.org/) *
* *
* This program is free software; you can redistribute it and/or *
* modify it under the terms of the GNU General Public License *
* as published by the Free Software Foundation; either version 2 *
* of the License, or (at your option) any later version. *
* *
* This program is distributed in the hope that it will be useful, *
* but WITHOUT ANY WARRANTY; without even the implied warranty of *
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
* GNU General Public License for more details. *
* *
* You should have received a copy of the GNU General Public License *
* along with this program; if not, write to the Free Software Foundation *
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA. *
******************************************************************************/
2013-03-17 20:19:29 +01:00
#include "icinga/notification.h"
#include "icinga/notificationcommand.h"
2013-03-17 20:19:29 +01:00
#include "icinga/macroprocessor.h"
#include "icinga/service.h"
#include "icinga/notificationmessage.h"
#include "remoting/endpointmanager.h"
2013-03-16 21:18:53 +01:00
#include "base/dynamictype.h"
#include "base/objectlock.h"
#include "base/logger_fwd.h"
2013-03-25 18:36:15 +01:00
#include "base/utility.h"
#include "base/convert.h"
2013-03-15 18:21:29 +01:00
#include <boost/tuple/tuple.hpp>
2013-03-16 21:18:53 +01:00
#include <boost/foreach.hpp>
#include <boost/exception/diagnostic_information.hpp>
2013-02-09 11:42:22 +01:00
using namespace icinga;
2013-03-01 12:07:52 +01:00
REGISTER_TYPE(Notification);
2013-02-09 11:42:22 +01:00
2013-03-14 23:52:52 +01:00
Notification::Notification(const Dictionary::Ptr& serializedUpdate)
: DynamicObject(serializedUpdate)
{
2013-02-26 10:13:54 +01:00
RegisterAttribute("notification_command", Attribute_Config, &m_NotificationCommand);
RegisterAttribute("notification_interval", Attribute_Config, &m_NotificationInterval);
RegisterAttribute("notification_period", Attribute_Config, &m_NotificationPeriod);
RegisterAttribute("last_notification", Attribute_Replicated, &m_LastNotification);
RegisterAttribute("next_notification", Attribute_Replicated, &m_NextNotification);
2013-02-26 10:13:54 +01:00
RegisterAttribute("macros", Attribute_Config, &m_Macros);
RegisterAttribute("users", Attribute_Config, &m_Users);
2013-02-27 21:49:03 +01:00
RegisterAttribute("groups", Attribute_Config, &m_Groups);
2013-05-13 13:44:57 +02:00
RegisterAttribute("times", Attribute_Config, &m_Times);
RegisterAttribute("notification_type_filter", Attribute_Config, &m_NotificationTypeFilter);
RegisterAttribute("notification_state_filter", Attribute_Config, &m_NotificationStateFilter);
2013-02-26 10:13:54 +01:00
RegisterAttribute("host_name", Attribute_Config, &m_HostName);
RegisterAttribute("service", Attribute_Config, &m_Service);
2013-04-24 14:15:08 +02:00
RegisterAttribute("export_macros", Attribute_Config, &m_ExportMacros);
}
2013-02-09 11:42:22 +01:00
Notification::~Notification(void)
{
2013-02-27 15:23:25 +01:00
Service::InvalidateNotificationsCache();
2013-02-09 11:42:22 +01:00
}
Notification::Ptr Notification::GetByName(const String& name)
{
DynamicObject::Ptr configObject = DynamicObject::GetObject("Notification", name);
return dynamic_pointer_cast<Notification>(configObject);
}
Service::Ptr Notification::GetService(void) const
{
2013-02-26 10:13:54 +01:00
Host::Ptr host = Host::GetByName(m_HostName);
2013-02-09 11:42:22 +01:00
2013-02-27 15:23:25 +01:00
if (!host)
return Service::Ptr();
2013-02-26 10:13:54 +01:00
if (m_Service.IsEmpty())
2013-03-02 09:07:47 +01:00
return host->GetHostCheckService();
2013-02-09 11:42:22 +01:00
else
2013-03-02 09:07:47 +01:00
return host->GetServiceByShortName(m_Service);
2013-02-09 11:42:22 +01:00
}
NotificationCommand::Ptr Notification::GetNotificationCommand(void) const
2013-02-09 11:42:22 +01:00
{
return NotificationCommand::GetByName(m_NotificationCommand);
2013-02-09 11:42:22 +01:00
}
Dictionary::Ptr Notification::GetMacros(void) const
{
2013-02-26 10:13:54 +01:00
return m_Macros;
2013-02-09 11:42:22 +01:00
}
Array::Ptr Notification::GetExportMacros(void) const
{
return m_ExportMacros;
}
2013-03-16 21:18:53 +01:00
std::set<User::Ptr> Notification::GetUsers(void) const
2013-02-24 08:26:10 +01:00
{
2013-03-16 21:18:53 +01:00
std::set<User::Ptr> result;
2013-02-24 08:26:10 +01:00
2013-03-15 18:21:29 +01:00
Array::Ptr users = m_Users;
2013-02-24 08:26:10 +01:00
if (users) {
2013-03-01 12:07:52 +01:00
ObjectLock olock(users);
2013-03-15 18:21:29 +01:00
BOOST_FOREACH(const String& name, users) {
2013-02-27 21:49:03 +01:00
User::Ptr user = User::GetByName(name);
if (!user)
continue;
result.insert(user);
}
}
return result;
}
2013-03-16 21:18:53 +01:00
std::set<UserGroup::Ptr> Notification::GetGroups(void) const
2013-02-27 21:49:03 +01:00
{
2013-03-16 21:18:53 +01:00
std::set<UserGroup::Ptr> result;
2013-02-27 21:49:03 +01:00
2013-03-15 18:21:29 +01:00
Array::Ptr groups = m_Groups;
2013-02-27 21:49:03 +01:00
if (groups) {
2013-03-01 12:07:52 +01:00
ObjectLock olock(groups);
2013-03-15 18:21:29 +01:00
BOOST_FOREACH(const String& name, groups) {
2013-02-27 21:49:03 +01:00
UserGroup::Ptr ug = UserGroup::GetByName(name);
if (!ug)
continue;
result.insert(ug);
2013-02-24 08:26:10 +01:00
}
}
return result;
}
2013-05-13 13:44:57 +02:00
Dictionary::Ptr Notification::GetTimes(void) const
{
return m_Times;
}
unsigned long Notification::GetNotificationTypeFilter(void) const
{
if (m_NotificationTypeFilter.IsEmpty())
return ~(unsigned long)0; /* All states. */
else
return m_NotificationTypeFilter;
}
unsigned long Notification::GetNotificationStateFilter(void) const
{
if (m_NotificationStateFilter.IsEmpty())
return ~(unsigned long)0; /* All states. */
else
return m_NotificationStateFilter;
}
double Notification::GetNotificationInterval(void) const
{
if (m_NotificationInterval.IsEmpty())
return 300;
else
return m_NotificationInterval;
}
TimePeriod::Ptr Notification::GetNotificationPeriod(void) const
{
return TimePeriod::GetByName(m_NotificationPeriod);
}
double Notification::GetLastNotification(void) const
{
if (m_LastNotification.IsEmpty())
return 0;
else
return m_LastNotification;
}
/**
* Sets the timestamp when the last notification was sent.
*/
void Notification::SetLastNotification(double time)
{
m_LastNotification = time;
Touch("last_notification");
}
double Notification::GetNextNotification(void) const
{
if (m_NextNotification.IsEmpty())
return 0;
else
return m_NextNotification;
}
/**
* Sets the timestamp when the next periodical notification should be sent.
* This does not affect notifications that are sent for state changes.
*/
void Notification::SetNextNotification(double time)
{
m_NextNotification = time;
Touch("next_notification");
}
2013-02-24 01:10:34 +01:00
String Notification::NotificationTypeToString(NotificationType type)
2013-02-09 11:42:22 +01:00
{
2013-02-24 01:10:34 +01:00
switch (type) {
case NotificationDowntimeStart:
return "DOWNTIMESTART";
case NotificationDowntimeEnd:
return "DOWNTIMEEND";
case NotificationDowntimeRemoved:
return "DOWNTIMECANCELLED";
case NotificationCustom:
return "CUSTOM";
case NotificationAcknowledgement:
return "ACKNOWLEDGEMENT";
2013-02-24 01:10:34 +01:00
case NotificationProblem:
return "PROBLEM";
case NotificationRecovery:
return "RECOVERY";
2013-06-21 10:20:29 +02:00
case NotificationFlappingStart:
return "FLAPPINGSTART";
case NotificationFlappingEnd:
return "FLAPPINGEND";
2013-02-24 01:10:34 +01:00
default:
return "UNKNOWN_NOTIFICATION";
}
}
void Notification::BeginExecuteNotification(NotificationType type, const Dictionary::Ptr& cr, bool force, const String& author, const String& text)
2013-02-24 01:10:34 +01:00
{
ASSERT(!OwnsLock());
2013-02-24 01:10:34 +01:00
2013-05-13 13:44:57 +02:00
if (!force) {
TimePeriod::Ptr tp = GetNotificationPeriod();
if (tp && !tp->IsInside(Utility::GetTime())) {
Log(LogInformation, "icinga", "Not sending notifications for notification object '" + GetName() + "': not in timeperiod");
return;
}
2013-05-13 13:44:57 +02:00
double now = Utility::GetTime();
Dictionary::Ptr times = GetTimes();
Service::Ptr service = GetService();
if (times && times->Contains("begin") && now < service->GetLastHardStateChange() + times->Get("begin")) {
Log(LogInformation, "icinga", "Not sending notifications for notification object '" + GetName() + "': before escalation range");
return;
}
if (times && times->Contains("end") && now > service->GetLastHardStateChange() + times->Get("end")) {
Log(LogInformation, "icinga", "Not sending notifications for notification object '" + GetName() + "': after escalation range");
return;
}
unsigned long ftype = 1 << type;
Log(LogDebug, "icinga", "FType=" + Convert::ToString(ftype) + ", TypeFilter=" + Convert::ToString(GetNotificationTypeFilter()));
if (!(ftype & GetNotificationTypeFilter())) {
Log(LogInformation, "icinga", "Not sending notifications for notification object '" + GetName() + "': type filter does not match");
return;
}
unsigned long fstate = 1 << GetService()->GetState();
if (!(fstate & GetNotificationStateFilter())) {
Log(LogInformation, "icinga", "Not sending notifications for notification object '" + GetName() + "': state filter does not match");
return;
}
}
{
ObjectLock olock(this);
SetLastNotification(Utility::GetTime());
}
2013-03-16 21:18:53 +01:00
std::set<User::Ptr> allUsers;
2013-02-27 21:49:03 +01:00
2013-03-16 21:18:53 +01:00
std::set<User::Ptr> users = GetUsers();
2013-02-27 21:49:03 +01:00
std::copy(users.begin(), users.end(), std::inserter(allUsers, allUsers.begin()));
2013-03-02 09:07:47 +01:00
BOOST_FOREACH(const UserGroup::Ptr& ug, GetGroups()) {
2013-03-16 21:18:53 +01:00
std::set<User::Ptr> members = ug->GetMembers();
2013-02-27 21:49:03 +01:00
std::copy(members.begin(), members.end(), std::inserter(allUsers, allUsers.begin()));
}
2013-02-24 08:26:10 +01:00
2013-02-27 21:49:03 +01:00
BOOST_FOREACH(const User::Ptr& user, allUsers) {
Log(LogDebug, "icinga", "Sending notification for user '" + user->GetName() + "'");
Utility::QueueAsyncCallback(boost::bind(&Notification::ExecuteNotificationHelper, this, type, user, cr, force, author, text));
2013-02-24 08:26:10 +01:00
}
}
void Notification::ExecuteNotificationHelper(NotificationType type, const User::Ptr& user, const Dictionary::Ptr& cr, bool force, const String& author, const String& text)
2013-02-24 08:26:10 +01:00
{
ASSERT(!OwnsLock());
2013-03-02 09:07:47 +01:00
if (!force) {
TimePeriod::Ptr tp = user->GetNotificationPeriod();
2013-02-24 08:26:10 +01:00
if (tp && !tp->IsInside(Utility::GetTime())) {
Log(LogInformation, "icinga", "Not sending notifications for notification object '" +
GetName() + " and user '" + user->GetName() + "': user not in timeperiod");
return;
}
unsigned long ftype = 1 << type;
if (!(ftype & user->GetNotificationTypeFilter())) {
Log(LogInformation, "icinga", "Not sending notifications for notification object '" +
GetName() + " and user '" + user->GetName() + "': type filter does not match");
return;
}
unsigned long fstate = 1 << GetService()->GetState();
if (!(fstate & user->GetNotificationStateFilter())) {
Log(LogInformation, "icinga", "Not sending notifications for notification object '" +
GetName() + " and user '" + user->GetName() + "': state filter does not match");
return;
}
2013-02-24 08:26:10 +01:00
}
2013-02-09 11:42:22 +01:00
try {
GetNotificationCommand()->Execute(GetSelf(), user, cr, type);
2013-02-09 11:42:22 +01:00
RequestMessage rm;
rm.SetMethod("icinga::NotificationSent");
NotificationMessage params;
params.SetService(GetService()->GetName());
params.SetUser(user->GetName());
params.SetType(type);
params.SetAuthor(author);
params.SetCommentText(text);
params.SetCheckResult(cr);
rm.SetParams(params);
EndpointManager::GetInstance()->SendMulticastMessage(rm);
2013-03-16 21:18:53 +01:00
Log(LogInformation, "icinga", "Completed sending notification for service '" + GetService()->GetName() + "'");
} catch (const std::exception& ex) {
std::ostringstream msgbuf;
2013-02-09 11:42:22 +01:00
msgbuf << "Exception occured during notification for service '"
2013-03-16 21:18:53 +01:00
<< GetService()->GetName() << "': " << boost::diagnostic_information(ex);
2013-02-09 11:42:22 +01:00
String message = msgbuf.str();
2013-03-16 21:18:53 +01:00
Log(LogWarning, "icinga", message);
2013-02-09 11:42:22 +01:00
}
}
2013-03-04 15:52:42 +01:00
void Notification::OnAttributeChanged(const String& name)
{
ASSERT(!OwnsLock());
2013-03-02 09:07:47 +01:00
if (name == "host_name" || name == "service")
2013-02-27 15:23:25 +01:00
Service::InvalidateNotificationsCache();
}
2013-04-16 10:12:53 +02:00
bool Notification::ResolveMacro(const String& macro, const Dictionary::Ptr&, String *result) const
{
Dictionary::Ptr macros = GetMacros();
if (macros && macros->Contains(macro)) {
*result = macros->Get(macro);
return true;
}
return false;
}