Code

Added initial version of the puppet-storeconfigs backend.
authorSebastian Harl <sh@tokkee.org>
Mon, 10 Dec 2012 14:41:45 +0000 (15:41 +0100)
committerSebastian Harl <sh@tokkee.org>
Mon, 10 Dec 2012 14:41:45 +0000 (15:41 +0100)
This backend currently retrieves host information from Puppet by querying its
Store-Configs database using DBI.

configure.ac
src/Makefile.am
src/backend/puppet-storeconfigs.c [new file with mode: 0644]

index d6e21c1..ae9318c 100644 (file)
@@ -222,12 +222,20 @@ if test "x$A2X" = "x"; then
 fi
 AC_SUBST([A2X])
 
+dnl Plugin checks.
+enable_puppet_storeconfigs=$with_libdbi
+if test "x$enable_puppet_storeconfigs" = "xno"; then
+       enable_puppet_storeconfigs="no (requires libdbi)"
+fi
+
 m4_divert_once([HELP_ENABLE], [
 Backends:])
 
 AC_SC_PLUGIN_INIT
 AC_SC_PLUGIN([collectd], [yes],
                [backend accessing the system statistics collection daemon])
+AC_SC_PLUGIN([puppet-storeconfigs], [$enable_puppet_storeconfigs],
+               [backend accessing the Puppet stored configuration database])
 
 AM_CONDITIONAL([BUILD_DOCUMENTATION], test "x$build_documentation" = "xyes")
 
@@ -260,6 +268,7 @@ AC_MSG_RESULT([     libdbi:  . . . . . . . . . $with_libdbi])
 AC_MSG_RESULT()
 AC_MSG_RESULT([  Backends:])
 AC_MSG_RESULT([    collectd: . . . . . . . . . $enable_collectd])
+AC_MSG_RESULT([    puppet-storeconfigs:  . . . $enable_puppet_storeconfigs])
 AC_MSG_RESULT()
 AC_MSG_RESULT([This package is maintained by $PACKAGE_MAINTAINER.])
 AC_MSG_RESULT([Please report bugs to $PACKAGE_BUGREPORT.])
index 4544b5d..20db92b 100644 (file)
@@ -59,6 +59,14 @@ libsyscollector_la_LIBADD += -dlopen backend/collectd.la
 libsyscollector_la_DEPENDENCIES += backend/collectd.la
 endif
 
+if BUILD_PLUGIN_PUPPETSTORECONFIGS
+pkgbackendlib_LTLIBRARIES += backend/puppet-storeconfigs.la
+backend_puppet_storeconfigs_la_SOURCES = backend/puppet-storeconfigs.c
+backend_puppet_storeconfigs_la_LDFLAGS = -module -avoid-version
+libsyscollector_la_LIBADD += -dlopen backend/puppet-storeconfigs.la
+libsyscollector_la_DEPENDENCIES += backend/puppet-storeconfigs.la
+endif
+
 include/syscollector.h: include/syscollector.h.in ../version
        source ../version; sed \
            -e "s/@SC_VERSION_MAJOR@/$$VERSION_MAJOR/g" \
