Code

Standardize the extra-opts notes
[nagiosplug.git] / plugins / check_ntp.c
index a884c15ea9b486311708171147bec4eab8cb9592..e752bd9ff8852dbdff12b09b3a3077e988c3e8ba 100644 (file)
@@ -1,44 +1,37 @@
-/******************************************************************************
-*
+/*****************************************************************************
+* 
 * Nagios check_ntp plugin
-*
+* 
 * License: GPL
-* Copyright (c) 2006 sean finney <seanius@seanius.net>
-* Copyright (c) 2006 nagios-plugins team
-*
-* Last Modified: $Date$
-*
+* Copyright (c) 2006 Sean Finney <seanius@seanius.net>
+* Copyright (c) 2006-2008 Nagios Plugins Development Team
+* 
 * Description:
-*
+* 
 * This file contains the check_ntp plugin
-*
-*  This plugin to check ntp servers independant of any commandline
-*  programs or external libraries.
-*
-*
-* License Information:
-*
-* This program is free software; you can redistribute it and/or modify
+* 
+* This plugin to check ntp servers independant of any commandline
+* programs or external libraries.
+* 
+* 
+* This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
-* the Free Software Foundation; either version 2 of the License, or
+* the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
-*
+* 
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
-*
+* 
 * You should have received a copy of the GNU General Public License
-* along with this program; if not, write to the Free Software
-* Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
-
- $Id$
+* along with this program.  If not, see <http://www.gnu.org/licenses/>.
+* 
+* 
 *****************************************************************************/
 
 const char *progname = "check_ntp";
-const char *revision = "$Revision$";
-const char *copyright = "2006";
+const char *copyright = "2006-2008";
 const char *email = "nagiosplug-devel@lists.sourceforge.net";
 
 #include "common.h"
@@ -47,13 +40,16 @@ const char *email = "nagiosplug-devel@lists.sourceforge.net";
 
 static char *server_address=NULL;
 static int verbose=0;
-static double owarn=60;
-static double ocrit=120;
+static short do_offset=0;
+static char *owarn="60";
+static char *ocrit="120";
 static short do_jitter=0;
-static double jwarn=5000;
-static double jcrit=10000;
+static char *jwarn="5000";
+static char *jcrit="10000";
 
 int process_arguments (int, char **);
+thresholds *offset_thresholds = NULL;
+thresholds *jitter_thresholds = NULL;
 void print_help (void);
 void print_usage (void);
 
@@ -80,12 +76,13 @@ typedef struct {
 
 /* this structure holds data about results from querying offset from a peer */
 typedef struct {
-       time_t waiting;         /* ts set when we started waiting for a response */ 
+       time_t waiting;         /* ts set when we started waiting for a response */
        int num_responses;      /* number of successfully recieved responses */
        uint8_t stratum;        /* copied verbatim from the ntp_message */
        double rtdelay;         /* converted from the ntp_message */
        double rtdisp;          /* converted from the ntp_message */
        double offset[AVG_NUM]; /* offsets from each response */
+       uint8_t flags;       /* byte with leapindicator,vers,mode. see macros */
 } ntp_server_results;
 
 /* this structure holds everything in an ntp control message as per rfc1305 */
@@ -149,7 +146,7 @@ typedef struct {
  they are divided into halves, each being a 16-bit int in network byte order:
  - the first 16 bits are an int on the left side of a decimal point.
  - the second 16 bits represent a fraction n/(2^16)
- likewise for the 64-bit "fixed point" numbers with everything doubled :) 
+ likewise for the 64-bit "fixed point" numbers with everything doubled :)
  **/
 
 /* macros to access the left/right 16 bits of a 32-bit ntp "fixed point"
@@ -197,7 +194,7 @@ typedef struct {
 /* NTP control message header is 12 bytes, plus any data in the data
  * field, plus null padding to the nearest 32-bit boundary per rfc.
  */
-#define SIZEOF_NTPCM(m) (12+ntohs(m.count)+((m.count)?4-(ntohs(m.count)%4):0))
+#define SIZEOF_NTPCM(m) (12+ntohs(m.count)+((ntohs(m.count)%4)?4-(ntohs(m.count)%4):0))
 
 /* finally, a little helper or two for debugging: */
 #define DBG(x) do{if(verbose>1){ x; }}while(0);
