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->instance != 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)
240 if (db->is_connected)
244 status = mysql_ping (db->con);
248 WARNING ("mysql plugin: Lost connection to instance \"%s\": %s",
249 db->instance, mysql_error (db->con));
251 db->is_connected = 0;
255 db->con = mysql_init (NULL);
258 ERROR ("mysql plugin: mysql_init failed: %s",
259 mysql_error (db->con));
264 if (mysql_real_connect (db->con, db->host, db->user, db->pass,
265 db->database, db->port, db->socket, 0) == NULL)
267 ERROR ("mysql plugin: Failed to connect to database %s "
269 (db->database != NULL) ? db->database : "<none>",
270 (db->host != NULL) ? db->host : "localhost",
271 mysql_error (db->con));
275 INFO ("mysql plugin: Successfully connected to database %s "
276 "at server %s (server version: %s, protocol version: %d)",
277 (db->database != NULL) ? db->database : "<none>",
278 mysql_get_host_info (db->con),
279 mysql_get_server_info (db->con),
280 mysql_get_proto_info (db->con));
282 db->is_connected = 1;
284 } /* static MYSQL *getconnection (mysql_database_t *db) */
286 static void set_host (mysql_database_t *db, char *buf, size_t buflen)
288 if ((db->host == NULL)
289 || (strcmp ("", db->host) == 0)
290 || (strcmp ("127.0.0.1", db->host) == 0)
291 || (strcmp ("localhost", db->host) == 0))
292 sstrncpy (buf, hostname_g, buflen);
294 sstrncpy (buf, db->host, buflen);
295 } /* void set_host */
297 static void submit (const char *type, const char *type_instance,
298 value_t *values, size_t values_len, mysql_database_t *db)
300 value_list_t vl = VALUE_LIST_INIT;
303 vl.values_len = values_len;
305 set_host (db, vl.host, sizeof (vl.host));
307 sstrncpy (vl.plugin, "mysql", sizeof (vl.plugin));
309 /* Assured by "mysql_config_database" */
310 assert (db->instance != NULL);
311 sstrncpy (vl.plugin_instance, db->instance, sizeof (vl.plugin_instance));
313 sstrncpy (vl.type, type, sizeof (vl.type));
314 if (type_instance != NULL)
315 sstrncpy (vl.type_instance, type_instance, sizeof (vl.type_instance));
317 plugin_dispatch_values (&vl);
320 static void counter_submit (const char *type, const char *type_instance,
321 derive_t value, mysql_database_t *db)
325 values[0].derive = value;
326 submit (type, type_instance, values, STATIC_ARRAY_SIZE (values), db);
327 } /* void counter_submit */
329 static void gauge_submit (const char *type, const char *type_instance,
330 gauge_t value, mysql_database_t *db)
334 values[0].gauge = value;
335 submit (type, type_instance, values, STATIC_ARRAY_SIZE (values), db);
336 } /* void gauge_submit */
338 static void derive_submit (const char *type, const char *type_instance,
339 derive_t value, mysql_database_t *db)
343 values[0].derive = value;
344 submit (type, type_instance, values, STATIC_ARRAY_SIZE (values), db);
345 } /* void derive_submit */
347 static void traffic_submit (derive_t rx, derive_t tx, mysql_database_t *db)
351 values[0].derive = rx;
352 values[1].derive = tx;
354 submit ("mysql_octets", NULL, values, STATIC_ARRAY_SIZE (values), db);
355 } /* void traffic_submit */
357 static MYSQL_RES *exec_query (MYSQL *con, const char *query)
361 int query_len = strlen (query);
363 if (mysql_real_query (con, query, query_len))
365 ERROR ("mysql plugin: Failed to execute query: %s",
367 INFO ("mysql plugin: SQL query was: %s", query);
371 res = mysql_store_result (con);
374 ERROR ("mysql plugin: Failed to store query result: %s",
376 INFO ("mysql plugin: SQL query was: %s", query);
383 static int mysql_read_master_stats (mysql_database_t *db, MYSQL *con)
390 unsigned long long position;
392 query = "SHOW MASTER STATUS";
394 res = exec_query (con, query);
398 row = mysql_fetch_row (res);
401 ERROR ("mysql plugin: Failed to get master statistics: "
402 "`%s' did not return any rows.", query);
403 mysql_free_result (res);
407 field_num = mysql_num_fields (res);
410 ERROR ("mysql plugin: Failed to get master statistics: "
411 "`%s' returned less than two columns.", query);
412 mysql_free_result (res);
416 position = atoll (row[1]);
417 counter_submit ("mysql_log_position", "master-bin", position, db);
419 row = mysql_fetch_row (res);
421 WARNING ("mysql plugin: `%s' returned more than one row - "
422 "ignoring further results.", query);
424 mysql_free_result (res);
427 } /* mysql_read_master_stats */
429 static int mysql_read_slave_stats (mysql_database_t *db, MYSQL *con)
437 /* WTF? libmysqlclient does not seem to provide any means to
438 * translate a column name to a column index ... :-/ */
439 const int READ_MASTER_LOG_POS_IDX = 6;
440 const int SLAVE_IO_RUNNING_IDX = 10;
441 const int SLAVE_SQL_RUNNING_IDX = 11;
442 const int EXEC_MASTER_LOG_POS_IDX = 21;
443 const int SECONDS_BEHIND_MASTER_IDX = 32;
445 query = "SHOW SLAVE STATUS";
447 res = exec_query (con, query);
451 row = mysql_fetch_row (res);
454 ERROR ("mysql plugin: Failed to get slave statistics: "
455 "`%s' did not return any rows.", query);
456 mysql_free_result (res);
460 field_num = mysql_num_fields (res);
463 ERROR ("mysql plugin: Failed to get slave statistics: "
464 "`%s' returned less than 33 columns.", query);
465 mysql_free_result (res);
471 unsigned long long counter;
474 counter = atoll (row[READ_MASTER_LOG_POS_IDX]);
475 counter_submit ("mysql_log_position", "slave-read", counter, db);
477 counter = atoll (row[EXEC_MASTER_LOG_POS_IDX]);
478 counter_submit ("mysql_log_position", "slave-exec", counter, db);
480 if (row[SECONDS_BEHIND_MASTER_IDX] != NULL)
482 gauge = atof (row[SECONDS_BEHIND_MASTER_IDX]);
483 gauge_submit ("time_offset", NULL, gauge, db);
489 notification_t n = { 0, cdtime (), "", "",
490 "mysql", "", "time_offset", "", NULL };
494 io = row[SLAVE_IO_RUNNING_IDX];
495 sql = row[SLAVE_SQL_RUNNING_IDX];
497 set_host (db, n.host, sizeof (n.host));
499 /* Assured by "mysql_config_database" */
500 assert (db->instance != NULL);
501 sstrncpy (n.plugin_instance, db->instance, sizeof (n.plugin_instance));
503 if (((io == NULL) || (strcasecmp (io, "yes") != 0))
504 && (db->slave_io_running))
506 n.severity = NOTIF_WARNING;
507 ssnprintf (n.message, sizeof (n.message),
508 "slave I/O thread not started or not connected to master");
509 plugin_dispatch_notification (&n);
510 db->slave_io_running = 0;
512 else if (((io != NULL) && (strcasecmp (io, "yes") == 0))
513 && (! db->slave_io_running))
515 n.severity = NOTIF_OKAY;
516 ssnprintf (n.message, sizeof (n.message),
517 "slave I/O thread started and connected to master");
518 plugin_dispatch_notification (&n);
519 db->slave_io_running = 1;
522 if (((sql == NULL) || (strcasecmp (sql, "yes") != 0))
523 && (db->slave_sql_running))
525 n.severity = NOTIF_WARNING;
526 ssnprintf (n.message, sizeof (n.message),
527 "slave SQL thread not started");
528 plugin_dispatch_notification (&n);
529 db->slave_sql_running = 0;
531 else if (((sql != NULL) && (strcasecmp (sql, "yes") == 0))
532 && (! db->slave_sql_running))
534 n.severity = NOTIF_OKAY;
535 ssnprintf (n.message, sizeof (n.message),
536 "slave SQL thread started");
537 plugin_dispatch_notification (&n);
538 db->slave_sql_running = 1;
542 row = mysql_fetch_row (res);
544 WARNING ("mysql plugin: `%s' returned more than one row - "
545 "ignoring further results.", query);
547 mysql_free_result (res);
550 } /* mysql_read_slave_stats */
552 static int mysql_read (user_data_t *ud)
554 mysql_database_t *db;
560 derive_t qcache_hits = 0;
561 derive_t qcache_inserts = 0;
562 derive_t qcache_not_cached = 0;
563 derive_t qcache_lowmem_prunes = 0;
564 gauge_t qcache_queries_in_cache = NAN;
566 gauge_t threads_running = NAN;
567 gauge_t threads_connected = NAN;
568 gauge_t threads_cached = NAN;
569 derive_t threads_created = 0;
571 unsigned long long traffic_incoming = 0ULL;
572 unsigned long long traffic_outgoing = 0ULL;
574 if ((ud == NULL) || (ud->data == NULL))
576 ERROR ("mysql plugin: mysql_database_read: Invalid user data.");
580 db = (mysql_database_t *) ud->data;
582 /* An error message will have been printed in this case */
583 if ((con = getconnection (db)) == NULL)
586 query = "SHOW STATUS";
587 if (mysql_get_server_version (con) >= 50002)
588 query = "SHOW GLOBAL STATUS";
590 res = exec_query (con, query);
594 while ((row = mysql_fetch_row (res)))
597 unsigned long long val;
600 val = atoll (row[1]);
602 if (strncmp (key, "Com_",
603 strlen ("Com_")) == 0)
608 /* Ignore `prepared statements' */
609 if (strncmp (key, "Com_stmt_", strlen ("Com_stmt_")) != 0)
610 counter_submit ("mysql_commands",
611 key + strlen ("Com_"),
614 else if (strncmp (key, "Handler_",
615 strlen ("Handler_")) == 0)
620 counter_submit ("mysql_handler",
621 key + strlen ("Handler_"),
624 else if (strncmp (key, "Qcache_",
625 strlen ("Qcache_")) == 0)
627 if (strcmp (key, "Qcache_hits") == 0)
628 qcache_hits = (derive_t) val;
629 else if (strcmp (key, "Qcache_inserts") == 0)
630 qcache_inserts = (derive_t) val;
631 else if (strcmp (key, "Qcache_not_cached") == 0)
632 qcache_not_cached = (derive_t) val;
633 else if (strcmp (key, "Qcache_lowmem_prunes") == 0)
634 qcache_lowmem_prunes = (derive_t) val;
635 else if (strcmp (key, "Qcache_queries_in_cache") == 0)
636 qcache_queries_in_cache = (gauge_t) val;
638 else if (strncmp (key, "Bytes_",
639 strlen ("Bytes_")) == 0)
641 if (strcmp (key, "Bytes_received") == 0)
642 traffic_incoming += val;
643 else if (strcmp (key, "Bytes_sent") == 0)
644 traffic_outgoing += val;
646 else if (strncmp (key, "Threads_",
647 strlen ("Threads_")) == 0)
649 if (strcmp (key, "Threads_running") == 0)
650 threads_running = (gauge_t) val;
651 else if (strcmp (key, "Threads_connected") == 0)
652 threads_connected = (gauge_t) val;
653 else if (strcmp (key, "Threads_cached") == 0)
654 threads_cached = (gauge_t) val;
655 else if (strcmp (key, "Threads_created") == 0)
656 threads_created = (derive_t) val;
658 else if (strncmp (key, "Table_locks_",
659 strlen ("Table_locks_")) == 0)
661 counter_submit ("mysql_locks",
662 key + strlen ("Table_locks_"),
666 mysql_free_result (res); res = NULL;
668 if ((qcache_hits != 0)
669 || (qcache_inserts != 0)
670 || (qcache_not_cached != 0)
671 || (qcache_lowmem_prunes != 0))
673 derive_submit ("cache_result", "qcache-hits",
675 derive_submit ("cache_result", "qcache-inserts",
677 derive_submit ("cache_result", "qcache-not_cached",
678 qcache_not_cached, db);
679 derive_submit ("cache_result", "qcache-prunes",
680 qcache_lowmem_prunes, db);
682 gauge_submit ("cache_size", "qcache",
683 qcache_queries_in_cache, db);
686 if (threads_created != 0)
688 gauge_submit ("threads", "running",
689 threads_running, db);
690 gauge_submit ("threads", "connected",
691 threads_connected, db);
692 gauge_submit ("threads", "cached",
695 derive_submit ("total_threads", "created",
696 threads_created, db);
699 traffic_submit (traffic_incoming, traffic_outgoing, db);
701 if (db->master_stats)
702 mysql_read_master_stats (db, con);
704 if ((db->slave_stats) || (db->slave_notif))
705 mysql_read_slave_stats (db, con);
708 } /* int mysql_read */
710 void module_register (void)
712 plugin_register_complex_config ("mysql", mysql_config);
713 } /* void module_register */