Code

Fix for regex input of '|', being output causing problems with Nagios' parsing of
[nagiosplug.git] / plugins / check_procs.c
index 31a2bed922d130527ec6abaec8bd90e04b918f85..d875a618f3eb259644928f39b4299a650467aa13 100644 (file)
@@ -1,48 +1,45 @@
-/******************************************************************************
-*
+/*****************************************************************************
+* 
 * Nagios check_procs plugin
-*
+* 
 * License: GPL
-* Copyright (c) 1999-2006 nagios-plugins team
-*
-* Last Modified: $Date$
-*
+* Copyright (c) 2000-2008 Nagios Plugins Development Team
+* 
 * Description:
-*
+* 
 * This file contains the check_procs plugin
-*
-*  Checks all processes and generates WARNING or CRITICAL states if the specified
-*  metric is outside the required threshold ranges. The metric defaults to number
-*  of processes.  Search filters can be applied to limit the processes to check.
-*
-* License Information:
-*
-* This program is free software; you can redistribute it and/or modify
+* 
+* Checks all processes and generates WARNING or CRITICAL states if the
+* specified metric is outside the required threshold ranges. The metric
+* defaults to number of processes.  Search filters can be applied to limit
+* the processes to check.
+* 
+* 
+* 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_procs";
-const char *revision = "$Revision$";
-const char *copyright = "2000-2006";
+const char *program_name = "check_procs";  /* Required for coreutils libs */
+const char *copyright = "2000-2008";
 const char *email = "nagiosplug-devel@lists.sourceforge.net";
 
 #include "common.h"
-#include "popen.h"
 #include "utils.h"
+#include "utils_cmd.h"
+#include "regex.h"
 
 #include <pwd.h>
 
@@ -69,6 +66,7 @@ int options = 0; /* bitmask of filter criteria to test against */
 #define RSS  128
 #define PCPU 256
 #define ELAPSED 512
