2 * collectd - src/mysql.c
3 * Copyright (C) 2006-2009 Florian octo Forster
4 * Copyright (C) 2009 Doug MacEachern
5 * Copyright (C) 2009 Sebastian tokkee Harl
7 * This program is free software; you can redistribute it and/or modify it
8 * under the terms of the GNU General Public License as published by the
9 * Free Software Foundation; only version 2 of the License is applicable.
11 * This program is distributed in the hope that it will be useful, but
12 * WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * General Public License for more details.
16 * You should have received a copy of the GNU General Public License along
17 * with this program; if not, write to the Free Software Foundation, Inc.,
18 * 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
21 * Florian octo Forster <octo at verplant.org>
22 * Mirko Buffoni <briareos at eswat.org>
23 * Doug MacEachern <dougm at hyperic.com>
24 * Sebastian tokkee Harl <sh at tokkee.org>
30 #include "configfile.h"
34 #elif defined(HAVE_MYSQL_MYSQL_H)
35 #include <mysql/mysql.h>
38 /* TODO: Understand `Select_*' and possibly do that stuff as well.. */
40 struct mysql_database_s /* {{{ */
42 /* instance == NULL => legacy mode */
56 int slave_sql_running;
61 typedef struct mysql_database_s mysql_database_t; /* }}} */
63 static int mysql_read (user_data_t *ud);
65 static void mysql_database_free (void *arg) /* {{{ */
69 DEBUG ("mysql plugin: mysql_database_free (arg = %p);", arg);
71 db = (mysql_database_t *) arg;
77 mysql_close (db->con);
86 } /* }}} void mysql_database_free */
88 /* Configuration handling functions {{{
91 * <Database "plugin_instance1">
99 static int mysql_config_set_string (char **ret_string, /* {{{ */
104 if ((ci->values_num != 1)
105 || (ci->values[0].type != OCONFIG_TYPE_STRING))
107 WARNING ("mysql plugin: The `%s' config option "
108 "needs exactly one string argument.", ci->key);
112 string = strdup (ci->values[0].value.string);
115 ERROR ("mysql plugin: strdup failed.");
119 if (*ret_string != NULL)
121 *ret_string = string;
124 } /* }}} int mysql_config_set_string */
126 static int mysql_config_set_int (int *ret_int, /* {{{ */
129 if ((ci->values_num != 1)
130 || (ci->values[0].type != OCONFIG_TYPE_NUMBER))
132 WARNING ("mysql plugin: The `%s' config option "
133 "needs exactly one string argument.", ci->key);
137 *ret_int = ci->values[0].value.number;
140 } /* }}} int mysql_config_set_int */
142 static int mysql_config_set_boolean (int *ret_boolean, /* {{{ */
147 if (ci->values_num != 1)
152 if (ci->values[0].type == OCONFIG_TYPE_BOOLEAN)
153 *ret_boolean = ci->values[0].value.boolean;
154 else if (ci->values[0].type == OCONFIG_TYPE_STRING)
156 if (IS_TRUE (ci->values[0].value.string))
158 else if (IS_FALSE (ci->values[0].value.string))
169 WARNING ("mysql plugin: The `%s' config option "
170 "needs exactly one boolean argument.", ci->key);
174 } /* }}} mysql_config_set_boolean */
176 static int mysql_config (oconfig_item_t *ci) /* {{{ */
178 mysql_database_t *db;
183 if ((ci->values_num != 1)
184 || (ci->values[0].type != OCONFIG_TYPE_STRING))
186 WARNING ("mysql plugin: The `Database' block "
187 "needs exactly one string argument.");
191 db = (mysql_database_t *) malloc (sizeof (*db));
194 ERROR ("mysql plugin: malloc failed.");
197 memset (db, 0, sizeof (*db));
199 /* initialize all the pointers */
207 /* trigger a notification, if it's not running */
208 db->slave_io_running = 1;
209 db->slave_sql_running = 1;
212 if (strcasecmp ("Plugin", ci->key) == 0)
216 else if (strcasecmp ("Database", ci->key) == 0)
219 status = mysql_config_set_string (&db->instance, ci);
225 assert (db->instance != NULL);
229 ERROR ("mysql plugin: mysql_config: "
230 "Invalid key: %s", ci->key);
234 /* Fill the `mysql_database_t' structure.. */
235 for (i = 0; i < ci->children_num; i++)
237 oconfig_item_t *child = ci->children + i;
239 if (strcasecmp ("Host", child->key) == 0)
240 status = mysql_config_set_string (&db->host, child);
241 else if (strcasecmp ("User", child->key) == 0)
242 status = mysql_config_set_string (&db->user, child);
243 else if (strcasecmp ("Password", child->key) == 0)
244 status = mysql_config_set_string (&db->pass, child);
245 else if (strcasecmp ("Port", child->key) == 0)
246 status = mysql_config_set_int (&db->port, child);
247 else if (strcasecmp ("Socket", child->key) == 0)
248 status = mysql_config_set_string (&db->socket, child);
249 /* Check if we're currently handling the `Plugin' block. If so,
250 * handle `Database' _blocks_, too. */
251 else if ((plugin_block != 0)
252 && (strcasecmp ("Database", child->key) == 0)
253 && (child->children != NULL))
255 /* If `plugin_block > 1', there has been at least one
256 * `Database' block */
258 status = mysql_config (child);
260 /* Now handle ordinary `Database' options (without children) */
261 else if ((strcasecmp ("Database", child->key) == 0)
262 && (child->children == NULL))
263 status = mysql_config_set_string (&db->database, child);
264 else if (strcasecmp ("MasterStats", child->key) == 0)
265 status = mysql_config_set_boolean (&db->master_stats, child);
266 else if (strcasecmp ("SlaveStats", child->key) == 0)
267 status = mysql_config_set_boolean (&db->slave_stats, child);
268 else if (strcasecmp ("SlaveNotifications", child->key) == 0)
269 status = mysql_config_set_boolean (&db->slave_notif, child);
272 WARNING ("mysql plugin: Option `%s' not allowed here.", child->key);
280 /* Check if there were any `Database' blocks. */
281 if (plugin_block > 1)
283 /* There were connection blocks. Don't use any legacy stuff. */
284 if ((db->host != NULL)
285 || (db->user != NULL)
286 || (db->pass != NULL)
287 || (db->database != NULL)
288 || (db->socket != NULL)
291 WARNING ("mysql plugin: At least one <Database> "
292 "block has been found. The legacy "
293 "configuration will be ignored.");
295 mysql_database_free (db);
298 else if (plugin_block != 0)
300 WARNING ("mysql plugin: You're using the legacy "
301 "configuration options. Please consider "
302 "updating your configuration!");
305 /* Check that all necessary options have been given. */
308 /* Zero is allowed and automatically handled by
309 * `mysql_real_connect'. */
310 if ((db->port < 0) || (db->port > 65535))
312 ERROR ("mysql plugin: Database %s: Port number out "
314 (db->instance != NULL)
321 } /* while (status == 0) */
323 /* If all went well, register this database for reading */
327 char cb_name[DATA_MAX_NAME_LEN];
329 DEBUG ("mysql plugin: Registering new read callback: %s",
330 (db->database != NULL) ? db->database : "<default>");
332 memset (&ud, 0, sizeof (ud));
333 ud.data = (void *) db;
334 ud.free_func = mysql_database_free;
336 if (db->database != NULL)
337 ssnprintf (cb_name, sizeof (cb_name), "mysql-%s",
340 sstrncpy (cb_name, "mysql", sizeof (cb_name));
342 plugin_register_complex_read (cb_name, mysql_read,
343 /* interval = */ NULL, &ud);
347 mysql_database_free (db);
352 } /* }}} int mysql_config */
354 /* }}} End of configuration handling functions */
356 static MYSQL *getconnection (mysql_database_t *db)
361 if ((err = mysql_ping (db->con)) != 0)
363 WARNING ("mysql_ping failed: %s", mysql_error (db->con));
373 if ((db->con = mysql_init (db->con)) == NULL)
375 ERROR ("mysql_init failed: %s", mysql_error (db->con));
380 if (mysql_real_connect (db->con, db->host, db->user, db->pass,
381 db->database, db->port, db->socket, 0) == NULL)
383 ERROR ("mysql plugin: Failed to connect to database %s "
385 (db->database != NULL) ? db->database : "<none>",
386 (db->host != NULL) ? db->host : "localhost",
387 mysql_error (db->con));
393 INFO ("mysql plugin: Sucessfully connected to database %s "
394 "at server %s (server version: %s, protocol version: %d)",
395 (db->database != NULL) ? db->database : "<none>",
396 mysql_get_host_info (db->con),
397 mysql_get_server_info (db->con),
398 mysql_get_proto_info (db->con));
402 } /* static MYSQL *getconnection (mysql_database_t *db) */
404 static void set_host (mysql_database_t *db, char *buf, size_t buflen)
406 /* XXX legacy mode - use hostname_g */
407 if (db->instance == NULL)
408 sstrncpy (buf, hostname_g, buflen);
411 if ((db->host == NULL)
412 || (strcmp ("", db->host) == 0)
413 || (strcmp ("localhost", db->host) == 0))
414 sstrncpy (buf, hostname_g, buflen);
416 sstrncpy (buf, db->host, buflen);
420 static void set_plugin_instance (mysql_database_t *db,
421 char *buf, size_t buflen)
423 /* XXX legacy mode - no plugin_instance */
424 if (db->instance == NULL)
425 sstrncpy (buf, "", buflen);
427 sstrncpy (buf, db->instance, buflen);
430 static void submit (const char *type, const char *type_instance,
431 value_t *values, size_t values_len, mysql_database_t *db)
433 value_list_t vl = VALUE_LIST_INIT;
436 vl.values_len = values_len;
438 set_host (db, vl.host, sizeof (vl.host));
440 sstrncpy (vl.plugin, "mysql", sizeof (vl.plugin));
441 set_plugin_instance (db, vl.plugin_instance, sizeof (vl.plugin_instance));
443 sstrncpy (vl.type, type, sizeof (vl.type));
444 if (type_instance != NULL)
445 sstrncpy (vl.type_instance, type_instance, sizeof (vl.type_instance));
447 plugin_dispatch_values (&vl);
450 static void counter_submit (const char *type, const char *type_instance,
451 counter_t value, mysql_database_t *db)
455 values[0].counter = value;
456 submit (type, type_instance, values, STATIC_ARRAY_SIZE (values), db);
457 } /* void counter_submit */
459 static void gauge_submit (const char *type, const char *type_instance,
460 gauge_t value, mysql_database_t *db)
464 values[0].gauge = value;
465 submit (type, type_instance, values, STATIC_ARRAY_SIZE (values), db);
466 } /* void gauge_submit */
468 static void qcache_submit (counter_t hits, counter_t inserts,
469 counter_t not_cached, counter_t lowmem_prunes,
470 gauge_t queries_in_cache, mysql_database_t *db)
474 values[0].counter = hits;
475 values[1].counter = inserts;
476 values[2].counter = not_cached;
477 values[3].counter = lowmem_prunes;
478 values[4].gauge = queries_in_cache;
480 submit ("mysql_qcache", NULL, values, STATIC_ARRAY_SIZE (values), db);
481 } /* void qcache_submit */
483 static void threads_submit (gauge_t running, gauge_t connected, gauge_t cached,
484 counter_t created, mysql_database_t *db)
488 values[0].gauge = running;
489 values[1].gauge = connected;
490 values[2].gauge = cached;
491 values[3].counter = created;
493 submit ("mysql_threads", NULL, values, STATIC_ARRAY_SIZE (values), db);
494 } /* void threads_submit */
496 static void traffic_submit (counter_t rx, counter_t tx, mysql_database_t *db)
500 values[0].counter = rx;
501 values[1].counter = tx;
503 submit ("mysql_octets", NULL, values, STATIC_ARRAY_SIZE (values), db);
504 } /* void traffic_submit */
506 static MYSQL_RES *exec_query (MYSQL *con, const char *query)
510 int query_len = strlen (query);
512 if (mysql_real_query (con, query, query_len))
514 ERROR ("mysql plugin: Failed to execute query: %s",
516 INFO ("mysql plugin: SQL query was: %s", query);
520 res = mysql_store_result (con);
523 ERROR ("mysql plugin: Failed to store query result: %s",
525 INFO ("mysql plugin: SQL query was: %s", query);
532 static int mysql_read_master_stats (mysql_database_t *db, MYSQL *con)
539 unsigned long long position;
541 query = "SHOW MASTER STATUS";
543 res = exec_query (con, query);
547 row = mysql_fetch_row (res);
550 ERROR ("mysql plugin: Failed to get master statistics: "
551 "`%s' did not return any rows.", query);
555 field_num = mysql_num_fields (res);
558 ERROR ("mysql plugin: Failed to get master statistics: "
559 "`%s' returned less than two columns.", query);
563 position = atoll (row[1]);
564 counter_submit ("mysql_log_position", "master-bin", position, db);
566 row = mysql_fetch_row (res);
568 WARNING ("mysql plugin: `%s' returned more than one row - "
569 "ignoring further results.", query);
571 mysql_free_result (res);
574 } /* mysql_read_master_stats */
576 static int mysql_read_slave_stats (mysql_database_t *db, MYSQL *con)
584 /* WTF? libmysqlclient does not seem to provide any means to
585 * translate a column name to a column index ... :-/ */
586 const int READ_MASTER_LOG_POS_IDX = 6;
587 const int SLAVE_IO_RUNNING_IDX = 10;
588 const int SLAVE_SQL_RUNNING_IDX = 11;
589 const int EXEC_MASTER_LOG_POS_IDX = 21;
590 const int SECONDS_BEHIND_MASTER_IDX = 32;
592 query = "SHOW SLAVE STATUS";
594 res = exec_query (con, query);
598 row = mysql_fetch_row (res);
601 ERROR ("mysql plugin: Failed to get slave statistics: "
602 "`%s' did not return any rows.", query);
606 field_num = mysql_num_fields (res);
609 ERROR ("mysql plugin: Failed to get slave statistics: "
610 "`%s' returned less than 33 columns.", query);
616 unsigned long long counter;
619 counter = atoll (row[READ_MASTER_LOG_POS_IDX]);
620 counter_submit ("mysql_log_position", "slave-read", counter, db);
622 counter = atoll (row[EXEC_MASTER_LOG_POS_IDX]);
623 counter_submit ("mysql_log_position", "slave-exec", counter, db);
625 if (row[SECONDS_BEHIND_MASTER_IDX] != NULL)
627 gauge = atof (row[SECONDS_BEHIND_MASTER_IDX]);
628 gauge_submit ("time_offset", NULL, gauge, db);
634 notification_t n = { 0, time (NULL), "", "",
635 "mysql", "", "time_offset", "", NULL };
639 io = row[SLAVE_IO_RUNNING_IDX];
640 sql = row[SLAVE_SQL_RUNNING_IDX];
642 set_host (db, n.host, sizeof (n.host));
643 set_plugin_instance (db,
644 n.plugin_instance, sizeof (n.plugin_instance));
646 if (((io == NULL) || (strcasecmp (io, "yes") != 0))
647 && (db->slave_io_running))
649 n.severity = NOTIF_WARNING;
650 ssnprintf (n.message, sizeof (n.message),
651 "slave I/O thread not started or not connected to master");
652 plugin_dispatch_notification (&n);
653 db->slave_io_running = 0;
655 else if (((io != NULL) && (strcasecmp (io, "yes") == 0))
656 && (! db->slave_io_running))
658 n.severity = NOTIF_OKAY;
659 ssnprintf (n.message, sizeof (n.message),
660 "slave I/O thread started and connected to master");
661 plugin_dispatch_notification (&n);
662 db->slave_io_running = 1;
665 if (((sql == NULL) || (strcasecmp (sql, "yes") != 0))
666 && (db->slave_sql_running))
668 n.severity = NOTIF_WARNING;
669 ssnprintf (n.message, sizeof (n.message),
670 "slave SQL thread not started");
671 plugin_dispatch_notification (&n);
672 db->slave_sql_running = 0;
674 else if (((sql != NULL) && (strcasecmp (sql, "yes") == 0))
675 && (! db->slave_sql_running))
677 n.severity = NOTIF_OKAY;
678 ssnprintf (n.message, sizeof (n.message),
679 "slave SQL thread started");
680 plugin_dispatch_notification (&n);
681 db->slave_sql_running = 0;
685 row = mysql_fetch_row (res);
687 WARNING ("mysql plugin: `%s' returned more than one row - "
688 "ignoring further results.", query);
690 mysql_free_result (res);
693 } /* mysql_read_slave_stats */
695 static int mysql_read (user_data_t *ud)
697 mysql_database_t *db;
704 unsigned long long qcache_hits = 0ULL;
705 unsigned long long qcache_inserts = 0ULL;
706 unsigned long long qcache_not_cached = 0ULL;
707 unsigned long long qcache_lowmem_prunes = 0ULL;
708 int qcache_queries_in_cache = -1;
710 int threads_running = -1;
711 int threads_connected = -1;
712 int threads_cached = -1;
713 unsigned long long threads_created = 0ULL;
715 unsigned long long traffic_incoming = 0ULL;
716 unsigned long long traffic_outgoing = 0ULL;
718 if ((ud == NULL) || (ud->data == NULL))
720 ERROR ("mysql plugin: mysql_database_read: Invalid user data.");
724 db = (mysql_database_t *) ud->data;
726 /* An error message will have been printed in this case */
727 if ((con = getconnection (db)) == NULL)
730 query = "SHOW STATUS";
731 if (mysql_get_server_version (con) >= 50002)
732 query = "SHOW GLOBAL STATUS";
734 res = exec_query (con, query);
738 field_num = mysql_num_fields (res);
739 while ((row = mysql_fetch_row (res)))
742 unsigned long long val;
745 val = atoll (row[1]);
747 if (strncmp (key, "Com_", 4) == 0)
752 /* Ignore `prepared statements' */
753 if (strncmp (key, "Com_stmt_", 9) != 0)
754 counter_submit ("mysql_commands", key + 4, val, db);
756 else if (strncmp (key, "Handler_", 8) == 0)
761 counter_submit ("mysql_handler", key + 8, val, db);
763 else if (strncmp (key, "Qcache_", 7) == 0)
765 if (strcmp (key, "Qcache_hits") == 0)
767 else if (strcmp (key, "Qcache_inserts") == 0)
768 qcache_inserts = val;
769 else if (strcmp (key, "Qcache_not_cached") == 0)
770 qcache_not_cached = val;
771 else if (strcmp (key, "Qcache_lowmem_prunes") == 0)
772 qcache_lowmem_prunes = val;
773 else if (strcmp (key, "Qcache_queries_in_cache") == 0)
774 qcache_queries_in_cache = (int) val;
776 else if (strncmp (key, "Bytes_", 6) == 0)
778 if (strcmp (key, "Bytes_received") == 0)
779 traffic_incoming += val;
780 else if (strcmp (key, "Bytes_sent") == 0)
781 traffic_outgoing += val;
783 else if (strncmp (key, "Threads_", 8) == 0)
785 if (strcmp (key, "Threads_running") == 0)
786 threads_running = (int) val;
787 else if (strcmp (key, "Threads_connected") == 0)
788 threads_connected = (int) val;
789 else if (strcmp (key, "Threads_cached") == 0)
790 threads_cached = (int) val;
791 else if (strcmp (key, "Threads_created") == 0)
792 threads_created = val;
795 mysql_free_result (res); res = NULL;
797 if ((qcache_hits != 0ULL)
798 || (qcache_inserts != 0ULL)
799 || (qcache_not_cached != 0ULL)
800 || (qcache_lowmem_prunes != 0ULL))
801 qcache_submit (qcache_hits, qcache_inserts, qcache_not_cached,
802 qcache_lowmem_prunes, qcache_queries_in_cache, db);
804 if (threads_created != 0ULL)
805 threads_submit (threads_running, threads_connected,
806 threads_cached, threads_created, db);
808 traffic_submit (traffic_incoming, traffic_outgoing, db);
810 if (db->master_stats)
811 mysql_read_master_stats (db, con);
813 if ((db->slave_stats) || (db->slave_notif))
814 mysql_read_slave_stats (db, con);
817 } /* int mysql_read */
819 void module_register (void)
821 plugin_register_complex_config ("mysql", mysql_config);
822 } /* void module_register */