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
7 * Copyright (C) 2009 Rodolphe QuiƩdeville
9 * This program is free software; you can redistribute it and/or modify it
10 * under the terms of the GNU General Public License as published by the
11 * Free Software Foundation; only version 2 of the License is applicable.
13 * This program is distributed in the hope that it will be useful, but
14 * WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 * General Public License for more details.
18 * You should have received a copy of the GNU General Public License along
19 * with this program; if not, write to the Free Software Foundation, Inc.,
20 * 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
23 * Florian octo Forster <octo at verplant.org>
24 * Mirko Buffoni <briareos at eswat.org>
25 * Doug MacEachern <dougm at hyperic.com>
26 * Sebastian tokkee Harl <sh at tokkee.org>
27 * Rodolphe QuiƩdeville <rquiedeville at bearstech.com>
33 #include "configfile.h"
37 #elif defined(HAVE_MYSQL_MYSQL_H)
38 #include <mysql/mysql.h>
41 /* TODO: Understand `Select_*' and possibly do that stuff as well.. */
43 struct mysql_database_s /* {{{ */
45 /* instance == NULL => legacy mode */
59 int slave_sql_running;
64 typedef struct mysql_database_s mysql_database_t; /* }}} */
66 static int mysql_read (user_data_t *ud);
68 static void mysql_database_free (void *arg) /* {{{ */
72 DEBUG ("mysql plugin: mysql_database_free (arg = %p);", arg);
74 db = (mysql_database_t *) arg;
80 mysql_close (db->con);
89 } /* }}} void mysql_database_free */
91 /* Configuration handling functions {{{
94 * <Database "plugin_instance1">
102 static int mysql_config_set_string (char **ret_string, /* {{{ */
107 if ((ci->values_num != 1)
108 || (ci->values[0].type != OCONFIG_TYPE_STRING))
110 WARNING ("mysql plugin: The `%s' config option "
111 "needs exactly one string argument.", ci->key);
115 string = strdup (ci->values[0].value.string);
118 ERROR ("mysql plugin: strdup failed.");
122 if (*ret_string != NULL)
124 *ret_string = string;
127 } /* }}} int mysql_config_set_string */
129 static int mysql_config_set_int (int *ret_int, /* {{{ */
132 if ((ci->values_num != 1)
133 || (ci->values[0].type != OCONFIG_TYPE_NUMBER))
135 WARNING ("mysql plugin: The `%s' config option "
136 "needs exactly one string argument.", ci->key);
140 *ret_int = ci->values[0].value.number;
143 } /* }}} int mysql_config_set_int */
145 static int mysql_config_set_boolean (int *ret_boolean, /* {{{ */
150 if (ci->values_num != 1)
155 if (ci->values[0].type == OCONFIG_TYPE_BOOLEAN)
156 *ret_boolean = ci->values[0].value.boolean;
157 else if (ci->values[0].type == OCONFIG_TYPE_STRING)
159 if (IS_TRUE (ci->values[0].value.string))
161 else if (IS_FALSE (ci->values[0].value.string))
172 WARNING ("mysql plugin: The `%s' config option "
173 "needs exactly one boolean argument.", ci->key);
177 } /* }}} mysql_config_set_boolean */
179 static int mysql_config (oconfig_item_t *ci) /* {{{ */
181 mysql_database_t *db;
186 if ((ci->values_num != 1)
187 || (ci->values[0].type != OCONFIG_TYPE_STRING))
189 WARNING ("mysql plugin: The `Database' block "
190 "needs exactly one string argument.");
194 db = (mysql_database_t *) malloc (sizeof (*db));
197 ERROR ("mysql plugin: malloc failed.");
200 memset (db, 0, sizeof (*db));
202 /* initialize all the pointers */
210 /* trigger a notification, if it's not running */
211 db->slave_io_running = 1;
212 db->slave_sql_running = 1;
215 if (strcasecmp ("Plugin", ci->key) == 0)
219 else if (strcasecmp ("Database", ci->key) == 0)
222 status = mysql_config_set_string (&db->instance, ci);
228 assert (db->instance != NULL);
232 ERROR ("mysql plugin: mysql_config: "
233 "Invalid key: %s", ci->key);
237 /* Fill the `mysql_database_t' structure.. */
238 for (i = 0; i < ci->children_num; i++)
240 oconfig_item_t *child = ci->children + i;
242 if (strcasecmp ("Host", child->key) == 0)
243 status = mysql_config_set_string (&db->host, child);
244 else if (strcasecmp ("User", child->key) == 0)
245 status = mysql_config_set_string (&db->user, child);
246 else if (strcasecmp ("Password", child->key) == 0)
247 status = mysql_config_set_string (&db->pass, child);
248 else if (strcasecmp ("Port", child->key) == 0)
249 status = mysql_config_set_int (&db->port, child);
250 else if (strcasecmp ("Socket", child->key) == 0)
251 status = mysql_config_set_string (&db->socket, child);
252 /* Check if we're currently handling the `Plugin' block. If so,
253 * handle `Database' _blocks_, too. */
254 else if ((plugin_block != 0)
255 && (strcasecmp ("Database", child->key) == 0)
256 && (child->children != NULL))
258 /* If `plugin_block > 1', there has been at least one
259 * `Database' block */
261 status = mysql_config (child);
263 /* Now handle ordinary `Database' options (without children) */
264 else if ((strcasecmp ("Database", child->key) == 0)
265 && (child->children == NULL))
266 status = mysql_config_set_string (&db->database, child);
267 else if (strcasecmp ("MasterStats", child->key) == 0)
268 status = mysql_config_set_boolean (&db->master_stats, child);
269 else if (strcasecmp ("SlaveStats", child->key) == 0)
270 status = mysql_config_set_boolean (&db->slave_stats, child);
271 else if (strcasecmp ("SlaveNotifications", child->key) == 0)
272 status = mysql_config_set_boolean (&db->slave_notif, child);
275 WARNING ("mysql plugin: Option `%s' not allowed here.", child->key);
283 /* Check if there were any `Database' blocks. */
284 if (plugin_block > 1)
286 /* There were connection blocks. Don't use any legacy stuff. */
287 if ((db->host != NULL)
288 || (db->user != NULL)
289 || (db->pass != NULL)
290 || (db->database != NULL)
291 || (db->socket != NULL)
294 WARNING ("mysql plugin: At least one <Database> "
295 "block has been found. The legacy "
296 "configuration will be ignored.");
298 mysql_database_free (db);
301 else if (plugin_block != 0)
303 WARNING ("mysql plugin: You're using the legacy "
304 "configuration options. Please consider "
305 "updating your configuration!");
308 /* Check that all necessary options have been given. */
311 /* Zero is allowed and automatically handled by
312 * `mysql_real_connect'. */
313 if ((db->port < 0) || (db->port > 65535))
315 ERROR ("mysql plugin: Database %s: Port number out "
317 (db->instance != NULL)
324 } /* while (status == 0) */
326 /* If all went well, register this database for reading */
330 char cb_name[DATA_MAX_NAME_LEN];
332 DEBUG ("mysql plugin: Registering new read callback: %s",
333 (db->database != NULL) ? db->database : "<default>");
335 memset (&ud, 0, sizeof (ud));
336 ud.data = (void *) db;
337 ud.free_func = mysql_database_free;
339 if (db->database != NULL)
340 ssnprintf (cb_name, sizeof (cb_name), "mysql-%s",
343 sstrncpy (cb_name, "mysql", sizeof (cb_name));
345 plugin_register_complex_read (/* group = */ NULL, cb_name,
347 /* interval = */ NULL, &ud);
351 mysql_database_free (db);
356 } /* }}} int mysql_config */
358 /* }}} End of configuration handling functions */
360 static MYSQL *getconnection (mysql_database_t *db)
365 if ((err = mysql_ping (db->con)) != 0)
367 WARNING ("mysql_ping failed for %s: %s",
368 (db->instance != NULL)
371 mysql_error (db->con));
381 if ((db->con = mysql_init (db->con)) == NULL)
383 ERROR ("mysql_init failed: %s", mysql_error (db->con));
388 if (mysql_real_connect (db->con, db->host, db->user, db->pass,
389 db->database, db->port, db->socket, 0) == NULL)
391 ERROR ("mysql plugin: Failed to connect to database %s "
393 (db->database != NULL) ? db->database : "<none>",
394 (db->host != NULL) ? db->host : "localhost",
395 mysql_error (db->con));
401 INFO ("mysql plugin: Successfully connected to database %s "
402 "at server %s (server version: %s, protocol version: %d)",
403 (db->database != NULL) ? db->database : "<none>",
404 mysql_get_host_info (db->con),
405 mysql_get_server_info (db->con),
406 mysql_get_proto_info (db->con));
410 } /* static MYSQL *getconnection (mysql_database_t *db) */
412 static void set_host (mysql_database_t *db, char *buf, size_t buflen)
414 /* XXX legacy mode - use hostname_g */
415 if (db->instance == NULL)
416 sstrncpy (buf, hostname_g, buflen);
419 if ((db->host == NULL)
420 || (strcmp ("", db->host) == 0)
421 || (strcmp ("localhost", db->host) == 0))
422 sstrncpy (buf, hostname_g, buflen);
424 sstrncpy (buf, db->host, buflen);
428 static void set_plugin_instance (mysql_database_t *db,
429 char *buf, size_t buflen)
431 /* XXX legacy mode - no plugin_instance */
432 if (db->instance == NULL)
433 sstrncpy (buf, "", buflen);
435 sstrncpy (buf, db->instance, buflen);
438 static void submit (const char *type, const char *type_instance,
439 value_t *values, size_t values_len, mysql_database_t *db)
441 value_list_t vl = VALUE_LIST_INIT;
444 vl.values_len = values_len;
446 set_host (db, vl.host, sizeof (vl.host));
448 sstrncpy (vl.plugin, "mysql", sizeof (vl.plugin));
449 set_plugin_instance (db, vl.plugin_instance, sizeof (vl.plugin_instance));
451 sstrncpy (vl.type, type, sizeof (vl.type));
452 if (type_instance != NULL)
453 sstrncpy (vl.type_instance, type_instance, sizeof (vl.type_instance));
455 plugin_dispatch_values (&vl);
458 static void counter_submit (const char *type, const char *type_instance,
459 counter_t value, mysql_database_t *db)
463 values[0].counter = value;
464 submit (type, type_instance, values, STATIC_ARRAY_SIZE (values), db);
465 } /* void counter_submit */
467 static void gauge_submit (const char *type, const char *type_instance,
468 gauge_t value, mysql_database_t *db)
472 values[0].gauge = value;
473 submit (type, type_instance, values, STATIC_ARRAY_SIZE (values), db);
474 } /* void gauge_submit */
476 static void qcache_submit (counter_t hits, counter_t inserts,
477 counter_t not_cached, counter_t lowmem_prunes,
478 gauge_t queries_in_cache, mysql_database_t *db)
482 values[0].counter = hits;
483 values[1].counter = inserts;
484 values[2].counter = not_cached;
485 values[3].counter = lowmem_prunes;
486 values[4].gauge = queries_in_cache;
488 submit ("mysql_qcache", NULL, values, STATIC_ARRAY_SIZE (values), db);
489 } /* void qcache_submit */
491 static void threads_submit (gauge_t running, gauge_t connected, gauge_t cached,
492 counter_t created, mysql_database_t *db)
496 values[0].gauge = running;
497 values[1].gauge = connected;
498 values[2].gauge = cached;
499 values[3].counter = created;
501 submit ("mysql_threads", NULL, values, STATIC_ARRAY_SIZE (values), db);
502 } /* void threads_submit */
504 static void traffic_submit (counter_t rx, counter_t tx, mysql_database_t *db)
508 values[0].counter = rx;
509 values[1].counter = tx;
511 submit ("mysql_octets", NULL, values, STATIC_ARRAY_SIZE (values), db);
512 } /* void traffic_submit */
514 static MYSQL_RES *exec_query (MYSQL *con, const char *query)
518 int query_len = strlen (query);
520 if (mysql_real_query (con, query, query_len))
522 ERROR ("mysql plugin: Failed to execute query: %s",
524 INFO ("mysql plugin: SQL query was: %s", query);
528 res = mysql_store_result (con);
531 ERROR ("mysql plugin: Failed to store query result: %s",
533 INFO ("mysql plugin: SQL query was: %s", query);
540 static int mysql_read_master_stats (mysql_database_t *db, MYSQL *con)
547 unsigned long long position;
549 query = "SHOW MASTER STATUS";
551 res = exec_query (con, query);
555 row = mysql_fetch_row (res);
558 ERROR ("mysql plugin: Failed to get master statistics: "
559 "`%s' did not return any rows.", query);
560 mysql_free_result (res);
564 field_num = mysql_num_fields (res);
567 ERROR ("mysql plugin: Failed to get master statistics: "
568 "`%s' returned less than two columns.", query);
569 mysql_free_result (res);
573 position = atoll (row[1]);
574 counter_submit ("mysql_log_position", "master-bin", position, db);
576 row = mysql_fetch_row (res);
578 WARNING ("mysql plugin: `%s' returned more than one row - "
579 "ignoring further results.", query);
581 mysql_free_result (res);
584 } /* mysql_read_master_stats */
586 static int mysql_read_slave_stats (mysql_database_t *db, MYSQL *con)
594 /* WTF? libmysqlclient does not seem to provide any means to
595 * translate a column name to a column index ... :-/ */
596 const int READ_MASTER_LOG_POS_IDX = 6;
597 const int SLAVE_IO_RUNNING_IDX = 10;
598 const int SLAVE_SQL_RUNNING_IDX = 11;
599 const int EXEC_MASTER_LOG_POS_IDX = 21;
600 const int SECONDS_BEHIND_MASTER_IDX = 32;
602 query = "SHOW SLAVE STATUS";
604 res = exec_query (con, query);
608 row = mysql_fetch_row (res);
611 ERROR ("mysql plugin: Failed to get slave statistics: "
612 "`%s' did not return any rows.", query);
613 mysql_free_result (res);
617 field_num = mysql_num_fields (res);
620 ERROR ("mysql plugin: Failed to get slave statistics: "
621 "`%s' returned less than 33 columns.", query);
622 mysql_free_result (res);
628 unsigned long long counter;
631 counter = atoll (row[READ_MASTER_LOG_POS_IDX]);
632 counter_submit ("mysql_log_position", "slave-read", counter, db);
634 counter = atoll (row[EXEC_MASTER_LOG_POS_IDX]);
635 counter_submit ("mysql_log_position", "slave-exec", counter, db);
637 if (row[SECONDS_BEHIND_MASTER_IDX] != NULL)
639 gauge = atof (row[SECONDS_BEHIND_MASTER_IDX]);
640 gauge_submit ("time_offset", NULL, gauge, db);
646 notification_t n = { 0, time (NULL), "", "",
647 "mysql", "", "time_offset", "", NULL };
651 io = row[SLAVE_IO_RUNNING_IDX];
652 sql = row[SLAVE_SQL_RUNNING_IDX];
654 set_host (db, n.host, sizeof (n.host));
655 set_plugin_instance (db,
656 n.plugin_instance, sizeof (n.plugin_instance));
658 if (((io == NULL) || (strcasecmp (io, "yes") != 0))
659 && (db->slave_io_running))
661 n.severity = NOTIF_WARNING;
662 ssnprintf (n.message, sizeof (n.message),
663 "slave I/O thread not started or not connected to master");
664 plugin_dispatch_notification (&n);
665 db->slave_io_running = 0;
667 else if (((io != NULL) && (strcasecmp (io, "yes") == 0))
668 && (! db->slave_io_running))
670 n.severity = NOTIF_OKAY;
671 ssnprintf (n.message, sizeof (n.message),
672 "slave I/O thread started and connected to master");
673 plugin_dispatch_notification (&n);
674 db->slave_io_running = 1;
677 if (((sql == NULL) || (strcasecmp (sql, "yes") != 0))
678 && (db->slave_sql_running))
680 n.severity = NOTIF_WARNING;
681 ssnprintf (n.message, sizeof (n.message),
682 "slave SQL thread not started");
683 plugin_dispatch_notification (&n);
684 db->slave_sql_running = 0;
686 else if (((sql != NULL) && (strcasecmp (sql, "yes") == 0))
687 && (! db->slave_sql_running))
689 n.severity = NOTIF_OKAY;
690 ssnprintf (n.message, sizeof (n.message),
691 "slave SQL thread started");
692 plugin_dispatch_notification (&n);
693 db->slave_sql_running = 0;
697 row = mysql_fetch_row (res);
699 WARNING ("mysql plugin: `%s' returned more than one row - "
700 "ignoring further results.", query);
702 mysql_free_result (res);
705 } /* mysql_read_slave_stats */
707 static int mysql_read (user_data_t *ud)
709 mysql_database_t *db;
715 unsigned long long qcache_hits = 0ULL;
716 unsigned long long qcache_inserts = 0ULL;
717 unsigned long long qcache_not_cached = 0ULL;
718 unsigned long long qcache_lowmem_prunes = 0ULL;
719 int qcache_queries_in_cache = -1;
721 int threads_running = -1;
722 int threads_connected = -1;
723 int threads_cached = -1;
724 unsigned long long threads_created = 0ULL;
726 unsigned long long traffic_incoming = 0ULL;
727 unsigned long long traffic_outgoing = 0ULL;
729 if ((ud == NULL) || (ud->data == NULL))
731 ERROR ("mysql plugin: mysql_database_read: Invalid user data.");
735 db = (mysql_database_t *) ud->data;
737 /* An error message will have been printed in this case */
738 if ((con = getconnection (db)) == NULL)
741 query = "SHOW STATUS";
742 if (mysql_get_server_version (con) >= 50002)
743 query = "SHOW GLOBAL STATUS";
745 res = exec_query (con, query);
749 while ((row = mysql_fetch_row (res)))
752 unsigned long long val;
755 val = atoll (row[1]);
757 if (strncmp (key, "Com_",
758 strlen ("Com_")) == 0)
763 /* Ignore `prepared statements' */
764 if (strncmp (key, "Com_stmt_", strlen ("Com_stmt_")) != 0)
765 counter_submit ("mysql_commands",
766 key + strlen ("Com_"),
769 else if (strncmp (key, "Handler_",
770 strlen ("Handler_")) == 0)
775 counter_submit ("mysql_handler",
776 key + strlen ("Handler_"),
779 else if (strncmp (key, "Qcache_",
780 strlen ("Qcache_")) == 0)
782 if (strcmp (key, "Qcache_hits") == 0)
784 else if (strcmp (key, "Qcache_inserts") == 0)
785 qcache_inserts = val;
786 else if (strcmp (key, "Qcache_not_cached") == 0)
787 qcache_not_cached = val;
788 else if (strcmp (key, "Qcache_lowmem_prunes") == 0)
789 qcache_lowmem_prunes = val;
790 else if (strcmp (key, "Qcache_queries_in_cache") == 0)
791 qcache_queries_in_cache = (int) val;
793 else if (strncmp (key, "Bytes_",
794 strlen ("Bytes_")) == 0)
796 if (strcmp (key, "Bytes_received") == 0)
797 traffic_incoming += val;
798 else if (strcmp (key, "Bytes_sent") == 0)
799 traffic_outgoing += val;
801 else if (strncmp (key, "Threads_",
802 strlen ("Threads_")) == 0)
804 if (strcmp (key, "Threads_running") == 0)
805 threads_running = (int) val;
806 else if (strcmp (key, "Threads_connected") == 0)
807 threads_connected = (int) val;
808 else if (strcmp (key, "Threads_cached") == 0)
809 threads_cached = (int) val;
810 else if (strcmp (key, "Threads_created") == 0)
811 threads_created = val;
813 else if (strncmp (key, "Table_locks_",
814 strlen ("Table_locks_")) == 0)
816 counter_submit ("mysql_locks",
817 key + strlen ("Table_locks_"),
821 mysql_free_result (res); res = NULL;
823 if ((qcache_hits != 0ULL)
824 || (qcache_inserts != 0ULL)
825 || (qcache_not_cached != 0ULL)
826 || (qcache_lowmem_prunes != 0ULL))
827 qcache_submit (qcache_hits, qcache_inserts, qcache_not_cached,
828 qcache_lowmem_prunes, qcache_queries_in_cache, db);
830 if (threads_created != 0ULL)
831 threads_submit (threads_running, threads_connected,
832 threads_cached, threads_created, db);
834 traffic_submit (traffic_incoming, traffic_outgoing, db);
836 if (db->master_stats)
837 mysql_read_master_stats (db, con);
839 if ((db->slave_stats) || (db->slave_notif))
840 mysql_read_slave_stats (db, con);
843 } /* int mysql_read */
845 void module_register (void)
847 plugin_register_complex_config ("mysql", mysql_config);
848 } /* void module_register */