1 /******************************************************************************
3 * Copyright (C) 2012-2017 Icinga Development Team (https://www.icinga.com/) *
5 * This program is free software; you can redistribute it and/or *
6 * modify it under the terms of the GNU General Public License *
7 * as published by the Free Software Foundation; either version 2 *
8 * of the License, or (at your option) any later version. *
10 * This program is distributed in the hope that it will be useful, *
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
13 * GNU General Public License for more details. *
15 * You should have received a copy of the GNU General Public License *
16 * along with this program; if not, write to the Free Software Foundation *
17 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA. *
18 ******************************************************************************/
20 #include "checker/checkercomponent.hpp"
21 #include "checker/checkercomponent.tcpp"
22 #include "icinga/icingaapplication.hpp"
23 #include "icinga/cib.hpp"
24 #include "remote/apilistener.hpp"
25 #include "base/configtype.hpp"
26 #include "base/objectlock.hpp"
27 #include "base/utility.hpp"
28 #include "base/perfdatavalue.hpp"
29 #include "base/logger.hpp"
30 #include "base/exception.hpp"
31 #include "base/convert.hpp"
32 #include "base/statsfunction.hpp"
34 using namespace icinga;
36 REGISTER_TYPE(CheckerComponent);
38 REGISTER_STATSFUNCTION(CheckerComponent, &CheckerComponent::StatsFunc);
40 void CheckerComponent::StatsFunc(const Dictionary::Ptr& status, const Array::Ptr& perfdata)
42 Dictionary::Ptr nodes = new Dictionary();
44 for (const CheckerComponent::Ptr& checker : ConfigType::GetObjectsByType<CheckerComponent>()) {
45 unsigned long idle = checker->GetIdleCheckables();
46 unsigned long pending = checker->GetPendingCheckables();
48 Dictionary::Ptr stats = new Dictionary();
49 stats->Set("idle", idle);
50 stats->Set("pending", pending);
52 nodes->Set(checker->GetName(), stats);
54 String perfdata_prefix = "checkercomponent_" + checker->GetName() + "_";
55 perfdata->Add(new PerfdataValue(perfdata_prefix + "idle", Convert::ToDouble(idle)));
56 perfdata->Add(new PerfdataValue(perfdata_prefix + "pending", Convert::ToDouble(pending)));
59 status->Set("checkercomponent", nodes);
62 CheckerComponent::CheckerComponent(void)
66 void CheckerComponent::OnConfigLoaded(void)
68 ConfigObject::OnActiveChanged.connect(bind(&CheckerComponent::ObjectHandler, this, _1));
69 ConfigObject::OnPausedChanged.connect(bind(&CheckerComponent::ObjectHandler, this, _1));
71 Checkable::OnNextCheckChanged.connect(bind(&CheckerComponent::NextCheckChangedHandler, this, _1));
74 void CheckerComponent::Start(bool runtimeCreated)
76 ObjectImpl<CheckerComponent>::Start(runtimeCreated);
78 Log(LogInformation, "CheckerComponent")
79 << "'" << GetName() << "' started.";
82 m_Thread = boost::thread(boost::bind(&CheckerComponent::CheckThreadProc, this));
84 m_ResultTimer = new Timer();
85 m_ResultTimer->SetInterval(5);
86 m_ResultTimer->OnTimerExpired.connect(boost::bind(&CheckerComponent::ResultTimerHandler, this));
87 m_ResultTimer->Start();
90 void CheckerComponent::Stop(bool runtimeRemoved)
92 Log(LogInformation, "CheckerComponent")
93 << "'" << GetName() << "' stopped.";
96 boost::mutex::scoped_lock lock(m_Mutex);
101 m_ResultTimer->Stop();
104 ObjectImpl<CheckerComponent>::Stop(runtimeRemoved);
107 void CheckerComponent::CheckThreadProc(void)
109 Utility::SetThreadName("Check Scheduler");
111 boost::mutex::scoped_lock lock(m_Mutex);
114 typedef boost::multi_index::nth_index<CheckableSet, 1>::type CheckTimeView;
115 CheckTimeView& idx = boost::get<1>(m_IdleCheckables);
117 while (idx.begin() == idx.end() && !m_Stopped)
123 auto it = idx.begin();
124 CheckableScheduleInfo csi = *it;
126 double wait = csi.NextCheck - Utility::GetTime();
128 if (Checkable::GetPendingChecks() >= GetConcurrentChecks())
132 /* Wait for the next check. */
133 m_CV.timed_wait(lock, boost::posix_time::milliseconds(wait * 1000));
138 Checkable::Ptr checkable = csi.Object;
140 m_IdleCheckables.erase(checkable);
142 bool forced = checkable->GetForceNextCheck();
146 if (!checkable->IsReachable(DependencyCheckExecution)) {
147 Log(LogNotice, "CheckerComponent")
148 << "Skipping check for object '" << checkable->GetName() << "': Dependency failed.";
153 Service::Ptr service;
154 tie(host, service) = GetHostService(checkable);
156 if (host && !service && (!checkable->GetEnableActiveChecks() || !IcingaApplication::GetInstance()->GetEnableHostChecks())) {
157 Log(LogNotice, "CheckerComponent")
158 << "Skipping check for host '" << host->GetName() << "': active host checks are disabled";
161 if (host && service && (!checkable->GetEnableActiveChecks() || !IcingaApplication::GetInstance()->GetEnableServiceChecks())) {
162 Log(LogNotice, "CheckerComponent")
163 << "Skipping check for service '" << service->GetName() << "': active service checks are disabled";
167 TimePeriod::Ptr tp = checkable->GetCheckPeriod();
169 if (tp && !tp->IsInside(Utility::GetTime())) {
170 Log(LogNotice, "CheckerComponent")
171 << "Skipping check for object '" << checkable->GetName()
172 << "': not in check period '" << tp->GetName() << "'";
177 /* reschedule the checkable if checks are disabled */
179 m_IdleCheckables.insert(GetCheckableScheduleInfo(checkable));
182 checkable->UpdateNextCheck();
189 m_PendingCheckables.insert(GetCheckableScheduleInfo(checkable));
194 ObjectLock olock(checkable);
195 checkable->SetForceNextCheck(false);
198 Log(LogDebug, "CheckerComponent")
199 << "Executing check for '" << checkable->GetName() << "'";
201 Checkable::IncreasePendingChecks();
203 Utility::QueueAsyncCallback(boost::bind(&CheckerComponent::ExecuteCheckHelper, CheckerComponent::Ptr(this), checkable));
209 void CheckerComponent::ExecuteCheckHelper(const Checkable::Ptr& checkable)
212 checkable->ExecuteCheck();
213 } catch (const std::exception& ex) {
214 CheckResult::Ptr cr = new CheckResult();
215 cr->SetState(ServiceUnknown);
217 String output = "Exception occured while checking '" + checkable->GetName() + "': " + DiagnosticInformation(ex);
218 cr->SetOutput(output);
220 double now = Utility::GetTime();
221 cr->SetScheduleStart(now);
222 cr->SetScheduleEnd(now);
223 cr->SetExecutionStart(now);
224 cr->SetExecutionEnd(now);
226 checkable->ProcessCheckResult(cr);
228 Log(LogCritical, "checker", output);
231 Checkable::DecreasePendingChecks();
234 boost::mutex::scoped_lock lock(m_Mutex);
236 /* remove the object from the list of pending objects; if it's not in the
237 * list this was a manual (i.e. forced) check and we must not re-add the
238 * object to the list because it's already there. */
239 auto it = m_PendingCheckables.find(checkable);
241 if (it != m_PendingCheckables.end()) {
242 m_PendingCheckables.erase(it);
244 if (checkable->IsActive())
245 m_IdleCheckables.insert(GetCheckableScheduleInfo(checkable));
251 Log(LogDebug, "CheckerComponent")
252 << "Check finished for object '" << checkable->GetName() << "'";
255 void CheckerComponent::ResultTimerHandler(void)
257 std::ostringstream msgbuf;
260 boost::mutex::scoped_lock lock(m_Mutex);
262 msgbuf << "Pending checkables: " << m_PendingCheckables.size() << "; Idle checkables: " << m_IdleCheckables.size() << "; Checks/s: "
263 << (CIB::GetActiveHostChecksStatistics(60) + CIB::GetActiveServiceChecksStatistics(60)) / 60.0;
266 Log(LogNotice, "CheckerComponent", msgbuf.str());
269 void CheckerComponent::ObjectHandler(const ConfigObject::Ptr& object)
271 Checkable::Ptr checkable = dynamic_pointer_cast<Checkable>(object);
276 Zone::Ptr zone = Zone::GetByName(checkable->GetZoneName());
277 bool same_zone = (!zone || Zone::GetLocalZone() == zone);
280 boost::mutex::scoped_lock lock(m_Mutex);
282 if (object->IsActive() && !object->IsPaused() && same_zone) {
283 if (m_PendingCheckables.find(checkable) != m_PendingCheckables.end())
286 m_IdleCheckables.insert(GetCheckableScheduleInfo(checkable));
288 m_IdleCheckables.erase(checkable);
289 m_PendingCheckables.erase(checkable);
296 CheckableScheduleInfo CheckerComponent::GetCheckableScheduleInfo(const Checkable::Ptr& checkable)
298 CheckableScheduleInfo csi;
299 csi.Object = checkable;
300 csi.NextCheck = checkable->GetNextCheck();
304 void CheckerComponent::NextCheckChangedHandler(const Checkable::Ptr& checkable)
306 boost::mutex::scoped_lock lock(m_Mutex);
308 /* remove and re-insert the object from the set in order to force an index update */
309 typedef boost::multi_index::nth_index<CheckableSet, 0>::type CheckableView;
310 CheckableView& idx = boost::get<0>(m_IdleCheckables);
312 auto it = idx.find(checkable);
317 idx.erase(checkable);
319 CheckableScheduleInfo csi = GetCheckableScheduleInfo(checkable);
325 unsigned long CheckerComponent::GetIdleCheckables(void)
327 boost::mutex::scoped_lock lock(m_Mutex);
329 return m_IdleCheckables.size();
332 unsigned long CheckerComponent::GetPendingCheckables(void)
334 boost::mutex::scoped_lock lock(m_Mutex);
336 return m_PendingCheckables.size();