![[tokkee]](http://tokkee.org/images/avatar.png){kind=avatar}
index e6ea7573cf15a0514c939c754eed48ae16c10964..5c299ddc13193ba0df9073d8b006dcaeab88b975 100644 (file)
#include "sysdb.h"
#include "core/object.h"
+#include "core/store.h"
#include "core/time.h"
+#include "core/timeseries.h"
#include "liboconfig/oconfig.h"
#include <stdarg.h>
+#include <stdbool.h>
#ifdef __cplusplus
extern "C" {
int sdb_module_init(sdb_plugin_info_t *info)
typedef struct {
- _Bool do_loop;
+ bool do_loop;
sdb_time_t default_interval;
} sdb_plugin_loop_t;
#define SDB_PLUGIN_LOOP_INIT { 1, 0 }
sdb_plugin_register_log(const char *name, sdb_plugin_log_cb callback,
sdb_object_t *user_data);
+/*
+ * sdb_plugin_register_timeseries_fetcher:
+ * Register a "time-series fetcher" to be called whenever retrieving a
+ * time-series from a data-store or information about it. The fetch callback
+ * will receive an identifier describing where to retrieve the data from (e.g.
+ * a filename or some kind of URL) and options which further describe the
+ * query.
+ *
+ * The name is used literally (without prepending the plugin name) to look up
+ * the appropriate fetcher callback.
+ *
+ * Arguments:
+ * - user_data: If specified, this will be passed on to each call of the
+ * callback. The function will take ownership of the object, that is,
+ * increment the reference count by one. In case the caller does not longer
+ * use the object for other purposes, it should thus deref it.
+ */
+int
+sdb_plugin_register_timeseries_fetcher(const char *name,
+ sdb_timeseries_fetcher_t *fetcher, sdb_object_t *user_data);
+
+/*
+ * sdb_plugin_register_writer:
+ * Register a "writer" implementation to be used when adding an object to the
+ * store. It is invalid to register an incomplete writer which does not
+ * implement all of the writer interface.
+ *
+ * Arguments:
+ * - user_data: If specified, this will be passed on to each call of the
+ * callbacks. The function will take ownership of the object, that is,
+ * increment the reference count by one. In case the caller does not longer
+ * use the object for other purposes, it should thus deref it.
+ */
+int
+sdb_plugin_register_writer(const char *name,
+ sdb_store_writer_t *writer, sdb_object_t *user_data);
+
+/*
+ * sdb_plugin_register_reader:
+ * Register a "reader" implementation for querying the store. It is invalid to
+ * register an incomplete reader which does not implement all of the reader
+ * interface.
+ *
+ * Arguments:
+ * - user_data: If specified, this will be passed on to each call of the
+ * callbacks. The function will take ownership of the object, that is,
+ * increment the reference count by one. In case the caller does not longer
+ * use the object for other purposes, it should thus deref it.
+ */
+int
+sdb_plugin_register_reader(const char *name,
+ sdb_store_reader_t *reader, sdb_object_t *user_data);
+
+/*
+ * sdb_plugin_unregister_all:
+ * Unregister all registered plugins and destruct their user-data objects.
+ */
+void
+sdb_plugin_unregister_all(void);
+
/*
* sdb_plugin_get_ctx, sdb_plugin_set_ctx:
* The plugin context defines a set of settings that are available whenever a
int
sdb_plugin_set_ctx(sdb_plugin_ctx_t ctx, sdb_plugin_ctx_t *old);
+/*
+ * sdb_plugin_current:
+ * Retrieve information about the plugin (if any) from which the current call
+ * into the core originated. The return value may not be modified.
+ *
+ * Returns:
+ * - information about the current plugin if we were called from some
+ * plugin's callback function
+ * - NULL else
+ */
+const sdb_plugin_info_t *
+sdb_plugin_current(void);
+
/*
* sdb_plugin_configure:
* Configure the plugin called 'name' using the config tree 'ci'. The plugin
* Log a formatted message. See sdb_plugin_log for more information.
*/
int
-sdb_plugin_vlogf(int prio, const char *fmt, va_list ap);
+sdb_plugin_vlogf(int prio, const char *fmt, va_list ap)
+ __attribute__((format(printf, 2, 0)));
+int
+sdb_plugin_logf(int prio, const char *fmt, ...)
+ __attribute__((format(printf, 2, 3)));
+
+/*
+ * sdb_plugin_fetch_timeseries:
+ * Fetch the time-series identified by 'id' from a backend data-store of the
+ * specified 'type'. The type has to match an existing time-series fetcher
+ * callback's name. The identifier is passed through to the callback which
+ * then needs to make sense of it. The time-series option specify which data
+ * to fetch.
+ *
+ * Returns:
+ * - a time-series on success
+ * - NULL else
+ */
+sdb_timeseries_t *
+sdb_plugin_fetch_timeseries(const char *type, const char *id,
+ sdb_timeseries_opts_t *opts);
+
+/*
+ * sdb_plugin_describe_timeseries:
+ * Fetch information about the time-series identified by 'id' from a backend
+ * data-store of the specified 'type'. The type has to match an existing
+ * time-series fetcher callback's name. The identifier is passed through to
+ * the callback which then needs to make sense of it.
+ *
+ * Returns:
+ * - a time-series information object on success
+ * - NULL else
+ */
+sdb_timeseries_info_t *
+sdb_plugin_describe_timeseries(const char *type, const char *id);
+
+/*
+ * sdb_query_opts_t:
+ * Options for tuning the behavior of a query.
+ */
+typedef struct {
+ /* If enabled, populate the time-series info field of each metric. */
+ bool describe_timeseries;
+} sdb_query_opts_t;
+#define SDB_DEFAULT_QUERY_OPTS { false }
+
+/*
+ * sdb_plugin_query:
+ * Query the store using the query specified by 'ast'. The result will be
+ * written to 'buf' and any errors will be written to 'errbuf'. The query
+ * options default to SDB_DEFAULT_QUERY_OPTS.
+ *
+ * Returns:
+ * - 0 on success
+ * - a negative value else
+ */
+int
+sdb_plugin_query(sdb_ast_node_t *ast,
+ sdb_store_writer_t *w, sdb_object_t *wd,
+ sdb_query_opts_t *opts, sdb_strbuf_t *errbuf);
+
+/*
+ * sdb_plugin_store_host, sdb_plugin_store_service, sdb_plugin_store_metric,
+ * sdb_plugin_store_attribute, sdb_plugin_store_service_attribute,
+ * sdb_plugin_store_metric_attribute:
+ * Store an object in the database by sending it to all registered store
+ * writer plugins.
+ *
+ * Returns:
+ * - 0 on success
+ * - a negative value else
+ */
+int
+sdb_plugin_store_host(const char *name, sdb_time_t last_update);
+int
+sdb_plugin_store_service(const char *hostname, const char *name,
+ sdb_time_t last_update);
+int
+sdb_plugin_store_metric(const char *hostname, const char *name,
+ sdb_metric_store_t *store, sdb_time_t last_update);
+int
+sdb_plugin_store_attribute(const char *hostname, const char *key,
+ const sdb_data_t *value, sdb_time_t last_update);
+int
+sdb_plugin_store_service_attribute(const char *hostname, const char *service,
+ const char *key, const sdb_data_t *value, sdb_time_t last_update);
int
-sdb_plugin_logf(int prio, const char *fmt, ...);
+sdb_plugin_store_metric_attribute(const char *hostname, const char *metric,
+ const char *key, const sdb_data_t *value, sdb_time_t last_update);
#ifdef __cplusplus
} /* extern "C" */