@@ -264,7 +261,7 @@ void print_ntp_control_message(const ntp_control_message *p){
        if(p->op&REM_RESP && p->op&OP_READSTAT){
                peer=(ntp_assoc_status_pair*)p->data;
                for(i=0;i<numpeers;i++){
-                       printf("\tpeer id %.2x status %.2x", 
+                       printf("\tpeer id %.2x status %.2x",
                               ntohs(peer[i].assoc), ntohs(peer[i].status));
                        if (PEER_SEL(peer[i].status) >= PEER_INCLUDED){
                                if(PEER_SEL(peer[i].status) >= PEER_SYNCSOURCE){
@@ -298,44 +295,52 @@ void setup_request(ntp_message *p){
  * this is done by filtering servers based on stratum, dispersion, and
  * finally round-trip delay. */
 int best_offset_server(const ntp_server_results *slist, int nservers){
-       int i=0, j=0, cserver=0, candidates[5], csize=0;
+       int i=0, cserver=0, best_server=-1;
 
        /* for each server */
        for(cserver=0; cserver<nservers; cserver++){
-               /* compare it to each of the servers already in the candidate list */
-               for(i=0; i<csize; i++){
-                       /* does it have an equal or better stratum? */
-                       if(slist[cserver].stratum <= slist[i].stratum){
-                               /* does it have an equal or better dispersion? */
-                               if(slist[cserver].rtdisp <= slist[i].rtdisp){
-                                       /* does it have a better rtdelay? */
-                                       if(slist[cserver].rtdelay < slist[i].rtdelay){
-                                               break;
-                                       }
-                               }
-                       }
+               /* We don't want any servers that fails these tests */
+               /* Sort out servers that didn't respond or responede with a 0 stratum;
+                * stratum 0 is for reference clocks so no NTP server should ever report
+                * a stratum 0 */
+               if ( slist[cserver].stratum == 0){
+                       if (verbose) printf("discarding peer %d: stratum=%d\n", cserver, slist[cserver].stratum);
+                       continue;
+               }
+               /* Sort out servers with error flags */
+               if ( LI(slist[cserver].flags) == LI_ALARM ){
+                       if (verbose) printf("discarding peer %d: flags=%d\n", cserver, LI(slist[cserver].flags));
+                       continue;
                }
 
-               /* if we haven't reached the current list's end, move everyone
-                * over one to the right, and insert the new candidate */
-               if(i<csize){
-                       for(j=5; j>i; j--){
-                               candidates[j]=candidates[j-1];
-                       }
+               /* If we don't have a server yet, use the first one */
+               if (best_server == -1) {
+                       best_server = cserver;
+                       DBG(printf("using peer %d as our first candidate\n", best_server));
+                       continue;
                }
-               /* regardless, if they should be on the list... */
-               if(i<5) {
-                       candidates[i]=cserver;
-                       if(csize<5) csize++;
-               /* otherwise discard the server */
-               } else {
-                       DBG(printf("discarding peer id %d\n", cserver));
+
+               /* compare the server to the best one we've seen so far */
+               /* does it have an equal or better stratum? */
+               DBG(printf("comparing peer %d with peer %d\n", cserver, best_server));
+               if(slist[cserver].stratum <= slist[best_server].stratum){
+                       DBG(printf("stratum for peer %d <= peer %d\n", cserver, best_server));
+                       /* does it have an equal or better dispersion? */
+                       if(slist[cserver].rtdisp <= slist[best_server].rtdisp){
+                               DBG(printf("dispersion for peer %d <= peer %d\n", cserver, best_server));
+                               /* does it have a better rtdelay? */
+                               if(slist[cserver].rtdelay < slist[best_server].rtdelay){
+                                       DBG(printf("rtdelay for peer %d < peer %d\n", cserver, best_server));
+                                       best_server = cserver;
+                                       DBG(printf("peer %d is now our best candidate\n", best_server));
+                               }
+                       }
                }
        }
 
-       if(csize>0) {
-               DBG(printf("best server selected: peer %d\n", candidates[0]));
-               return candidates[0];
+       if(best_server >= 0) {
+               DBG(printf("best server selected: peer %d\n", best_server));
+               return best_server;
        } else {
                DBG(printf("no peers meeting synchronization criteria :(\n"));
                return -1;
@@ -344,7 +349,7 @@ int best_offset_server(const ntp_server_results *slist, int nservers){
 
 /* do everything we need to get the total average offset
  * - we use a certain amount of parallelization with poll() to ensure
- *   we don't waste time sitting around waiting for single packets. 
+ *   we don't waste time sitting around waiting for single packets.
  * - we also "manually" handle resolving host names and connecting, because
  *   we have to do it in a way that our lazy macros don't handle currently :( */
 double offset_request(const char *host, int *status){
@@ -382,6 +387,7 @@ double offset_request(const char *host, int *status){
        servers=(ntp_server_results*)malloc(sizeof(ntp_server_results)*num_hosts);
        if(servers==NULL) die(STATE_UNKNOWN, "can not allocate server array");
        memset(servers, 0, sizeof(ntp_server_results)*num_hosts);
+       DBG(printf("Found %d peers to check\n", num_hosts));
 
        /* setup each socket for writing, and the corresponding struct pollfd */
        ai_tmp=ai;
@@ -450,6 +456,7 @@ double offset_request(const char *host, int *status){
                                servers[i].rtdisp=NTP32asDOUBLE(req[i].rtdisp);
                                servers[i].rtdelay=NTP32asDOUBLE(req[i].rtdelay);
                                servers[i].waiting=0;
+                               servers[i].flags=req[i].flags;
                                servers_readable--;
                                one_read = 1;
                                if(servers[i].num_responses==AVG_NUM) servers_completed++;
@@ -465,7 +472,7 @@ double offset_request(const char *host, int *status){
        /* now, pick the best server from the list */
        best_index=best_offset_server(servers, num_hosts);
        if(best_index < 0){
-               *status=STATE_CRITICAL;
+               *status=STATE_UNKNOWN;
        } else {
                /* finally, calculate the average offset */
                for(i=0; i<servers[best_index].num_responses;i++){
@@ -567,7 +574,7 @@ double jitter_request(const char *host, int *status){
        if(verbose) printf("%d candiate peers available\n", num_candidates);
        if(verbose && syncsource_found) printf("synchronization source found\n");
        if(! syncsource_found){
-               *status = STATE_WARNING;
+               *status = STATE_UNKNOWN;
                if(verbose) printf("warning: no synchronization source found\n");
        }
 
@@ -617,7 +624,7 @@ double jitter_request(const char *host, int *status){
                                }
                                if(startofvalue == NULL || startofvalue==nptr){
                                        printf("warning: unable to read server jitter response.\n");
-                                       *status = STATE_WARNING;
+                                       *status = STATE_UNKNOWN;
                                } else {
                                        if(verbose) printf("%g\n", jitter);
                                        num_valid++;
@@ -656,7 +663,7 @@ int process_arguments(int argc, char **argv){
                {0, 0, 0, 0}
        };
 
-       
+
        if (argc < 2)
                usage ("\n");
 
@@ -671,25 +678,27 @@ int process_arguments(int argc, char **argv){
                        exit(STATE_OK);
                        break;
                case 'V':
-                       print_revision(progname, revision);
+                       print_revision(progname, NP_VERSION);
                        exit(STATE_OK);
                        break;
                case 'v':
                        verbose++;
                        break;
                case 'w':
-                       owarn = atof(optarg);
+                       do_offset=1;
+                       owarn = optarg;
                        break;
                case 'c':
-                       ocrit = atof(optarg);
+                       do_offset=1;
+                       ocrit = optarg;
                        break;
                case 'j':
                        do_jitter=1;
-                       jwarn = atof(optarg);
+                       jwarn = optarg;
                        break;
                case 'k':
                        do_jitter=1;
-                       jcrit = atof(optarg);
+                       jcrit = optarg;
                        break;
                case 'H':
                        if(is_host(optarg) == FALSE)
@@ -716,14 +725,6 @@ int process_arguments(int argc, char **argv){
                }
        }
 
-       if (ocrit < owarn){
-               usage4(_("Critical offset should be larger than warning offset"));
-       }
-
-       if (ocrit < owarn){
-               usage4(_("Critical jitter should be larger than warning jitter"));
-       }
-
        if(server_address == NULL){
                usage4(_("Hostname was not supplied"));
        }
@@ -734,16 +735,16 @@ int process_arguments(int argc, char **argv){
 char *perfd_offset (double offset)
 {
        return fperfdata ("offset", offset, "s",
-               TRUE, owarn,
-               TRUE, ocrit,
+               TRUE, offset_thresholds->warning->end,
+               TRUE, offset_thresholds->critical->end,
                FALSE, 0, FALSE, 0);
 }
 
 char *perfd_jitter (double jitter)
 {
        return fperfdata ("jitter", jitter, "s",
-               do_jitter, jwarn,
-               do_jitter, jcrit,
+               do_jitter, jitter_thresholds->warning->end,
+               do_jitter, jitter_thresholds->critical->end,
                TRUE, 0, FALSE, 0);
 }
 
@@ -752,11 +753,21 @@ int main(int argc, char *argv[]){
        double offset=0, jitter=0;
        char *result_line, *perfdata_line;
 
-       result=offset_result=jitter_result=STATE_UNKNOWN;
+       setlocale (LC_ALL, "");
+       bindtextdomain (PACKAGE, LOCALEDIR);
+       textdomain (PACKAGE);
+
+       result = offset_result = jitter_result = STATE_OK;
+
+       /* Parse extra opts if any */
+       argv=np_extra_opts (&argc, argv, progname);
 
        if (process_arguments (argc, argv) == ERROR)
                usage4 (_("Could not parse arguments"));
 
+       set_thresholds(&offset_thresholds, owarn, ocrit);
+       set_thresholds(&jitter_thresholds, jwarn, jcrit);
+
        /* initialize alarm signal handling */
        signal (SIGALRM, socket_timeout_alarm_handler);
 
@@ -764,14 +775,13 @@ int main(int argc, char *argv[]){
        alarm (socket_timeout);
 
        offset = offset_request(server_address, &offset_result);
-       if(fabs(offset) > ocrit){
+       /* check_ntp used to always return CRITICAL if offset_result == STATE_UNKNOWN.
+        * Now we'll only do that is the offset thresholds were set */
+       if (do_offset && offset_result == STATE_UNKNOWN) {
                result = STATE_CRITICAL;
-       } else if(fabs(offset) > owarn) {
-               result = STATE_WARNING;
        } else {
-               result = STATE_OK;
+               result = get_status(fabs(offset), offset_thresholds);
        }
-       result=max_state(result, offset_result);
 
        /* If not told to check the jitter, we don't even send packets.
         * jitter is checked using NTP control packets, which not all
@@ -780,39 +790,33 @@ int main(int argc, char *argv[]){
         */
        if(do_jitter){
                jitter=jitter_request(server_address, &jitter_result);
-               if(jitter > jcrit){
-                       result = max_state(result, STATE_CRITICAL);
-               } else if(jitter > jwarn) {
-                       result = max_state(result, STATE_WARNING);
-               } else if(jitter == -1.0 && result == STATE_OK){
-                       /* -1 indicates that we couldn't calculate the jitter
-                        * Only overrides STATE_OK from the offset */
+               result = max_state_alt(result, get_status(jitter, jitter_thresholds));
+               /* -1 indicates that we couldn't calculate the jitter
+                * Only overrides STATE_OK from the offset */
+               if(jitter == -1.0 && result == STATE_OK)
                        result = STATE_UNKNOWN;
-               }
        }
-       result=max_state(result, jitter_result);
+       result = max_state_alt(result, jitter_result);
 
        switch (result) {
                case STATE_CRITICAL :
-                       asprintf(&result_line, "NTP CRITICAL:");
+                       asprintf(&result_line, _("NTP CRITICAL:"));
                        break;
                case STATE_WARNING :
-                       asprintf(&result_line, "NTP WARNING:");
+                       asprintf(&result_line, _("NTP WARNING:"));
                        break;
                case STATE_OK :
-                       asprintf(&result_line, "NTP OK:");
+                       asprintf(&result_line, _("NTP OK:"));
                        break;
                default :
-                       asprintf(&result_line, "NTP UNKNOWN:");
+                       asprintf(&result_line, _("NTP UNKNOWN:"));
                        break;
        }
-       if(offset_result==STATE_CRITICAL){
+       if(offset_result == STATE_UNKNOWN){
                asprintf(&result_line, "%s %s", result_line, _("Offset unknown"));
+               asprintf(&perfdata_line, "");
        } else {
-               if(offset_result==STATE_WARNING){
-                       asprintf(&result_line, "%s %s", result_line, _("Unable to fully sample sync server"));
-               }
-               asprintf(&result_line, "%s Offset %.10g secs", result_line, offset);
+               asprintf(&result_line, "%s %s %.10g secs", result_line, _("Offset"), offset);
                asprintf(&perfdata_line, "%s", perfd_offset(offset));
        }
        if (do_jitter) {
@@ -828,34 +832,54 @@ int main(int argc, char *argv[]){
 
 
 void print_help(void){
-       print_revision(progname, revision);
+       print_revision(progname, NP_VERSION);
 
        printf ("Copyright (c) 2006 Sean Finney\n");
        printf (COPYRIGHT, copyright, email);
-  
-  printf ("%s\n", _("This plugin checks the selected ntp server"));
 
-  printf ("\n\n");
-  
+       printf ("%s\n", _("This plugin checks the selected ntp server"));
+
+       printf ("\n\n");
+
        print_usage();
-       printf (_(UT_HELP_VRSN));
-       printf (_(UT_HOST_PORT), 'p', "123");
-       printf (" %s\n", "-w, --warning=DOUBLE");
+       printf (UT_HELP_VRSN);
+       printf (UT_EXTRA_OPTS);
+       printf (UT_HOST_PORT, 'p', "123");
+       printf (" %s\n", "-w, --warning=THRESHOLD");
        printf ("    %s\n", _("Offset to result in warning status (seconds)"));
-       printf (" %s\n", "-c, --critical=DOUBLE");
+       printf (" %s\n", "-c, --critical=THRESHOLD");
        printf ("    %s\n", _("Offset to result in critical status (seconds)"));
-       printf (" %s\n", "-j, --warning=DOUBLE");
-       printf ("    %s\n", _("Warning value for jitter"));
-       printf (" %s\n", "-k, --critical=DOUBLE");
-       printf ("    %s\n", _("Critical value for jitter"));
-       printf (_(UT_TIMEOUT), DEFAULT_SOCKET_TIMEOUT);
-       printf (_(UT_VERBOSE));
-       printf (_(UT_SUPPORT));
+       printf (" %s\n", "-j, --jwarn=THRESHOLD");
+       printf ("    %s\n", _("Warning threshold for jitter"));
+       printf (" %s\n", "-k, --jcrit=THRESHOLD");
+       printf ("    %s\n", _("Critical threshold for jitter"));
+       printf (UT_TIMEOUT, DEFAULT_SOCKET_TIMEOUT);
+       printf (UT_VERBOSE);
+
+       printf("\n");
+       printf("%s\n", _("Notes:"));
+       printf(UT_THRESHOLDS_NOTES);
+
+       printf("\n");
+       printf("%s\n", _("Examples:"));
+       printf(" %s\n", _("Normal offset check:"));
+       printf("  %s\n", ("./check_ntp -H ntpserv -w 0.5 -c 1"));
+       printf("\n");
+       printf(" %s\n", _("Check jitter too, avoiding critical notifications if jitter isn't available"));
+       printf(" %s\n", _("(See Notes above for more details on thresholds formats):"));
+       printf("  %s\n", ("./check_ntp -H ntpserv -w 0.5 -c 1 -j -1:100 -k -1:200"));
+
+       printf (UT_SUPPORT);
+
+       printf ("%s\n", _("WARNING: check_ntp is deprecated. Please use check_ntp_peer or"));
+       printf ("%s\n\n", _("check_ntp_time instead."));
 }
 
 void
 print_usage(void)
 {
-  printf (_("Usage:"));
-  printf("%s -H <host> [-w <warn>] [-c <crit>] [-j <warn>] [-k <crit>] [-v verbose]\n", progname);
+       printf ("%s\n", _("WARNING: check_ntp is deprecated. Please use check_ntp_peer or"));
+       printf ("%s\n\n", _("check_ntp_time instead."));
+       printf (_("Usage:"));
+       printf(" %s -H <host> [-w <warn>] [-c <crit>] [-j <warn>] [-k <crit>] [-v verbose]\n", progname);
 }