Code

Fixed help output (Christian Mies)
[nagiosplug.git] / plugins / check_ntp.c
index 013c24bbbc9574d193695c75e48b4bdf124e75e1..86e3d0985bf4f2ee57fbf020844dfa150d8a060a 100644 (file)
@@ -4,7 +4,7 @@
 *
 * License: GPL
 * Copyright (c) 2006 sean finney <seanius@seanius.net>
-* Copyright (c) 2006 nagios-plugins team
+* Copyright (c) 2007 nagios-plugins team
 *
 * Last Modified: $Date$
 *
@@ -38,7 +38,7 @@
 
 const char *progname = "check_ntp";
 const char *revision = "$Revision$";
-const char *copyright = "2006";
+const char *copyright = "2007";
 const char *email = "nagiosplug-devel@lists.sourceforge.net";
 
 #include "common.h"
@@ -47,13 +47,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);
 
@@ -86,6 +89,7 @@ typedef struct {
        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 */
@@ -138,8 +142,8 @@ typedef struct {
 #define OP_SET(x,y)   do{ x |= (y&OP_MASK); }while(0)
 #define OP_READSTAT 0x01
 #define OP_READVAR  0x02
-/* In peer status bytes, bytes 6,7,8 determine clock selection status */
-#define PEER_SEL(x) (x&0x07)
+/* In peer status bytes, bits 6,7,8 determine clock selection status */
+#define PEER_SEL(x) ((ntohs(x)>>8)&0x07)
 #define PEER_INCLUDED 0x04
 #define PEER_SYNCSOURCE 0x06
 
@@ -302,6 +306,12 @@ int best_offset_server(const ntp_server_results *slist, int nservers){
 
        /* for each server */
        for(cserver=0; cserver<nservers; cserver++){
+               /* sort out servers with error flags */
+               if ( LI(slist[cserver].flags) != LI_NOWARNING ){
+                       if (verbose) printf("discarding peer id %d: flags=%d\n", cserver, LI(slist[cserver].flags));
+                       break;
+               }
+
                /* 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? */
@@ -450,6 +460,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 +476,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++){
@@ -475,7 +486,10 @@ double offset_request(const char *host, int *status){
        }
 
        /* cleanup */
-       for(j=0; j<num_hosts; j++){ close(socklist[j]); }
+       /* FIXME: Not closing the socket to avoid re-use of the local port
+        * which can cause old NTP packets to be read instead of NTP control
+        * pactets in jitter_request(). THERE MUST BE ANOTHER WAY...
+        * for(j=0; j<num_hosts; j++){ close(socklist[j]); } */
        free(socklist);
        free(ufds);
        free(servers);
@@ -501,11 +515,13 @@ setup_control_request(ntp_control_message *p, uint8_t opcode, uint16_t seq){
 double jitter_request(const char *host, int *status){
        int conn=-1, i, npeers=0, num_candidates=0, syncsource_found=0;
        int run=0, min_peer_sel=PEER_INCLUDED, num_selected=0, num_valid=0;
-       int peer_offset=0;
+       int peers_size=0, peer_offset=0;
        ntp_assoc_status_pair *peers=NULL;
        ntp_control_message req;
+       const char *getvar = "jitter";
        double rval = 0.0, jitter = -1.0;
        char *startofvalue=NULL, *nptr=NULL;
+       void *tmp;
 
        /* Long-winded explanation:
         * Getting the jitter requires a number of steps:
@@ -538,9 +554,12 @@ double jitter_request(const char *host, int *status){
                /* Each peer identifier is 4 bytes in the data section, which
                 * we represent as a ntp_assoc_status_pair datatype.
                 */
-               npeers+=(ntohs(req.count)/sizeof(ntp_assoc_status_pair));
-               peers=(ntp_assoc_status_pair*)realloc(peers, sizeof(ntp_assoc_status_pair)*npeers);
-               memcpy((void*)((ptrdiff_t)peers+peer_offset), (void*)req.data, sizeof(ntp_assoc_status_pair)*npeers);
+               peers_size+=ntohs(req.count);
+               if((tmp=realloc(peers, peers_size)) == NULL)
+                       free(peers), die(STATE_UNKNOWN, "can not (re)allocate 'peers' buffer\n");
+               peers=tmp;
+               memcpy((void*)((ptrdiff_t)peers+peer_offset), (void*)req.data, ntohs(req.count));
+               npeers=peers_size/sizeof(ntp_assoc_status_pair);
                peer_offset+=ntohs(req.count);
        } while(req.op&REM_MORE);
 
@@ -558,7 +577,10 @@ 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;
+       if(! syncsource_found){
+               *status = STATE_UNKNOWN;
+               if(verbose) printf("warning: no synchronization source found\n");
+       }
 
 
        for (run=0; run<AVG_NUM; run++){
@@ -574,8 +596,10 @@ double jitter_request(const char *host, int *status){
                                 * thus reducing net traffic, guaranteeing us only a single
                                 * datagram in reply, and making intepretation much simpler
                                 */
-                               strncpy(req.data, "jitter", 6);
-                               req.count = htons(6);
+                               /* Older servers doesn't know what jitter is, so if we get an
+                                * error on the first pass we redo it with "dispersion" */
+                               strncpy(req.data, getvar, MAX_CM_SIZE-1);
+                               req.count = htons(strlen(getvar));
                                DBG(printf("sending READVAR request...\n"));
                                write(conn, &req, SIZEOF_NTPCM(req));
                                DBG(print_ntp_control_message(&req));
@@ -585,17 +609,26 @@ double jitter_request(const char *host, int *status){
                                read(conn, &req, SIZEOF_NTPCM(req));
                                DBG(print_ntp_control_message(&req));
 
+                               if(req.op&REM_ERROR && strstr(getvar, "jitter")) {
+                                       if(verbose) printf("The 'jitter' command failed (old ntp server?)\nRestarting with 'dispersion'...\n");
+                                       getvar = "dispersion";
+                                       num_selected--;
+                                       i--;
+                                       continue;
+                               }
+
                                /* get to the float value */
                                if(verbose) {
-                                       printf("parsing jitter from peer %.2x: ", peers[i].assoc);
+                                       printf("parsing jitter from peer %.2x: ", ntohs(peers[i].assoc));
                                }
-                               startofvalue = strchr(req.data, '=') + 1;
+                               startofvalue = strchr(req.data, '=');
                                if(startofvalue != NULL) {
+                                       startofvalue++;
                                        jitter = strtod(startofvalue, &nptr);
                                }
                                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++;
@@ -608,10 +641,10 @@ double jitter_request(const char *host, int *status){
                }
        }
 
-       rval /= num_valid;
+       rval = num_valid ? rval / num_valid : -1.0;
 
        close(conn);
-       free(peers);
+       if(peers!=NULL) free(peers);
        /* If we return -1.0, it means no synchronization source was found */
        return rval;
 }
@@ -656,18 +689,20 @@ int process_arguments(int argc, char **argv){
                        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)
@@ -694,14 +729,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"));
        }
@@ -709,15 +736,39 @@ int process_arguments(int argc, char **argv){
        return 0;
 }
 
+char *perfd_offset (double offset)
+{
+       return fperfdata ("offset", offset, "s",
+               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, jitter_thresholds->warning->end,
+               do_jitter, jitter_thresholds->critical->end,
+               TRUE, 0, FALSE, 0);
+}
+
 int main(int argc, char *argv[]){
        int result, offset_result, jitter_result;
        double offset=0, jitter=0;
+       char *result_line, *perfdata_line;
+
+       setlocale (LC_ALL, "");
+       bindtextdomain (PACKAGE, LOCALEDIR);
+       textdomain (PACKAGE);
 
-       result=offset_result=jitter_result=STATE_UNKNOWN;
+       result = offset_result = jitter_result = STATE_OK;
 
        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);
 
@@ -725,14 +776,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
@@ -741,42 +791,40 @@ 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 :
-                       printf("NTP CRITICAL: ");
+                       asprintf(&result_line, _("NTP CRITICAL:"));
                        break;
                case STATE_WARNING :
-                       printf("NTP WARNING: ");
+                       asprintf(&result_line, _("NTP WARNING:"));
                        break;
                case STATE_OK :
-                       printf("NTP OK: ");
+                       asprintf(&result_line, _("NTP OK:"));
                        break;
                default :
-                       printf("NTP UNKNOWN: ");
+                       asprintf(&result_line, _("NTP UNKNOWN:"));
                        break;
        }
-       if(offset_result==STATE_CRITICAL){
-               printf("Offset unknown|offset=unknown");
+       if(offset_result == STATE_UNKNOWN){
+               asprintf(&result_line, "%s %s", result_line, _("Offset unknown"));
+               asprintf(&perfdata_line, "");
        } else {
-               if(offset_result==STATE_WARNING){
-                       printf("Unable to fully sample sync server. ");
-               }
-               printf("Offset %.10g secs|offset=%.10g", offset, offset);
+               asprintf(&result_line, "%s %s %.10g secs", result_line, _("Offset"), offset);
+               asprintf(&perfdata_line, "%s", perfd_offset(offset));
        }
-       if (do_jitter) printf(" jitter=%f", jitter);
-       printf("\n");
+       if (do_jitter) {
+               asprintf(&result_line, "%s, jitter=%f", result_line, jitter);
+               asprintf(&perfdata_line, "%s %s", perfdata_line,  perfd_jitter(jitter));
+       }
+       printf("%s|%s\n", result_line, perfdata_line);
 
        if(server_address!=NULL) free(server_address);
        return result;
@@ -797,13 +845,31 @@ void print_help(void){
        print_usage();
        printf (_(UT_HELP_VRSN));
        printf (_(UT_HOST_PORT), 'p', "123");
-       printf (_(UT_WARN_CRIT));
-       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 (" %s\n", "-w, --warning=THRESHOLD");
+       printf ("    %s\n", _("Offset to result in warning status (seconds)"));
+       printf (" %s\n", "-c, --critical=THRESHOLD");
+       printf ("    %s\n", _("Offset to result in critical status (seconds)"));
+       printf (" %s\n", "-j, --warning=THRESHOLD");
+       printf ("    %s\n", _("Warning threshold for jitter"));
+       printf (" %s\n", "-k, --critical=THRESHOLD");
+       printf ("    %s\n", _("Critical threshold for jitter"));
        printf (_(UT_TIMEOUT), DEFAULT_SOCKET_TIMEOUT);
        printf (_(UT_VERBOSE));
+
+       printf("\n");
+       printf("%s\n", _("Notes:"));
+       printf(" %s\n", _("See:"));
+       printf(" %s\n", ("http://nagiosplug.sourceforge.net/developer-guidelines.html#THRESHOLDFORMAT"));
+       printf(" %s\n", _("for THRESHOLD format and examples."));
+
+       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(" %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));
 }
 
@@ -811,5 +877,5 @@ void
 print_usage(void)
 {
   printf (_("Usage:"));
-  printf("%s -H <host> [-w <warn>] [-c <crit>] [-j <warn>] [-k <crit>] [-v verbose]\n", progname);
+  printf(" %s -H <host> [-w <warn>] [-c <crit>] [-j <warn>] [-k <crit>] [-v verbose]\n", progname);
 }