/**
* collectd - src/mysql.c
- * Copyright (C) 2006,2007 Florian octo Forster
+ * Copyright (C) 2006-2009 Florian octo Forster
+ * Copyright (C) 2009 Sebastian tokkee Harl
*
* This program is free software; you can redistribute it and/or modify it
* under the terms of the GNU General Public License as published by the
*
* Authors:
* Florian octo Forster <octo at verplant.org>
+ * Sebastian tokkee Harl <sh at tokkee.org>
**/
#include "collectd.h"
#include "plugin.h"
#include "configfile.h"
-#ifdef HAVE_MYSQL_MYSQL_H
+#ifdef HAVE_MYSQL_H
+#include <mysql.h>
+#elif defined(HAVE_MYSQL_MYSQL_H)
#include <mysql/mysql.h>
#endif
/* TODO: Understand `Select_*' and possibly do that stuff as well.. */
-static const char *config_keys[] =
+struct mysql_database_s /* {{{ */
{
- "Host",
- "User",
- "Password",
- "Database",
- NULL
+ /* instance == NULL => legacy mode */
+ char *instance;
+ char *host;
+ char *user;
+ char *pass;
+ char *database;
+ char *socket;
+ int port;
+
+ int master_stats;
+ int slave_stats;
+
+ MYSQL *con;
+ int state;
};
-static int config_keys_num = 4;
+typedef struct mysql_database_s mysql_database_t; /* }}} */
-static char *host = "localhost";
-static char *user;
-static char *pass;
-static char *db = NULL;
+static int mysql_read (user_data_t *ud);
-static MYSQL *getconnection (void)
+static void mysql_database_free (void *arg) /* {{{ */
{
- static MYSQL *con;
- static int state;
+ mysql_database_t *db;
- static int wait_for = 0;
- static int wait_increase = 60;
+ DEBUG ("mysql plugin: mysql_database_free (arg = %p);", arg);
- if (state != 0)
+ db = (mysql_database_t *) arg;
+
+ if (db == NULL)
+ return;
+
+ if (db->con != NULL)
+ mysql_close (db->con);
+
+ sfree (db->host);
+ sfree (db->user);
+ sfree (db->pass);
+ sfree (db->socket);
+ sfree (db->instance);
+ sfree (db->database);
+ sfree (db);
+} /* }}} void mysql_database_free */
+
+/* Configuration handling functions {{{
+ *
+ * <Plugin mysql>
+ * <Database "plugin_instance1">
+ * Host "localhost"
+ * Port 22000
+ * ...
+ * </Database>
+ * </Plugin>
+ */
+
+static int mysql_config_set_string (char **ret_string, /* {{{ */
+ oconfig_item_t *ci)
+{
+ char *string;
+
+ if ((ci->values_num != 1)
+ || (ci->values[0].type != OCONFIG_TYPE_STRING))
{
- int err;
- if ((err = mysql_ping (con)) != 0)
+ WARNING ("mysql plugin: The `%s' config option "
+ "needs exactly one string argument.", ci->key);
+ return (-1);
+ }
+
+ string = strdup (ci->values[0].value.string);
+ if (string == NULL)
+ {
+ ERROR ("mysql plugin: strdup failed.");
+ return (-1);
+ }
+
+ if (*ret_string != NULL)
+ free (*ret_string);
+ *ret_string = string;
+
+ return (0);
+} /* }}} int mysql_config_set_string */
+
+static int mysql_config_set_int (int *ret_int, /* {{{ */
+ oconfig_item_t *ci)
+{
+ if ((ci->values_num != 1)
+ || (ci->values[0].type != OCONFIG_TYPE_NUMBER))
+ {
+ WARNING ("mysql plugin: The `%s' config option "
+ "needs exactly one string argument.", ci->key);
+ return (-1);
+ }
+
+ *ret_int = ci->values[0].value.number;
+
+ return (0);
+} /* }}} int mysql_config_set_int */
+
+static int mysql_config_set_boolean (int *ret_boolean, /* {{{ */
+ oconfig_item_t *ci)
+{
+ int status = 0;
+
+ if (ci->values_num != 1)
+ status = -1;
+
+ if (status == 0)
+ {
+ if (ci->values[0].type == OCONFIG_TYPE_BOOLEAN)
+ *ret_boolean = ci->values[0].value.boolean;
+ else if (ci->values[0].type == OCONFIG_TYPE_STRING)
+ {
+ if (IS_TRUE (ci->values[0].value.string))
+ *ret_boolean = 1;
+ else if (IS_FALSE (ci->values[0].value.string))
+ *ret_boolean = 0;
+ else
+ status = -1;
+ }
+ else
+ status = -1;
+ }
+
+ if (status != 0)
+ {
+ WARNING ("mysql plugin: The `%s' config option "
+ "needs exactly one boolean argument.", ci->key);
+ return (-1);
+ }
+ return (0);
+} /* }}} mysql_config_set_boolean */
+
+static int mysql_config (oconfig_item_t *ci) /* {{{ */
+{
+ mysql_database_t *db;
+ int plugin_block;
+ int status = 0;
+ int i;
+
+ if ((ci->values_num != 1)
+ || (ci->values[0].type != OCONFIG_TYPE_STRING))
+ {
+ WARNING ("mysql plugin: The `Database' block "
+ "needs exactly one string argument.");
+ return (-1);
+ }
+
+ db = (mysql_database_t *) malloc (sizeof (*db));
+ if (db == NULL)
+ {
+ ERROR ("mysql plugin: malloc failed.");
+ return (-1);
+ }
+ memset (db, 0, sizeof (*db));
+
+ /* initialize all the pointers */
+ db->host = NULL;
+ db->user = NULL;
+ db->pass = NULL;
+ db->database = NULL;
+ db->socket = NULL;
+ db->con = NULL;
+
+ plugin_block = 1;
+ if (strcasecmp ("Plugin", ci->key) == 0)
+ {
+ db->instance = NULL;
+ }
+ else if (strcasecmp ("Database", ci->key) == 0)
+ {
+ plugin_block = 0;
+ status = mysql_config_set_string (&db->instance, ci);
+ if (status != 0)
+ {
+ sfree (db);
+ return (status);
+ }
+ assert (db->instance != NULL);
+ db->database = strdup (db->instance);
+ }
+ else
+ {
+ ERROR ("mysql plugin: mysql_config: "
+ "Invalid key: %s", ci->key);
+ return (-1);
+ }
+
+ /* Fill the `mysql_database_t' structure.. */
+ for (i = 0; i < ci->children_num; i++)
+ {
+ oconfig_item_t *child = ci->children + i;
+
+ if (strcasecmp ("Host", child->key) == 0)
+ status = mysql_config_set_string (&db->host, child);
+ else if (strcasecmp ("User", child->key) == 0)
+ status = mysql_config_set_string (&db->user, child);
+ else if (strcasecmp ("Password", child->key) == 0)
+ status = mysql_config_set_string (&db->pass, child);
+ else if (strcasecmp ("Port", child->key) == 0)
+ status = mysql_config_set_int (&db->port, child);
+ else if (strcasecmp ("Socket", child->key) == 0)
+ status = mysql_config_set_string (&db->socket, child);
+ /* Check if we're currently handling the `Plugin' block. If so,
+ * handle `Database' _blocks_, too. */
+ else if ((plugin_block != 0)
+ && (strcasecmp ("Database", child->key) == 0)
+ && (child->children != NULL))
{
- WARNING ("mysql_ping failed: %s", mysql_error (con));
- state = 0;
+ /* If `plugin_block > 1', there has been at least one
+ * `Database' block */
+ plugin_block++;
+ status = mysql_config (child);
}
+ /* Now handle ordinary `Database' options (without children) */
+ else if ((strcasecmp ("Database", child->key) == 0)
+ && (child->children == NULL))
+ status = mysql_config_set_string (&db->database, child);
+ else if (strcasecmp ("MasterStats", child->key) == 0)
+ status = mysql_config_set_boolean (&db->master_stats, child);
+ else if (strcasecmp ("SlaveStats", child->key) == 0)
+ status = mysql_config_set_boolean (&db->slave_stats, child);
else
{
- state = 1;
- return (con);
+ WARNING ("mysql plugin: Option `%s' not allowed here.", child->key);
+ status = -1;
}
+
+ if (status != 0)
+ break;
}
- if (wait_for > 0)
+ /* Check if there were any `Database' blocks. */
+ if (plugin_block > 1)
{
- wait_for -= interval_g;
- return (NULL);
+ /* There were connection blocks. Don't use any legacy stuff. */
+ if ((db->host != NULL)
+ || (db->user != NULL)
+ || (db->pass != NULL)
+ || (db->database != NULL)
+ || (db->socket != NULL)
+ || (db->port != 0))
+ {
+ WARNING ("mysql plugin: At least one <Database> "
+ "block has been found. The legacy "
+ "configuration will be ignored.");
+ }
+ mysql_database_free (db);
+ return (0);
+ }
+ else if (plugin_block != 0)
+ {
+ WARNING ("mysql plugin: You're using the legacy "
+ "configuration options. Please consider "
+ "updating your configuration!");
}
- wait_for = wait_increase;
- wait_increase *= 2;
- if (wait_increase > 86400)
- wait_increase = 86400;
+ /* Check that all necessary options have been given. */
+ while (status == 0)
+ {
+ /* Zero is allowed and automatically handled by
+ * `mysql_real_connect'. */
+ if ((db->port < 0) || (db->port > 65535))
+ {
+ ERROR ("mysql plugin: Database %s: Port number out "
+ "of range: %i",
+ (db->instance != NULL)
+ ? db->instance
+ : "<legacy>",
+ db->port);
+ status = -1;
+ }
+ if (db->database == NULL)
+ {
+ ERROR ("mysql plugin: No `Database' configured");
+ status = -1;
+ }
+ break;
+ } /* while (status == 0) */
+
+ /* If all went well, register this database for reading */
+ if (status == 0)
+ {
+ user_data_t ud;
+ char cb_name[DATA_MAX_NAME_LEN];
- if ((con = mysql_init (con)) == NULL)
+ DEBUG ("mysql plugin: Registering new read callback: %s", db->database);
+
+ memset (&ud, 0, sizeof (ud));
+ ud.data = (void *) db;
+ ud.free_func = mysql_database_free;
+
+ if (db->database != NULL)
+ ssnprintf (cb_name, sizeof (cb_name), "mysql-%s",
+ db->database);
+ else
+ sstrncpy (cb_name, "mysql", sizeof (cb_name));
+
+ plugin_register_complex_read (cb_name, mysql_read,
+ /* interval = */ NULL, &ud);
+ }
+ else
{
- ERROR ("mysql_init failed: %s", mysql_error (con));
- state = 0;
+ mysql_database_free (db);
+ return (-1);
+ }
+
+ return (0);
+} /* }}} int mysql_config */
+
+/* }}} End of configuration handling functions */
+
+static MYSQL *getconnection (mysql_database_t *db)
+{
+ if (db->state != 0)
+ {
+ int err;
+ if ((err = mysql_ping (db->con)) != 0)
+ {
+ WARNING ("mysql_ping failed: %s", mysql_error (db->con));
+ db->state = 0;
+ }
+ else
+ {
+ db->state = 1;
+ return (db->con);
+ }
+ }
+
+ if ((db->con = mysql_init (db->con)) == NULL)
+ {
+ ERROR ("mysql_init failed: %s", mysql_error (db->con));
+ db->state = 0;
return (NULL);
}
- if (mysql_real_connect (con, host, user, pass, db, 0, NULL, 0) == NULL)
+ if (mysql_real_connect (db->con, db->host, db->user, db->pass,
+ db->database, db->port, db->socket, 0) == NULL)
{
- ERROR ("mysql_real_connect failed: %s", mysql_error (con));
- state = 0;
+ ERROR ("mysql_real_connect failed: %s", mysql_error (db->con));
+ db->state = 0;
return (NULL);
}
else
{
- state = 1;
- wait_for = 0;
- wait_increase = 60;
- return (con);
+ db->state = 1;
+ return (db->con);
}
-} /* static MYSQL *getconnection (void) */
+} /* static MYSQL *getconnection (mysql_database_t *db) */
-static int config (const char *key, const char *value)
+static void set_host (mysql_database_t *db, value_list_t *vl)
{
- if (strcasecmp (key, "host") == 0)
- return ((host = strdup (value)) == NULL ? 1 : 0);
- else if (strcasecmp (key, "user") == 0)
- return ((user = strdup (value)) == NULL ? 1 : 0);
- else if (strcasecmp (key, "password") == 0)
- return ((pass = strdup (value)) == NULL ? 1 : 0);
- else if (strcasecmp (key, "database") == 0)
- return ((db = strdup (value)) == NULL ? 1 : 0);
+ /* XXX legacy mode - use hostname_g */
+ if (db->instance == NULL)
+ sstrncpy (vl->host, hostname_g, sizeof (vl->host));
else
- return (-1);
+ {
+ if ((db->host == NULL)
+ || (strcmp ("", db->host) == 0)
+ || (strcmp ("localhost", db->host) == 0))
+ sstrncpy (vl->host, hostname_g, sizeof (vl->host));
+ else
+ sstrncpy (vl->host, db->host, sizeof (vl->host));
+ }
}
-static void counter_submit (const char *type, const char *type_instance,
- counter_t value)
+static void set_plugin_instance (mysql_database_t *db, value_list_t *vl)
+{
+ /* XXX legacy mode - no plugin_instance */
+ if (db->instance == NULL)
+ sstrncpy (vl->plugin_instance, "",
+ sizeof (vl->plugin_instance));
+ else
+ sstrncpy (vl->plugin_instance, db->instance,
+ sizeof (vl->plugin_instance));
+}
+
+static void submit (const char *type, const char *type_instance,
+ value_t *values, size_t values_len, mysql_database_t *db)
{
- value_t values[1];
value_list_t vl = VALUE_LIST_INIT;
- values[0].counter = value;
+ vl.values = values;
+ vl.values_len = values_len;
+
+ set_host (db, &vl);
+
+ sstrncpy (vl.plugin, "mysql", sizeof (vl.plugin));
+ set_plugin_instance (db, &vl);
- vl.values = values;
- vl.values_len = 1;
- vl.time = time (NULL);
- strcpy (vl.host, hostname_g);
- strcpy (vl.plugin, "mysql");
- strncpy (vl.type, type, sizeof (vl.type));
- strncpy (vl.type_instance, type_instance, sizeof (vl.type_instance));
+ sstrncpy (vl.type, type, sizeof (vl.type));
+ if (type_instance != NULL)
+ sstrncpy (vl.type_instance, type_instance, sizeof (vl.type_instance));
plugin_dispatch_values (&vl);
+} /* submit */
+
+static void counter_submit (const char *type, const char *type_instance,
+ counter_t value, mysql_database_t *db)
+{
+ value_t values[1];
+
+ values[0].counter = value;
+ submit (type, type_instance, values, STATIC_ARRAY_SIZE (values), db);
} /* void counter_submit */
+static void gauge_submit (const char *type, const char *type_instance,
+ gauge_t value, mysql_database_t *db)
+{
+ value_t values[1];
+
+ values[0].gauge = value;
+ submit (type, type_instance, values, STATIC_ARRAY_SIZE (values), db);
+} /* void gauge_submit */
+
static void qcache_submit (counter_t hits, counter_t inserts,
counter_t not_cached, counter_t lowmem_prunes,
- gauge_t queries_in_cache)
+ gauge_t queries_in_cache, mysql_database_t *db)
{
value_t values[5];
- value_list_t vl = VALUE_LIST_INIT;
values[0].counter = hits;
values[1].counter = inserts;
values[3].counter = lowmem_prunes;
values[4].gauge = queries_in_cache;
- vl.values = values;
- vl.values_len = 5;
- vl.time = time (NULL);
- strcpy (vl.host, hostname_g);
- strcpy (vl.plugin, "mysql");
- strcpy (vl.type, "mysql_qcache");
-
- plugin_dispatch_values (&vl);
+ submit ("mysql_qcache", NULL, values, STATIC_ARRAY_SIZE (values), db);
} /* void qcache_submit */
static void threads_submit (gauge_t running, gauge_t connected, gauge_t cached,
- counter_t created)
+ counter_t created, mysql_database_t *db)
{
value_t values[4];
- value_list_t vl = VALUE_LIST_INIT;
values[0].gauge = running;
values[1].gauge = connected;
values[2].gauge = cached;
values[3].counter = created;
- vl.values = values;
- vl.values_len = 4;
- vl.time = time (NULL);
- strcpy (vl.host, hostname_g);
- strcpy (vl.plugin, "mysql");
- strcpy (vl.type, "mysql_threads");
-
- plugin_dispatch_values (&vl);
+ submit ("mysql_threads", NULL, values, STATIC_ARRAY_SIZE (values), db);
} /* void threads_submit */
-static void traffic_submit (counter_t rx, counter_t tx)
+static void traffic_submit (counter_t rx, counter_t tx, mysql_database_t *db)
{
value_t values[2];
- value_list_t vl = VALUE_LIST_INIT;
values[0].counter = rx;
values[1].counter = tx;
- vl.values = values;
- vl.values_len = 2;
- vl.time = time (NULL);
- strcpy (vl.host, hostname_g);
- strcpy (vl.plugin, "mysql");
- strcpy (vl.type, "mysql_octets");
-
- plugin_dispatch_values (&vl);
+ submit ("mysql_octets", NULL, values, STATIC_ARRAY_SIZE (values), db);
} /* void traffic_submit */
-static int mysql_read (void)
+static MYSQL_RES *exec_query (MYSQL *con, const char *query)
{
+ MYSQL_RES *res;
+
+ int query_len = strlen (query);
+
+ if (mysql_real_query (con, query, query_len))
+ {
+ ERROR ("mysql plugin: Failed to execute query: %s",
+ mysql_error (con));
+ INFO ("mysql plugin: SQL query was: %s", query);
+ return (NULL);
+ }
+
+ res = mysql_store_result (con);
+ if (res == NULL)
+ {
+ ERROR ("mysql plugin: Failed to store query result: %s",
+ mysql_error (con));
+ INFO ("mysql plugin: SQL query was: %s", query);
+ return (NULL);
+ }
+
+ return (res);
+} /* exec_query */
+
+static int mysql_read_master_stats (mysql_database_t *db, MYSQL *con)
+{
+ MYSQL_RES *res;
+ MYSQL_ROW row;
+
+ char *query;
+ int field_num;
+ unsigned long long position;
+
+ query = "SHOW MASTER STATUS";
+
+ res = exec_query (con, query);
+ if (res == NULL)
+ return (-1);
+
+ row = mysql_fetch_row (res);
+ if (row == NULL)
+ {
+ ERROR ("mysql plugin: Failed to get master statistics: "
+ "`%s' did not return any rows.", query);
+ return (-1);
+ }
+
+ field_num = mysql_num_fields (res);
+ if (field_num < 2)
+ {
+ ERROR ("mysql plugin: Failed to get master statistics: "
+ "`%s' returned less than two columns.", query);
+ return (-1);
+ }
+
+ position = atoll (row[1]);
+ counter_submit ("mysql_log_position", "master-bin", position, db);
+
+ row = mysql_fetch_row (res);
+ if (row != NULL)
+ WARNING ("mysql plugin: `%s' returned more than one row - "
+ "ignoring further results.", query);
+
+ mysql_free_result (res);
+
+ return (0);
+} /* mysql_read_master_stats */
+
+static int mysql_read_slave_stats (mysql_database_t *db, MYSQL *con)
+{
+ MYSQL_RES *res;
+ MYSQL_ROW row;
+
+ char *query;
+ int field_num;
+
+ /* WTF? libmysqlclient does not seem to provide any means to
+ * translate a column name to a column index ... :-/ */
+ const int READ_MASTER_LOG_POS_IDX = 6;
+ const int EXEC_MASTER_LOG_POS_IDX = 21;
+ const int SECONDS_BEHIND_MASTER_IDX = 32;
+
+ unsigned long long counter;
+ double gauge;
+
+ query = "SHOW SLAVE STATUS";
+
+ res = exec_query (con, query);
+ if (res == NULL)
+ return (-1);
+
+ row = mysql_fetch_row (res);
+ if (row == NULL)
+ {
+ ERROR ("mysql plugin: Failed to get slave statistics: "
+ "`%s' did not return any rows.", query);
+ return (-1);
+ }
+
+ field_num = mysql_num_fields (res);
+ if (field_num < 33)
+ {
+ ERROR ("mysql plugin: Failed to get slave statistics: "
+ "`%s' returned less than 33 columns.", query);
+ return (-1);
+ }
+
+ counter = atoll (row[READ_MASTER_LOG_POS_IDX]);
+ counter_submit ("mysql_log_position", "slave-read", counter, db);
+
+ counter = atoll (row[EXEC_MASTER_LOG_POS_IDX]);
+ counter_submit ("mysql_log_position", "slave-exec", counter, db);
+
+ if (row[SECONDS_BEHIND_MASTER_IDX] != NULL)
+ {
+ gauge = atof (row[SECONDS_BEHIND_MASTER_IDX]);
+ gauge_submit ("time_offset", NULL, gauge, db);
+ }
+
+ row = mysql_fetch_row (res);
+ if (row != NULL)
+ WARNING ("mysql plugin: `%s' returned more than one row - "
+ "ignoring further results.", query);
+
+ mysql_free_result (res);
+
+ return (0);
+} /* mysql_read_slave_stats */
+
+static int mysql_read (user_data_t *ud)
+{
+ mysql_database_t *db;
MYSQL *con;
MYSQL_RES *res;
MYSQL_ROW row;
char *query;
- int query_len;
int field_num;
unsigned long long qcache_hits = 0ULL;
unsigned long long traffic_incoming = 0ULL;
unsigned long long traffic_outgoing = 0ULL;
+ if ((ud == NULL) || (ud->data == NULL))
+ {
+ ERROR ("mysql plugin: mysql_database_read: Invalid user data.");
+ return (-1);
+ }
+
+ db = (mysql_database_t *) ud->data;
+
/* An error message will have been printed in this case */
- if ((con = getconnection ()) == NULL)
+ if ((con = getconnection (db)) == NULL)
return (-1);
query = "SHOW STATUS";
if (mysql_get_server_version (con) >= 50002)
query = "SHOW GLOBAL STATUS";
- query_len = strlen (query);
-
- if (mysql_real_query (con, query, query_len))
- {
- ERROR ("mysql_real_query failed: %s\n",
- mysql_error (con));
+ res = exec_query (con, query);
+ if (res == NULL)
return (-1);
- }
-
- if ((res = mysql_store_result (con)) == NULL)
- {
- ERROR ("mysql_store_result failed: %s\n",
- mysql_error (con));
- return (-1);
- }
field_num = mysql_num_fields (res);
while ((row = mysql_fetch_row (res)))
/* Ignore `prepared statements' */
if (strncmp (key, "Com_stmt_", 9) != 0)
- counter_submit ("mysql_commands", key + 4, val);
+ counter_submit ("mysql_commands", key + 4, val, db);
}
else if (strncmp (key, "Handler_", 8) == 0)
{
if (val == 0ULL)
continue;
- counter_submit ("mysql_handler", key + 8, val);
+ counter_submit ("mysql_handler", key + 8, val, db);
}
else if (strncmp (key, "Qcache_", 7) == 0)
{
|| (qcache_not_cached != 0ULL)
|| (qcache_lowmem_prunes != 0ULL))
qcache_submit (qcache_hits, qcache_inserts, qcache_not_cached,
- qcache_lowmem_prunes, qcache_queries_in_cache);
+ qcache_lowmem_prunes, qcache_queries_in_cache, db);
if (threads_created != 0ULL)
threads_submit (threads_running, threads_connected,
- threads_cached, threads_created);
+ threads_cached, threads_created, db);
+
+ traffic_submit (traffic_incoming, traffic_outgoing, db);
- traffic_submit (traffic_incoming, traffic_outgoing);
+ if (db->master_stats)
+ mysql_read_master_stats (db, con);
- /* mysql_close (con); */
+ if (db->slave_stats)
+ mysql_read_slave_stats (db, con);
return (0);
} /* int mysql_read */
void module_register (void)
{
- plugin_register_config ("mysql", config, config_keys, config_keys_num);
- plugin_register_read ("mysql", mysql_read);
+ plugin_register_complex_config ("mysql", mysql_config);
} /* void module_register */
projects / collectd.git / blobdiff