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_j $opt_k $verbose $PROGNAME $def_jitter);
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 "w=f" => \$opt_w, "warning=f" => \$opt_w, # offset|adjust warning if above this number
90 "c=f" => \$opt_c, "critical=f" => \$opt_c, # offset|adjust critical if above this number
91 "j=s" => \$opt_j, "jwarn=i" => \$opt_j, # jitter warning if above this number
92 "k=s" => \$opt_k, "jcrit=i" => \$opt_k, # jitter critical if above this number
93 "t=s" => \$opt_t, "timeout=i" => \$opt_t,
94 "H=s" => \$opt_H, "hostname=s" => \$opt_H);
96 if ($opt_V) {
97 print_revision($PROGNAME,'$Revision$ ');
98 exit $ERRORS{'OK'};
99 }
101 if ($opt_h) {
102 print_help();
103 exit $ERRORS{'OK'};
104 }
106 # jitter test params specified
107 if (defined $opt_j || defined $opt_k ) {
108 $def_jitter = 1;
109 }
111 $opt_H = shift unless ($opt_H);
112 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]+)*)$/);
113 unless ($host) {
114 print "No target host specified\n";
115 print_usage();
116 exit $ERRORS{'UNKNOWN'};
117 }
119 my ($timeout, $owarn, $ocrit, $jwarn, $jcrit);
121 $timeout = $TIMEOUT;
122 ($opt_t) && ($opt_t =~ /^([0-9]+)$/) && ($timeout = $1);
124 $owarn = $DEFAULT_OFFSET_WARN;
125 ($opt_w) && ($opt_w =~ /^([0-9.]+)$/) && ($owarn = $1);
127 $ocrit = $DEFAULT_OFFSET_CRIT;
128 ($opt_c) && ($opt_c =~ /^([0-9.]+)$/) && ($ocrit = $1);
130 $jwarn = $DEFAULT_JITTER_WARN;
131 ($opt_j) && ($opt_j =~ /^([0-9]+)$/) && ($jwarn = $1);
133 $jcrit = $DEFAULT_JITTER_CRIT;
134 ($opt_k) && ($opt_k =~ /^([0-9]+)$/) && ($jcrit = $1);
136 if ($ocrit < $owarn ) {
137 print "Critical offset should be larger than warning offset\n";
138 print_usage();
139 exit $ERRORS{"UNKNOWN"};
140 }
141 if ($opt_k < $opt_j) {
142 print "Critical jitter should be larger than warning jitter\n";
143 print_usage();
144 exit $ERRORS{'UNKNOWN'};
145 }
148 my $stratum = -1;
149 my $ignoreret = 0;
150 my $answer = undef;
151 my $offset = undef;
152 my $jitter = undef;
153 my $syspeer = undef;
154 my $candidates = 0;
155 my $msg; # first line of output to print if format is invalid
157 my $state = $ERRORS{'UNKNOWN'};
158 my $ntpdate_error = $ERRORS{'UNKNOWN'};
159 my $jitter_error = $ERRORS{'UNKNOWN'};
161 # some systems don't have a proper ntpq (migrated from ntpdc)
162 my $have_ntpq = undef;
163 if ($utils::PATH_TO_NTPQ && -x $utils::PATH_TO_NTPQ ) {
164 $have_ntpq = 1;
165 }else{
166 $have_ntpq = 0;
167 }
169 # Just in case of problems, let's not hang Nagios
170 $SIG{'ALRM'} = sub {
171 print ("ERROR: No response from ntp server (alarm)\n");
172 exit $ERRORS{"UNKNOWN"};
173 };
174 alarm($timeout);
177 ###
178 ###
179 ### First, check ntpdate
180 ###
181 ###
183 if (!open (NTPDATE, "$utils::PATH_TO_NTPDATE -q $host 2>&1 |")) {
184 print "Could not open ntpdate\n";
185 exit $ERRORS{"UNKNOWN"};
186 }
188 while (<NTPDATE>) {
189 print if ($verbose);
190 $msg = $_ unless ($msg);
192 if (/stratum\s(\d+)/) {
193 $stratum = $1;
194 }
196 if (/(offset|adjust)\s+([-.\d]+)/i) {
197 $offset = $2;
199 # An offset of 0.000000 with an error is probably bogus. Actually,
200 # it's probably always bogus, but let's be paranoid here.
201 if ($offset == 0) { undef $offset;}
203 $ntpdate_error = defined ($offset) ? $ERRORS{"OK"} : $ERRORS{"CRITICAL"};
204 print "ntperr = $ntpdate_error \n" if $verbose;
206 }
208 if (/no server suitable for synchronization found/) {
209 if ($stratum == 16) {
210 $ntpdate_error = $ERRORS{"WARNING"};
211 $msg = "Desynchronized peer server found";
212 $ignoreret=1;
213 }
214 else {
215 $ntpdate_error = $ERRORS{"CRITICAL"};
216 $msg = "No suitable peer server found - ";
217 }
218 }
220 }
222 close (NTPDATE);
223 # declare an error if we also get a non-zero return code from ntpdate
224 # unless already set to critical
225 if ( $? && !$ignoreret ) {
226 print "stderr = $? : $! \n" if $verbose;
227 $ntpdate_error = $ntpdate_error == $ERRORS{"CRITICAL"} ? $ERRORS{"CRITICAL"} : $ERRORS{"UNKNOWN"} ;
228 print "ntperr = $ntpdate_error : $!\n" if $verbose;
229 }
231 ###
232 ###
233 ### Then scan xntpq/ntpq if it exists
234 ### and look in the 11th column for jitter
235 ###
236 # Field 1: Tally Code ( Space, 'x','.','-','+','#','*','o')
237 # Only match for '*' which implies sys.peer
238 # or 'o' which implies pps.peer
239 # If both exist, the last one is picked.
240 # Field 2: address of the remote peer
241 # Field 3: Refid of the clock (0.0.0.0 if unknown, WWWV/PPS/GPS/ACTS/USNO/PCS/... if Stratum1)
242 # Field 4: stratum (0-15)
243 # Field 5: Type of the peer: local (l), unicast (u), multicast (m)
244 # broadcast (b); not sure about multicast/broadcast
245 # Field 6: last packet receive (in seconds)
246 # Field 7: polling interval
247 # Field 8: reachability resgister (octal)
248 # Field 9: delay
249 # Field 10: offset
250 # Field 11: dispersion/jitter
251 #
253 if ($have_ntpq) {
255 if ( open(NTPQ,"$utils::PATH_TO_NTPQ -np $host 2>&1 |") ) {
256 while (<NTPQ>) {
257 print $_ if ($verbose);
258 if ( /timed out/ ){
259 $have_ntpq = 0 ;
260 last ;
261 }
262 # number of candidates on <host> for sys.peer
263 if (/^(\*|\+|\#|o])/) {
264 ++$candidates;
265 print "Candiate count= $candidates\n" if ($verbose);
266 }
268 # match sys.peer or pps.peer
269 if (/^(\*|o)([-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.]+)/) {
270 $syspeer = $2;
271 $stratum = $4;
272 $jitter = $11;
273 print "match $_ \n" if $verbose;
274 if ($jitter > $jcrit) {
275 print "Jitter_crit = $11 :$jcrit\n" if ($verbose);
276 $jitter_error = $ERRORS{'CRITICAL'};
277 } elsif ($jitter > $jwarn ) {
278 print "Jitter_warn = $11 :$jwarn \n" if ($verbose);
279 $jitter_error = $ERRORS{'WARNING'};
280 } else {
281 $jitter_error = $ERRORS{'OK'};
282 }
283 }
284 }
285 close NTPQ;
286 }
287 }
290 if ($ntpdate_error != $ERRORS{'OK'}) {
291 $state = $ntpdate_error;
292 if ($ntpdate_error == $ERRORS{'WARNING'} ) {
293 $answer = $msg . "\n";
294 }
295 else {
296 $answer = $msg . "Server for ntp probably down\n";
297 }
299 if (defined($offset) && abs($offset) > $ocrit) {
300 $state = $ERRORS{'CRITICAL'};
301 $answer = "Server Error and offset $offset msec > +/- $ocrit msec\n";
302 } elsif (defined($offset) && abs($offset) > $owarn) {
303 $answer = "Server error and offset $offset msec > +/- $owarn msec\n";
304 } elsif (defined($jitter) && abs($jitter) > $jcrit) {
305 $answer = "Server error and jitter $jitter msec > +/- $jcrit msec\n";
306 } elsif (defined($jitter) && abs($jitter) > $jwarn) {
307 $answer = "Server error and jitter $jitter msec > +/- $jwarn msec\n";
308 }
310 } elsif ($have_ntpq && $jitter_error != $ERRORS{'OK'}) {
311 $state = $jitter_error;
312 $answer = "Jitter $jitter too high\n";
313 if (defined($offset) && abs($offset) > $ocrit) {
314 $state = $ERRORS{'CRITICAL'};
315 $answer = "Jitter error and offset $offset sec > +/- $ocrit sec\n";
316 } elsif (defined($offset) && abs($offset) > $owarn) {
317 $answer = "Jitter error and offset $offset sec > +/- $owarn sec\n";
318 } elsif (defined($jitter) && abs($jitter) > $jcrit) {
319 $answer = "Jitter error and jitter $jitter msec > +/- $jcrit msec\n";
320 } elsif (defined($jitter) && abs($jitter) > $jwarn) {
321 $answer = "Jitter error and jitter $jitter msec > +/- $jwarn msec\n";
322 }
324 } elsif( !$have_ntpq ) { # no errors from ntpdate and no ntpq or ntpq timed out
325 if (abs($offset) > $ocrit) {
326 $state = $ERRORS{'CRITICAL'};
327 $answer = "Offset $offset msec > +/- $ocrit sec\n";
328 } elsif (abs($offset) > $owarn) {
329 $state = $ERRORS{'WARNING'};
330 $answer = "Offset $offset msec > +/- $owarn sec\n";
331 } elsif (( abs($offset) > $owarn) && $def_jitter ) {
332 $state = $ERRORS{'WARNING'};
333 $answer = "Offset $offset msec > +/- $owarn sec, ntpq timed out\n";
334 } elsif ( $def_jitter ) {
335 $state = $ERRORS{'WARNING'};
336 $answer = "Offset $offset secs, ntpq timed out\n";
337 } else{
338 $state = $ERRORS{'OK'};
339 $answer = "Offset $offset secs \n";
340 }
344 } else { # no errors from ntpdate or ntpq
345 if (abs($offset) > $ocrit) {
346 $state = $ERRORS{'CRITICAL'};
347 $answer = "Offset $offset msec > +/- $ocrit sec, jitter $jitter msec\n";
348 } elsif (abs($jitter) > $jcrit ) {
349 $state = $ERRORS{'CRITICAL'};
350 $answer = "Jitter $jitter msec> +/- $jcrit msec, offset $offset sec \n";
351 } elsif (abs($offset) > $owarn) {
352 $state = $ERRORS{'WARNING'};
353 $answer = "Offset $offset msec > +/- $owarn sec, jitter $jitter msec\n";
354 } elsif (abs($jitter) > $jwarn ) {
355 $state = $ERRORS{'WARNING'};
356 $answer = "Jitter $jitter msec> +/- $jwarn msec, offset $offset sec \n";
358 } else {
359 $state = $ERRORS{'OK'};
360 $answer = "Offset $offset secs, jitter $jitter msec, peer is stratum $stratum\n";
361 }
363 }
365 foreach my $key (keys %ERRORS) {
366 if ($state==$ERRORS{$key}) {
367 print ("NTP $key: $answer");
368 last;
369 }
370 }
371 exit $state;
374 ####
375 #### subs
377 sub print_usage () {
378 print "Usage: $PROGNAME -H <host> [-w <warn>] [-c <crit>] [-j <warn>] [-k <crit>] [-v verbose]\n";
379 }
381 sub print_help () {
382 print_revision($PROGNAME,'$Revision$');
383 print "Copyright (c) 2003 Bo Kersey/Karl DeBisschop\n";
384 print "\n";
385 print_usage();
386 print "
387 Checks the local timestamp offset versus <host> with ntpdate
388 Checks the jitter/dispersion of clock signal between <host> and its sys.peer with ntpq\n
389 -w ( --warning)
390 Clock offset in seconds at which a warning message will be generated.\n Defaults to $DEFAULT_OFFSET_WARN.
391 -c (--critical)
392 Clock offset in seconds at which a critical message will be generated.\n Defaults to $DEFAULT_OFFSET_CRIT.
393 -j (--jwarn)
394 Clock jitter in milliseconds at which a warning message will be generated.\n Defaults to $DEFAULT_JITTER_WARN.
395 -k (--jcrit)
396 Clock jitter in milliseconds at which a warning message will be generated.\n Defaults to $DEFAULT_JITTER_CRIT.\n
398 If jitter/dispersion is specified with -j or -k and ntpq times out, then a
399 warning is returned.
400 ";
401 support();
402 }