Various plugins: Convert more plugins to use "derive" instead of "counter".
[collectd.git] / src / mysql.c
1 /**
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
8  *
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.
12  *
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.
17  *
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
21  *
22  * Authors:
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>
28  **/
29
30 #include "collectd.h"
31 #include "common.h"
32 #include "plugin.h"
33 #include "configfile.h"
34
35 #ifdef HAVE_MYSQL_H
36 #include <mysql.h>
37 #elif defined(HAVE_MYSQL_MYSQL_H)
38 #include <mysql/mysql.h>
39 #endif
40
41 /* TODO: Understand `Select_*' and possibly do that stuff as well.. */
42
43 struct mysql_database_s /* {{{ */
44 {
45         char *instance;
46         char *host;
47         char *user;
48         char *pass;
49         char *database;
50         char *socket;
51         int   port;
52
53         _Bool master_stats;
54         _Bool slave_stats;
55
56         _Bool slave_notif;
57         _Bool slave_io_running;
58         _Bool slave_sql_running;
59
60         MYSQL *con;
61         int    state;
62 };
63 typedef struct mysql_database_s mysql_database_t; /* }}} */
64
65 static int mysql_read (user_data_t *ud);
66
67 static void mysql_database_free (void *arg) /* {{{ */
68 {
69         mysql_database_t *db;
70
71         DEBUG ("mysql plugin: mysql_database_free (arg = %p);", arg);
72
73         db = (mysql_database_t *) arg;
74
75         if (db == NULL)
76                 return;
77
78         if (db->con != NULL)
79                 mysql_close (db->con);
80
81         sfree (db->host);
82         sfree (db->user);
83         sfree (db->pass);
84         sfree (db->socket);
85         sfree (db->instance);
86         sfree (db->database);
87         sfree (db);
88 } /* }}} void mysql_database_free */
89
90 /* Configuration handling functions {{{
91  *
92  * <Plugin mysql>
93  *   <Database "plugin_instance1">
94  *     Host "localhost"
95  *     Port 22000
96  *     ...
97  *   </Database>
98  * </Plugin>
99  */
100 static int mysql_config_database (oconfig_item_t *ci) /* {{{ */
101 {
102         mysql_database_t *db;
103         int status = 0;
104         int i;
105
106         if ((ci->values_num != 1)
107             || (ci->values[0].type != OCONFIG_TYPE_STRING))
108         {
109                 WARNING ("mysql plugin: The `Database' block "
110                          "needs exactly one string argument.");
111                 return (-1);
112         }
113
114         db = (mysql_database_t *) malloc (sizeof (*db));
115         if (db == NULL)
116         {
117                 ERROR ("mysql plugin: malloc failed.");
118                 return (-1);
119         }
120         memset (db, 0, sizeof (*db));
121
122         /* initialize all the pointers */
123         db->host     = NULL;
124         db->user     = NULL;
125         db->pass     = NULL;
126         db->database = NULL;
127         db->socket   = NULL;
128         db->con      = NULL;
129
130         /* trigger a notification, if it's not running */
131         db->slave_io_running  = 1;
132         db->slave_sql_running = 1;
133
134         status = cf_util_get_string (ci, &db->instance);
135         if (status != 0)
136         {
137                 sfree (db);
138                 return (status);
139         }
140         assert (db->instance != NULL);
141
142         /* Fill the `mysql_database_t' structure.. */
143         for (i = 0; i < ci->children_num; i++)
144         {
145                 oconfig_item_t *child = ci->children + i;
146
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)
154                 {
155                         status = cf_util_get_port_number (child);
156                         if (status > 0)
157                         {
158                                 db->port = status;
159                                 status = 0;
160                         }
161                 }
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);
172                 else
173                 {
174                         WARNING ("mysql plugin: Option `%s' not allowed here.", child->key);
175                         status = -1;
176                 }
177
178                 if (status != 0)
179                         break;
180         }
181
182         /* If all went well, register this database for reading */
183         if (status == 0)
184         {
185                 user_data_t ud;
186                 char cb_name[DATA_MAX_NAME_LEN];
187
188                 DEBUG ("mysql plugin: Registering new read callback: %s",
189                                 (db->database != NULL) ? db->database : "<default>");
190
191                 memset (&ud, 0, sizeof (ud));
192                 ud.data = (void *) db;
193                 ud.free_func = mysql_database_free;
194
195                 if (db->database != NULL)
196                         ssnprintf (cb_name, sizeof (cb_name), "mysql-%s",
197                                         db->database);
198                 else
199                         sstrncpy (cb_name, "mysql", sizeof (cb_name));
200
201                 plugin_register_complex_read (/* group = */ NULL, cb_name,
202                                               mysql_read,
203                                               /* interval = */ NULL, &ud);
204         }
205         else
206         {
207                 mysql_database_free (db);
208                 return (-1);
209         }
210
211         return (0);
212 } /* }}} int mysql_config_database */
213
214 static int mysql_config (oconfig_item_t *ci) /* {{{ */
215 {
216         int i;
217
218         if (ci == NULL)
219                 return (EINVAL);
220
221         /* Fill the `mysql_database_t' structure.. */
222         for (i = 0; i < ci->children_num; i++)
223         {
224                 oconfig_item_t *child = ci->children + i;
225
226                 if (strcasecmp ("Database", child->key) == 0)
227                         mysql_config_database (child);
228                 else
229                         WARNING ("mysql plugin: Option \"%s\" not allowed here.",
230                                         child->key);
231         }
232
233         return (0);
234 } /* }}} int mysql_config */
235
236 /* }}} End of configuration handling functions */
237
238 static MYSQL *getconnection (mysql_database_t *db)
239 {
240         if (db->state != 0)
241         {
242                 int err;
243                 if ((err = mysql_ping (db->con)) != 0)
244                 {
245                         /* Assured by "mysql_config_database" */
246                         assert (db->instance != NULL);
247                         WARNING ("mysql_ping failed for instance \"%s\": %s",
248                                         db->instance,
249                                         mysql_error (db->con));
250                         db->state = 0;
251                 }
252                 else
253                 {
254                         db->state = 1;
255                         return (db->con);
256                 }
257         }
258
259         if ((db->con = mysql_init (db->con)) == NULL)
260         {
261                 ERROR ("mysql_init failed: %s", mysql_error (db->con));
262                 db->state = 0;
263                 return (NULL);
264         }
265
266         if (mysql_real_connect (db->con, db->host, db->user, db->pass,
267                                 db->database, db->port, db->socket, 0) == NULL)
268         {
269                 ERROR ("mysql plugin: Failed to connect to database %s "
270                                 "at server %s: %s",
271                                 (db->database != NULL) ? db->database : "<none>",
272                                 (db->host != NULL) ? db->host : "localhost",
273                                 mysql_error (db->con));
274                 db->state = 0;
275                 return (NULL);
276         }
277         else
278         {
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));
285                 db->state = 1;
286                 return (db->con);
287         }
288 } /* static MYSQL *getconnection (mysql_database_t *db) */
289
290 static void set_host (mysql_database_t *db, char *buf, size_t buflen)
291 {
292         if ((db->host == NULL)
293                         || (strcmp ("", db->host) == 0)
294                         || (strcmp ("localhost", db->host) == 0))
295                 sstrncpy (buf, hostname_g, buflen);
296         else
297                 sstrncpy (buf, db->host, buflen);
298 } /* void set_host */
299
300 static void submit (const char *type, const char *type_instance,
301                 value_t *values, size_t values_len, mysql_database_t *db)
302 {
303         value_list_t vl = VALUE_LIST_INIT;
304
305         vl.values     = values;
306         vl.values_len = values_len;
307
308         set_host (db, vl.host, sizeof (vl.host));
309
310         sstrncpy (vl.plugin, "mysql", sizeof (vl.plugin));
311
312         /* Assured by "mysql_config_database" */
313         assert (db->instance != NULL);
314         sstrncpy (vl.plugin_instance, db->instance, sizeof (vl.plugin_instance));
315
316         sstrncpy (vl.type, type, sizeof (vl.type));
317         if (type_instance != NULL)
318                 sstrncpy (vl.type_instance, type_instance, sizeof (vl.type_instance));
319
320         plugin_dispatch_values (&vl);
321 } /* submit */
322
323 static void counter_submit (const char *type, const char *type_instance,
324                 derive_t value, mysql_database_t *db)
325 {
326         value_t values[1];
327
328         values[0].derive = value;
329         submit (type, type_instance, values, STATIC_ARRAY_SIZE (values), db);
330 } /* void counter_submit */
331
332 static void gauge_submit (const char *type, const char *type_instance,
333                 gauge_t value, mysql_database_t *db)
334 {
335         value_t values[1];
336
337         values[0].gauge = value;
338         submit (type, type_instance, values, STATIC_ARRAY_SIZE (values), db);
339 } /* void gauge_submit */
340
341 static void derive_submit (const char *type, const char *type_instance,
342                 derive_t value, mysql_database_t *db)
343 {
344         value_t values[1];
345
346         values[0].derive = value;
347         submit (type, type_instance, values, STATIC_ARRAY_SIZE (values), db);
348 } /* void derive_submit */
349
350 static void traffic_submit (derive_t rx, derive_t tx, mysql_database_t *db)
351 {
352         value_t values[2];
353
354         values[0].derive = rx;
355         values[1].derive = tx;
356
357         submit ("mysql_octets", NULL, values, STATIC_ARRAY_SIZE (values), db);
358 } /* void traffic_submit */
359
360 static MYSQL_RES *exec_query (MYSQL *con, const char *query)
361 {
362         MYSQL_RES *res;
363
364         int query_len = strlen (query);
365
366         if (mysql_real_query (con, query, query_len))
367         {
368                 ERROR ("mysql plugin: Failed to execute query: %s",
369                                 mysql_error (con));
370                 INFO ("mysql plugin: SQL query was: %s", query);
371                 return (NULL);
372         }
373
374         res = mysql_store_result (con);
375         if (res == NULL)
376         {
377                 ERROR ("mysql plugin: Failed to store query result: %s",
378                                 mysql_error (con));
379                 INFO ("mysql plugin: SQL query was: %s", query);
380                 return (NULL);
381         }
382
383         return (res);
384 } /* exec_query */
385
386 static int mysql_read_master_stats (mysql_database_t *db, MYSQL *con)
387 {
388         MYSQL_RES *res;
389         MYSQL_ROW  row;
390
391         char *query;
392         int   field_num;
393         unsigned long long position;
394
395         query = "SHOW MASTER STATUS";
396
397         res = exec_query (con, query);
398         if (res == NULL)
399                 return (-1);
400
401         row = mysql_fetch_row (res);
402         if (row == NULL)
403         {
404                 ERROR ("mysql plugin: Failed to get master statistics: "
405                                 "`%s' did not return any rows.", query);
406                 return (-1);
407         }
408
409         field_num = mysql_num_fields (res);
410         if (field_num < 2)
411         {
412                 ERROR ("mysql plugin: Failed to get master statistics: "
413                                 "`%s' returned less than two columns.", query);
414                 return (-1);
415         }
416
417         position = atoll (row[1]);
418         counter_submit ("mysql_log_position", "master-bin", position, db);
419
420         row = mysql_fetch_row (res);
421         if (row != NULL)
422                 WARNING ("mysql plugin: `%s' returned more than one row - "
423                                 "ignoring further results.", query);
424
425         mysql_free_result (res);
426
427         return (0);
428 } /* mysql_read_master_stats */
429
430 static int mysql_read_slave_stats (mysql_database_t *db, MYSQL *con)
431 {
432         MYSQL_RES *res;
433         MYSQL_ROW  row;
434
435         char *query;
436         int   field_num;
437
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;
445
446         query = "SHOW SLAVE STATUS";
447
448         res = exec_query (con, query);
449         if (res == NULL)
450                 return (-1);
451
452         row = mysql_fetch_row (res);
453         if (row == NULL)
454         {
455                 ERROR ("mysql plugin: Failed to get slave statistics: "
456                                 "`%s' did not return any rows.", query);
457                 return (-1);
458         }
459
460         field_num = mysql_num_fields (res);
461         if (field_num < 33)
462         {
463                 ERROR ("mysql plugin: Failed to get slave statistics: "
464                                 "`%s' returned less than 33 columns.", query);
465                 return (-1);
466         }
467
468         if (db->slave_stats)
469         {
470                 unsigned long long counter;
471                 double gauge;
472
473                 counter = atoll (row[READ_MASTER_LOG_POS_IDX]);
474                 counter_submit ("mysql_log_position", "slave-read", counter, db);
475
476                 counter = atoll (row[EXEC_MASTER_LOG_POS_IDX]);
477                 counter_submit ("mysql_log_position", "slave-exec", counter, db);
478
479                 if (row[SECONDS_BEHIND_MASTER_IDX] != NULL)
480                 {
481                         gauge = atof (row[SECONDS_BEHIND_MASTER_IDX]);
482                         gauge_submit ("time_offset", NULL, gauge, db);
483                 }
484         }
485
486         if (db->slave_notif)
487         {
488                 notification_t n = { 0, cdtime (), "", "",
489                         "mysql", "", "time_offset", "", NULL };
490
491                 char *io, *sql;
492
493                 io  = row[SLAVE_IO_RUNNING_IDX];
494                 sql = row[SLAVE_SQL_RUNNING_IDX];
495
496                 set_host (db, n.host, sizeof (n.host));
497
498                 /* Assured by "mysql_config_database" */
499                 assert (db->instance != NULL);
500                 sstrncpy (n.plugin_instance, db->instance, sizeof (n.plugin_instance));
501
502                 if (((io == NULL) || (strcasecmp (io, "yes") != 0))
503                                 && (db->slave_io_running))
504                 {
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;
510                 }
511                 else if (((io != NULL) && (strcasecmp (io, "yes") == 0))
512                                 && (! db->slave_io_running))
513                 {
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;
519                 }
520
521                 if (((sql == NULL) || (strcasecmp (sql, "yes") != 0))
522                                 && (db->slave_sql_running))
523                 {
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;
529                 }
530                 else if (((sql != NULL) && (strcasecmp (sql, "yes") == 0))
531                                 && (! db->slave_sql_running))
532                 {
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;
538                 }
539         }
540
541         row = mysql_fetch_row (res);
542         if (row != NULL)
543                 WARNING ("mysql plugin: `%s' returned more than one row - "
544                                 "ignoring further results.", query);
545
546         mysql_free_result (res);
547
548         return (0);
549 } /* mysql_read_slave_stats */
550
551 static int mysql_read (user_data_t *ud)
552 {
553         mysql_database_t *db;
554         MYSQL     *con;
555         MYSQL_RES *res;
556         MYSQL_ROW  row;
557         char      *query;
558         int        field_num;
559
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;
565
566         gauge_t threads_running   = NAN;
567         gauge_t threads_connected = NAN;
568         gauge_t threads_cached    = NAN;
569         derive_t threads_created = 0;
570
571         unsigned long long traffic_incoming = 0ULL;
572         unsigned long long traffic_outgoing = 0ULL;
573
574         if ((ud == NULL) || (ud->data == NULL))
575         {
576                 ERROR ("mysql plugin: mysql_database_read: Invalid user data.");
577                 return (-1);
578         }
579
580         db = (mysql_database_t *) ud->data;
581
582         /* An error message will have been printed in this case */
583         if ((con = getconnection (db)) == NULL)
584                 return (-1);
585
586         query = "SHOW STATUS";
587         if (mysql_get_server_version (con) >= 50002)
588                 query = "SHOW GLOBAL STATUS";
589
590         res = exec_query (con, query);
591         if (res == NULL)
592                 return (-1);
593
594         field_num = mysql_num_fields (res);
595         while ((row = mysql_fetch_row (res)))
596         {
597                 char *key;
598                 unsigned long long val;
599
600                 key = row[0];
601                 val = atoll (row[1]);
602
603                 if (strncmp (key, "Com_", 
604                                   strlen ("Com_")) == 0)
605                 {
606                         if (val == 0ULL)
607                                 continue;
608
609                         /* Ignore `prepared statements' */
610                         if (strncmp (key, "Com_stmt_", strlen ("Com_stmt_")) != 0)
611                                 counter_submit ("mysql_commands", 
612                                                 key + strlen ("Com_"), 
613                                                 val, db);
614                 }
615                 else if (strncmp (key, "Handler_", 
616                                         strlen ("Handler_")) == 0)
617                 {
618                         if (val == 0ULL)
619                                 continue;
620
621                         counter_submit ("mysql_handler", 
622                                         key + strlen ("Handler_"), 
623                                         val, db);
624                 }
625                 else if (strncmp (key, "Qcache_",
626                                         strlen ("Qcache_")) == 0)
627                 {
628                         if (strcmp (key, "Qcache_hits") == 0)
629                                 qcache_hits = (derive_t) val;
630                         else if (strcmp (key, "Qcache_inserts") == 0)
631                                 qcache_inserts = (derive_t) val;
632                         else if (strcmp (key, "Qcache_not_cached") == 0)
633                                 qcache_not_cached = (derive_t) val;
634                         else if (strcmp (key, "Qcache_lowmem_prunes") == 0)
635                                 qcache_lowmem_prunes = (derive_t) val;
636                         else if (strcmp (key, "Qcache_queries_in_cache") == 0)
637                                 qcache_queries_in_cache = (gauge_t) val;
638                 }
639                 else if (strncmp (key, "Bytes_", 
640                                         strlen ("Bytes_")) == 0)
641                 {
642                         if (strcmp (key, "Bytes_received") == 0)
643                                 traffic_incoming += val;
644                         else if (strcmp (key, "Bytes_sent") == 0)
645                                 traffic_outgoing += val;
646                 }
647                 else if (strncmp (key, "Threads_", 
648                                         strlen ("Threads_")) == 0)
649                 {
650                         if (strcmp (key, "Threads_running") == 0)
651                                 threads_running = (gauge_t) val;
652                         else if (strcmp (key, "Threads_connected") == 0)
653                                 threads_connected = (gauge_t) val;
654                         else if (strcmp (key, "Threads_cached") == 0)
655                                 threads_cached = (gauge_t) val;
656                         else if (strcmp (key, "Threads_created") == 0)
657                                 threads_created = (derive_t) val;
658                 }
659                 else if (strncmp (key, "Table_locks_",
660                                         strlen ("Table_locks_")) == 0)
661                 {
662                         counter_submit ("mysql_locks",
663                                         key + strlen ("Table_locks_"),
664                                         val, db);
665                 }
666         }
667         mysql_free_result (res); res = NULL;
668
669         if ((qcache_hits != 0)
670                         || (qcache_inserts != 0)
671                         || (qcache_not_cached != 0)
672                         || (qcache_lowmem_prunes != 0))
673         {
674                 derive_submit ("cache_result", "qcache-hits",
675                                 qcache_hits, db);
676                 derive_submit ("cache_result", "qcache-inserts",
677                                 qcache_inserts, db);
678                 derive_submit ("cache_result", "qcache-not_cached",
679                                 qcache_not_cached, db);
680                 derive_submit ("cache_result", "qcache-prunes",
681                                 qcache_lowmem_prunes, db);
682
683                 gauge_submit ("cache_size", "qcache",
684                                 qcache_queries_in_cache, db);
685         }
686
687         if (threads_created != 0)
688         {
689                 gauge_submit ("threads", "running",
690                                 threads_running, db);
691                 gauge_submit ("threads", "connected",
692                                 threads_connected, db);
693                 gauge_submit ("threads", "cached",
694                                 threads_cached, db);
695
696                 derive_submit ("total_threads", "created",
697                                 threads_created, db);
698         }
699
700         traffic_submit  (traffic_incoming, traffic_outgoing, db);
701
702         if (db->master_stats)
703                 mysql_read_master_stats (db, con);
704
705         if ((db->slave_stats) || (db->slave_notif))
706                 mysql_read_slave_stats (db, con);
707
708         return (0);
709 } /* int mysql_read */
710
711 void module_register (void)
712 {
713         plugin_register_complex_config ("mysql", mysql_config);
714 } /* void module_register */