Code

Add newline after "Usage:" in --help
[nagiosplug.git] / plugins / check_mrtg.c
index 80c9b00894bd2b0766aad18214a11ed5482bf64d..d6162f35dee7f2b4837ac43bee4664cabd985d37 100644 (file)
@@ -1,87 +1,38 @@
-/******************************************************************************
- *
- * Program: MRTG (Multi-Router Traffic Grapher) generic plugin for Nagios
- * License: GPL
- *
- * License Information:
- *
- * 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
- * (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$
- *
- *****************************************************************************/
-
-#define PROGNAME "check_mrtg"
-#define REVISION "$Revision$"
-#define COPYRIGHT "Copyright (c) 1999-2001 Ethan Galstad"
-
-#define SUMMARY "\
-This plugin will check either the average or maximum value of one of the\n\
-two variables recorded in an MRTG log file.\n"
-
-/* old command line: 
-        <log_file> <expire_minutes> <AVG|MAX> <variable> <vwl> <vcl> <label> [units] */
-#define OPTIONS "\
--F log_file -a <AVG | MAX> -v variable -w warning -c critical\n\
-            [-l label] [-u units] [-e expire_minutes] [-t timeout] [-v]"
-
-#define LONGOPTIONS "\
- -F, --logfile=FILE\n\
-   The MRTG log file containing the data you want to monitor\n\
- -e, --expires=MINUTES\n\
-   Minutes before MRTG data is considered to be too old\n\
- -a, --aggregation=AVG|MAX\n\
-   Should we check average or maximum values?\n\
- -v, --variable=INTEGER\n\
-   Which variable set should we inspect? 1 or 2?\n\
- -w, --warning=INTEGER\n\
-   Threshold value for data to result in WARNING status\n\
- -c, --critical=INTEGER\n\
-   Threshold value for data to result in CRITICAL status\n\
- -l, --label=STRING\n\
-   Type label for data (Examples: Conns, \"Processor Load\", In, Out)\n\
- -u, --units=STRING\n\
-   Option units label for data (Example: Packets/Sec, Errors/Sec, \n\
-   \"Bytes Per Second\", \"%% Utilization\")\n\
- -h, --help\n\
-   Print detailed help screen\n\
- -V, --version\n\
-   Print version information\n"
-
-#define DESCRIPTION "\
-If the value exceeds the <vwl> threshold, a WARNING status is returned.  If\n\
-the value exceeds the <vcl> threshold, a CRITICAL status is returned.  If\n\
-the data in the log file is older than <expire_minutes> old, a WARNING\n\
-status is returned and a warning message is printed.\n\
-\n\
-This plugin is useful for monitoring MRTG data that does not correspond to\n\
-bandwidth usage.  (Use the check_mrtgtraf plugin for monitoring bandwidth).\n\
-It can be used to monitor any kind of data that MRTG is monitoring - errors,\n\
-packets/sec, etc.  I use MRTG in conjuction with the Novell NLM that allows\n\
-me to track processor utilization, user connections, drive space, etc and\n\
-this plugin works well for monitoring that kind of data as well.\n\
-\n\
-Notes:\n\
-- This plugin only monitors one of the two variables stored in the MRTG log\n\
-  file.  If you want to monitor both values you will have to define two\n\
-  commands with different values for the <variable> argument.  Of course,\n\
-  you can always hack the code to make this plugin work for you...\n\
-- MRTG stands for the Multi Router Traffic Grapher.  It can be downloaded from\n\
-  http://ee-staff.ethz.ch/~oetiker/webtools/mrtg/mrtg.html\n"
-
-#include "config.h"
+/*****************************************************************************
+* 
+* Nagios check_mrtg plugin
+* 
+* License: GPL
+* Copyright (c) 1999-2007 Nagios Plugins Development Team
+* 
+* Description:
+* 
+* This file contains the check_mrtg plugin
+* 
+* This plugin will check either the average or maximum value of one of the
+* two variables recorded in an MRTG log file.
+* 
+* 
+* 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 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, see <http://www.gnu.org/licenses/>.
+* 
+* 
+*****************************************************************************/
+
+const char *progname = "check_mrtg";
+const char *copyright = "1999-2007";
+const char *email = "nagiosplug-devel@lists.sourceforge.net";
+
 #include "common.h"
 #include "utils.h"
 
@@ -96,8 +47,8 @@ int use_average = TRUE;
 int variable_number = -1;
 unsigned long value_warning_threshold = 0L;
 unsigned long value_critical_threshold = 0L;
-char *value_label = "";
-char *units_label = "";
+char *label;
+char *units;
 
 int
 main (int argc, char **argv)
@@ -108,19 +59,25 @@ main (int argc, char **argv)
        char input_buffer[MAX_INPUT_BUFFER];
        char *temp_buffer;
        time_t current_time;
-       char error_message[MAX_INPUT_BUFFER];
        time_t timestamp = 0L;
        unsigned long average_value_rate = 0L;
        unsigned long maximum_value_rate = 0L;
-       unsigned long value_rate = 0L;
+       unsigned long rate = 0L;
+
+       setlocale (LC_ALL, "");
+       bindtextdomain (PACKAGE, LOCALEDIR);
+       textdomain (PACKAGE);
+
+       /* Parse extra opts if any */
+       argv=np_extra_opts (&argc, argv, progname);
 
-       if (process_arguments (argc, argv) != OK)
-               usage ("Invalid command arguments supplied\n");
+       if (process_arguments (argc, argv) == ERROR)
+               usage4 (_("Could not parse arguments\n"));
 
        /* open the MRTG log file for reading */
        fp = fopen (log_file, "r");
        if (fp == NULL) {
-               printf ("Unable to open MRTG log file\n");
+               printf (_("Unable to open MRTG log file\n"));
                return STATE_UNKNOWN;
        }
 
@@ -167,56 +124,51 @@ main (int argc, char **argv)
 
        /* if we couldn't read enough data, return an unknown error */
        if (line <= 2) {
-               result = STATE_UNKNOWN;
-               sprintf (error_message, "Unable to process MRTG log file\n");
+               printf (_("Unable to process MRTG log file\n"));
+               return STATE_UNKNOWN;
        }
 
        /* make sure the MRTG data isn't too old */
-       if (result == STATE_OK) {
-               time (&current_time);
-               if (expire_minutes > 0
-                               && (current_time - timestamp) > (expire_minutes * 60)) {
-                       result = STATE_WARNING;
-                       sprintf (error_message, "MRTG data has expired (%d minutes old)\n",
-                                                        (int) ((current_time - timestamp) / 60));
-               }
+       time (&current_time);
+       if (expire_minutes > 0
+                       && (current_time - timestamp) > (expire_minutes * 60)) {
+               printf (_("MRTG data has expired (%d minutes old)\n"),
+                       (int) ((current_time - timestamp) / 60));
+               return STATE_WARNING;
        }
 
        /* else check the incoming/outgoing rates */
-       if (result == STATE_OK) {
-
-               if (use_average == TRUE)
-                       value_rate = average_value_rate;
-               else
-                       value_rate = maximum_value_rate;
-
-               if (value_rate > value_critical_threshold)
-                       result = STATE_CRITICAL;
-               else if (value_rate > value_warning_threshold)
-                       result = STATE_WARNING;
-       }
-
-       sprintf (error_message, "%s. %s = %lu %s",
-                                        (use_average == TRUE) ? "Ave" : "Max", value_label, value_rate,
-                                        units_label);
-       printf ("%s\n", error_message);
+       if (use_average == TRUE)
+               rate = average_value_rate;
+       else
+               rate = maximum_value_rate;
+
+       if (rate > value_critical_threshold)
+               result = STATE_CRITICAL;
+       else if (rate > value_warning_threshold)
+               result = STATE_WARNING;
+
+       printf("%s. %s = %lu %s|%s\n",
+              (use_average == TRUE) ? _("Avg") : _("Max"),
+              label, rate, units,
+              perfdata(label, (long) rate, units,
+                       (int) value_warning_threshold, (long) value_warning_threshold,
+                       (int) value_critical_threshold, (long) value_critical_threshold,
+                       0, 0, 0, 0));
 
        return result;
 }
 
 
 
-
-
 /* process command-line arguments */
 int
 process_arguments (int argc, char **argv)
 {
        int c;
 
-#ifdef HAVE_GETOPT_H
-       int option_index = 0;
-       static struct option long_options[] = {
+       int option = 0;
+       static struct option longopts[] = {
                {"logfile", required_argument, 0, 'F'},
                {"expires", required_argument, 0, 'e'},
                {"aggregation", required_argument, 0, 'a'},
@@ -225,12 +177,11 @@ process_arguments (int argc, char **argv)
                {"warning", required_argument, 0, 'w'},
                {"label", required_argument, 0, 'l'},
                {"units", required_argument, 0, 'u'},
-               {"verbose", no_argument, 0, 'v'},
+               {"variable", required_argument, 0, 'v'},
                {"version", no_argument, 0, 'V'},
                {"help", no_argument, 0, 'h'},
                {0, 0, 0, 0}
        };
-#endif
 
        if (argc < 2)
                return ERROR;
@@ -245,13 +196,8 @@ process_arguments (int argc, char **argv)
        }
 
        while (1) {
-#ifdef HAVE_GETOPT_H
-               c =
-                       getopt_long (argc, argv, "hVF:e:a:v:c:w:l:u:", long_options,
-                                                                        &option_index);
-#else
-               c = getopt (argc, argv, "hVF:e:a:v:c:w:l:u:");
-#endif
+               c = getopt_long (argc, argv, "hVF:e:a:v:c:w:l:u:", longopts,
+                                                                        &option);
 
                if (c == -1 || c == EOF)
                        break;
@@ -272,7 +218,7 @@ process_arguments (int argc, char **argv)
                case 'v':
                        variable_number = atoi (optarg);
                        if (variable_number < 1 || variable_number > 2)
-                               usage ("Invalid variable number\n");
+                               usage4 (_("Invalid variable number"));
                        break;
                case 'w':                                                                       /* critical time threshold */
                        value_warning_threshold = strtoul (optarg, NULL, 10);
@@ -281,19 +227,19 @@ process_arguments (int argc, char **argv)
                        value_critical_threshold = strtoul (optarg, NULL, 10);
                        break;
                case 'l':                                                                       /* label */
-                       value_label = optarg;
+                       label = optarg;
                        break;
                case 'u':                                                                       /* timeout */
-                       units_label = optarg;
+                       units = optarg;
                        break;
                case 'V':                                                                       /* version */
-                       print_revision (PROGNAME, REVISION);
+                       print_revision (progname, NP_VERSION);
                        exit (STATE_OK);
                case 'h':                                                                       /* help */
                        print_help ();
                        exit (STATE_OK);
                case '?':                                                                       /* help */
-                       usage ("Invalid argument\n");
+                       usage5 ();
                }
        }
 
@@ -306,9 +252,9 @@ process_arguments (int argc, char **argv)
                if (is_intpos (argv[c]))
                        expire_minutes = atoi (argv[c++]);
                else
-                       terminate (STATE_UNKNOWN,
-                                  "%s is not a valid expiration time\nUse '%s -h' for additional help\n",
-                                  argv[c], PROGNAME);
+                       die (STATE_UNKNOWN,
+                                  _("%s is not a valid expiration time\nUse '%s -h' for additional help\n"),
+                                  argv[c], progname);
        }
 
        if (argc > c && strcmp (argv[c], "MAX") == 0) {
@@ -324,7 +270,7 @@ process_arguments (int argc, char **argv)
                variable_number = atoi (argv[c++]);
                if (variable_number < 1 || variable_number > 2) {
                        printf ("%s :", argv[c]);
-                       usage ("Invalid variable number\n");
+                       usage (_("Invalid variable number\n"));
                }
        }
 
