plugins-scripts/check_ntp.pl

   1 #!/usr/bin/perl -w
   2
   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
  59 require 5.004;
  60 use POSIX;
  61 use strict;
  62 use Getopt::Long;
  63 use vars qw($opt_V $opt_h $opt_H $opt_w $opt_c $opt_j $opt_k $verbose $PROGNAME);
  64 use lib utils.pm;
  65 use utils qw($TIMEOUT %ERRORS &print_revision &support);
  66
  67 $PROGNAME="check_ntp";
  68
  69 sub print_help ();
  70 sub print_usage ();
  71
  72 $ENV{'PATH'}='';
  73 $ENV{'BASH_ENV'}='';
  74 $ENV{'ENV'}='';
  75
  76 # defaults in sec
  77 my $DEFAULT_OFFSET_WARN =  60;  # 1 minute
  78 my $DEFAULT_OFFSET_CRIT = 120;  # 2 minutes
  79 # default in millisec
  80 my $DEFAULT_JITTER_WARN =   5000; # 5 sec
  81 my $DEFAULT_JITTER_CRIT =  10000; # 10 sec
  82
  83 Getopt::Long::Configure('bundling');
  84 GetOptions
  85         ("V"   => \$opt_V, "version"    => \$opt_V,
  86          "h"   => \$opt_h, "help"       => \$opt_h,
  87          "v" => \$verbose, "verbose"    => \$verbose,
  88          "w=f" => \$opt_w, "warning=f"  => \$opt_w,   # offset|adjust warning if above this number
  89          "c=f" => \$opt_c, "critical=f" => \$opt_c,   # offset|adjust critical if above this number
  90          "j=s" => \$opt_j, "jwarn=s"    => \$opt_j,   # jitter warning if above this number
  91          "k=s" => \$opt_k, "jcrit=s"    => \$opt_k,   # jitter critical if above this number
  92          "H=s" => \$opt_H, "hostname=s" => \$opt_H);
  93
  94 if ($opt_V) {
  95         print_revision($PROGNAME,'$Revision$ ');
  96         exit $ERRORS{'OK'};
  97 }
  98
  99 if ($opt_h) {
 100         print_help();
 101         exit $ERRORS{'OK'};
 102 }
 103
 104 $opt_H = shift unless ($opt_H);
 105 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]+)*)$/);
 106 unless ($host) {
 107         print "No target host specified\n";
 108         print_usage();
 109         exit $ERRORS{'UNKNOWN'};
 110 }
 111
 112 ($opt_w) || ($opt_w = $DEFAULT_OFFSET_WARN);
 113 my $owarn = $1 if ($opt_w =~ /([0-9.]+)/);
 114
 115 ($opt_c) || ($opt_c = $DEFAULT_OFFSET_CRIT);
 116 my $ocrit = $1 if ($opt_c =~ /([0-9.]+)/);
 117
 118 ($opt_j) || ($opt_j = $DEFAULT_JITTER_WARN);
 119 my $jwarn = $1 if ($opt_j =~ /([0-9]+)/);
 120
 121 ($opt_k) || ($opt_k = $DEFAULT_JITTER_CRIT);
 122 my $jcrit = $1 if ($opt_k =~ /([0-9]+)/);
 123
 124 if ($ocrit < $owarn ) {
 125         print "Critical offset should be larger than warning offset\n";
 126         print_usage();
 127         exit $ERRORS{"UNKNOWN"};
 128 }
 129 if ($opt_k < $opt_j) {
 130         print "Critical jitter should be larger than warning jitter\n";
 131         print_usage();
 132         exit $ERRORS{'UNKNOWN'};
 133 }
 134
 135 my $stratum = -1;
 136 my $ignoreret = 0;
 137 my $answer = undef;
 138 my $offset = undef;
 139 my $jitter = undef;
 140 my $syspeer = undef;
 141 my $candidates = 0;
 142 my $msg; # first line of output to print if format is invalid
 143
 144 my $state = $ERRORS{'UNKNOWN'};
 145 my $ntpdate_error = $ERRORS{'UNKNOWN'};
 146 my $jitter_error = $ERRORS{'UNKNOWN'};
 147
 148 # some systems don't have a proper ntpq  (migrated from ntpdc)
 149 my $have_ntpq = undef;
 150 if ($utils::PATH_TO_NTPQ && -x $utils::PATH_TO_NTPQ ) {
 151         $have_ntpq = 1;
 152 }else{
 153         $have_ntpq = 0;
 154 }
 155
 156 # Just in case of problems, let's not hang Nagios
 157 $SIG{'ALRM'} = sub {
 158         print ("ERROR: No response from ntp server (alarm)\n");
 159         exit $ERRORS{"UNKNOWN"};
 160 };
 161 alarm($TIMEOUT);
 162
 163
 164 ###
 165 ###
 166 ### First, check ntpdate
 167 ###
 168 ###
 169
 170 if (!open (NTPDATE, "$utils::PATH_TO_NTPDATE -q $host 2>&1 |")) {
 171         print "Could not open ntpdate\n";
 172         exit $ERRORS{"UNKNOWN"};
 173 }
 174
 175 while (<NTPDATE>) {
 176         print if ($verbose);
 177         $msg = $_ unless ($msg);
 178
 179         if (/stratum\s(\d+)/) {
 180                 $stratum = $1;
 181         }
 182
 183         if (/(offset|adjust)\s+([-.\d]+)/i) {
 184                 $offset = $2;
 185
 186                 # An offset of 0.000000 with an error is probably bogus. Actually,
 187                 # it's probably always bogus, but let's be paranoid here.
 188                 if ($offset == 0) { undef $offset;}
 189
 190                 $ntpdate_error = defined ($offset) ? $ERRORS{"OK"} : $ERRORS{"CRITICAL"};
 191                 print "ntperr = $ntpdate_error \n" if $verbose;
 192
 193         }
 194
 195         if (/no server suitable for synchronization found/) {
 196                 if ($stratum == 16) {
 197                         $ntpdate_error = $ERRORS{"WARNING"};
 198                         $msg = "Desynchronized peer server found";
 199                         $ignoreret=1;
 200                 }
 201                 else {
 202                         $ntpdate_error = $ERRORS{"CRITICAL"};
 203                         $msg = "No suitable peer server found - ";
 204                 }
 205         }
 206
 207 }
 208
 209 close (NTPDATE);
 210 # declare an error if we also get a non-zero return code from ntpdate
 211 # unless already set to critical
 212 if ( $? && !$ignoreret ) {
 213         print "stderr = $? : $! \n" if $verbose;
 214         $ntpdate_error = $ntpdate_error == $ERRORS{"CRITICAL"} ? $ERRORS{"CRITICAL"} : $ERRORS{"UNKNOWN"}  ;
 215         print "ntperr = $ntpdate_error : $!\n" if $verbose;
 216 }
 217
 218 ###
 219 ###
 220 ### Then scan xntpq/ntpq if it exists
 221 ### and look in the 11th column for jitter
 222 ###
 223 # Field 1: Tally Code ( Space, 'x','.','-','+','#','*','o')
 224 #           Only match for '*' which implies sys.peer
 225 #           or 'o' which implies pps.peer
 226 #           If both exist, the last one is picked.
 227 # Field 2: address of the remote peer
 228 # Field 3: Refid of the clock (0.0.0.0 if unknown)
 229 # Field 4: stratum (0-15)
 230 # Field 5: Type of the peer: local (l), unicast (u), multicast (m)
 231 #          broadcast (b); not sure about multicast/broadcast
 232 # Field 6: last packet receive (in seconds)
 233 # Field 7: polling interval
 234 # Field 8: reachability resgister (octal)
 235 # Field 9: delay
 236 # Field 10: offset
 237 # Field 11: dispersion/jitter
 238 #
 239
 240 if ($have_ntpq) {
 241
 242         if ( open(NTPQ,"$utils::PATH_TO_NTPQ -np $host 2>&1 |") ) {
 243                 while (<NTPQ>) {
 244                         print $_ if ($verbose);
 245                         # number of candidates on <host> for sys.peer
 246                         if (/^(\*|\+|\#|o])/) {
 247                                 ++$candidates;
 248                                 print "Candiate count= $candidates\n" if ($verbose);
 249                         }
 250
 251                         # match sys.peer or pps.peer
 252                         if (/^(\*|o)([-0-9.\s]+)\s+([-0-9.]+)\s+([-0-9.]+)\s+([lumb]+)\s+([-0-9.]+)\s+([-0-9.]+)\s+([-0-9.]+)\s+([-0-9.]+)\s+([-0-9.]+)\s+([-0-9.]+)/) {
 253                                 $syspeer = $2;
 254                                 $jitter = $11;
 255                                 print "match $_ \n" if $verbose;
 256                                 if ($jitter > $jcrit) {
 257                                         print "Jitter_crit = $11 :$jcrit\n" if ($verbose);
 258                                         $jitter_error = $ERRORS{'CRITICAL'};
 259                                 } elsif ($jitter > $jwarn ) {
 260                                         print "Jitter_warn = $11 :$jwarn \n" if ($verbose);
 261                                         $jitter_error = $ERRORS{'WARNING'};
 262                                 } else {
 263                                         $jitter_error = $ERRORS{'OK'};
 264                                 }
 265                         }
 266                 }
 267                 close NTPQ;
 268         }
 269 }
 270
 271
 272 if ($ntpdate_error != $ERRORS{'OK'}) {
 273         $state = $ntpdate_error;
 274         if ($ntpdate_error == $ERRORS{'WARNING'} ) {
 275                 $answer = $msg . "\n";
 276         }
 277         else {
 278                 $answer = $msg . "Server for ntp probably down\n";
 279         }
 280
 281         if (defined($offset) && abs($offset) > $ocrit) {
 282                 $state = $ERRORS{'CRITICAL'};
 283                 $answer = "Server Error and offset $offset msec > +/- $ocrit msec\n";
 284         } elsif (defined($offset) && abs($offset) > $owarn) {
 285                 $answer = "Server error and offset $offset msec > +/- $owarn msec\n";
 286         } elsif (defined($jitter) && abs($jitter) > $jcrit) {
 287                 $answer = "Server error and jitter $jitter msec > +/- $jcrit msec\n";
 288         } elsif (defined($jitter) && abs($jitter) > $jwarn) {
 289                 $answer = "Server error and jitter $jitter msec > +/- $jwarn msec\n";
 290         }
 291
 292 } elsif ($have_ntpq && $jitter_error != $ERRORS{'OK'}) {
 293         $state = $jitter_error;
 294         $answer = "Jitter $jitter too high\n";
 295         if (defined($offset) && abs($offset) > $ocrit) {
 296                 $state = $ERRORS{'CRITICAL'};
 297                 $answer = "Jitter error and offset $offset sec > +/- $ocrit sec\n";
 298         } elsif (defined($offset) && abs($offset) > $owarn) {
 299                 $answer = "Jitter error and offset $offset sec > +/- $owarn sec\n";
 300         } elsif (defined($jitter) && abs($jitter) > $jcrit) {
 301                 $answer = "Jitter error and jitter $jitter msec > +/- $jcrit msec\n";
 302         } elsif (defined($jitter) && abs($jitter) > $jwarn) {
 303                 $answer = "Jitter error and jitter $jitter msec > +/- $jwarn msec\n";
 304         }
 305
 306 } else { # no errors from ntpdate or ntpq
 307         if (abs($offset) > $ocrit) {
 308                 $state = $ERRORS{'CRITICAL'};
 309                 $answer = "Offset $offset msec > +/- $ocrit sec, jitter $jitter msec\n";
 310         } elsif (abs($jitter) > $jcrit ) {
 311                 $state = $ERRORS{'CRITICAL'};
 312                 $answer = "Jitter $jitter msec> +/- $jcrit msec, offset $offset sec \n";
 313         } elsif (abs($offset) > $owarn) {
 314                 $state = $ERRORS{'WARNING'};
 315                 $answer = "Offset $offset msec > +/- $owarn sec, jitter $jitter msec\n";
 316         } elsif (abs($jitter) > $jwarn ) {
 317                 $state = $ERRORS{'WARNING'};
 318                 $answer = "Jitter $jitter msec> +/- $jwarn msec, offset $offset sec \n";
 319
 320         } else {
 321                 $state = $ERRORS{'OK'};
 322                 $answer = "Offset $offset secs, jitter $jitter msec\n";
 323         }
 324
 325 #        else { # no offset defined
 326 #               $state = $ERRORS{'UNKNOWN'};
 327 #               $answer = "Invalid format returned from ntpdate ($msg)\n";
 328 #       }
 329
 330 }
 331
 332 foreach my $key (keys %ERRORS) {
 333         if ($state==$ERRORS{$key}) {
 334                 print ("$key: $answer");
 335                 last;
 336         }
 337 }
 338 exit $state;
 339
 340
 341 ####
 342 #### subs
 343
 344 sub print_usage () {
 345         print "Usage: $PROGNAME -H <host> [-w <warn>] [-c <crit>] [-j <warn>] [-k <crit>] [-v verbose]\n";
 346 }
 347
 348 sub print_help () {
 349         print_revision($PROGNAME,'$Revision$');
 350         print "Copyright (c) 2000 Bo Kersey/Karl DeBisschop\n";
 351         print "\n";
 352         print_usage();
 353         print "
 354 Checks the local timestamp offset versus <host> with ntpdate
 355 Checks the jitter/dispersion of clock signal between <host> and its sys.peer with ntpq\n
 356 -w ( --warning)
 357      Clock offset in seconds at which a warning message will be generated.\n    Defaults to $DEFAULT_OFFSET_WARN.
 358 -c (--critical)
 359      Clock offset in seconds at which a critical message will be generated.\n   Defaults to $DEFAULT_OFFSET_CRIT.
 360 -j (--jwarn)
 361      Clock jitter in milliseconds at which a warning message will be generated.\n       Defaults to $DEFAULT_JITTER_WARN.
 362 -k (--jcrit)
 363     Clock jitter in milliseconds at which a warning message will be generated.\n        Defaults to $DEFAULT_JITTER_CRIT.\n";
 364         support();
 365 }