bindings/java/: CollectdMatchFactoryInterface: Add more JavaDoc.
[collectd.git] / src / mysql.c
1 /**
2  * collectd - src/mysql.c
3  * Copyright (C) 2006,2007  Florian octo Forster
4  *
5  * This program is free software; you can redistribute it and/or modify it
6  * under the terms of the GNU General Public License as published by the
7  * Free Software Foundation; only version 2 of the License is applicable.
8  *
9  * This program is distributed in the hope that it will be useful, but
10  * WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
12  * General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License along
15  * with this program; if not, write to the Free Software Foundation, Inc.,
16  * 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
17  *
18  * Authors:
19  *   Florian octo Forster <octo at verplant.org>
20  **/
21
22 #include "collectd.h"
23 #include "common.h"
24 #include "plugin.h"
25 #include "configfile.h"
26
27 #ifdef HAVE_MYSQL_H
28 #include <mysql.h>
29 #elif defined(HAVE_MYSQL_MYSQL_H)
30 #include <mysql/mysql.h>
31 #endif
32
33 /* TODO: Understand `Select_*' and possibly do that stuff as well.. */
34
35 static const char *config_keys[] =
36 {
37         "Host",
38         "User",
39         "Password",
40         "Database",
41         "Port",
42         "Socket",
43         NULL
44 };
45 static int config_keys_num = 6;
46
47 static char *host = "localhost";
48 static char *user;
49 static char *pass;
50 static char *db = NULL;
51 static char *socket = NULL;
52 static int   port = 0;
53
54 static MYSQL *getconnection (void)
55 {
56         static MYSQL *con;
57         static int    state;
58
59         static int wait_for = 0;
60         static int wait_increase = 60;
61
62         if (state != 0)
63         {
64                 int err;
65                 if ((err = mysql_ping (con)) != 0)
66                 {
67                         WARNING ("mysql_ping failed: %s", mysql_error (con));
68                         state = 0;
69                 }
70                 else
71                 {
72                         state = 1;
73                         return (con);
74                 }
75         }
76
77         if (wait_for > 0)
78         {
79                 wait_for -= interval_g;
80                 return (NULL);
81         }
82
83         wait_for = wait_increase;
84         wait_increase *= 2;
85         if (wait_increase > 86400)
86                 wait_increase = 86400;
87
88         if ((con = mysql_init (con)) == NULL)
89         {
90                 ERROR ("mysql_init failed: %s", mysql_error (con));
91                 state = 0;
92                 return (NULL);
93         }
94
95         if (mysql_real_connect (con, host, user, pass, db, port, socket, 0) == NULL)
96         {
97                 ERROR ("mysql_real_connect failed: %s", mysql_error (con));
98                 state = 0;
99                 return (NULL);
100         }
101         else
102         {
103                 state = 1;
104                 wait_for = 0;
105                 wait_increase = 60;
106                 return (con);
107         }
108 } /* static MYSQL *getconnection (void) */
109
110 static int config (const char *key, const char *value)
111 {
112         if (strcasecmp (key, "host") == 0)
113                 return ((host = strdup (value)) == NULL ? 1 : 0);
114         else if (strcasecmp (key, "user") == 0)
115                 return ((user = strdup (value)) == NULL ? 1 : 0);
116         else if (strcasecmp (key, "password") == 0)
117                 return ((pass = strdup (value)) == NULL ? 1 : 0);
118         else if (strcasecmp (key, "database") == 0)
119                 return ((db = strdup (value)) == NULL ? 1 : 0);
120         else if (strcasecmp (key, "socket") == 0)
121                 return ((socket = strdup (value)) == NULL ? 1 : 0);
122         else if (strcasecmp (key, "port") == 0)
123         {
124             char *endptr = NULL;
125             int temp;
126
127             errno = 0;
128             temp = strtol (value, &endptr, 0);
129             if ((errno != 0) || (value == endptr))
130             {
131                 ERROR ("mysql plugin: Invalid \"Port\" argument: %s",
132                         value);
133                 port = 0;
134                 return (1);
135             }
136             else if ((temp < 0) || (temp >= 65535))
137             {
138                 ERROR ("mysql plugin: Port number out of range: %i",
139                         temp);
140                 port = 0;
141                 return (1);
142             }
143
144             port = temp;
145             return (0);
146         }
147         else
148                 return (-1);
149 } /* int config */
150
151 static void counter_submit (const char *type, const char *type_instance,
152                 counter_t value)
153 {
154         value_t values[1];
155         value_list_t vl = VALUE_LIST_INIT;
156
157         values[0].counter = value;
158
159         vl.values = values;
160         vl.values_len = 1;
161         sstrncpy (vl.host, hostname_g, sizeof (vl.host));
162         sstrncpy (vl.plugin, "mysql", sizeof (vl.plugin));
163         sstrncpy (vl.type, type, sizeof (vl.type));
164         sstrncpy (vl.type_instance, type_instance, sizeof (vl.type_instance));
165
166         plugin_dispatch_values (&vl);
167 } /* void counter_submit */
168
169 static void qcache_submit (counter_t hits, counter_t inserts,
170                 counter_t not_cached, counter_t lowmem_prunes,
171                 gauge_t queries_in_cache)
172 {
173         value_t values[5];
174         value_list_t vl = VALUE_LIST_INIT;
175
176         values[0].counter = hits;
177         values[1].counter = inserts;
178         values[2].counter = not_cached;
179         values[3].counter = lowmem_prunes;
180         values[4].gauge   = queries_in_cache;
181
182         vl.values = values;
183         vl.values_len = 5;
184         sstrncpy (vl.host, hostname_g, sizeof (vl.host));
185         sstrncpy (vl.plugin, "mysql", sizeof (vl.plugin));
186         sstrncpy (vl.type, "mysql_qcache", sizeof (vl.type));
187
188         plugin_dispatch_values (&vl);
189 } /* void qcache_submit */
190
191 static void threads_submit (gauge_t running, gauge_t connected, gauge_t cached,
192                 counter_t created)
193 {
194         value_t values[4];
195         value_list_t vl = VALUE_LIST_INIT;
196
197         values[0].gauge   = running;
198         values[1].gauge   = connected;
199         values[2].gauge   = cached;
200         values[3].counter = created;
201
202         vl.values = values;
203         vl.values_len = 4;
204         sstrncpy (vl.host, hostname_g, sizeof (vl.host));
205         sstrncpy (vl.plugin, "mysql", sizeof (vl.plugin));
206         sstrncpy (vl.type, "mysql_threads", sizeof (vl.type));
207
208         plugin_dispatch_values (&vl);
209 } /* void threads_submit */
210
211 static void traffic_submit (counter_t rx, counter_t tx)
212 {
213         value_t values[2];
214         value_list_t vl = VALUE_LIST_INIT;
215
216         values[0].counter = rx;
217         values[1].counter = tx;
218
219         vl.values = values;
220         vl.values_len = 2;
221         sstrncpy (vl.host, hostname_g, sizeof (vl.host));
222         sstrncpy (vl.plugin, "mysql", sizeof (vl.plugin));
223         sstrncpy (vl.type, "mysql_octets", sizeof (vl.type));
224
225         plugin_dispatch_values (&vl);
226 } /* void traffic_submit */
227
228 static int mysql_read (void)
229 {
230         MYSQL     *con;
231         MYSQL_RES *res;
232         MYSQL_ROW  row;
233         char      *query;
234         int        query_len;
235         int        field_num;
236
237         unsigned long long qcache_hits          = 0ULL;
238         unsigned long long qcache_inserts       = 0ULL;
239         unsigned long long qcache_not_cached    = 0ULL;
240         unsigned long long qcache_lowmem_prunes = 0ULL;
241         int qcache_queries_in_cache = -1;
242
243         int threads_running   = -1;
244         int threads_connected = -1;
245         int threads_cached    = -1;
246         unsigned long long threads_created = 0ULL;
247
248         unsigned long long traffic_incoming = 0ULL;
249         unsigned long long traffic_outgoing = 0ULL;
250
251         /* An error message will have been printed in this case */
252         if ((con = getconnection ()) == NULL)
253                 return (-1);
254
255         query = "SHOW STATUS";
256         if (mysql_get_server_version (con) >= 50002)
257                 query = "SHOW GLOBAL STATUS";
258
259         query_len = strlen (query);
260
261         if (mysql_real_query (con, query, query_len))
262         {
263                 ERROR ("mysql_real_query failed: %s\n",
264                                 mysql_error (con));
265                 return (-1);
266         }
267
268         if ((res = mysql_store_result (con)) == NULL)
269         {
270                 ERROR ("mysql_store_result failed: %s\n",
271                                 mysql_error (con));
272                 return (-1);
273         }
274
275         field_num = mysql_num_fields (res);
276         while ((row = mysql_fetch_row (res)))
277         {
278                 char *key;
279                 unsigned long long val;
280
281                 key = row[0];
282                 val = atoll (row[1]);
283
284                 if (strncmp (key, "Com_", 4) == 0)
285                 {
286                         if (val == 0ULL)
287                                 continue;
288
289                         /* Ignore `prepared statements' */
290                         if (strncmp (key, "Com_stmt_", 9) != 0)
291                                 counter_submit ("mysql_commands", key + 4, val);
292                 }
293                 else if (strncmp (key, "Handler_", 8) == 0)
294                 {
295                         if (val == 0ULL)
296                                 continue;
297
298                         counter_submit ("mysql_handler", key + 8, val);
299                 }
300                 else if (strncmp (key, "Qcache_", 7) == 0)
301                 {
302                         if (strcmp (key, "Qcache_hits") == 0)
303                                 qcache_hits = val;
304                         else if (strcmp (key, "Qcache_inserts") == 0)
305                                 qcache_inserts = val;
306                         else if (strcmp (key, "Qcache_not_cached") == 0)
307                                 qcache_not_cached = val;
308                         else if (strcmp (key, "Qcache_lowmem_prunes") == 0)
309                                 qcache_lowmem_prunes = val;
310                         else if (strcmp (key, "Qcache_queries_in_cache") == 0)
311                                 qcache_queries_in_cache = (int) val;
312                 }
313                 else if (strncmp (key, "Bytes_", 6) == 0)
314                 {
315                         if (strcmp (key, "Bytes_received") == 0)
316                                 traffic_incoming += val;
317                         else if (strcmp (key, "Bytes_sent") == 0)
318                                 traffic_outgoing += val;
319                 }
320                 else if (strncmp (key, "Threads_", 8) == 0)
321                 {
322                         if (strcmp (key, "Threads_running") == 0)
323                                 threads_running = (int) val;
324                         else if (strcmp (key, "Threads_connected") == 0)
325                                 threads_connected = (int) val;
326                         else if (strcmp (key, "Threads_cached") == 0)
327                                 threads_cached = (int) val;
328                         else if (strcmp (key, "Threads_created") == 0)
329                                 threads_created = val;
330                 }
331         }
332         mysql_free_result (res); res = NULL;
333
334         if ((qcache_hits != 0ULL)
335                         || (qcache_inserts != 0ULL)
336                         || (qcache_not_cached != 0ULL)
337                         || (qcache_lowmem_prunes != 0ULL))
338                 qcache_submit (qcache_hits, qcache_inserts, qcache_not_cached,
339                                 qcache_lowmem_prunes, qcache_queries_in_cache);
340
341         if (threads_created != 0ULL)
342                 threads_submit (threads_running, threads_connected,
343                                 threads_cached, threads_created);
344
345         traffic_submit  (traffic_incoming, traffic_outgoing);
346
347         /* mysql_close (con); */
348
349         return (0);
350 } /* int mysql_read */
351
352 void module_register (void)
353 {
354         plugin_register_config ("mysql", config, config_keys, config_keys_num);
355         plugin_register_read ("mysql", mysql_read);
356 } /* void module_register */