remove debug output or more precisely: changed its log level from notice to debug...
[pingcheck] / src / host / hoststatus.cpp
1 /*
2 The software in this package is distributed under the GNU General
3 Public License version 2 (with a special exception described below).
4
5 A copy of GNU General Public License (GPL) is included in this distribution,
6 in the file COPYING.GPL.
7
8 As a special exception, if other files instantiate templates or use macros
9 or inline functions from this file, or you compile this file and link it
10 with other works to produce a work based on this file, this file
11 does not by itself cause the resulting work to be covered
12 by the GNU General Public License.
13
14 However the source code for this file must still be made available
15 in accordance with section (3) of the GNU General Public License.
16
17 This exception does not invalidate any other reasons why a work based
18 on this file might be covered by the GNU General Public License.
19 */
20 #include "host/hoststatus.h"
21
22 #include <iostream>
23 #include <logfunc.hpp>
24
25 #include "boost_assert_handler.h"
26
27 using namespace std;
28 using I2n::Logger::GlobalLogger;
29
30 //-----------------------------------------------------------------------------
31 // HostStatus
32 //-----------------------------------------------------------------------------
33
34 /**
35  * @param host_address The address of the host it has to analyze.
36  * @param ping_fail_percentage_limit The percentage threshold of pings that can
37  * fail.
38  * @param link_analyzer The object used to notify the status of the host.
39  */
40 HostStatus::HostStatus(
41         const string &host_address,
42         const int ping_fail_limit_percentage,
43         const LinkStatusItem link_analyzer
44 ) :
45     HostAddress( host_address ),
46     LinkAnalyzer( link_analyzer ),
47     PingFailLimitPercentage( ping_fail_limit_percentage ),
48     ResolvedIpCount( 0 ),
49     PingsPerformedCount( 0 ),
50     PingsFailedCount( 0 ),
51     ExceededPingFailedLimit( false )
52 {
53     BOOST_ASSERT( !HostAddress.empty() );
54     BOOST_ASSERT( ( 0 <= PingFailLimitPercentage ) && ( PingFailLimitPercentage <= 100 ) );
55 }
56
57 HostStatus::~HostStatus()
58 {
59 }
60
61 /**
62  * @param resolved_ip_count The number of IPs resolved for the host.
63  */
64 void HostStatus::set_resolved_ip_count( const int resolved_ip_count )
65 {
66     BOOST_ASSERT( 1 <= resolved_ip_count );
67
68     if (resolved_ip_count != ResolvedIpCount)
69     {   // assume that the target has changed --> reset counters
70         reset_ping_counters();
71     }
72     ResolvedIpCount = resolved_ip_count;
73
74     GlobalLogger.debug() << "Stat(" << HostAddress << "): "
75         << PingsFailedCount << " fail/" << PingsPerformedCount << " pings/"
76         << ResolvedIpCount << " IPs: #IPs set";
77 }
78
79 /**
80  * @return true if the amount of failed pings given to the host exceeded the
81  * limit.
82  */
83 bool HostStatus::exceeded_ping_failed_limit() const
84 {
85     return ExceededPingFailedLimit;
86 }
87
88 /**
89  * Adds a ping status (success or failure).
90  * @param ping_success
91  */
92 void HostStatus::update_ping_statistics( bool ping_success )
93 {
94     GlobalLogger.debug() << "Stat(" << HostAddress << "): "
95         << PingsFailedCount << " fail/" << PingsPerformedCount << " pings/"
96         << ResolvedIpCount << " IPs: add ping with success=" << ping_success;
97
98     BOOST_ASSERT( 1 <= ResolvedIpCount );
99     BOOST_ASSERT( 0 <= PingsPerformedCount );
100     BOOST_ASSERT( PingsFailedCount <= PingsPerformedCount );
101
102     increase_ping_performed_count();
103
104     if ( !ping_success )
105     {
106         increase_ping_failed_count();
107     }
108
109     analyze_ping_failed_count();
110
111     // after we tried all IPs resolved for this host, we can analyze how many
112     // failed
113     if ( tried_all_resolved_ip() )
114     {
115         analyze_ping_statistics();
116
117         reset_ping_counters();
118     }
119
120     BOOST_ASSERT( PingsFailedCount <= PingsPerformedCount );
121 }
122
123
124 bool HostStatus::tried_all_resolved_ip() const
125 {
126     BOOST_ASSERT( ( 0 < PingsPerformedCount ) && ( PingsPerformedCount <= ResolvedIpCount ) );
127
128     return ( PingsPerformedCount == ResolvedIpCount );
129 }
130
131 void HostStatus::analyze_ping_statistics()
132 {
133     BOOST_ASSERT( !HostAddress.empty() );
134     BOOST_ASSERT( PingsPerformedCount == ResolvedIpCount );
135
136     // notify if the amount of pings that failed exceed the limit
137     if ( exceeded_ping_failed_limit() )
138     {
139         GlobalLogger.debug() << "Stat(" << HostAddress << "): "
140             << PingsFailedCount << " fail/" << PingsPerformedCount << " pings/"
141             << ResolvedIpCount << " IPs: notify down";
142         LinkAnalyzer->notify_host_down( HostAddress );
143     }
144     else
145     {
146         GlobalLogger.debug() << "Stat(" << HostAddress << "): "
147             << PingsFailedCount << " fail/" << PingsPerformedCount << " pings/"
148             << ResolvedIpCount << " IPs: notify up";
149         LinkAnalyzer->notify_host_up( HostAddress );
150     }
151 } //lint !e1762
152
153 void HostStatus::reset_ping_counters()
154 {
155     PingsPerformedCount = 0;
156     PingsFailedCount = 0;
157 }
158
159 void HostStatus::increase_ping_performed_count()
160 {
161     ++PingsPerformedCount;
162
163     BOOST_ASSERT( ( 0 < PingsPerformedCount ) && ( PingsPerformedCount <= ResolvedIpCount ) );
164 }
165
166 void HostStatus::increase_ping_failed_count()
167 {
168     ++PingsFailedCount;
169
170     BOOST_ASSERT( ( 0 <= PingsFailedCount ) && ( PingsFailedCount <= PingsPerformedCount ) );
171 }
172
173 void HostStatus::analyze_ping_failed_count()
174 {
175     BOOST_ASSERT( ( 0 <= PingFailLimitPercentage ) && ( PingFailLimitPercentage <= 100 ) );
176     BOOST_ASSERT( ( 0 <= PingsFailedCount ) && ( PingsFailedCount <= PingsPerformedCount ) );
177
178     int ping_fail_limit_count = ( ResolvedIpCount * PingFailLimitPercentage ) / 100;
179
180     // keep a boolean variable because the PingsFailedCount can be reseted
181     if ( PingsFailedCount > ping_fail_limit_count )
182     {
183         ExceededPingFailedLimit = true;
184
185         GlobalLogger.debug() << "Stat(" << HostAddress << "): "
186             << PingsFailedCount << " fail/" << PingsPerformedCount << " pings/"
187             << ResolvedIpCount << " IPs: exceed limit=" << ping_fail_limit_count;
188     }
189     else
190     {
191         ExceededPingFailedLimit = false;
192
193         GlobalLogger.debug() << "Stat(" << HostAddress << "): "
194             << PingsFailedCount << " fail/" << PingsPerformedCount << " pings/"
195             << ResolvedIpCount << " IPs: below limit=" << ping_fail_limit_count;
196     }
197 }