+#define EREG_ARGS 1024
 /* Different metrics */
 char *metric_name;
 enum metric {
@@ -89,10 +87,13 @@ float pcpu;
 char *statopts;
 char *prog;
 char *args;
+char *input_filename = NULL;
+regex_t re_args;
 char *fmt;
 char *fails;
 char tmp[MAX_INPUT_BUFFER];
 
+FILE *ps_input = NULL;
 
 
 int
@@ -124,8 +125,9 @@ main (int argc, char **argv)
        int expected_cols = PS_COLS - 1;
        int warn = 0; /* number of processes in warn state */
        int crit = 0; /* number of processes in crit state */
-       int i = 0;
+       int i = 0, j = 0;
        int result = STATE_UNKNOWN;
+       output chld_out, chld_err;
 
        setlocale (LC_ALL, "");
        bindtextdomain (PACKAGE, LOCALEDIR);
@@ -138,6 +140,9 @@ main (int argc, char **argv)
        asprintf (&metric_name, "PROCS");
        metric = METRIC_PROCS;
 
+       /* Parse extra opts if any */
+       argv=np_extra_opts (&argc, argv, progname);
+
        if (process_arguments (argc, argv) == ERROR)
                usage4 (_("Could not parse arguments"));
 
@@ -145,35 +150,27 @@ main (int argc, char **argv)
        mypid = getpid();
 
        /* Set signal handling and alarm timeout */
-       if (signal (SIGALRM, popen_timeout_alarm_handler) == SIG_ERR) {
-               usage4 (_("Cannot catch SIGALRM"));
+       if (signal (SIGALRM, timeout_alarm_handler) == SIG_ERR) {
+               die (STATE_UNKNOWN, _("Cannot catch SIGALRM"));
        }
-       alarm (timeout_interval);
+       (void) alarm ((unsigned) timeout_interval);
 
        if (verbose >= 2)
                printf (_("CMD: %s\n"), PS_COMMAND);
 
-       child_process = spopen (PS_COMMAND);
-       if (child_process == NULL) {
-               printf (_("Could not open pipe: %s\n"), PS_COMMAND);
-               return STATE_UNKNOWN;
+       if (input_filename == NULL) {
+               result = cmd_run( PS_COMMAND, &chld_out, &chld_err, 0);
+               if (chld_err.lines > 0) {
+                       printf ("%s: %s", _("System call sent warnings to stderr"), chld_err.line[0]);
+                       exit(STATE_WARNING);
+               }
+       } else {
+               result = cmd_file_read( input_filename, &chld_out, 0);
        }
 
-       child_stderr = fdopen (child_stderr_array[fileno (child_process)], "r");
-       if (child_stderr == NULL)
-               printf (_("Could not open stderr for %s\n"), PS_COMMAND);
-
-       /* flush first line */
-       fgets (input_buffer, MAX_INPUT_BUFFER - 1, child_process);
-       while ( input_buffer[strlen(input_buffer)-1] != '\n' )
-               fgets (input_buffer, MAX_INPUT_BUFFER - 1, child_process);
-
-       while (fgets (input_buffer, MAX_INPUT_BUFFER - 1, child_process)) {
-               asprintf (&input_line, "%s", input_buffer);
-               while ( input_buffer[strlen(input_buffer)-1] != '\n' ) {
-                       fgets (input_buffer, MAX_INPUT_BUFFER - 1, child_process);
-                       asprintf (&input_line, "%s%s", input_line, input_buffer);
-               }
+       /* flush first line: j starts at 1 */
+       for (j = 1; j < chld_out.lines; j++) {
+               input_line = chld_out.line[j];
 
                if (verbose >= 3)
                        printf ("%s", input_line);
@@ -184,7 +181,7 @@ main (int argc, char **argv)
                cols = sscanf (input_line, PS_FORMAT, PS_VARLIST);
 
                /* Zombie processes do not give a procprog command */
-               if ( cols == (expected_cols - 1) && strstr(procstat, zombie) ) {
+               if ( cols < expected_cols && strstr(procstat, zombie) ) {
                        cols = expected_cols;
                }
                if ( cols >= expected_cols ) {
@@ -193,13 +190,13 @@ main (int argc, char **argv)
                        strip (procargs);
 
                        /* Some ps return full pathname for command. This removes path */
-                       procprog = base_name(procprog);
+                       strcpy(procprog, base_name(procprog));
 
                        /* we need to convert the elapsed time to seconds */
                        procseconds = convert_to_seconds(procetime);
 
                        if (verbose >= 3)
-                               printf ("%d %d %d %d %d %d %.2f %s %s %s %s\n", 
+                               printf ("proc#=%d uid=%d vsz=%d rss=%d pid=%d ppid=%d pcpu=%.2f stat=%s etime=%s prog=%s args=%s\n", 
                                        procs, procuid, procvsz, procrss,
                                        procpid, procppid, procpcpu, procstat, 
                                        procetime, procprog, procargs);
@@ -211,6 +208,8 @@ main (int argc, char **argv)
                                resultsum |= STAT;
                        if ((options & ARGS) && procargs && (strstr (procargs, args) != NULL))
                                resultsum |= ARGS;
+                       if ((options & EREG_ARGS) && procargs && (regexec(&re_args, procargs, (size_t) 0, NULL, 0) == 0))
+                               resultsum |= EREG_ARGS;
                        if ((options & PROG) && procprog && (strcmp (prog, procprog) == 0))
                                resultsum |= PROG;
                        if ((options & PPID) && (procppid == ppid))
@@ -231,6 +230,12 @@ main (int argc, char **argv)
                                continue;
 
                        procs++;
+                       if (verbose >= 2) {
+                               printf ("Matched: uid=%d vsz=%d rss=%d pid=%d ppid=%d pcpu=%.2f stat=%s etime=%s prog=%s args=%s\n", 
+                                       procuid, procvsz, procrss,
+                                       procpid, procppid, procpcpu, procstat, 
+                                       procetime, procprog, procargs);
+                       }
 
                        if (metric == METRIC_VSZ)
                                i = check_thresholds (procvsz);
@@ -261,25 +266,9 @@ main (int argc, char **argv)
                }
        }
 
-       /* If we get anything on STDERR, at least set warning */
-       while (fgets (input_buffer, MAX_INPUT_BUFFER - 1, child_stderr)) {
-               if (verbose)
-                       printf ("STDERR: %s", input_buffer);
-               result = max_state (result, STATE_WARNING);
-               printf (_("System call sent warnings to stderr\n"));
-       }
-       
-       (void) fclose (child_stderr);
-
-       /* close the pipe */
-       if (spclose (child_process)) {
-               printf (_("System call returned nonzero status\n"));
-               result = max_state (result, STATE_WARNING);
-       }
-
        if (found == 0) {                                                       /* no process lines parsed so return STATE_UNKNOWN */
                printf (_("Unable to read output\n"));
-               return result;
+               return STATE_UNKNOWN;
        }
 
        if ( result == STATE_UNKNOWN ) 
@@ -326,6 +315,11 @@ process_arguments (int argc, char **argv)
        char *user;
        struct passwd *pw;
        int option = 0;
+       int err;
+       int cflags = REG_NOSUB | REG_EXTENDED;
+       char errbuf[MAX_INPUT_BUFFER];
+       char *temp_string;
+       int i=0;
        static struct option longopts[] = {
                {"warning", required_argument, 0, 'w'},
                {"critical", required_argument, 0, 'c'},
@@ -342,6 +336,8 @@ process_arguments (int argc, char **argv)
                {"help", no_argument, 0, 'h'},
                {"version", no_argument, 0, 'V'},
                {"verbose", no_argument, 0, 'v'},
+               {"ereg-argument-array", required_argument, 0, CHAR_MAX+1},
+               {"input-file", required_argument, 0, CHAR_MAX+2},
                {0, 0, 0, 0}
        };
 
@@ -358,12 +354,12 @@ process_arguments (int argc, char **argv)
 
                switch (c) {
                case '?':                                                                       /* help */
-                       usage2 (_("Unknown argument"), optarg);
+                       usage5 ();
                case 'h':                                                                       /* help */
                        print_help ();
                        exit (STATE_OK);
                case 'V':                                                                       /* version */
-                       print_revision (progname, revision);
+                       print_revision (progname, NP_VERSION);
                        exit (STATE_OK);
                case 't':                                                                       /* timeout period */
                        if (!is_integer (optarg))
@@ -416,13 +412,13 @@ process_arguments (int argc, char **argv)
                                pw = getpwuid ((uid_t) uid);
                                /*  check to be sure user exists */
                                if (pw == NULL)
-                                       usage2 (_("UID %s was not found"), optarg);
+                                       usage2 (_("UID was not found"), optarg);
                        }
                        else {
                                pw = getpwnam (optarg);
                                /*  check to be sure user exists */
                                if (pw == NULL)
-                                       usage2 (_("User name %s was not found"), optarg);
+                                       usage2 (_("User name was not found"), optarg);
                                /*  then get uid */
                                uid = pw->pw_uid;
                        }
@@ -450,6 +446,22 @@ process_arguments (int argc, char **argv)
                        asprintf (&fmt, "%s%sargs '%s'", (fmt ? fmt : ""), (options ? ", " : ""), args);
                        options |= ARGS;
                        break;
+               case CHAR_MAX+1:
+                       err = regcomp(&re_args, optarg, cflags);
+                       if (err != 0) {
+                               regerror (err, &re_args, errbuf, MAX_INPUT_BUFFER);
+                               die (STATE_UNKNOWN, "PROCS %s: %s - %s\n", _("UNKNOWN"), _("Could not compile regular expression"), errbuf);
+                       }
+                       /* Strip off any | within the regex optarg */
+                       temp_string = strdup(optarg);
+                       while(temp_string[i]!='\0'){
+                               if(temp_string[i]=='|')
+                                       temp_string[i]=',';
+                               i++;
+                       }
+                       asprintf (&fmt, "%s%sregex args '%s'", (fmt ? fmt : ""), (options ? ", " : ""), temp_string);
+                       options |= EREG_ARGS;
+                       break;
                case 'r':                                       /* RSS */
                        if (sscanf (optarg, "%d%[^0-9]", &rss, tmp) == 1) {
                                asprintf (&fmt, "%s%sRSS >= %d", (fmt ? fmt : ""), (options ? ", " : ""), rss);
@@ -499,6 +511,9 @@ process_arguments (int argc, char **argv)
                case 'v':                                                                       /* command */
                        verbose++;
                        break;
+               case CHAR_MAX+2:
+                       input_filename = optarg;
+                       break;
                }
        }
 
@@ -664,9 +679,9 @@ convert_to_seconds(char *etime) {
 void
 print_help (void)
 {
-       print_revision (progname, revision);
+       print_revision (progname, NP_VERSION);
 
-       printf ("Copyright (c) 1999 Ethan Galstad <nagios@nagios.org>");
+       printf ("Copyright (c) 1999 Ethan Galstad <nagios@nagios.org>\n");
        printf (COPYRIGHT, copyright, email);
 
        printf ("%s\n", _("Checks all processes and generates WARNING or CRITICAL states if the specified"));
@@ -674,57 +689,52 @@ print_help (void)
   printf ("%s\n", _("of processes.  Search filters can be applied to limit the processes to check."));
 
   printf ("\n\n");
-  
-       print_usage ();
 
-       printf(_("\n\
-Required Arguments:\n\
- -w, --warning=RANGE\n\
-   Generate warning state if metric is outside this range\n\
- -c, --critical=RANGE\n\
-   Generate critical state if metric is outside this range\n"));
+       print_usage ();
 
-       printf(_("\n\
-Optional Arguments:\n\
- -m, --metric=TYPE\n\
-   Check thresholds against metric. Valid types:\n\
-   PROCS   - number of processes (default)\n\
-   VSZ     - virtual memory size\n\
-   RSS     - resident set memory size\n\
-   CPU     - percentage cpu\n"));
+  printf (UT_HELP_VRSN);
+  printf (UT_EXTRA_OPTS);
+  printf (" %s\n", "-w, --warning=RANGE");
+  printf ("   %s\n", _("Generate warning state if metric is outside this range"));
+  printf (" %s\n", "-c, --critical=RANGE");
+  printf ("   %s\n", _("Generate critical state if metric is outside this range"));
+  printf (" %s\n", "-m, --metric=TYPE");
+  printf ("  %s\n", _("Check thresholds against metric. Valid types:"));
+  printf ("  %s\n", _("PROCS   - number of processes (default)"));
+  printf ("  %s\n", _("VSZ     - virtual memory size"));
+  printf ("  %s\n", _("RSS     - resident set memory size"));
+  printf ("  %s\n", _("CPU     - percentage CPU"));
 /* only linux etime is support currently */
 #if defined( __linux__ )
-       printf(_("\
-   ELAPSED - time elapsed in seconds\n"));
+       printf ("  %s\n", _("ELAPSED - time elapsed in seconds"));
 #endif /* defined(__linux__) */
-       printf (_(UT_TIMEOUT), DEFAULT_SOCKET_TIMEOUT);
-
-       printf(_("\
- -v, --verbose\n\
-   Extra information. Up to 3 verbosity levels\n"));
-
-       printf(_("\n\
-Optional Filters:\n\
- -s, --state=STATUSFLAGS\n\
-   Only scan for processes that have, in the output of `ps`, one or\n\
-   more of the status flags you specify (for example R, Z, S, RS,\n\
-   RSZDT, plus others based on the output of your 'ps' command).\n\
- -p, --ppid=PPID\n\
-   Only scan for children of the parent process ID indicated.\n\
- -z, --vsz=VSZ\n\
-   Only scan for processes with vsz higher than indicated.\n\
- -r, --rss=RSS\n\
-   Only scan for processes with rss higher than indicated.\n"));
-
-       printf(_("\
- -P, --pcpu=PCPU\n\
-   Only scan for processes with pcpu higher than indicated.\n\
- -u, --user=USER\n\
-   Only scan for processes with user name or ID indicated.\n\
- -a, --argument-array=STRING\n\
-   Only scan for processes with args that contain STRING.\n\
- -C, --command=COMMAND\n\
-   Only scan for exact matches of COMMAND (without path).\n"));
+       printf (UT_TIMEOUT, DEFAULT_SOCKET_TIMEOUT);
+
+       printf (" %s\n", "-v, --verbose");
+  printf ("    %s\n", _("Extra information. Up to 3 verbosity levels"));
+
+  printf ("\n");
+       printf ("%s\n", "Filters:");
+  printf (" %s\n", "-s, --state=STATUSFLAGS");
+  printf ("   %s\n", _("Only scan for processes that have, in the output of `ps`, one or"));
+  printf ("   %s\n", _("more of the status flags you specify (for example R, Z, S, RS,"));
+  printf ("   %s\n", _("RSZDT, plus others based on the output of your 'ps' command)."));
+  printf (" %s\n", "-p, --ppid=PPID");
+  printf ("   %s\n", _("Only scan for children of the parent process ID indicated."));
+  printf (" %s\n", "-z, --vsz=VSZ");
+  printf ("   %s\n", _("Only scan for processes with VSZ higher than indicated."));
+  printf (" %s\n", "-r, --rss=RSS");
+  printf ("   %s\n", _("Only scan for processes with RSS higher than indicated."));
+       printf (" %s\n", "-P, --pcpu=PCPU");
+  printf ("   %s\n", _("Only scan for processes with PCPU higher than indicated."));
+  printf (" %s\n", "-u, --user=USER");
+  printf ("   %s\n", _("Only scan for processes with user name or ID indicated."));
+  printf (" %s\n", "-a, --argument-array=STRING");
+  printf ("   %s\n", _("Only scan for processes with args that contain STRING."));
+  printf (" %s\n", "--ereg-argument-array=STRING");
+  printf ("   %s\n", _("Only scan for processes with args that contain the regex STRING."));
+  printf (" %s\n", "-C, --command=COMMAND");
+  printf ("   %s\n", _("Only scan for exact matches of COMMAND (without path)."));
 
        printf(_("\n\
 RANGEs are specified 'min:max' or 'min:' or ':max' (or 'max'). If\n\
@@ -738,26 +748,25 @@ the specified threshold ranges. The process count can be filtered by\n\
 process owner, parent process PID, current state (e.g., 'Z'), or may\n\
 be the total number of running processes\n\n"));
 
-       printf(_("\
-Examples:\n\
- check_procs -w 2:2 -c 2:1024 -C portsentry\n\
-   Warning if not two processes with command name portsentry. Critical\n\
-   if < 2 or > 1024 processes\n\n\
- check_procs -w 10 -a '/usr/local/bin/perl' -u root\n\
-   Warning alert if > 10 processes with command arguments containing \n\
-   '/usr/local/bin/perl' and owned by root\n\n\
- check_procs -w 50000 -c 100000 --metric=VSZ\n\
-   Alert if vsz of any processes over 50K or 100K\n\
- check_procs -w 10 -c 20 --metric=CPU\n\
-   Alert if cpu of any processes over 10%% or 20%%\n\n"));
-
-       printf (_(UT_SUPPORT));
+       printf ("%s\n", _("Examples:"));
+  printf (" %s\n", "check_procs -w 2:2 -c 2:1024 -C portsentry");
+  printf ("  %s\n", _("Warning if not two processes with command name portsentry."));
+  printf ("  %s\n\n", _("Critical if < 2 or > 1024 processes"));
+  printf (" %s\n", "check_procs -w 10 -a '/usr/local/bin/perl' -u root");
+  printf ("  %s\n", _("Warning alert if > 10 processes with command arguments containing"));
+  printf ("  %s\n\n", _("'/usr/local/bin/perl' and owned by root"));
+  printf (" %s\n", "check_procs -w 50000 -c 100000 --metric=VSZ");
+  printf ("  %s\n\n", _("Alert if VSZ of any processes over 50K or 100K"));
+  printf (" %s\n", "check_procs -w 10 -c 20 --metric=CPU");
+  printf ("  %s\n", _("Alert if CPU of any processes over 10%% or 20%%"));
+
+       printf (UT_SUPPORT);
 }
 
 void
 print_usage (void)
 {
-  printf (_("Usage:"));
+  printf ("%s\n", _("Usage:"));
        printf ("%s -w <range> -c <range> [-m metric] [-s state] [-p ppid]\n", progname);
   printf (" [-u user] [-r rss] [-z vsz] [-P %%cpu] [-a argument-array]\n");
   printf (" [-C command] [-t timeout] [-v]\n");