Code

plugin: Dynamically populate timeseries information when querying metrics.
[sysdb.git] / src / core / plugin.c
index 44ea48a06b53e38434cd23a6a9a951d689d48cf2..ecd84b5f9c5f5f525017872ecdf54fe234a6267f 100644 (file)
@@ -114,6 +114,14 @@ typedef struct {
 } reader_t;
 #define READER(obj) ((reader_t *)(obj))
 
+typedef struct {
+       callback_t super; /* cb_callback will always be NULL */
+#define ts_user_data super.cb_user_data
+#define ts_ctx super.cb_ctx
+       sdb_timeseries_fetcher_t impl;
+} ts_fetcher_t;
+#define TS_FETCHER(obj) ((ts_fetcher_t *)(obj))
+
 /*
  * private variables
  */
@@ -133,7 +141,7 @@ static sdb_llist_t      *collector_list = NULL;
 static sdb_llist_t      *cname_list = NULL;
 static sdb_llist_t      *shutdown_list = NULL;
 static sdb_llist_t      *log_list = NULL;
-static sdb_llist_t      *ts_fetcher_list = NULL;
+static sdb_llist_t      *timeseries_fetcher_list = NULL;
 static sdb_llist_t      *writer_list = NULL;
 static sdb_llist_t      *reader_list = NULL;
 
@@ -147,7 +155,7 @@ static struct {
        { "cname",              &cname_list },
        { "shutdown",           &shutdown_list },
        { "log",                &log_list },
-       { "timeseries fetcher", &ts_fetcher_list },
+       { "timeseries fetcher", &timeseries_fetcher_list },
        { "store writer",       &writer_list },
        { "store reader",       &reader_list },
 };
@@ -259,6 +267,73 @@ plugin_unregister_by_name(const char *plugin_name)
        /* else: other callbacks still reference it */
 } /* plugin_unregister_by_name */
 
+/*
+ * store writer wrapper for performing database queries:
+ * It wraps another store writer, adding extra logic as needed.
+ */
+
+typedef struct {
+       sdb_object_t super;
+       sdb_store_writer_t *w;
+       sdb_object_t *ud;
+} query_writer_t;
+#define QUERY_WRITER_INIT(w, ud) { SDB_OBJECT_INIT, (w), (ud) }
+#define QUERY_WRITER(obj) ((query_writer_t *)(obj))
+
+static int
+query_store_host(sdb_store_host_t *host, sdb_object_t *user_data)
+{
+       query_writer_t *qw = QUERY_WRITER(user_data);
+       return qw->w->store_host(host, qw->ud);
+} /* query_store_host */
+
+static int
+query_store_service(sdb_store_service_t *service, sdb_object_t *user_data)
+{
+       query_writer_t *qw = QUERY_WRITER(user_data);
+       return qw->w->store_service(service, qw->ud);
+} /* query_store_service */
+
+static int
+query_store_metric(sdb_store_metric_t *metric, sdb_object_t *user_data)
+{
+       query_writer_t *qw = QUERY_WRITER(user_data);
+       sdb_timeseries_info_t *infos[metric->stores_num];
+       sdb_metric_store_t stores[metric->stores_num];
+
+       const sdb_metric_store_t *orig_stores = metric->stores;
+       int status;
+       size_t i;
+
+       for (i = 0; i < metric->stores_num; i++) {
+               /* TODO: Make this optional using query options. */
+               sdb_metric_store_t *s = stores + i;
+               *s = metric->stores[i];
+               infos[i] = sdb_plugin_describe_timeseries(s->type, s->id);
+               s->info = infos[i];
+       }
+
+       metric->stores = stores;
+       status = qw->w->store_metric(metric, qw->ud);
+       metric->stores = orig_stores;
+
+       for (i = 0; i < metric->stores_num; i++)
+               sdb_timeseries_info_destroy(infos[i]);
+       return status;
+} /* query_store_metric */
+
+static int
+query_store_attribute(sdb_store_attribute_t *attr, sdb_object_t *user_data)
+{
+       query_writer_t *qw = QUERY_WRITER(user_data);
+       return qw->w->store_attribute(attr, qw->ud);
+} /* query_store_attribute */
+
+static sdb_store_writer_t query_writer = {
+       query_store_host, query_store_service,
+       query_store_metric, query_store_attribute,
+};
+
 /*
  * private types
  */
@@ -505,6 +580,52 @@ static sdb_type_t reader_type = {
        plugin_reader_destroy
 };
 
