X-Git-Url: https://git.octo.it/?a=blobdiff_plain;f=src%2Fpostgresql.c;h=e6527b95e810640b0f98c175b90a0b95bb925e17;hb=3b4201d2235c25ed21174c41c526c9b7894de539;hp=40f8ec57dadaa91c5cfc414cbfdf7bf0a1bc0284;hpb=92445ff3363441d0f515de4a3ab92a504cfc0366;p=collectd.git diff --git a/src/postgresql.c b/src/postgresql.c index 40f8ec57..e6527b95 100644 --- a/src/postgresql.c +++ b/src/postgresql.c @@ -1,6 +1,7 @@ /** * collectd - src/postgresql.c - * Copyright (C) 2008 Sebastian Harl + * Copyright (C) 2008, 2009 Sebastian Harl + * Copyright (C) 2009 Florian Forster * * 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 @@ -15,8 +16,9 @@ * with this program; if not, write to the Free Software Foundation, Inc., * 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA * - * Author: + * Authors: * Sebastian Harl + * Florian Forster **/ /* @@ -29,6 +31,7 @@ #include "configfile.h" #include "plugin.h" +#include "utils_db_query.h" #include "utils_complain.h" #include @@ -38,6 +41,10 @@ #define log_warn(...) WARNING ("postgresql: " __VA_ARGS__) #define log_info(...) INFO ("postgresql: " __VA_ARGS__) +#ifndef C_PSQL_DEFAULT_CONF +# define C_PSQL_DEFAULT_CONF PKGDATADIR "/postgresql_default.conf" +#endif + /* Appends the (parameter, value) pair to the string * pointed to by 'buf' suitable to be used as argument * for PQconnectdb(). If value equals NULL, the pair @@ -72,11 +79,32 @@ C_PSQL_IS_UNIX_DOMAIN_SOCKET (host) ? "/.s.PGSQL." : ":", \ port +typedef enum { + C_PSQL_PARAM_HOST = 1, + C_PSQL_PARAM_DB, + C_PSQL_PARAM_USER, + C_PSQL_PARAM_INTERVAL, +} c_psql_param_t; + +/* Parameter configuration. Stored as `user data' in the query objects. */ +typedef struct { + c_psql_param_t *params; + int params_num; +} c_psql_user_data_t; + typedef struct { PGconn *conn; c_complain_t conn_complaint; + int proto_version; + int server_version; + + int max_params_num; + /* user configuration */ + udb_query_t **queries; + size_t queries_num; + char *host; char *port; char *database; @@ -90,64 +118,83 @@ typedef struct { char *service; } c_psql_database_t; +static char *def_queries[] = { + "backends", + "transactions", + "queries", + "query_plans", + "table_states", + "disk_io", + "disk_usage" +}; +static int def_queries_num = STATIC_ARRAY_SIZE (def_queries); + +static udb_query_t **queries = NULL; +static size_t queries_num = 0; + static c_psql_database_t *databases = NULL; static int databases_num = 0; -static void submit (const c_psql_database_t *db, - const char *type, const char *type_instance, - value_t *values, size_t values_len) +static c_psql_database_t *c_psql_database_new (const char *name) { - value_list_t vl = VALUE_LIST_INIT; + c_psql_database_t *db; - vl.values = values; - vl.values_len = values_len; - vl.time = time (NULL); + ++databases_num; + if (NULL == (databases = (c_psql_database_t *)realloc (databases, + databases_num * sizeof (*databases)))) { + log_err ("Out of memory."); + exit (5); + } - if (C_PSQL_IS_UNIX_DOMAIN_SOCKET (db->host) - || (0 == strcmp (db->host, "localhost"))) - sstrncpy (vl.host, hostname_g, sizeof (vl.host)); - else - sstrncpy (vl.host, db->host, sizeof (vl.host)); + db = databases + (databases_num - 1); - sstrncpy (vl.plugin, "postgresql", sizeof (vl.plugin)); - sstrncpy (vl.plugin_instance, db->database, sizeof (vl.plugin_instance)); + db->conn = NULL; - sstrncpy (vl.type, type, sizeof (vl.type)); + C_COMPLAIN_INIT (&db->conn_complaint); - if (NULL != type_instance) - sstrncpy (vl.type_instance, type_instance, sizeof (vl.type_instance)); + db->proto_version = 0; + db->server_version = 0; - plugin_dispatch_values (&vl); - return; -} /* submit */ + db->max_params_num = 0; -static void submit_counter (const c_psql_database_t *db, - const char *type, const char *type_instance, - const char *value) -{ - value_t values[1]; + db->queries = NULL; + db->queries_num = 0; + + db->database = sstrdup (name); + db->host = NULL; + db->port = NULL; + db->user = NULL; + db->password = NULL; - if ((NULL == value) || ('\0' == *value)) - return; + db->sslmode = NULL; - values[0].counter = atoll (value); - submit (db, type, type_instance, values, 1); - return; -} /* submit_counter */ + db->krbsrvname = NULL; + + db->service = NULL; + return db; +} /* c_psql_database_new */ -static void submit_gauge (const c_psql_database_t *db, - const char *type, const char *type_instance, - const char *value) +static void c_psql_database_delete (c_psql_database_t *db) { - value_t values[1]; + PQfinish (db->conn); + db->conn = NULL; + + sfree (db->queries); + db->queries_num = 0; - if ((NULL == value) || ('\0' == *value)) - return; + sfree (db->database); + sfree (db->host); + sfree (db->port); + sfree (db->user); + sfree (db->password); - values[0].gauge = atof (value); - submit (db, type, type_instance, values, 1); + sfree (db->sslmode); + + sfree (db->krbsrvname); + + sfree (db->service); return; -} /* submit_gauge */ +} /* c_psql_database_delete */ static int c_psql_check_connection (c_psql_database_t *db) { @@ -167,148 +214,182 @@ static int c_psql_check_connection (c_psql_database_t *db) db->database, PQerrorMessage (db->conn)); return -1; } + + db->proto_version = PQprotocolVersion (db->conn); + if (3 > db->proto_version) + log_warn ("Protocol version %d does not support parameters.", + db->proto_version); } + db->server_version = PQserverVersion (db->conn); + c_release (LOG_INFO, &db->conn_complaint, "Successfully reconnected to database %s", PQdb (db->conn)); return 0; } /* c_psql_check_connection */ -static int c_psql_stat_database (c_psql_database_t *db) +static PGresult *c_psql_exec_query_noparams (c_psql_database_t *db, + udb_query_t *q) { - const char *const query = - "SELECT numbackends, xact_commit, xact_rollback " - "FROM pg_stat_database " - "WHERE datname = $1;"; + return PQexec (db->conn, udb_query_get_statement (q)); +} /* c_psql_exec_query_noparams */ - PGresult *res; - - int n; - - res = PQexecParams (db->conn, query, /* number of parameters */ 1, - NULL, (const char *const *)&db->database, NULL, NULL, - /* return text data */ 0); - - if (PGRES_TUPLES_OK != PQresultStatus (res)) { - log_err ("Failed to execute SQL query: %s", - PQerrorMessage (db->conn)); - log_info ("SQL query was: %s", query); - PQclear (res); - return -1; - } - - n = PQntuples (res); - if (1 < n) { - log_warn ("pg_stat_database has more than one entry " - "for database %s - ignoring additional results.", - db->database); - } - else if (1 > n) { - log_err ("pg_stat_database has no entry for database %s", - db->database); - PQclear (res); - return -1; +static PGresult *c_psql_exec_query_params (c_psql_database_t *db, + udb_query_t *q, c_psql_user_data_t *data) +{ + char *params[db->max_params_num]; + char interval[64]; + int i; + + if ((data == NULL) || (data->params_num == 0)) + return (c_psql_exec_query_noparams (db, q)); + + assert (db->max_params_num >= data->params_num); + + for (i = 0; i < data->params_num; ++i) { + switch (data->params[i]) { + case C_PSQL_PARAM_HOST: + params[i] = C_PSQL_IS_UNIX_DOMAIN_SOCKET (db->host) + ? "localhost" : db->host; + break; + case C_PSQL_PARAM_DB: + params[i] = db->database; + break; + case C_PSQL_PARAM_USER: + params[i] = db->user; + break; + case C_PSQL_PARAM_INTERVAL: + ssnprintf (interval, sizeof (interval), "%i", interval_g); + params[i] = interval; + break; + default: + assert (0); + } } - submit_gauge (db, "pg_numbackends", NULL, PQgetvalue (res, 0, 0)); - - submit_counter (db, "pg_xact", "commit", PQgetvalue (res, 0, 1)); - submit_counter (db, "pg_xact", "rollback", PQgetvalue (res, 0, 2)); - - PQclear (res); - return 0; -} /* c_psql_stat_database */ + return PQexecParams (db->conn, udb_query_get_statement (q), + data->params_num, NULL, + (const char *const *) params, + NULL, NULL, /* return text data */ 0); +} /* c_psql_exec_query_params */ -static int c_psql_stat_user_tables (c_psql_database_t *db) +static int c_psql_exec_query (c_psql_database_t *db, udb_query_t *q) { - const char *const query = - "SELECT sum(seq_scan), sum(seq_tup_read), " - "sum(idx_scan), sum(idx_tup_fetch), " - "sum(n_tup_ins), sum(n_tup_upd), sum(n_tup_del), " - "sum(n_tup_hot_upd), sum(n_live_tup), sum(n_dead_tup) " - "FROM pg_stat_user_tables;"; - PGresult *res; - int n; + c_psql_user_data_t *data; - res = PQexec (db->conn, query); + const char *host; - if (PGRES_TUPLES_OK != PQresultStatus (res)) { - log_err ("Failed to execute SQL query: %s", - PQerrorMessage (db->conn)); - log_info ("SQL query was: %s", query); - PQclear (res); - return -1; - } - - n = PQntuples (res); - assert (1 >= n); - - if (1 > n) /* no user tables */ - return 0; + char **column_names; + char **column_values; + int column_num; - submit_counter (db, "pg_scan", "seq", PQgetvalue (res, 0, 0)); - submit_counter (db, "pg_scan", "seq_tup_read", PQgetvalue (res, 0, 1)); - submit_counter (db, "pg_scan", "idx", PQgetvalue (res, 0, 2)); - submit_counter (db, "pg_scan", "idx_tup_fetch", PQgetvalue (res, 0, 3)); + int rows_num; + int status; + int row, col; - submit_counter (db, "pg_n_tup_c", "ins", PQgetvalue (res, 0, 4)); - submit_counter (db, "pg_n_tup_c", "upd", PQgetvalue (res, 0, 5)); - submit_counter (db, "pg_n_tup_c", "del", PQgetvalue (res, 0, 6)); - submit_counter (db, "pg_n_tup_c", "hot_upd", PQgetvalue (res, 0, 7)); - - submit_gauge (db, "pg_n_tup_g", "live", PQgetvalue (res, 0, 8)); - submit_gauge (db, "pg_n_tup_g", "dead", PQgetvalue (res, 0, 9)); - - PQclear (res); - return 0; -} /* c_psql_stat_user_tables */ - -static int c_psql_statio_user_tables (c_psql_database_t *db) -{ - const char *const query = - "SELECT sum(heap_blks_read), sum(heap_blks_hit), " - "sum(idx_blks_read), sum(idx_blks_hit), " - "sum(toast_blks_read), sum(toast_blks_hit), " - "sum(tidx_blks_read), sum(tidx_blks_hit) " - "FROM pg_statio_user_tables;"; + /* The user data may hold parameter information, but may be NULL. */ + data = udb_query_get_user_data (q); - PGresult *res; + /* Versions up to `3' don't know how to handle parameters. */ + if (3 <= db->proto_version) + res = c_psql_exec_query_params (db, q, data); + else if ((NULL == data) || (0 == data->params_num)) + res = c_psql_exec_query_noparams (db, q); + else { + log_err ("Connection to database \"%s\" does not support parameters " + "(protocol version %d) - cannot execute query \"%s\".", + db->database, db->proto_version, + udb_query_get_name (q)); + return -1; + } - int n; + column_names = NULL; + column_values = NULL; - res = PQexec (db->conn, query); +#define BAIL_OUT(status) \ + sfree (column_names); \ + sfree (column_values); \ + PQclear (res); \ + return status if (PGRES_TUPLES_OK != PQresultStatus (res)) { log_err ("Failed to execute SQL query: %s", PQerrorMessage (db->conn)); - log_info ("SQL query was: %s", query); - PQclear (res); - return -1; + log_info ("SQL query was: %s", + udb_query_get_statement (q)); + BAIL_OUT (-1); } - n = PQntuples (res); - assert (1 >= n); + rows_num = PQntuples (res); + if (1 > rows_num) { + BAIL_OUT (0); + } - if (1 > n) /* no user tables */ - return 0; + column_num = PQnfields (res); + column_names = (char **) calloc (column_num, sizeof (char *)); + if (NULL == column_names) { + log_err ("calloc failed."); + BAIL_OUT (-1); + } + + column_values = (char **) calloc (column_num, sizeof (char *)); + if (NULL == column_values) { + log_err ("calloc failed."); + BAIL_OUT (-1); + } + + for (col = 0; col < column_num; ++col) { + /* Pointers returned by `PQfname' are freed by `PQclear' via + * `BAIL_OUT'. */ + column_names[col] = PQfname (res, col); + if (NULL == column_names[col]) { + log_err ("Failed to resolve name of column %i.", col); + BAIL_OUT (-1); + } + } - submit_counter (db, "pg_blks", "heap_read", PQgetvalue (res, 0, 0)); - submit_counter (db, "pg_blks", "heap_hit", PQgetvalue (res, 0, 1)); + if (C_PSQL_IS_UNIX_DOMAIN_SOCKET (db->host) + || (0 == strcmp (db->host, "localhost"))) + host = hostname_g; + else + host = db->host; + + status = udb_query_prepare_result (q, host, "postgresql", + db->database, column_names, (size_t) column_num); + if (0 != status) { + log_err ("udb_query_prepare_result failed with status %i.", + status); + BAIL_OUT (-1); + } - submit_counter (db, "pg_blks", "idx_read", PQgetvalue (res, 0, 2)); - submit_counter (db, "pg_blks", "idx_hit", PQgetvalue (res, 0, 3)); + for (row = 0; row < rows_num; ++row) { + for (col = 0; col < column_num; ++col) { + /* Pointers returned by `PQgetvalue' are freed by `PQclear' via + * `BAIL_OUT'. */ + column_values[col] = PQgetvalue (res, row, col); + if (NULL == column_values[col]) { + log_err ("Failed to get value at (row = %i, col = %i).", + row, col); + break; + } + } - submit_counter (db, "pg_blks", "toast_read", PQgetvalue (res, 0, 4)); - submit_counter (db, "pg_blks", "toast_hit", PQgetvalue (res, 0, 5)); + /* check for an error */ + if (col < column_num) + continue; - submit_counter (db, "pg_blks", "tidx_read", PQgetvalue (res, 0, 6)); - submit_counter (db, "pg_blks", "tidx_hit", PQgetvalue (res, 0, 7)); + status = udb_query_handle_result (q, column_values); + if (status != 0) { + log_err ("udb_query_handle_result failed with status %i.", + status); + } + } /* for (row = 0; row < rows_num; ++row) */ - PQclear (res); - return 0; -} /* c_psql_statio_user_tables */ + BAIL_OUT (0); +#undef BAIL_OUT +} /* c_psql_exec_query */ static int c_psql_read (void) { @@ -318,14 +399,25 @@ static int c_psql_read (void) for (i = 0; i < databases_num; ++i) { c_psql_database_t *db = databases + i; + int j; + assert (NULL != db->database); if (0 != c_psql_check_connection (db)) continue; - c_psql_stat_database (db); - c_psql_stat_user_tables (db); - c_psql_statio_user_tables (db); + for (j = 0; j < db->queries_num; ++j) + { + udb_query_t *q; + + q = db->queries[j]; + + if ((0 != db->server_version) + && (udb_query_check_version (q, db->server_version) <= 0)) + continue; + + c_psql_exec_query (db, q); + } ++success; } @@ -345,26 +437,16 @@ static int c_psql_shutdown (void) plugin_unregister_read ("postgresql"); plugin_unregister_shutdown ("postgresql"); - for (i = 0; i < databases_num; ++i) { - c_psql_database_t *db = databases + i; - - PQfinish (db->conn); - - sfree (db->database); - sfree (db->host); - sfree (db->port); - sfree (db->user); - sfree (db->password); - - sfree (db->sslmode); - - sfree (db->krbsrvname); - - sfree (db->service); - } + for (i = 0; i < databases_num; ++i) + c_psql_database_delete (databases + i); sfree (databases); databases_num = 0; + + udb_query_free (queries, queries_num); + queries = NULL; + queries_num = 0; + return 0; } /* c_psql_shutdown */ @@ -386,6 +468,12 @@ static int c_psql_init (void) char *server_host; int server_version; + /* this will happen during reinitialization */ + if (NULL != db->conn) { + c_psql_check_connection (db); + continue; + } + status = ssnprintf (buf, buf_len, "dbname = '%s'", db->database); if (0 < status) { buf += status; @@ -404,15 +492,21 @@ static int c_psql_init (void) if (0 != c_psql_check_connection (db)) continue; + db->proto_version = PQprotocolVersion (db->conn); + server_host = PQhost (db->conn); server_version = PQserverVersion (db->conn); - log_info ("Sucessfully connected to database %s (user %s) " + log_info ("Successfully connected to database %s (user %s) " "at server %s%s%s (server version: %d.%d.%d, " "protocol version: %d, pid: %d)", PQdb (db->conn), PQuser (db->conn), - C_PSQL_SOCKET3(server_host, PQport (db->conn)), + C_PSQL_SOCKET3 (server_host, PQport (db->conn)), C_PSQL_SERVER_VERSION3 (server_version), - PQprotocolVersion (db->conn), PQbackendPID (db->conn)); + db->proto_version, PQbackendPID (db->conn)); + + if (3 > db->proto_version) + log_warn ("Protocol version %d does not support parameters.", + db->proto_version); } plugin_register_read ("postgresql", c_psql_read); @@ -420,7 +514,7 @@ static int c_psql_init (void) return 0; } /* c_psql_init */ -static int config_set (char *name, char **var, const oconfig_item_t *ci) +static int config_set_s (char *name, char **var, const oconfig_item_t *ci) { if ((0 != ci->children_num) || (1 != ci->values_num) || (OCONFIG_TYPE_STRING != ci->values[0].type)) { @@ -431,77 +525,150 @@ static int config_set (char *name, char **var, const oconfig_item_t *ci) sfree (*var); *var = sstrdup (ci->values[0].value.string); return 0; -} /* config_set */ +} /* config_set_s */ -static int c_psql_config_database (oconfig_item_t *ci) +static int config_query_param_add (udb_query_t *q, oconfig_item_t *ci) { - c_psql_database_t *db; + c_psql_user_data_t *data; + const char *param_str; - int i; + c_psql_param_t *tmp; - if ((1 != ci->values_num) - || (OCONFIG_TYPE_STRING != ci->values[0].type)) { - log_err (" expects a single string argument."); - return 1; + data = udb_query_get_user_data (q); + if (NULL == data) { + data = (c_psql_user_data_t *) smalloc (sizeof (*data)); + if (NULL == data) { + log_err ("Out of memory."); + return -1; + } + memset (data, 0, sizeof (*data)); + data->params = NULL; } - ++databases_num; - if (NULL == (databases = (c_psql_database_t *)realloc (databases, - databases_num * sizeof (*databases)))) { + tmp = (c_psql_param_t *) realloc (data->params, + (data->params_num + 1) * sizeof (c_psql_param_t)); + if (NULL == tmp) { log_err ("Out of memory."); - exit (5); + return -1; + } + data->params = tmp; + + param_str = ci->values[0].value.string; + if (0 == strcasecmp (param_str, "hostname")) + data->params[data->params_num] = C_PSQL_PARAM_HOST; + else if (0 == strcasecmp (param_str, "database")) + data->params[data->params_num] = C_PSQL_PARAM_DB; + else if (0 == strcasecmp (param_str, "username")) + data->params[data->params_num] = C_PSQL_PARAM_USER; + else if (0 == strcasecmp (param_str, "interval")) + data->params[data->params_num] = C_PSQL_PARAM_INTERVAL; + else { + log_err ("Invalid parameter \"%s\".", param_str); + return 1; } - db = databases + (databases_num - 1); + data->params_num++; + udb_query_set_user_data (q, data); - db->conn = NULL; + return (0); +} /* config_query_param_add */ - db->conn_complaint.last = 0; - db->conn_complaint.interval = 0; +static int config_query_callback (udb_query_t *q, oconfig_item_t *ci) +{ + if (0 == strcasecmp ("Param", ci->key)) + return config_query_param_add (q, ci); - db->database = sstrdup (ci->values[0].value.string); - db->host = NULL; - db->port = NULL; - db->user = NULL; - db->password = NULL; + log_err ("Option not allowed within a Query block: `%s'", ci->key); - db->sslmode = NULL; + return (-1); +} /* config_query_callback */ - db->krbsrvname = NULL; +static int c_psql_config_database (oconfig_item_t *ci) +{ + c_psql_database_t *db; - db->service = NULL; + int i; + + if ((1 != ci->values_num) + || (OCONFIG_TYPE_STRING != ci->values[0].type)) { + log_err (" expects a single string argument."); + return 1; + } + + db = c_psql_database_new (ci->values[0].value.string); for (i = 0; i < ci->children_num; ++i) { oconfig_item_t *c = ci->children + i; if (0 == strcasecmp (c->key, "Host")) - config_set ("Host", &db->host, c); + config_set_s ("Host", &db->host, c); else if (0 == strcasecmp (c->key, "Port")) - config_set ("Port", &db->port, c); + config_set_s ("Port", &db->port, c); else if (0 == strcasecmp (c->key, "User")) - config_set ("User", &db->user, c); + config_set_s ("User", &db->user, c); else if (0 == strcasecmp (c->key, "Password")) - config_set ("Password", &db->password, c); + config_set_s ("Password", &db->password, c); else if (0 == strcasecmp (c->key, "SSLMode")) - config_set ("SSLMode", &db->sslmode, c); + config_set_s ("SSLMode", &db->sslmode, c); else if (0 == strcasecmp (c->key, "KRBSrvName")) - config_set ("KRBSrvName", &db->krbsrvname, c); + config_set_s ("KRBSrvName", &db->krbsrvname, c); else if (0 == strcasecmp (c->key, "Service")) - config_set ("Service", &db->service, c); + config_set_s ("Service", &db->service, c); + else if (0 == strcasecmp (c->key, "Query")) + udb_query_pick_from_list (c, queries, queries_num, + &db->queries, &db->queries_num); else log_warn ("Ignoring unknown config key \"%s\".", c->key); } + + /* If no `Query' options were given, add the default queries.. */ + if (db->queries_num == 0) + { + for (i = 0; i < def_queries_num; i++) + udb_query_pick_from_list_by_name (def_queries[i], + queries, queries_num, + &db->queries, &db->queries_num); + } + + for (i = 0; (size_t)i < db->queries_num; ++i) { + c_psql_user_data_t *data; + data = udb_query_get_user_data (db->queries[i]); + if ((data != NULL) && (data->params_num > db->max_params_num)) + db->max_params_num = data->params_num; + } return 0; -} +} /* c_psql_config_database */ static int c_psql_config (oconfig_item_t *ci) { + static int have_def_config = 0; + int i; + if (0 == have_def_config) { + oconfig_item_t *c; + + have_def_config = 1; + + c = oconfig_parse_file (C_PSQL_DEFAULT_CONF); + if (NULL == c) + log_err ("Failed to read default config ("C_PSQL_DEFAULT_CONF")."); + else + c_psql_config (c); + + if (NULL == queries) + log_err ("Default config ("C_PSQL_DEFAULT_CONF") did not define " + "any queries - please check your installation."); + } + for (i = 0; i < ci->children_num; ++i) { oconfig_item_t *c = ci->children + i; - if (0 == strcasecmp (c->key, "Database")) + if (0 == strcasecmp (c->key, "Query")) + udb_query_create (&queries, &queries_num, c, + /* callback = */ config_query_callback, + /* legacy mode = */ 1); + else if (0 == strcasecmp (c->key, "Database")) c_psql_config_database (c); else log_warn ("Ignoring unknown config key \"%s\".", c->key); @@ -516,4 +683,3 @@ void module_register (void) } /* module_register */ /* vim: set sw=4 ts=4 tw=78 noexpandtab : */ -