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