diff --git a/src/backend/puppet-storeconfigs.c b/src/backend/puppet-storeconfigs.c
new file mode 100644 (file)
index 0000000..5ebd16f
--- /dev/null
@@ -0,0 +1,315 @@
+/*
+ * syscollector - src/backend/puppet-storeconfigs.c
+ * Copyright (C) 2012 Sebastian 'tokkee' Harl <sh@tokkee.org>
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions
+ * are met:
+ * 1. Redistributions of source code must retain the above copyright
+ *    notice, this list of conditions and the following disclaimer.
+ * 2. Redistributions in binary form must reproduce the above copyright
+ *    notice, this list of conditions and the following disclaimer in the
+ *    documentation and/or other materials provided with the distribution.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
+ * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+ * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR
+ * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+ * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+ * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
+ * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
+ * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
+ * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
+ * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+#include "syscollector.h"
+#include "core/plugin.h"
+#include "core/store.h"
+#include "utils/dbi.h"
+#include "utils/string.h"
+
+#include "liboconfig/utils.h"
+
+#include <dbi/dbi.h>
+
+#include <assert.h>
+#include <errno.h>
+
+#include <string.h>
+#include <strings.h>
+
+SC_PLUGIN_MAGIC;
+
+/*
+ * private helper functions
+ */
+
+static int
+sc_puppet_stcfg_get_data(sc_dbi_client_t __attribute__((unused)) *client,
+               size_t n, sc_dbi_data_t *data)
+{
+       sc_host_t host = SC_HOST_INIT;
+
+       assert(n == 2);
+       assert((data[0].type == DBI_TYPE_STRING)
+                       && (data[1].type == DBI_TYPE_DATETIME));
+
+       host.host_name = strdup(data[0].data.string);
+       host.host_last_update = data[1].data.datetime;
+
+       if (sc_store_host(&host)) {
+               fprintf(stderr, "puppet storeconfigs backend: Failed to store/update "
+                               "host '%s'.\n", host.host_name);
+               free(host.host_name);
+               return -1;
+       }
+
+       fprintf(stderr, "puppet storeconfigs backend: Added/updated host '%s' "
+                       "(last update timestamp = %"PRIscTIME").\n",
+                       host.host_name, host.host_last_update);
+       free(host.host_name);
+       return 0;
+} /* sc_puppet_stcfg_get_data */
+
+/*
+ * plugin API
+ */
+
+static int
+sc_puppet_stcfg_init(sc_object_t *user_data)
+{
+       sc_dbi_client_t *client;
+
+       if (! user_data)
+               return -1;
+
+       client = SC_OBJ_WRAPPER(user_data)->data;
+       if (sc_dbi_client_connect(client)) {
+               fprintf(stderr, "puppet storeconfigs backend: "
+                               "Failed to connect to the storeconfigs DB.\n");
+               return -1;
+       }
+
+       fprintf(stderr, "puppet storeconfigs backend: Successfully "
+                       "connected to the storeconfigs DB.\n");
+       return 0;
+} /* sc_collectd_init */
+
+static int
+sc_puppet_stcfg_collect(sc_object_t *user_data)
+{
+       sc_dbi_client_t *client;
+
+       if (! user_data)
+               return -1;
+
+       client = SC_OBJ_WRAPPER(user_data)->data;
+       if (sc_dbi_exec_query(client, "SELECT name, updated_at FROM hosts;",
+                               sc_puppet_stcfg_get_data, /* #columns = */ 2,
+                               /* col types = */ DBI_TYPE_STRING, DBI_TYPE_DATETIME)) {
+               fprintf(stderr, "puppet storeconfigs backend: Failed to retrieve "
+                               "hosts from the storeconfigs DB.\n");
+               return -1;
+       }
+       return 0;
+} /* sc_collectd_collect */
+
+static int
+sc_puppet_stcfg_config_conn(oconfig_item_t *ci)
+{
+       char *name = NULL;
+       char cb_name[1024];
+
+       sc_object_t *user_data;
+       sc_dbi_client_t *client;
+       sc_dbi_options_t *options = NULL;
+
+       char *driver = NULL;
+       char *database = NULL;
+
+       int i;
+
+       if (oconfig_get_string(ci, &name)) {
+               fprintf(stderr, "puppet storeconfigs backend: Connection requires a "
+                               "single string argument\n\tUsage: <Connection NAME>\n");
+               return -1;
+       }
+
+       for (i = 0; i < ci->children_num; ++i) {
+               oconfig_item_t *child = ci->children + i;
+               char *key = NULL, *value = NULL;
+
+               int status = 0;
+
+               if (! strcasecmp(child->key, "DBAdapter")) {
+                       if (oconfig_get_string(child, &driver)) {
+                               fprintf(stderr, "puppet storeconfigs backend: DBAdapter "
+                                               "requires a single string argument inside "
+                                               "<Connection %s>\n\tUsage: DBAdapter NAME\n",
+                                               name);
+                       }
+                       continue;
+               }
+               else if (! strcasecmp(child->key, "DBName")) {
+                       if (oconfig_get_string(child, &database)) {
+                               fprintf(stderr, "puppet storeconfigs backend: DBName"
+                                               "requires a single string argument inside "
+                                               "<Connection %s>\n\tUsage: DBName NAME\n",
+                                               name);
+                       }
+                       continue;
+               }
+               else if (! strcasecmp(child->key, "DBServer")) {
+                       status = oconfig_get_string(child, &value);
+                       key = "host";
+               }
+               else if (! strcasecmp(child->key, "DBPort")) {
+                       status = oconfig_get_string(child, &value);
+                       key = "port";
+               }
+               else if (! strcasecmp(child->key, "DBUser")) {
+                       status = oconfig_get_string(child, &value);
+                       key = "username";
+               }
+               else if (! strcasecmp(child->key, "DBPassword")) {
+                       status = oconfig_get_string(child, &value);
+                       key = "password";
+               }
+               else if (! strcasecmp(child->key, "DBIOption")) {
+                       if ((child->values_num != 2)
+                                       || (child->values[0].type != OCONFIG_TYPE_STRING)
+                                       || (child->values[1].type != OCONFIG_TYPE_STRING)) {
+                               fprintf(stderr, "puppet storeconfigs backend: DBIOption "
+                                               "requires exactly two string arguments inside "
+                                               "<Connection %s>\n\tUsage: DBIOption KEY VALUE\n",
+                                               name);
+                               continue;
+                       }
+
+                       status = 0;
+                       key = child->values[0].value.string;
+                       value = child->values[1].value.string;
+               }
+               else {
+                       fprintf(stderr, "puppet storeconfigs backend: Ignoring unknown "
+                                       "config option '%s' inside <Connection %s>.\n",
+                                       child->key, name);
+                       continue;
+               }
+
+               if (status) {
+                       fprintf(stderr, "puppet storeconfigs backend: Option '%s' "
+                                       "requires a single string argument inside "
+                                       "<Connection %s>\n\tUsage: DBAdapter NAME\n",
+                                       child->key, name);
+                       continue;
+               }
+
+               assert(key && value);
+
+               if (! options) {
+                       if (! (options = sc_dbi_options_create())) {
+                               char errmsg[1024];
+                               fprintf(stderr, "puppet storeconfigs backend: Failed to "
+                                               "create DBI options object: %s\n",
+                                               sc_strerror(errno, errmsg, sizeof(errmsg)));
+                               continue;
+                       }
+               }
+
+               if (sc_dbi_options_add(options, key, value)) {
+                       char errmsg[1024];
+                       fprintf(stderr, "puppet storeconfigs backend: Failed to add "
+                                       "option '%s': %s\n", key,
+                                       sc_strerror(errno, errmsg, sizeof(errmsg)));
+                       continue;
+               }
+       }
+
+       if (! driver) {
+               fprintf(stderr, "puppet storeconfigs backend: Connection '%s' "
+                               "missing the 'DBAdapter' option.\n", name);
+               return -1;
+       }
+       if (! database) {
+               fprintf(stderr, "puppet storeconfigs backend: Connection '%s' "
+                               "missing the 'DBName' option.\n", name);
+               return -1;
+       }
+
+       snprintf(cb_name, sizeof(cb_name), "puppet-storeconfigs-%s", name);
+       cb_name[sizeof(cb_name) - 1] = '\0';
+
+       client = sc_dbi_client_create(driver, database);
+       if (! client) {
+               char errbuf[1024];
+               fprintf(stderr, "puppet storeconfigs backend: "
+                               "Failed to create DBI client: %s\n",
+                               sc_strerror(errno, errbuf, sizeof(errbuf)));
+               return -1;
+       }
+
+       sc_dbi_client_set_options(client, options);
+
+       user_data = sc_object_create_wrapper(client,
+                       (void (*)(void *))sc_dbi_client_destroy);
+       if (! user_data) {
+               sc_dbi_client_destroy(client);
+               fprintf(stderr, "puppet storeconfigs backend: "
+                               "Failed to allocate sc_object_t\n");
+               return -1;
+       }
+
+       sc_plugin_register_init(cb_name, sc_puppet_stcfg_init, user_data);
+       sc_plugin_register_collector(cb_name, sc_puppet_stcfg_collect,
+                       /* interval */ NULL, user_data);
+
+       /* pass control to the list */
+       sc_object_deref(user_data);
+       return 0;
+} /* sc_puppet_stcfg_config_conn */
+
+static int
+sc_puppet_stcfg_config(oconfig_item_t *ci)
+{
+       int i;
+
+       for (i = 0; i < ci->children_num; ++i) {
+               oconfig_item_t *child = ci->children + i;
+
+               if (! strcasecmp(child->key, "Connection"))
+                       sc_puppet_stcfg_config_conn(child);
+               else
+                       fprintf(stderr, "puppet storeconfigs backend: Ignoring unknown "
+                                       "config option '%s'.\n", child->key);
+       }
+       return 0;
+} /* sc_puppet_stcfg_config */
+
+int
+sc_module_init(sc_plugin_info_t *info)
+{
+       sc_plugin_set_info(info, SC_PLUGIN_INFO_NAME, "puppet-storeconfigs");
+       sc_plugin_set_info(info, SC_PLUGIN_INFO_DESC,
+                       "backend accessing the Puppet stored configuration database");
+       sc_plugin_set_info(info, SC_PLUGIN_INFO_COPYRIGHT,
+                       "Copyright (C) 2012 Sebastian 'tokkee' Harl <sh@tokkee.org>");
+       sc_plugin_set_info(info, SC_PLUGIN_INFO_LICENSE, "BSD");
+       sc_plugin_set_info(info, SC_PLUGIN_INFO_VERSION, SC_VERSION);
+       sc_plugin_set_info(info, SC_PLUGIN_INFO_PLUGIN_VERSION, SC_VERSION);
+
+       if (dbi_initialize(/* driver dir = */ NULL) < 0) {
+               fprintf(stderr, "puppet storeconfigs backend: failed to initialize "
+                               "DBI; possibly you don't have any drivers installed.\n");
+               return -1;
+       }
+
+       sc_plugin_register_config("puppet-storeconfigs", sc_puppet_stcfg_config);
+       return 0;
+} /* sc_version_extra */
+
+/* vim: set tw=78 sw=4 ts=4 noexpandtab : */
+