@@ -336,12 +282,12 @@ process_arguments (int argc, char **argv)
                value_critical_threshold = strtoul (argv[c++], NULL, 10);
        }
 
-       if (argc > c && strlen (value_label) == 0) {
-               value_label = argv[c++];
+       if (argc > c && strlen (label) == 0) {
+               label = argv[c++];
        }
 
-       if (argc > c && strlen (units_label) == 0) {
-               units_label = argv[c++];
+       if (argc > c && strlen (units) == 0) {
+               units = argv[c++];
        }
 
        return validate_arguments ();
@@ -351,31 +297,89 @@ int
 validate_arguments (void)
 {
        if (variable_number == -1)
-               usage ("You must supply the variable number\n");
+               usage4 (_("You must supply the variable number"));
+
+       if (label == NULL)
+               label = strdup ("value");
+
+       if (units == NULL)
+               units = strdup ("");
 
        return OK;
 }
 
+
+
 void
 print_help (void)
 {
-       print_revision (PROGNAME, REVISION);
-       printf ("%s\n\n%s\n", COPYRIGHT, SUMMARY);
+       print_revision (progname, NP_VERSION);
+
+       printf ("Copyright (c) 1999 Ethan Galstad <nagios@nagios.org>\n");
+       printf (COPYRIGHT, copyright, email);
+
+       printf ("%s\n", _("This plugin will check either the average or maximum value of one of the"));
+  printf ("%s\n", _("two variables recorded in an MRTG log file."));
+
+  printf ("\n\n");
+
        print_usage ();
-       printf ("\nOptions:\n" LONGOPTIONS "\n" DESCRIPTION "\n");
-       support ();
+
+       printf (UT_HELP_VRSN);
+       printf (UT_EXTRA_OPTS);
+
+       printf (" %s\n", "-F, --logfile=FILE");
+  printf ("   %s\n", _("The MRTG log file containing the data you want to monitor"));
+  printf (" %s\n", "-e, --expires=MINUTES");
+  printf ("   %s\n", _("Minutes before MRTG data is considered to be too old"));
+  printf (" %s\n", "-a, --aggregation=AVG|MAX");
+  printf ("   %s\n", _("Should we check average or maximum values?"));
+  printf (" %s\n", "-v, --variable=INTEGER");
+  printf ("   %s\n", _("Which variable set should we inspect? (1 or 2)"));
+  printf (" %s\n", "-w, --warning=INTEGER");
+  printf ("   %s\n", _("Threshold value for data to result in WARNING status"));
+  printf (" %s\n", "-c, --critical=INTEGER");
+  printf ("   %s\n", _("Threshold value for data to result in CRITICAL status"));
+       printf (" %s\n", "-l, --label=STRING");
+  printf ("   %s\n", _("Type label for data (Examples: Conns, \"Processor Load\", In, Out)"));
+  printf (" %s\n", "-u, --units=STRING");
+  printf ("   %s\n", _("Option units label for data (Example: Packets/Sec, Errors/Sec,"));
+  printf ("   %s\n", _("\"Bytes Per Second\", \"%% Utilization\")"));
+
+  printf ("\n");
+       printf (" %s\n", _("If the value exceeds the <vwl> threshold, a WARNING status is returned. If"));
+  printf (" %s\n", _("the value exceeds the <vcl> threshold, a CRITICAL status is returned.  If"));
+  printf (" %s\n", _("the data in the log file is older than <expire_minutes> old, a WARNING"));
+  printf (" %s\n", _("status is returned and a warning message is printed."));
+
+  printf ("\n");
+       printf (" %s\n", _("This plugin is useful for monitoring MRTG data that does not correspond to"));
+  printf (" %s\n", _("bandwidth usage.  (Use the check_mrtgtraf plugin for monitoring bandwidth)."));
+  printf (" %s\n", _("It can be used to monitor any kind of data that MRTG is monitoring - errors,"));
+  printf (" %s\n", _("packets/sec, etc.  I use MRTG in conjuction with the Novell NLM that allows"));
+  printf (" %s\n", _("me to track processor utilization, user connections, drive space, etc and"));
+  printf (" %s\n\n", _("this plugin works well for monitoring that kind of data as well."));
+
+       printf ("%s\n", _("Notes:"));
+  printf (" %s\n", _("- This plugin only monitors one of the two variables stored in the MRTG log"));
+  printf ("   %s\n", _("file.  If you want to monitor both values you will have to define two"));
+  printf ("   %s\n", _("commands with different values for the <variable> argument.  Of course,"));
+  printf ("   %s\n", _("you can always hack the code to make this plugin work for you..."));
+  printf (" %s\n", _("- MRTG stands for the Multi Router Traffic Grapher.  It can be downloaded from"));
+  printf ("   %s\n", "http://ee-staff.ethz.ch/~oetiker/webtools/mrtg/mrtg.html");
+
+       printf (UT_SUPPORT);
 }
 
+
+
+/* original command line:
+        <log_file> <expire_minutes> <AVG|MAX> <variable> <vwl> <vcl> <label> [units] */
+
 void
 print_usage (void)
 {
-       printf ("Usage:\n" " %s %s\n"
-#ifdef HAVE_GETOPT_H
-                                       " %s (-h | --help) for detailed help\n"
-                                       " %s (-V | --version) for version information\n",
-#else
-                                       " %s -h for detailed help\n"
-                                       " %s -V for version information\n",
-#endif
-                                       PROGNAME, OPTIONS, PROGNAME, PROGNAME);
+  printf ("%s\n", _("Usage:"));
+       printf ("%s -F log_file -a <AVG | MAX> -v variable -w warning -c critical\n",progname);
+  printf ("[-l label] [-u units] [-e expire_minutes] [-t timeout] [-v]\n");
 }