d6584aea7316a4512883e7fb4b444c417600fa8c
1 #!/usr/bin/perl -w
3 # (c)1999 Ian Cass, Knowledge Matters Ltd.
4 # Read the GNU copyright stuff for all the legalese
5 #
6 # Check NTP time servers plugin. This plugin requires the ntpdate utility to
7 # be installed on the system, however since it's part of the ntp suite, you
8 # should already have it installed.
9 #
10 # $Id$
11 #
12 # Nothing clever done in this program - its a very simple bare basics hack to
13 # get the job done.
14 #
15 # Things to do...
16 # check @words[9] for time differences greater than +/- x secs & return a
17 # warning.
18 #
19 # (c) 1999 Mark Jewiss, Knowledge Matters Limited
20 # 22-9-1999, 12:45
21 #
22 # Modified script to accept 2 parameters or set defaults.
23 # Now issues warning or critical alert is time difference is greater than the
24 # time passed.
25 #
26 # These changes have not been tested completely due to the unavailability of a
27 # server with the incorrect time.
28 #
29 # (c) 1999 Bo Kersey, VirCIO - Managed Server Solutions <bo@vircio.com>
30 # 22-10-99, 12:17
31 #
32 # Modified the script to give useage if no parameters are input.
33 #
34 # Modified the script to check for negative as well as positive
35 # time differences.
36 #
37 # Modified the script to work with ntpdate 3-5.93e Wed Apr 14 20:23:03 EDT 1999
38 #
39 # Modified the script to work with ntpdate's that return adjust or offset...
40 #
41 #
42 # Script modified 2000 June 01 by William Pietri <william@bianca.com>
43 #
44 # Modified script to handle weird cases:
45 # o NTP server doesn't respond (e.g., has died)
46 # o Server has correct time but isn't suitable synchronization
47 # source. This happens while starting up and if contact
48 # with master has been lost.
49 #
50 # Modifed to run under Embedded Perl (sghosh@users.sf.net)
51 # - combined logic some blocks together..
52 #
53 # Added ntpdate check for stratum 16 desynch peer (James Fidell) Feb 03, 2003
54 #
55 # ntpdate - offset is in seconds
56 # changed ntpdc to ntpq - jitter/dispersion is in milliseconds
57 #
58 # Patch for for regex for stratum1 refid.
60 require 5.004;
61 use POSIX;
62 use strict;
63 use Getopt::Long;
64 use vars qw($opt_V $opt_h $opt_H $opt_t $opt_w $opt_c $opt_O $opt_j $opt_k $verbose $PROGNAME $def_jitter $ipv4 $ipv6);
65 use lib utils.pm;
66 use utils qw($TIMEOUT %ERRORS &print_revision &support);
68 $PROGNAME="check_ntp";
70 sub print_help ();
71 sub print_usage ();
73 $ENV{'PATH'}='';
74 $ENV{'BASH_ENV'}='';
75 $ENV{'ENV'}='';
77 # defaults in sec
78 my $DEFAULT_OFFSET_WARN = 60; # 1 minute
79 my $DEFAULT_OFFSET_CRIT = 120; # 2 minutes
80 # default in millisec
81 my $DEFAULT_JITTER_WARN = 5000; # 5 sec
82 my $DEFAULT_JITTER_CRIT = 10000; # 10 sec
84 Getopt::Long::Configure('bundling');
85 GetOptions
86 ("V" => \$opt_V, "version" => \$opt_V,
87 "h" => \$opt_h, "help" => \$opt_h,
88 "v" => \$verbose, "verbose" => \$verbose,
89 "4" => \$ipv4, "use-ipv4" => \$ipv4,
90 "6" => \$ipv6, "use-ipv6" => \$ipv6,
91 "w=f" => \$opt_w, "warning=f" => \$opt_w, # offset|adjust warning if above this number
92 "c=f" => \$opt_c, "critical=f" => \$opt_c, # offset|adjust critical if above this number
93 "O" => \$opt_O, "zero-offset" => \$opt_O, # zero-offset bad
94 "j=s" => \$opt_j, "jwarn=i" => \$opt_j, # jitter warning if above this number
95 "k=s" => \$opt_k, "jcrit=i" => \$opt_k, # jitter critical if above this number
96 "t=s" => \$opt_t, "timeout=i" => \$opt_t,
97 "H=s" => \$opt_H, "hostname=s" => \$opt_H);
99 if ($opt_V) {
100 print_revision($PROGNAME,'$Revision$ ');
101 exit $ERRORS{'OK'};
102 }
104 if ($opt_h) {
105 print_help();
106 exit $ERRORS{'OK'};
107 }
109 # jitter test params specified
110 if (defined $opt_j || defined $opt_k ) {
111 $def_jitter = 1;
112 }
114 $opt_H = shift unless ($opt_H);
115 my $host = $1 if ($opt_H && $opt_H =~ m/^([0-9]+\.[0-9]+\.[0-9]+\.[0-9]+|[a-zA-Z][-a-zA-Z0-9]+(\.[a-zA-Z][-a-zA-Z0-9]+)*)$/);
116 unless ($host) {
117 print "No target host specified\n";
118 print_usage();
119 exit $ERRORS{'UNKNOWN'};
120 }
122 my ($timeout, $owarn, $ocrit, $jwarn, $jcrit);
124 $timeout = $TIMEOUT;
125 ($opt_t) && ($opt_t =~ /^([0-9]+)$/) && ($timeout = $1);
127 $owarn = $DEFAULT_OFFSET_WARN;
128 ($opt_w) && ($opt_w =~ /^([0-9.]+)$/) && ($owarn = $1);
130 $ocrit = $DEFAULT_OFFSET_CRIT;
131 ($opt_c) && ($opt_c =~ /^([0-9.]+)$/) && ($ocrit = $1);
133 $jwarn = $DEFAULT_JITTER_WARN;
134 ($opt_j) && ($opt_j =~ /^([0-9]+)$/) && ($jwarn = $1);
136 $jcrit = $DEFAULT_JITTER_CRIT;
137 ($opt_k) && ($opt_k =~ /^([0-9]+)$/) && ($jcrit = $1);
139 if ($ocrit < $owarn ) {
140 print "Critical offset should be larger than warning offset\n";
141 print_usage();
142 exit $ERRORS{"UNKNOWN"};
143 }
145 if ($def_jitter) {
146 if ($opt_k < $opt_j) {
147 print "Critical jitter should be larger than warning jitter\n";
148 print_usage();
149 exit $ERRORS{'UNKNOWN'};
150 }
151 }
154 my $stratum = -1;
155 my $ignoreret = 0;
156 my $answer = undef;
157 my $offset = undef;
158 my $jitter = undef;
159 my $syspeer = undef;
160 my $candidate = 0;
161 my @candidates;
162 my $msg; # first line of output to print if format is invalid
164 my $state = $ERRORS{'UNKNOWN'};
165 my $ntpdate_error = $ERRORS{'UNKNOWN'};
166 my $jitter_error = $ERRORS{'UNKNOWN'};
168 # some systems don't have a proper ntpq (migrated from ntpdc)
169 my $have_ntpq = undef;
170 if ($utils::PATH_TO_NTPQ && -x $utils::PATH_TO_NTPQ ) {
171 $have_ntpq = 1;
172 }else{
173 $have_ntpq = 0;
174 }
176 # Just in case of problems, let's not hang Nagios
177 $SIG{'ALRM'} = sub {
178 print ("ERROR: No response from ntp server (alarm)\n");
179 exit $ERRORS{"UNKNOWN"};
180 };
181 alarm($timeout);
183 # Determine protocol to be used for ntpdate and ntpq
184 my $ntpdate = $utils::PATH_TO_NTPDATE;
185 my $ntpq = $utils::PATH_TO_NTPQ;
186 if ($ipv4) {
187 $ntpdate .= " -4";
188 $ntpq .= " -4";
189 }
190 elsif ($ipv6) {
191 $ntpdate .= " -6";
192 $ntpq .= " -6";
193 }
194 # else don't use any flags
196 ###
197 ###
198 ### First, check ntpdate
199 ###
200 ###
202 if (!open (NTPDATE, $ntpdate . " -q $host 2>&1 |")) {
203 print "Could not open ntpdate\n";
204 exit $ERRORS{"UNKNOWN"};
205 }
207 while (<NTPDATE>) {
208 #print if ($verbose); # noop
209 $msg = $_ unless ($msg);
211 if (/stratum\s(\d+)/) {
212 $stratum = $1;
213 }
215 if (/(offset|adjust)\s+([-.\d]+)/i) {
216 $offset = $2;
218 # An offset of 0.000000 with an error is probably bogus. Actually,
219 # it's probably always bogus, but let's be paranoid here.
220 # Has been reported that 0.0000 happens in a production environment
221 # on Solaris 8 so this check should be taken out - SF tracker 1150777
222 if (defined $opt_O ) {
223 if ($offset == 0) { undef $offset;}
224 }
226 $ntpdate_error = defined ($offset) ? $ERRORS{"OK"} : $ERRORS{"CRITICAL"};
227 print "ntperr = $ntpdate_error \n" if $verbose;
229 }
231 if (/no server suitable for synchronization found/) {
232 if ($stratum == 16) {
233 $ntpdate_error = $ERRORS{"WARNING"};
234 $msg = "Desynchronized peer server found";
235 $ignoreret=1;
236 }
237 else {
238 $ntpdate_error = $ERRORS{"CRITICAL"};
239 $msg = "No suitable peer server found - ";
240 }
241 }
243 }
245 close (NTPDATE);
246 # declare an error if we also get a non-zero return code from ntpdate
247 # unless already set to critical
248 if ( $? && !$ignoreret ) {
249 print "stderr = $? : $! \n" if $verbose;
250 $ntpdate_error = $ntpdate_error == $ERRORS{"CRITICAL"} ? $ERRORS{"CRITICAL"} : $ERRORS{"UNKNOWN"} ;
251 print "ntperr = $ntpdate_error : $!\n" if $verbose;
252 }
254 ###
255 ###
256 ### Then scan xntpq/ntpq if it exists
257 ### and look in the 11th column for jitter
258 ###
259 # Field 1: Tally Code ( Space, 'x','.','-','+','#','*','o')
260 # Only match for '*' which implies sys.peer
261 # or 'o' which implies pps.peer
262 # If both exist, the last one is picked.
263 # Field 2: address of the remote peer
264 # Field 3: Refid of the clock (0.0.0.0 if unknown, WWWV/PPS/GPS/ACTS/USNO/PCS/... if Stratum1)
265 # Field 4: stratum (0-15)
266 # Field 5: Type of the peer: local (l), unicast (u), multicast (m)
267 # broadcast (b); not sure about multicast/broadcast
268 # Field 6: last packet receive (in seconds)
269 # Field 7: polling interval
270 # Field 8: reachability resgister (octal)
271 # Field 9: delay
272 # Field 10: offset
273 # Field 11: dispersion/jitter
274 #
275 # According to bug 773588 Some solaris xntpd implementations seemto match on
276 # "#" even though the docs say it exceeds maximum distance. Providing patch
277 # here which will generate a warining.
279 if ($have_ntpq) {
281 if ( open(NTPQ, $ntpq . " -np $host 2>&1 |") ) {
282 while (<NTPQ>) {
283 print $_ if ($verbose);
284 if ( /timed out/ ){
285 $have_ntpq = 0 ;
286 last ;
287 }
288 # number of candidates on <host> for sys.peer
289 if (/^(\*|\+|\#|o])/) {
290 ++$candidate;
291 push (@candidates, $_);
292 print "Candidate count= $candidate\n" if ($verbose);
293 }
295 # match sys.peer or pps.peer
296 if (/^(\*|o)([-0-9.\s]+)\s+([-0-9A-Za-z_().]+)\s+([-0-9.]+)\s+([lumb-]+)\s+([-0-9hm.]+)\s+([-0-9.mh]+)\s+([-0-9.]+)\s+([-0-9.]+)\s+([-0-9.]+)\s+([-0-9.]+)/) {
297 $syspeer = $2;
298 $stratum = $4;
299 $jitter = $11;
300 print "match $_ \n" if $verbose;
301 if ($jitter > $jcrit) {
302 print "Jitter_crit = $11 :$jcrit\n" if ($verbose);
303 $jitter_error = $ERRORS{'CRITICAL'};
304 } elsif ($jitter > $jwarn ) {
305 print "Jitter_warn = $11 :$jwarn\n" if ($verbose);
306 $jitter_error = $ERRORS{'WARNING'};
307 } else {
308 $jitter_error = $ERRORS{'OK'};
309 }
310 } else {
311 print "No match!\n" if $verbose;
312 $jitter = '(not parsed)';
313 }
315 }
316 close NTPQ;
318 # if we did not match sys.peer or pps.peer but matched # candidates only
319 # generate a warning
320 # based on bug id 773588
321 unless (defined $syspeer) {
322 if ($#candidates >=0) {
323 foreach my $c (@candidates) {
324 $c =~ /^(#)([-0-9.\s]+)\s+([-0-9A-Za-z_().]+)\s+([-0-9.]+)\s+([lumb-]+)\s+([-0-9m.]+)\s+([-0-9.]+)\s+([-0-9.]+)\s+([-0-9.]+)\s+([-0-9.]+)\s+([-0-9.]+)/;
325 $syspeer = $2;
326 $stratum = $4;
327 $jitter = $11;
328 print "candidate match $c \n" if $verbose;
329 if ($jitter > $jcrit) {
330 print "Candidate match - Jitter_crit = $11 :$jcrit\n" if ($verbose);
331 $jitter_error = $ERRORS{'CRITICAL'};
332 }elsif ($jitter > $jwarn ) {
333 print "Candidate match - Jitter_warn = $11 :$jwarn \n" if ($verbose);
334 $jitter_error = $ERRORS{'WARNING'};
335 } else {
336 $jitter_error = $ERRORS{'WARNING'};
337 }
338 }
340 }
341 }
342 }
343 }
346 if ($ntpdate_error != $ERRORS{'OK'}) {
347 $state = $ntpdate_error;
348 if ($ntpdate_error == $ERRORS{'WARNING'} ) {
349 $answer = $msg;
350 }
351 else {
352 $answer = $msg . "Server for ntp probably down";
353 }
355 if (defined($offset) && abs($offset) > $ocrit) {
356 $state = $ERRORS{'CRITICAL'};
357 $answer = "Server Error and offset $offset sec > +/- $ocrit sec";
358 } elsif (defined($offset) && abs($offset) > $owarn) {
359 $answer = "Server error and offset $offset sec > +/- $owarn sec";
360 } elsif (defined($jitter) && abs($jitter) > $jcrit) {
361 $answer = "Server error and jitter $jitter msec > +/- $jcrit msec";
362 } elsif (defined($jitter) && abs($jitter) > $jwarn) {
363 $answer = "Server error and jitter $jitter msec > +/- $jwarn msec";
364 }
366 } elsif ($have_ntpq && $jitter_error != $ERRORS{'OK'}) {
367 $state = $jitter_error;
368 $answer = "Jitter $jitter too high";
369 if (defined($offset) && abs($offset) > $ocrit) {
370 $state = $ERRORS{'CRITICAL'};
371 $answer = "Jitter error and offset $offset sec > +/- $ocrit sec";
372 } elsif (defined($offset) && abs($offset) > $owarn) {
373 $answer = "Jitter error and offset $offset sec > +/- $owarn sec";
374 } elsif (defined($jitter) && abs($jitter) > $jcrit) {
375 $answer = "Jitter error and jitter $jitter msec > +/- $jcrit msec";
376 } elsif (defined($jitter) && abs($jitter) > $jwarn) {
377 $answer = "Jitter error and jitter $jitter msec > +/- $jwarn msec";
378 }
380 } elsif( !$have_ntpq ) { # no errors from ntpdate and no ntpq or ntpq timed out
381 if (abs($offset) > $ocrit) {
382 $state = $ERRORS{'CRITICAL'};
383 $answer = "Offset $offset sec > +/- $ocrit sec";
384 } elsif (abs($offset) > $owarn) {
385 $state = $ERRORS{'WARNING'};
386 $answer = "Offset $offset sec > +/- $owarn sec";
387 } elsif (( abs($offset) > $owarn) && $def_jitter ) {
388 $state = $ERRORS{'WARNING'};
389 $answer = "Offset $offset sec > +/- $owarn sec, ntpq timed out";
390 } elsif ( $def_jitter ) {
391 $state = $ERRORS{'WARNING'};
392 $answer = "Offset $offset secs, ntpq timed out";
393 } else{
394 $state = $ERRORS{'OK'};
395 $answer = "Offset $offset secs";
396 }
400 } else { # no errors from ntpdate or ntpq
401 if (abs($offset) > $ocrit) {
402 $state = $ERRORS{'CRITICAL'};
403 $answer = "Offset $offset sec > +/- $ocrit sec, jitter $jitter msec";
404 } elsif (abs($jitter) > $jcrit ) {
405 $state = $ERRORS{'CRITICAL'};
406 $answer = "Jitter $jitter msec> +/- $jcrit msec, offset $offset sec";
407 } elsif (abs($offset) > $owarn) {
408 $state = $ERRORS{'WARNING'};
409 $answer = "Offset $offset sec > +/- $owarn sec, jitter $jitter msec";
410 } elsif (abs($jitter) > $jwarn ) {
411 $state = $ERRORS{'WARNING'};
412 $answer = "Jitter $jitter msec> +/- $jwarn msec, offset $offset sec";
414 } else {
415 $state = $ERRORS{'OK'};
416 $answer = "Offset $offset secs, jitter $jitter msec, peer is stratum $stratum";
417 }
419 }
421 foreach my $key (keys %ERRORS) {
422 if ($state==$ERRORS{$key}) {
423 # print ("NTP $key: $answer");
424 print ("NTP $key: $answer|offset=$offset, jitter=" . $jitter/1000 . ",peer_stratum=$stratum\n");
425 last;
426 }
427 }
428 exit $state;
431 ####
432 #### subs
434 sub print_usage () {
435 print "Usage: $PROGNAME -H <host> [-46] [-O] [-w <warn>] [-c <crit>] [-j <warn>] [-k <crit>] [-v verbose]\n";
436 }
438 sub print_help () {
439 print_revision($PROGNAME,'$Revision$');
440 print "Copyright (c) 2003 Bo Kersey/Karl DeBisschop\n";
441 print "\n";
442 print_usage();
443 print "
444 Checks the local timestamp offset versus <host> with ntpdate
445 Checks the jitter/dispersion of clock signal between <host> and its sys.peer with ntpq\n
446 -O (--zero-offset)
447 A zero offset on \"ntpdate\" will generate a CRITICAL.\n
448 -w (--warning)
449 Clock offset in seconds at which a warning message will be generated.\n Defaults to $DEFAULT_OFFSET_WARN.
450 -c (--critical)
451 Clock offset in seconds at which a critical message will be generated.\n Defaults to $DEFAULT_OFFSET_CRIT.
452 -j (--jwarn)
453 Clock jitter in milliseconds at which a warning message will be generated.\n Defaults to $DEFAULT_JITTER_WARN.
454 -k (--jcrit)
455 Clock jitter in milliseconds at which a critical message will be generated.\n Defaults to $DEFAULT_JITTER_CRIT.
457 If jitter/dispersion is specified with -j or -k and ntpq times out, then a
458 warning is returned.\n
459 -4 (--use-ipv4)
460 Use IPv4 connection
461 -6 (--use-ipv6)
462 Use IPv6 connection
463 \n";
464 support();
465 }