2 * collectd - src/mysql.c
3 * Copyright (C) 2006-2009 Florian octo Forster
4 * Copyright (C) 2008 Mirko Buffoni
5 * Copyright (C) 2009 Doug MacEachern
6 * Copyright (C) 2009 Sebastian tokkee Harl
8 * This program is free software; you can redistribute it and/or modify it
9 * under the terms of the GNU General Public License as published by the
10 * Free Software Foundation; only version 2 of the License is applicable.
12 * This program is distributed in the hope that it will be useful, but
13 * WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * General Public License for more details.
17 * You should have received a copy of the GNU General Public License along
18 * with this program; if not, write to the Free Software Foundation, Inc.,
19 * 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
22 * Florian octo Forster <octo at verplant.org>
23 * Mirko Buffoni <briareos at eswat.org>
24 * Doug MacEachern <dougm at hyperic.com>
25 * Sebastian tokkee Harl <sh at tokkee.org>
31 #include "configfile.h"
35 #elif defined(HAVE_MYSQL_MYSQL_H)
36 #include <mysql/mysql.h>
39 /* TODO: Understand `Select_*' and possibly do that stuff as well.. */
41 struct mysql_database_s /* {{{ */
43 /* instance == NULL => legacy mode */
57 int slave_sql_running;
62 typedef struct mysql_database_s mysql_database_t; /* }}} */
64 static int mysql_read (user_data_t *ud);
66 static void mysql_database_free (void *arg) /* {{{ */
70 DEBUG ("mysql plugin: mysql_database_free (arg = %p);", arg);
72 db = (mysql_database_t *) arg;
78 mysql_close (db->con);
87 } /* }}} void mysql_database_free */
89 /* Configuration handling functions {{{
92 * <Database "plugin_instance1">
100 static int mysql_config_set_string (char **ret_string, /* {{{ */
105 if ((ci->values_num != 1)
106 || (ci->values[0].type != OCONFIG_TYPE_STRING))
108 WARNING ("mysql plugin: The `%s' config option "
109 "needs exactly one string argument.", ci->key);
113 string = strdup (ci->values[0].value.string);
116 ERROR ("mysql plugin: strdup failed.");
120 if (*ret_string != NULL)
122 *ret_string = string;
125 } /* }}} int mysql_config_set_string */
127 static int mysql_config_set_int (int *ret_int, /* {{{ */
130 if ((ci->values_num != 1)
131 || (ci->values[0].type != OCONFIG_TYPE_NUMBER))
133 WARNING ("mysql plugin: The `%s' config option "
134 "needs exactly one string argument.", ci->key);
138 *ret_int = ci->values[0].value.number;
141 } /* }}} int mysql_config_set_int */
143 static int mysql_config_set_boolean (int *ret_boolean, /* {{{ */
148 if (ci->values_num != 1)
153 if (ci->values[0].type == OCONFIG_TYPE_BOOLEAN)
154 *ret_boolean = ci->values[0].value.boolean;
155 else if (ci->values[0].type == OCONFIG_TYPE_STRING)
157 if (IS_TRUE (ci->values[0].value.string))
159 else if (IS_FALSE (ci->values[0].value.string))
170 WARNING ("mysql plugin: The `%s' config option "
171 "needs exactly one boolean argument.", ci->key);
175 } /* }}} mysql_config_set_boolean */
177 static int mysql_config (oconfig_item_t *ci) /* {{{ */
179 mysql_database_t *db;
184 if ((ci->values_num != 1)
185 || (ci->values[0].type != OCONFIG_TYPE_STRING))
187 WARNING ("mysql plugin: The `Database' block "
188 "needs exactly one string argument.");
192 db = (mysql_database_t *) malloc (sizeof (*db));
195 ERROR ("mysql plugin: malloc failed.");
198 memset (db, 0, sizeof (*db));
200 /* initialize all the pointers */
208 /* trigger a notification, if it's not running */
209 db->slave_io_running = 1;
210 db->slave_sql_running = 1;
213 if (strcasecmp ("Plugin", ci->key) == 0)
217 else if (strcasecmp ("Database", ci->key) == 0)
220 status = mysql_config_set_string (&db->instance, ci);
226 assert (db->instance != NULL);
230 ERROR ("mysql plugin: mysql_config: "
231 "Invalid key: %s", ci->key);
235 /* Fill the `mysql_database_t' structure.. */
236 for (i = 0; i < ci->children_num; i++)
238 oconfig_item_t *child = ci->children + i;
240 if (strcasecmp ("Host", child->key) == 0)
241 status = mysql_config_set_string (&db->host, child);
242 else if (strcasecmp ("User", child->key) == 0)
243 status = mysql_config_set_string (&db->user, child);
244 else if (strcasecmp ("Password", child->key) == 0)
245 status = mysql_config_set_string (&db->pass, child);
246 else if (strcasecmp ("Port", child->key) == 0)
247 status = mysql_config_set_int (&db->port, child);
248 else if (strcasecmp ("Socket", child->key) == 0)
249 status = mysql_config_set_string (&db->socket, child);
250 /* Check if we're currently handling the `Plugin' block. If so,
251 * handle `Database' _blocks_, too. */
252 else if ((plugin_block != 0)
253 && (strcasecmp ("Database", child->key) == 0)
254 && (child->children != NULL))
256 /* If `plugin_block > 1', there has been at least one
257 * `Database' block */
259 status = mysql_config (child);
261 /* Now handle ordinary `Database' options (without children) */
262 else if ((strcasecmp ("Database", child->key) == 0)
263 && (child->children == NULL))
264 status = mysql_config_set_string (&db->database, child);
265 else if (strcasecmp ("MasterStats", child->key) == 0)
266 status = mysql_config_set_boolean (&db->master_stats, child);
267 else if (strcasecmp ("SlaveStats", child->key) == 0)
268 status = mysql_config_set_boolean (&db->slave_stats, child);
269 else if (strcasecmp ("SlaveNotifications", child->key) == 0)
270 status = mysql_config_set_boolean (&db->slave_notif, child);
273 WARNING ("mysql plugin: Option `%s' not allowed here.", child->key);
281 /* Check if there were any `Database' blocks. */
282 if (plugin_block > 1)
284 /* There were connection blocks. Don't use any legacy stuff. */
285 if ((db->host != NULL)
286 || (db->user != NULL)
287 || (db->pass != NULL)
288 || (db->database != NULL)
289 || (db->socket != NULL)
292 WARNING ("mysql plugin: At least one <Database> "
293 "block has been found. The legacy "
294 "configuration will be ignored.");
296 mysql_database_free (db);
299 else if (plugin_block != 0)
301 WARNING ("mysql plugin: You're using the legacy "
302 "configuration options. Please consider "
303 "updating your configuration!");
306 /* Check that all necessary options have been given. */
309 /* Zero is allowed and automatically handled by
310 * `mysql_real_connect'. */
311 if ((db->port < 0) || (db->port > 65535))
313 ERROR ("mysql plugin: Database %s: Port number out "
315 (db->instance != NULL)
322 } /* while (status == 0) */
324 /* If all went well, register this database for reading */
328 char cb_name[DATA_MAX_NAME_LEN];
330 DEBUG ("mysql plugin: Registering new read callback: %s",
331 (db->database != NULL) ? db->database : "<default>");
333 memset (&ud, 0, sizeof (ud));
334 ud.data = (void *) db;
335 ud.free_func = mysql_database_free;
337 if (db->database != NULL)
338 ssnprintf (cb_name, sizeof (cb_name), "mysql-%s",
341 sstrncpy (cb_name, "mysql", sizeof (cb_name));
343 plugin_register_complex_read (cb_name, mysql_read,
344 /* interval = */ NULL, &ud);
348 mysql_database_free (db);
353 } /* }}} int mysql_config */
355 /* }}} End of configuration handling functions */
357 static MYSQL *getconnection (mysql_database_t *db)
362 if ((err = mysql_ping (db->con)) != 0)
364 WARNING ("mysql_ping failed: %s", mysql_error (db->con));
374 if ((db->con = mysql_init (db->con)) == NULL)
376 ERROR ("mysql_init failed: %s", mysql_error (db->con));
381 if (mysql_real_connect (db->con, db->host, db->user, db->pass,
382 db->database, db->port, db->socket, 0) == NULL)
384 ERROR ("mysql plugin: Failed to connect to database %s "
386 (db->database != NULL) ? db->database : "<none>",
387 (db->host != NULL) ? db->host : "localhost",
388 mysql_error (db->con));
394 INFO ("mysql plugin: Sucessfully connected to database %s "
395 "at server %s (server version: %s, protocol version: %d)",
396 (db->database != NULL) ? db->database : "<none>",
397 mysql_get_host_info (db->con),
398 mysql_get_server_info (db->con),
399 mysql_get_proto_info (db->con));
403 } /* static MYSQL *getconnection (mysql_database_t *db) */
405 static void set_host (mysql_database_t *db, char *buf, size_t buflen)
407 /* XXX legacy mode - use hostname_g */
408 if (db->instance == NULL)
409 sstrncpy (buf, hostname_g, buflen);
412 if ((db->host == NULL)
413 || (strcmp ("", db->host) == 0)
414 || (strcmp ("localhost", db->host) == 0))
415 sstrncpy (buf, hostname_g, buflen);
417 sstrncpy (buf, db->host, buflen);
421 static void set_plugin_instance (mysql_database_t *db,
422 char *buf, size_t buflen)
424 /* XXX legacy mode - no plugin_instance */
425 if (db->instance == NULL)
426 sstrncpy (buf, "", buflen);
428 sstrncpy (buf, db->instance, buflen);
431 static void submit (const char *type, const char *type_instance,
432 value_t *values, size_t values_len, mysql_database_t *db)
434 value_list_t vl = VALUE_LIST_INIT;
437 vl.values_len = values_len;
439 set_host (db, vl.host, sizeof (vl.host));
441 sstrncpy (vl.plugin, "mysql", sizeof (vl.plugin));
442 set_plugin_instance (db, vl.plugin_instance, sizeof (vl.plugin_instance));
444 sstrncpy (vl.type, type, sizeof (vl.type));
445 if (type_instance != NULL)
446 sstrncpy (vl.type_instance, type_instance, sizeof (vl.type_instance));
448 plugin_dispatch_values (&vl);
451 static void counter_submit (const char *type, const char *type_instance,
452 counter_t value, mysql_database_t *db)
456 values[0].counter = value;
457 submit (type, type_instance, values, STATIC_ARRAY_SIZE (values), db);
458 } /* void counter_submit */
460 static void gauge_submit (const char *type, const char *type_instance,
461 gauge_t value, mysql_database_t *db)
465 values[0].gauge = value;
466 submit (type, type_instance, values, STATIC_ARRAY_SIZE (values), db);
467 } /* void gauge_submit */
469 static void qcache_submit (counter_t hits, counter_t inserts,
470 counter_t not_cached, counter_t lowmem_prunes,
471 gauge_t queries_in_cache, mysql_database_t *db)
475 values[0].counter = hits;
476 values[1].counter = inserts;
477 values[2].counter = not_cached;
478 values[3].counter = lowmem_prunes;
479 values[4].gauge = queries_in_cache;
481 submit ("mysql_qcache", NULL, values, STATIC_ARRAY_SIZE (values), db);
482 } /* void qcache_submit */
484 static void threads_submit (gauge_t running, gauge_t connected, gauge_t cached,
485 counter_t created, mysql_database_t *db)
489 values[0].gauge = running;
490 values[1].gauge = connected;
491 values[2].gauge = cached;
492 values[3].counter = created;
494 submit ("mysql_threads", NULL, values, STATIC_ARRAY_SIZE (values), db);
495 } /* void threads_submit */
497 static void traffic_submit (counter_t rx, counter_t tx, mysql_database_t *db)
501 values[0].counter = rx;
502 values[1].counter = tx;
504 submit ("mysql_octets", NULL, values, STATIC_ARRAY_SIZE (values), db);
505 } /* void traffic_submit */
507 static MYSQL_RES *exec_query (MYSQL *con, const char *query)
511 int query_len = strlen (query);
513 if (mysql_real_query (con, query, query_len))
515 ERROR ("mysql plugin: Failed to execute query: %s",
517 INFO ("mysql plugin: SQL query was: %s", query);
521 res = mysql_store_result (con);
524 ERROR ("mysql plugin: Failed to store query result: %s",
526 INFO ("mysql plugin: SQL query was: %s", query);
533 static int mysql_read_master_stats (mysql_database_t *db, MYSQL *con)
540 unsigned long long position;
542 query = "SHOW MASTER STATUS";
544 res = exec_query (con, query);
548 row = mysql_fetch_row (res);
551 ERROR ("mysql plugin: Failed to get master statistics: "
552 "`%s' did not return any rows.", query);
556 field_num = mysql_num_fields (res);
559 ERROR ("mysql plugin: Failed to get master statistics: "
560 "`%s' returned less than two columns.", query);
564 position = atoll (row[1]);
565 counter_submit ("mysql_log_position", "master-bin", position, db);
567 row = mysql_fetch_row (res);
569 WARNING ("mysql plugin: `%s' returned more than one row - "
570 "ignoring further results.", query);
572 mysql_free_result (res);
575 } /* mysql_read_master_stats */
577 static int mysql_read_slave_stats (mysql_database_t *db, MYSQL *con)
585 /* WTF? libmysqlclient does not seem to provide any means to
586 * translate a column name to a column index ... :-/ */
587 const int READ_MASTER_LOG_POS_IDX = 6;
588 const int SLAVE_IO_RUNNING_IDX = 10;
589 const int SLAVE_SQL_RUNNING_IDX = 11;
590 const int EXEC_MASTER_LOG_POS_IDX = 21;
591 const int SECONDS_BEHIND_MASTER_IDX = 32;
593 query = "SHOW SLAVE STATUS";
595 res = exec_query (con, query);
599 row = mysql_fetch_row (res);
602 ERROR ("mysql plugin: Failed to get slave statistics: "
603 "`%s' did not return any rows.", query);
607 field_num = mysql_num_fields (res);
610 ERROR ("mysql plugin: Failed to get slave statistics: "
611 "`%s' returned less than 33 columns.", query);
617 unsigned long long counter;
620 counter = atoll (row[READ_MASTER_LOG_POS_IDX]);
621 counter_submit ("mysql_log_position", "slave-read", counter, db);
623 counter = atoll (row[EXEC_MASTER_LOG_POS_IDX]);
624 counter_submit ("mysql_log_position", "slave-exec", counter, db);
626 if (row[SECONDS_BEHIND_MASTER_IDX] != NULL)
628 gauge = atof (row[SECONDS_BEHIND_MASTER_IDX]);
629 gauge_submit ("time_offset", NULL, gauge, db);
635 notification_t n = { 0, time (NULL), "", "",
636 "mysql", "", "time_offset", "", NULL };
640 io = row[SLAVE_IO_RUNNING_IDX];
641 sql = row[SLAVE_SQL_RUNNING_IDX];
643 set_host (db, n.host, sizeof (n.host));
644 set_plugin_instance (db,
645 n.plugin_instance, sizeof (n.plugin_instance));
647 if (((io == NULL) || (strcasecmp (io, "yes") != 0))
648 && (db->slave_io_running))
650 n.severity = NOTIF_WARNING;
651 ssnprintf (n.message, sizeof (n.message),
652 "slave I/O thread not started or not connected to master");
653 plugin_dispatch_notification (&n);
654 db->slave_io_running = 0;
656 else if (((io != NULL) && (strcasecmp (io, "yes") == 0))
657 && (! db->slave_io_running))
659 n.severity = NOTIF_OKAY;
660 ssnprintf (n.message, sizeof (n.message),
661 "slave I/O thread started and connected to master");
662 plugin_dispatch_notification (&n);
663 db->slave_io_running = 1;
666 if (((sql == NULL) || (strcasecmp (sql, "yes") != 0))
667 && (db->slave_sql_running))
669 n.severity = NOTIF_WARNING;
670 ssnprintf (n.message, sizeof (n.message),
671 "slave SQL thread not started");
672 plugin_dispatch_notification (&n);
673 db->slave_sql_running = 0;
675 else if (((sql != NULL) && (strcasecmp (sql, "yes") == 0))
676 && (! db->slave_sql_running))
678 n.severity = NOTIF_OKAY;
679 ssnprintf (n.message, sizeof (n.message),
680 "slave SQL thread started");
681 plugin_dispatch_notification (&n);
682 db->slave_sql_running = 0;
686 row = mysql_fetch_row (res);
688 WARNING ("mysql plugin: `%s' returned more than one row - "
689 "ignoring further results.", query);
691 mysql_free_result (res);
694 } /* mysql_read_slave_stats */
696 static int mysql_read (user_data_t *ud)
698 mysql_database_t *db;
705 unsigned long long qcache_hits = 0ULL;
706 unsigned long long qcache_inserts = 0ULL;
707 unsigned long long qcache_not_cached = 0ULL;
708 unsigned long long qcache_lowmem_prunes = 0ULL;
709 int qcache_queries_in_cache = -1;
711 int threads_running = -1;
712 int threads_connected = -1;
713 int threads_cached = -1;
714 unsigned long long threads_created = 0ULL;
716 unsigned long long traffic_incoming = 0ULL;
717 unsigned long long traffic_outgoing = 0ULL;
719 if ((ud == NULL) || (ud->data == NULL))
721 ERROR ("mysql plugin: mysql_database_read: Invalid user data.");
725 db = (mysql_database_t *) ud->data;
727 /* An error message will have been printed in this case */
728 if ((con = getconnection (db)) == NULL)
731 query = "SHOW STATUS";
732 if (mysql_get_server_version (con) >= 50002)
733 query = "SHOW GLOBAL STATUS";
735 res = exec_query (con, query);
739 field_num = mysql_num_fields (res);
740 while ((row = mysql_fetch_row (res)))
743 unsigned long long val;
746 val = atoll (row[1]);
748 if (strncmp (key, "Com_", 4) == 0)
753 /* Ignore `prepared statements' */
754 if (strncmp (key, "Com_stmt_", 9) != 0)
755 counter_submit ("mysql_commands", key + 4, val, db);
757 else if (strncmp (key, "Handler_", 8) == 0)
762 counter_submit ("mysql_handler", key + 8, val, db);
764 else if (strncmp (key, "Qcache_", 7) == 0)
766 if (strcmp (key, "Qcache_hits") == 0)
768 else if (strcmp (key, "Qcache_inserts") == 0)
769 qcache_inserts = val;
770 else if (strcmp (key, "Qcache_not_cached") == 0)
771 qcache_not_cached = val;
772 else if (strcmp (key, "Qcache_lowmem_prunes") == 0)
773 qcache_lowmem_prunes = val;
774 else if (strcmp (key, "Qcache_queries_in_cache") == 0)
775 qcache_queries_in_cache = (int) val;
777 else if (strncmp (key, "Bytes_", 6) == 0)
779 if (strcmp (key, "Bytes_received") == 0)
780 traffic_incoming += val;
781 else if (strcmp (key, "Bytes_sent") == 0)
782 traffic_outgoing += val;
784 else if (strncmp (key, "Threads_", 8) == 0)
786 if (strcmp (key, "Threads_running") == 0)
787 threads_running = (int) val;
788 else if (strcmp (key, "Threads_connected") == 0)
789 threads_connected = (int) val;
790 else if (strcmp (key, "Threads_cached") == 0)
791 threads_cached = (int) val;
792 else if (strcmp (key, "Threads_created") == 0)
793 threads_created = val;
796 mysql_free_result (res); res = NULL;
798 if ((qcache_hits != 0ULL)
799 || (qcache_inserts != 0ULL)
800 || (qcache_not_cached != 0ULL)
801 || (qcache_lowmem_prunes != 0ULL))
802 qcache_submit (qcache_hits, qcache_inserts, qcache_not_cached,
803 qcache_lowmem_prunes, qcache_queries_in_cache, db);
805 if (threads_created != 0ULL)
806 threads_submit (threads_running, threads_connected,
807 threads_cached, threads_created, db);
809 traffic_submit (traffic_incoming, traffic_outgoing, db);
811 if (db->master_stats)
812 mysql_read_master_stats (db, con);
814 if ((db->slave_stats) || (db->slave_notif))
815 mysql_read_slave_stats (db, con);
818 } /* int mysql_read */
820 void module_register (void)
822 plugin_register_complex_config ("mysql", mysql_config);
823 } /* void module_register */