+static int
+plugin_ts_fetcher_init(sdb_object_t *obj, va_list ap)
+{
+       sdb_timeseries_fetcher_t *impl;
+       sdb_object_t *ud;
+
+       if (! plugin_init_ok(obj, ap))
+               return -1;
+
+       impl = va_arg(ap, sdb_timeseries_fetcher_t *);
+       ud = va_arg(ap, sdb_object_t *);
+       assert(impl);
+
+       if ((! impl->describe) || (! impl->fetch)) {
+               sdb_log(SDB_LOG_ERR, "core: timeseries fetcher callback '%s' "
+                               "does not fully implement the interface.",
+                               obj->name);
+               return -1;
+       }
+
+       /* ctx may be NULL if the callback was not registered by a plugin */
+
+       TS_FETCHER(obj)->impl = *impl;
+       TS_FETCHER(obj)->ts_ctx  = ctx_get();
+       sdb_object_ref(SDB_OBJ(TS_FETCHER(obj)->ts_ctx));
+
+       sdb_object_ref(ud);
+       TS_FETCHER(obj)->ts_user_data = ud;
+       return 0;
+} /* plugin_ts_fetcher_init */
+
+static void
+plugin_ts_fetcher_destroy(sdb_object_t *obj)
+{
+       assert(obj);
+       sdb_object_deref(TS_FETCHER(obj)->ts_user_data);
+       sdb_object_deref(SDB_OBJ(TS_FETCHER(obj)->ts_ctx));
+} /* plugin_ts_fetcher_destroy */
+
+static sdb_type_t ts_fetcher_type = {
+       sizeof(ts_fetcher_t),
+
+       plugin_ts_fetcher_init,
+       plugin_ts_fetcher_destroy
+};
+
 static int
 module_init(const char *name, lt_dlhandle lh, sdb_plugin_info_t *info)
 {
@@ -1013,12 +1134,12 @@ sdb_plugin_register_collector(const char *name, sdb_plugin_collector_cb callback
 } /* sdb_plugin_register_collector */
 
 int
-sdb_plugin_register_ts_fetcher(const char *name,
-               sdb_plugin_fetch_ts_cb callback, sdb_object_t *user_data)
+sdb_plugin_register_timeseries_fetcher(const char *name,
+               sdb_timeseries_fetcher_t *fetcher, sdb_object_t *user_data)
 {
-       return plugin_add_impl(&ts_fetcher_list, callback_type, "time-series fetcher",
-                       name, callback, user_data);
-} /* sdb_plugin_register_ts_fetcher */
+       return plugin_add_impl(&timeseries_fetcher_list, ts_fetcher_type, "time-series fetcher",
+                       name, fetcher, user_data);
+} /* sdb_plugin_register_timeseries_fetcher */
 
 int
 sdb_plugin_register_writer(const char *name,
@@ -1479,8 +1600,7 @@ sdb_timeseries_t *
 sdb_plugin_fetch_timeseries(const char *type, const char *id,
                sdb_timeseries_opts_t *opts)
 {
-       callback_t *plugin;
-       sdb_plugin_fetch_ts_cb callback;
+       ts_fetcher_t *fetcher;
        sdb_timeseries_t *ts;
 
        ctx_t *old_ctx;
@@ -1488,28 +1608,54 @@ sdb_plugin_fetch_timeseries(const char *type, const char *id,
        if ((! type) || (! id) || (! opts))
                return NULL;
 
-       plugin = CB(sdb_llist_search_by_name(ts_fetcher_list, type));
-       if (! plugin) {
+       fetcher = TS_FETCHER(sdb_llist_search_by_name(timeseries_fetcher_list, type));
+       if (! fetcher) {
                sdb_log(SDB_LOG_ERR, "core: Cannot fetch time-series of type %s: "
                                "no such plugin loaded", type);
                errno = ENOENT;
                return NULL;
        }
 
-       old_ctx = ctx_set(plugin->cb_ctx);
-       callback = (sdb_plugin_fetch_ts_cb)plugin->cb_callback;
-       ts = callback(id, opts, plugin->cb_user_data);
+       old_ctx = ctx_set(fetcher->ts_ctx);
+       ts = fetcher->impl.fetch(id, opts, fetcher->ts_user_data);
        ctx_set(old_ctx);
        return ts;
 } /* sdb_plugin_fetch_timeseries */
 
+sdb_timeseries_info_t *
+sdb_plugin_describe_timeseries(const char *type, const char *id)
+{
+       ts_fetcher_t *fetcher;
+       sdb_timeseries_info_t *ts_info;
+
+       ctx_t *old_ctx;
+
+       if ((! type) || (! id))
+               return NULL;
+
+       fetcher = TS_FETCHER(sdb_llist_search_by_name(timeseries_fetcher_list, type));
+       if (! fetcher) {
+               sdb_log(SDB_LOG_ERR, "core: Cannot describe time-series of type %s: "
+                               "no such plugin loaded", type);
+               errno = ENOENT;
+               return NULL;
+       }
+
+       old_ctx = ctx_set(fetcher->ts_ctx);
+       ts_info = fetcher->impl.describe(id, fetcher->ts_user_data);
+       ctx_set(old_ctx);
+       return ts_info;
+} /* sdb_plugin_describe_timeseries */
+
 int
 sdb_plugin_query(sdb_ast_node_t *ast,
                sdb_store_writer_t *w, sdb_object_t *wd, sdb_strbuf_t *errbuf)
 {
-       size_t n = sdb_llist_len(reader_list);
+       query_writer_t qw = QUERY_WRITER_INIT(w, wd);
        reader_t *reader;
        sdb_object_t *q;
+
+       size_t n = sdb_llist_len(reader_list);
        int status = 0;
 
        if (! ast)
@@ -1539,7 +1685,7 @@ sdb_plugin_query(sdb_ast_node_t *ast,
 
        q = reader->impl.prepare_query(ast, errbuf, reader->r_user_data);
        if (q)
-               status = reader->impl.execute_query(q, w, SDB_OBJ(wd),
+               status = reader->impl.execute_query(q, &query_writer, SDB_OBJ(&qw),
                                errbuf, reader->r_user_data);
        else
                status = -1;