2 * collectd - src/mysql.c
3 * Copyright (C) 2006-2010 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 collectd.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 /* {{{ */
57 _Bool slave_io_running;
58 _Bool slave_sql_running;
63 typedef struct mysql_database_s mysql_database_t; /* }}} */
65 static int mysql_read (user_data_t *ud);
67 static void mysql_database_free (void *arg) /* {{{ */
71 DEBUG ("mysql plugin: mysql_database_free (arg = %p);", arg);
73 db = (mysql_database_t *) arg;
79 mysql_close (db->con);
88 } /* }}} void mysql_database_free */
90 /* Configuration handling functions {{{
93 * <Database "plugin_instance1">
100 static int mysql_config_database (oconfig_item_t *ci) /* {{{ */
102 mysql_database_t *db;
106 if ((ci->values_num != 1)
107 || (ci->values[0].type != OCONFIG_TYPE_STRING))
109 WARNING ("mysql plugin: The `Database' block "
110 "needs exactly one string argument.");
114 db = (mysql_database_t *) malloc (sizeof (*db));
117 ERROR ("mysql plugin: malloc failed.");
120 memset (db, 0, sizeof (*db));
122 /* initialize all the pointers */
130 /* trigger a notification, if it's not running */
131 db->slave_io_running = 1;
132 db->slave_sql_running = 1;
134 status = cf_util_get_string (ci, &db->instance);
140 assert (db->instance != NULL);
142 /* Fill the `mysql_database_t' structure.. */
143 for (i = 0; i < ci->children_num; i++)
145 oconfig_item_t *child = ci->children + i;
147 if (strcasecmp ("Host", child->key) == 0)
148 status = cf_util_get_string (child, &db->host);
149 else if (strcasecmp ("User", child->key) == 0)
150 status = cf_util_get_string (child, &db->user);
151 else if (strcasecmp ("Password", child->key) == 0)
152 status = cf_util_get_string (child, &db->pass);
153 else if (strcasecmp ("Port", child->key) == 0)
155 status = cf_util_get_port_number (child);
162 else if (strcasecmp ("Socket", child->key) == 0)
163 status = cf_util_get_string (child, &db->socket);
164 else if (strcasecmp ("Database", child->key) == 0)
165 status = cf_util_get_string (child, &db->database);
166 else if (strcasecmp ("MasterStats", child->key) == 0)
167 status = cf_util_get_boolean (child, &db->master_stats);
168 else if (strcasecmp ("SlaveStats", child->key) == 0)
169 status = cf_util_get_boolean (child, &db->slave_stats);
170 else if (strcasecmp ("SlaveNotifications", child->key) == 0)
171 status = cf_util_get_boolean (child, &db->slave_notif);
174 WARNING ("mysql plugin: Option `%s' not allowed here.", child->key);
182 /* If all went well, register this database for reading */
186 char cb_name[DATA_MAX_NAME_LEN];
188 DEBUG ("mysql plugin: Registering new read callback: %s",
189 (db->database != NULL) ? db->database : "<default>");
191 memset (&ud, 0, sizeof (ud));
192 ud.data = (void *) db;
193 ud.free_func = mysql_database_free;
195 if (db->database != NULL)
196 ssnprintf (cb_name, sizeof (cb_name), "mysql-%s",
199 sstrncpy (cb_name, "mysql", sizeof (cb_name));
201 plugin_register_complex_read (/* group = */ NULL, cb_name,
203 /* interval = */ NULL, &ud);
207 mysql_database_free (db);
212 } /* }}} int mysql_config_database */
214 static int mysql_config (oconfig_item_t *ci) /* {{{ */
221 /* Fill the `mysql_database_t' structure.. */
222 for (i = 0; i < ci->children_num; i++)
224 oconfig_item_t *child = ci->children + i;
226 if (strcasecmp ("Database", child->key) == 0)
227 mysql_config_database (child);
229 WARNING ("mysql plugin: Option \"%s\" not allowed here.",
234 } /* }}} int mysql_config */
236 /* }}} End of configuration handling functions */
238 static MYSQL *getconnection (mysql_database_t *db)
243 if ((err = mysql_ping (db->con)) != 0)
245 /* Assured by "mysql_config_database" */
246 assert (db->instance != NULL);
247 WARNING ("mysql_ping failed for instance \"%s\": %s",
249 mysql_error (db->con));
259 if ((db->con = mysql_init (db->con)) == NULL)
261 ERROR ("mysql_init failed: %s", mysql_error (db->con));
266 if (mysql_real_connect (db->con, db->host, db->user, db->pass,
267 db->database, db->port, db->socket, 0) == NULL)
269 ERROR ("mysql plugin: Failed to connect to database %s "
271 (db->database != NULL) ? db->database : "<none>",
272 (db->host != NULL) ? db->host : "localhost",
273 mysql_error (db->con));
279 INFO ("mysql plugin: Successfully connected to database %s "
280 "at server %s (server version: %s, protocol version: %d)",
281 (db->database != NULL) ? db->database : "<none>",
282 mysql_get_host_info (db->con),
283 mysql_get_server_info (db->con),
284 mysql_get_proto_info (db->con));
288 } /* static MYSQL *getconnection (mysql_database_t *db) */
290 static void set_host (mysql_database_t *db, char *buf, size_t buflen)
292 if ((db->host == NULL)
293 || (strcmp ("", db->host) == 0)
294 || (strcmp ("localhost", db->host) == 0))
295 sstrncpy (buf, hostname_g, buflen);
297 sstrncpy (buf, db->host, buflen);
298 } /* void set_host */
300 static void submit (const char *type, const char *type_instance,
301 value_t *values, size_t values_len, mysql_database_t *db)
303 value_list_t vl = VALUE_LIST_INIT;
306 vl.values_len = values_len;
308 set_host (db, vl.host, sizeof (vl.host));
310 sstrncpy (vl.plugin, "mysql", sizeof (vl.plugin));
312 /* Assured by "mysql_config_database" */
313 assert (db->instance != NULL);
314 sstrncpy (vl.plugin_instance, db->instance, sizeof (vl.plugin_instance));
316 sstrncpy (vl.type, type, sizeof (vl.type));
317 if (type_instance != NULL)
318 sstrncpy (vl.type_instance, type_instance, sizeof (vl.type_instance));
320 plugin_dispatch_values (&vl);
323 static void counter_submit (const char *type, const char *type_instance,
324 derive_t value, mysql_database_t *db)
328 values[0].derive = value;
329 submit (type, type_instance, values, STATIC_ARRAY_SIZE (values), db);
330 } /* void counter_submit */
332 static void gauge_submit (const char *type, const char *type_instance,
333 gauge_t value, mysql_database_t *db)
337 values[0].gauge = value;
338 submit (type, type_instance, values, STATIC_ARRAY_SIZE (values), db);
339 } /* void gauge_submit */
341 static void derive_submit (const char *type, const char *type_instance,
342 derive_t value, mysql_database_t *db)
346 values[0].derive = value;
347 submit (type, type_instance, values, STATIC_ARRAY_SIZE (values), db);
348 } /* void derive_submit */
350 static void traffic_submit (derive_t rx, derive_t tx, mysql_database_t *db)
354 values[0].derive = rx;
355 values[1].derive = tx;
357 submit ("mysql_octets", NULL, values, STATIC_ARRAY_SIZE (values), db);
358 } /* void traffic_submit */
360 static MYSQL_RES *exec_query (MYSQL *con, const char *query)
364 int query_len = strlen (query);
366 if (mysql_real_query (con, query, query_len))
368 ERROR ("mysql plugin: Failed to execute query: %s",
370 INFO ("mysql plugin: SQL query was: %s", query);
374 res = mysql_store_result (con);
377 ERROR ("mysql plugin: Failed to store query result: %s",
379 INFO ("mysql plugin: SQL query was: %s", query);
386 static int mysql_read_master_stats (mysql_database_t *db, MYSQL *con)
393 unsigned long long position;
395 query = "SHOW MASTER STATUS";
397 res = exec_query (con, query);
401 row = mysql_fetch_row (res);
404 ERROR ("mysql plugin: Failed to get master statistics: "
405 "`%s' did not return any rows.", query);
409 field_num = mysql_num_fields (res);
412 ERROR ("mysql plugin: Failed to get master statistics: "
413 "`%s' returned less than two columns.", query);
417 position = atoll (row[1]);
418 counter_submit ("mysql_log_position", "master-bin", position, db);
420 row = mysql_fetch_row (res);
422 WARNING ("mysql plugin: `%s' returned more than one row - "
423 "ignoring further results.", query);
425 mysql_free_result (res);
428 } /* mysql_read_master_stats */
430 static int mysql_read_slave_stats (mysql_database_t *db, MYSQL *con)
438 /* WTF? libmysqlclient does not seem to provide any means to
439 * translate a column name to a column index ... :-/ */
440 const int READ_MASTER_LOG_POS_IDX = 6;
441 const int SLAVE_IO_RUNNING_IDX = 10;
442 const int SLAVE_SQL_RUNNING_IDX = 11;
443 const int EXEC_MASTER_LOG_POS_IDX = 21;
444 const int SECONDS_BEHIND_MASTER_IDX = 32;
446 query = "SHOW SLAVE STATUS";
448 res = exec_query (con, query);
452 row = mysql_fetch_row (res);
455 ERROR ("mysql plugin: Failed to get slave statistics: "
456 "`%s' did not return any rows.", query);
460 field_num = mysql_num_fields (res);
463 ERROR ("mysql plugin: Failed to get slave statistics: "
464 "`%s' returned less than 33 columns.", query);
470 unsigned long long counter;
473 counter = atoll (row[READ_MASTER_LOG_POS_IDX]);
474 counter_submit ("mysql_log_position", "slave-read", counter, db);
476 counter = atoll (row[EXEC_MASTER_LOG_POS_IDX]);
477 counter_submit ("mysql_log_position", "slave-exec", counter, db);
479 if (row[SECONDS_BEHIND_MASTER_IDX] != NULL)
481 gauge = atof (row[SECONDS_BEHIND_MASTER_IDX]);
482 gauge_submit ("time_offset", NULL, gauge, db);
488 notification_t n = { 0, cdtime (), "", "",
489 "mysql", "", "time_offset", "", NULL };
493 io = row[SLAVE_IO_RUNNING_IDX];
494 sql = row[SLAVE_SQL_RUNNING_IDX];
496 set_host (db, n.host, sizeof (n.host));
498 /* Assured by "mysql_config_database" */
499 assert (db->instance != NULL);
500 sstrncpy (n.plugin_instance, db->instance, sizeof (n.plugin_instance));
502 if (((io == NULL) || (strcasecmp (io, "yes") != 0))
503 && (db->slave_io_running))
505 n.severity = NOTIF_WARNING;
506 ssnprintf (n.message, sizeof (n.message),
507 "slave I/O thread not started or not connected to master");
508 plugin_dispatch_notification (&n);
509 db->slave_io_running = 0;
511 else if (((io != NULL) && (strcasecmp (io, "yes") == 0))
512 && (! db->slave_io_running))
514 n.severity = NOTIF_OKAY;
515 ssnprintf (n.message, sizeof (n.message),
516 "slave I/O thread started and connected to master");
517 plugin_dispatch_notification (&n);
518 db->slave_io_running = 1;
521 if (((sql == NULL) || (strcasecmp (sql, "yes") != 0))
522 && (db->slave_sql_running))
524 n.severity = NOTIF_WARNING;
525 ssnprintf (n.message, sizeof (n.message),
526 "slave SQL thread not started");
527 plugin_dispatch_notification (&n);
528 db->slave_sql_running = 0;
530 else if (((sql != NULL) && (strcasecmp (sql, "yes") == 0))
531 && (! db->slave_sql_running))
533 n.severity = NOTIF_OKAY;
534 ssnprintf (n.message, sizeof (n.message),
535 "slave SQL thread started");
536 plugin_dispatch_notification (&n);
537 db->slave_sql_running = 0;
541 row = mysql_fetch_row (res);
543 WARNING ("mysql plugin: `%s' returned more than one row - "
544 "ignoring further results.", query);
546 mysql_free_result (res);
549 } /* mysql_read_slave_stats */
551 static int mysql_read (user_data_t *ud)
553 mysql_database_t *db;
559 derive_t qcache_hits = 0;
560 derive_t qcache_inserts = 0;
561 derive_t qcache_not_cached = 0;
562 derive_t qcache_lowmem_prunes = 0;
563 gauge_t qcache_queries_in_cache = NAN;
565 gauge_t threads_running = NAN;
566 gauge_t threads_connected = NAN;
567 gauge_t threads_cached = NAN;
568 derive_t threads_created = 0;
570 unsigned long long traffic_incoming = 0ULL;
571 unsigned long long traffic_outgoing = 0ULL;
573 if ((ud == NULL) || (ud->data == NULL))
575 ERROR ("mysql plugin: mysql_database_read: Invalid user data.");
579 db = (mysql_database_t *) ud->data;
581 /* An error message will have been printed in this case */
582 if ((con = getconnection (db)) == NULL)
585 query = "SHOW STATUS";
586 if (mysql_get_server_version (con) >= 50002)
587 query = "SHOW GLOBAL STATUS";
589 res = exec_query (con, query);
593 while ((row = mysql_fetch_row (res)))
596 unsigned long long val;
599 val = atoll (row[1]);
601 if (strncmp (key, "Com_",
602 strlen ("Com_")) == 0)
607 /* Ignore `prepared statements' */
608 if (strncmp (key, "Com_stmt_", strlen ("Com_stmt_")) != 0)
609 counter_submit ("mysql_commands",
610 key + strlen ("Com_"),
613 else if (strncmp (key, "Handler_",
614 strlen ("Handler_")) == 0)
619 counter_submit ("mysql_handler",
620 key + strlen ("Handler_"),
623 else if (strncmp (key, "Qcache_",
624 strlen ("Qcache_")) == 0)
626 if (strcmp (key, "Qcache_hits") == 0)
627 qcache_hits = (derive_t) val;
628 else if (strcmp (key, "Qcache_inserts") == 0)
629 qcache_inserts = (derive_t) val;
630 else if (strcmp (key, "Qcache_not_cached") == 0)
631 qcache_not_cached = (derive_t) val;
632 else if (strcmp (key, "Qcache_lowmem_prunes") == 0)
633 qcache_lowmem_prunes = (derive_t) val;
634 else if (strcmp (key, "Qcache_queries_in_cache") == 0)
635 qcache_queries_in_cache = (gauge_t) val;
637 else if (strncmp (key, "Bytes_",
638 strlen ("Bytes_")) == 0)
640 if (strcmp (key, "Bytes_received") == 0)
641 traffic_incoming += val;
642 else if (strcmp (key, "Bytes_sent") == 0)
643 traffic_outgoing += val;
645 else if (strncmp (key, "Threads_",
646 strlen ("Threads_")) == 0)
648 if (strcmp (key, "Threads_running") == 0)
649 threads_running = (gauge_t) val;
650 else if (strcmp (key, "Threads_connected") == 0)
651 threads_connected = (gauge_t) val;
652 else if (strcmp (key, "Threads_cached") == 0)
653 threads_cached = (gauge_t) val;
654 else if (strcmp (key, "Threads_created") == 0)
655 threads_created = (derive_t) val;
657 else if (strncmp (key, "Table_locks_",
658 strlen ("Table_locks_")) == 0)
660 counter_submit ("mysql_locks",
661 key + strlen ("Table_locks_"),
665 mysql_free_result (res); res = NULL;
667 if ((qcache_hits != 0)
668 || (qcache_inserts != 0)
669 || (qcache_not_cached != 0)
670 || (qcache_lowmem_prunes != 0))
672 derive_submit ("cache_result", "qcache-hits",
674 derive_submit ("cache_result", "qcache-inserts",
676 derive_submit ("cache_result", "qcache-not_cached",
677 qcache_not_cached, db);
678 derive_submit ("cache_result", "qcache-prunes",
679 qcache_lowmem_prunes, db);
681 gauge_submit ("cache_size", "qcache",
682 qcache_queries_in_cache, db);
685 if (threads_created != 0)
687 gauge_submit ("threads", "running",
688 threads_running, db);
689 gauge_submit ("threads", "connected",
690 threads_connected, db);
691 gauge_submit ("threads", "cached",
694 derive_submit ("total_threads", "created",
695 threads_created, db);
698 traffic_submit (traffic_incoming, traffic_outgoing, db);
700 if (db->master_stats)
701 mysql_read_master_stats (db, con);
703 if ((db->slave_stats) || (db->slave_notif))
704 mysql_read_slave_stats (db, con);
707 } /* int mysql_read */
709 void module_register (void)
711 plugin_register_complex_config ("mysql", mysql_config);
712 } /* void module_register */