plugins/check_mysql.c

   1 /*****************************************************************************
   2 *
   3 * Nagios check_mysql plugin
   4 *
   5 * License: GPL
   6 * Copyright (c) 1999 Didi Rieder (adrieder@sbox.tu-graz.ac.at)
   7 * Copyright (c) 2000 Karl DeBisschop (kdebisschop@users.sourceforge.net)
   8 * Copyright (c) 1999-2009 Nagios Plugins Development Team
   9 *
  10 * Description:
  11 *
  12 * This file contains the check_mysql plugin
  13 *
  14 * This program tests connections to a mysql server
  15 *
  16 *
  17 * This program is free software: you can redistribute it and/or modify
  18 * it under the terms of the GNU General Public License as published by
  19 * the Free Software Foundation, either version 3 of the License, or
  20 * (at your option) any later version.
  21 *
  22 * This program is distributed in the hope that it will be useful,
  23 * but WITHOUT ANY WARRANTY; without even the implied warranty of
  24 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  25 * GNU General Public License for more details.
  26 *
  27 * You should have received a copy of the GNU General Public License
  28 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  29 *
  30 *
  31 *****************************************************************************/
  32
  33 const char *progname = "check_mysql";
  34 const char *copyright = "1999-2007";
  35 const char *email = "nagiosplug-devel@lists.sourceforge.net";
  36
  37 #define SLAVERESULTSIZE 70
  38
  39 #include "common.h"
  40 #include "utils.h"
  41 #include "utils_base.h"
  42 #include "netutils.h"
  43
  44 #include <mysql.h>
  45 #include <errmsg.h>
  46
  47 char *db_user = NULL;
  48 char *db_host = NULL;
  49 char *db_socket = NULL;
  50 char *db_pass = NULL;
  51 char *db = NULL;
  52 unsigned int db_port = MYSQL_PORT;
  53 int check_slave = 0, warn_sec = 0, crit_sec = 0;
  54 int verbose = 0;
  55
  56 thresholds *my_threshold = NULL;
  57
  58 int process_arguments (int, char **);
  59 int validate_arguments (void);
  60 void print_help (void);
  61 void print_usage (void);
  62
  63 int
  64 main (int argc, char **argv)
  65 {
  66
  67         MYSQL mysql;
  68         MYSQL_RES *res;
  69         MYSQL_ROW row;
  70
  71         /* should be status */
  72
  73         char *result = NULL;
  74         char *error = NULL;
  75         char slaveresult[SLAVERESULTSIZE];
  76
  77         setlocale (LC_ALL, "");
  78         bindtextdomain (PACKAGE, LOCALEDIR);
  79         textdomain (PACKAGE);
  80
  81         /* Parse extra opts if any */
  82         argv=np_extra_opts (&argc, argv, progname);
  83
  84         if (process_arguments (argc, argv) == ERROR)
  85                 usage4 (_("Could not parse arguments"));
  86
  87         /* initialize mysql  */
  88         mysql_init (&mysql);
  89
  90         mysql_options(&mysql,MYSQL_READ_DEFAULT_GROUP,"client");
  91
  92         /* establish a connection to the server and error checking */
  93         if (!mysql_real_connect(&mysql,db_host,db_user,db_pass,db,db_port,db_socket,0)) {
  94                 if (mysql_errno (&mysql) == CR_UNKNOWN_HOST)
  95                         die (STATE_WARNING, "%s\n", mysql_error (&mysql));
  96                 else if (mysql_errno (&mysql) == CR_VERSION_ERROR)
  97                         die (STATE_WARNING, "%s\n", mysql_error (&mysql));
  98                 else if (mysql_errno (&mysql) == CR_OUT_OF_MEMORY)
  99                         die (STATE_WARNING, "%s\n", mysql_error (&mysql));
 100                 else if (mysql_errno (&mysql) == CR_IPSOCK_ERROR)
 101                         die (STATE_WARNING, "%s\n", mysql_error (&mysql));
 102                 else if (mysql_errno (&mysql) == CR_SOCKET_CREATE_ERROR)
 103                         die (STATE_WARNING, "%s\n", mysql_error (&mysql));
 104                 else
 105                         die (STATE_CRITICAL, "%s\n", mysql_error (&mysql));
 106         }
 107
 108         /* get the server stats */
 109         result = strdup (mysql_stat (&mysql));
 110
 111         /* error checking once more */
 112         if (mysql_error (&mysql)) {
 113                 if (mysql_errno (&mysql) == CR_SERVER_GONE_ERROR)
 114                         die (STATE_CRITICAL, "%s\n", mysql_error (&mysql));
 115                 else if (mysql_errno (&mysql) == CR_SERVER_LOST)
 116                         die (STATE_CRITICAL, "%s\n", mysql_error (&mysql));
 117                 else if (mysql_errno (&mysql) == CR_UNKNOWN_ERROR)
 118                         die (STATE_CRITICAL, "%s\n", mysql_error (&mysql));
 119         }
 120
 121         if(check_slave) {
 122                 /* check the slave status */
 123                 if (mysql_query (&mysql, "show slave status") != 0) {
 124                         error = strdup(mysql_error(&mysql));
 125                         mysql_close (&mysql);
 126                         die (STATE_CRITICAL, _("slave query error: %s\n"), error);
 127                 }
 128
 129                 /* store the result */
 130                 if ( (res = mysql_store_result (&mysql)) == NULL) {
 131                         error = strdup(mysql_error(&mysql));
 132                         mysql_close (&mysql);
 133                         die (STATE_CRITICAL, _("slave store_result error: %s\n"), error);
 134                 }
 135
 136                 /* Check there is some data */
 137                 if (mysql_num_rows(res) == 0) {
 138                         mysql_close(&mysql);
 139                         die (STATE_WARNING, "%s\n", _("No slaves defined"));
 140                 }
 141
 142                 /* fetch the first row */
 143                 if ( (row = mysql_fetch_row (res)) == NULL) {
 144                         error = strdup(mysql_error(&mysql));
 145                         mysql_free_result (res);
 146                         mysql_close (&mysql);
 147                         die (STATE_CRITICAL, _("slave fetch row error: %s\n"), error);
 148                 }
 149
 150                 if (mysql_field_count (&mysql) == 12) {
 151                         /* mysql 3.23.x */
 152                         snprintf (slaveresult, SLAVERESULTSIZE, _("Slave running: %s"), row[6]);
 153                         if (strcmp (row[6], "Yes") != 0) {
 154                                 mysql_free_result (res);
 155                                 mysql_close (&mysql);
 156                                 die (STATE_CRITICAL, "%s\n", slaveresult);
 157                         }
 158
 159                 } else {
 160                         /* mysql 4.x.x */
 161                         int slave_io_field = -1 , slave_sql_field = -1, seconds_behind_field = -1, i, num_fields;
 162                         MYSQL_FIELD* fields;
 163
 164                         num_fields = mysql_num_fields(res);
 165                         fields = mysql_fetch_fields(res);
 166                         for(i = 0; i < num_fields; i++) {
 167                                 if (strcmp(fields[i].name, "Slave_IO_Running") == 0) {
 168                                         slave_io_field = i;
 169                                         continue;
 170                                 }
 171                                 if (strcmp(fields[i].name, "Slave_SQL_Running") == 0) {
 172                                         slave_sql_field = i;
 173                                         continue;
 174                                 }
 175                                 if (strcmp(fields[i].name, "Seconds_Behind_Master") == 0) {
 176                                         seconds_behind_field = i;
 177                                         continue;
 178                                 }
 179                         }
 180
 181                         if ((slave_io_field < 0) || (slave_sql_field < 0) || (num_fields == 0)) {
 182                                 mysql_free_result (res);
 183                                 mysql_close (&mysql);
 184                                 die (STATE_CRITICAL, "Slave status unavailable\n");
 185                         }
 186
 187                         snprintf (slaveresult, SLAVERESULTSIZE, "Slave IO: %s Slave SQL: %s Seconds Behind Master: %s", row[slave_io_field], row[slave_sql_field], seconds_behind_field!=-1?row[seconds_behind_field]:"Unknown");
 188                         if (strcmp (row[slave_io_field], "Yes") != 0 || strcmp (row[slave_sql_field], "Yes") != 0) {
 189                                 mysql_free_result (res);
 190                                 mysql_close (&mysql);
 191                                 die (STATE_CRITICAL, "%s\n", slaveresult);
 192                         }
 193
 194                         if (verbose >=3) {
 195                                 if (seconds_behind_field == -1) {
 196                                         printf("seconds_behind_field not found\n");
 197                                 } else {
 198                                         printf ("seconds_behind_field(index %d)=%s\n", seconds_behind_field, row[seconds_behind_field]);
 199                                 }
 200                         }
 201
 202                         if ((seconds_behind_field != -1) && (strcmp (row[seconds_behind_field], "NULL") != 0)) {
 203                                 double value = atof(row[seconds_behind_field]);
 204                                 int status;
 205
 206                                 status = get_status(value, my_threshold);
 207
 208                                 if (status == STATE_WARNING) {
 209                                         printf("SLOW_SLAVE %s: %s\n", _("WARNING"), slaveresult);
 210                                         exit(STATE_WARNING);
 211                                 } else if (status == STATE_CRITICAL) {
 212                                         printf("SLOW_SLAVE %s: %s\n", _("CRITICAL"), slaveresult);
 213                                         exit(STATE_CRITICAL);
 214                                 }
 215                         }
 216                 }
 217
 218                 /* free the result */
 219                 mysql_free_result (res);
 220         }
 221
 222         /* close the connection */
 223         mysql_close (&mysql);
 224
 225         /* print out the result of stats */
 226         if (check_slave) {
 227                 printf ("%s %s\n", result, slaveresult);
 228         } else {
 229                 printf ("%s\n", result);
 230         }
 231
 232         return STATE_OK;
 233 }
 234
 235
 236 /* process command-line arguments */
 237 int
 238 process_arguments (int argc, char **argv)
 239 {
 240         int c;
 241         char *warning = NULL;
 242         char *critical = NULL;
 243
 244         int option = 0;
 245         static struct option longopts[] = {
 246                 {"hostname", required_argument, 0, 'H'},
 247                 {"socket", required_argument, 0, 's'},
 248                 {"database", required_argument, 0, 'd'},
 249                 {"username", required_argument, 0, 'u'},
 250                 {"password", required_argument, 0, 'p'},
 251                 {"port", required_argument, 0, 'P'},
 252                 {"critical", required_argument, 0, 'c'},
 253                 {"warning", required_argument, 0, 'w'},
 254                 {"check-slave", no_argument, 0, 'S'},
 255                 {"verbose", no_argument, 0, 'v'},
 256                 {"version", no_argument, 0, 'V'},
 257                 {"help", no_argument, 0, 'h'},
 258                 {0, 0, 0, 0}
 259         };
 260
 261         if (argc < 1)
 262                 return ERROR;
 263
 264         while (1) {
 265                 c = getopt_long (argc, argv, "hvVSP:p:u:d:H:s:c:w:", longopts, &option);
 266
 267                 if (c == -1 || c == EOF)
 268                         break;
 269
 270                 switch (c) {
 271                 case 'H':                                                                       /* hostname */
 272                         if (is_host (optarg)) {
 273                                 db_host = optarg;
 274                         }
 275                         else {
 276                                 usage2 (_("Invalid hostname/address"), optarg);
 277                         }
 278                         break;
 279                 case 's':                                                                       /* socket */
 280                         db_socket = optarg;
 281                         break;
 282                 case 'd':                                                                       /* database */
 283                         db = optarg;
 284                         break;
 285                 case 'u':                                                                       /* username */
 286                         db_user = optarg;
 287                         break;
 288                 case 'p':                                                                       /* authentication information: password */
 289                         db_pass = strdup(optarg);
 290
 291                         /* Delete the password from process list */
 292                         while (*optarg != '\0') {
 293                                 *optarg = 'X';
 294                                 optarg++;
 295                         }
 296                         break;
 297                 case 'P':                                                                       /* critical time threshold */
 298                         db_port = atoi (optarg);
 299                         break;
 300                 case 'S':
 301                         check_slave = 1;                                                        /* check-slave */
 302                         break;
 303                 case 'w':
 304                         warning = optarg;
 305                         break;
 306                 case 'c':
 307                         critical = optarg;
 308                         break;
 309                 case 'V':                                                                       /* version */
 310                         print_revision (progname, NP_VERSION);
 311                         exit (STATE_OK);
 312                 case 'h':                                                                       /* help */
 313                         print_help ();
 314                         exit (STATE_OK);
 315                 case 'v':
 316                         verbose++;
 317                         break;
 318                 case '?':                                                                       /* help */
 319                         usage5 ();
 320                 }
 321         }
 322
 323         c = optind;
 324
 325         set_thresholds(&my_threshold, warning, critical);
 326
 327         while ( argc > c ) {
 328
 329                 if (db_host == NULL)
 330                         if (is_host (argv[c])) {
 331                                 db_host = argv[c++];
 332                         }
 333                         else {
 334                                 usage2 (_("Invalid hostname/address"), argv[c]);
 335                         }
 336                 else if (db_user == NULL)
 337                         db_user = argv[c++];
 338                 else if (db_pass == NULL)
 339                         db_pass = argv[c++];
 340                 else if (db == NULL)
 341                         db = argv[c++];
 342                 else if (is_intnonneg (argv[c]))
 343                         db_port = atoi (argv[c++]);
 344                 else
 345                         break;
 346         }
 347
 348         return validate_arguments ();
 349 }
 350
 351
 352 int
 353 validate_arguments (void)
 354 {
 355         if (db_user == NULL)
 356                 db_user = strdup("");
 357
 358         if (db_host == NULL)
 359                 db_host = strdup("");
 360
 361         if (db == NULL)
 362                 db = strdup("");
 363
 364         return OK;
 365 }
 366
 367
 368 void
 369 print_help (void)
 370 {
 371         char *myport;
 372         asprintf (&myport, "%d", MYSQL_PORT);
 373
 374         print_revision (progname, NP_VERSION);
 375
 376         printf (_(COPYRIGHT), copyright, email);
 377
 378         printf ("%s\n", _("This program tests connections to a MySQL server"));
 379
 380   printf ("\n\n");
 381
 382         print_usage ();
 383
 384   printf (_(UT_HELP_VRSN));
 385         printf (_(UT_EXTRA_OPTS));
 386
 387   printf (_(UT_HOST_PORT), 'P', myport);
 388   printf (" %s\n", "-s, --socket=STRING");
 389   printf ("    %s\n", _("Use the specified socket (has no effect if -H is used)"));
 390
 391   printf (" %s\n", "-d, --database=STRING");
 392   printf ("    %s\n", _("Check database with indicated name"));
 393   printf (" %s\n", "-u, --username=STRING");
 394   printf ("    %s\n", _("Connect using the indicated username"));
 395   printf (" %s\n", "-p, --password=STRING");
 396   printf ("    %s\n", _("Use the indicated password to authenticate the connection"));
 397   printf ("    ==> %s <==\n", _("IMPORTANT: THIS FORM OF AUTHENTICATION IS NOT SECURE!!!"));
 398   printf ("    %s\n", _("Your clear-text password could be visible as a process table entry"));
 399   printf (" %s\n", "-S, --check-slave");
 400   printf ("    %s\n", _("Check if the slave thread is running properly."));
 401   printf (" %s\n", "-w, --warning");
 402   printf ("    %s\n", _("Exit with WARNING status if slave server is more than INTEGER seconds"));
 403   printf ("    %s\n", _("behind master"));
 404   printf (" %s\n", "-c, --critical");
 405   printf ("    %s\n", _("Exit with CRITICAL status if slave server is more then INTEGER seconds"));
 406   printf ("    %s\n", _("behind master"));
 407
 408   printf ("\n");
 409   printf (" %s\n", _("There are no required arguments. By default, the local database is checked"));
 410   printf (" %s\n", _("using the default unix socket. You can force TCP on localhost by using an"));
 411   printf (" %s\n", _("IP address or FQDN ('localhost' will use the socket as well)."));
 412
 413 #ifdef NP_EXTRA_OPTS
 414         printf ("\n");
 415         printf ("%s\n", _("Notes:"));
 416         printf (_(UT_EXTRA_OPTS_NOTES));
 417         printf ("\n");
 418         printf (" %s\n", _("You must specify -p with an empty string to force an empty password,"));
 419         printf (" %s\n", _("overriding any my.cnf settings."));
 420 #endif
 421
 422         printf (_(UT_SUPPORT));
 423 }
 424
 425
 426 void
 427 print_usage (void)
 428 {
 429         printf (_("Usage:"));
 430   printf (" %s [-d database] [-H host] [-P port] [-s socket]\n",progname);
 431   printf ("       [-u user] [-p password] [-S]\n");
 432 }