index a7d86f529df54f56c4f9328ac6068731f52a28fa..e3b3387151ef38b66ec7f32f745304abaff10391 100644 (file)
--- a/src/include/core/store.h
+++ b/src/include/core/store.h
#include "core/object.h"
#include "core/data.h"
#include "core/time.h"
#include "core/object.h"
#include "core/data.h"
#include "core/time.h"
+#include "core/timeseries.h"
#include "utils/strbuf.h"
#include <stdio.h>
#include "utils/strbuf.h"
#include <stdio.h>
struct sdb_store_obj;
typedef struct sdb_store_obj sdb_store_obj_t;
struct sdb_store_obj;
typedef struct sdb_store_obj sdb_store_obj_t;
+/*
+ * Expressions represent arithmetic expressions based on stored objects and
+ * their various attributes.
+ *
+ * An expression object inherits from sdb_object_t and, thus, may safely be
+ * cast to a generic object.
+ */
+struct sdb_store_expr;
+typedef struct sdb_store_expr sdb_store_expr_t;
+#define SDB_STORE_EXPR(obj) ((sdb_store_expr_t *)(obj))
+
+/*
+ * Store matchers may be used to lookup hosts from the store based on their
+ * various attributes. Service and attribute matchers are applied to a host's
+ * services and attributes and evaluate to true if *any* service or attribute
+ * matches.
+ *
+ * A store matcher object inherits from sdb_object_t and, thus, may safely be
+ * cast to a generic object.
+ */
+struct sdb_store_matcher;
+typedef struct sdb_store_matcher sdb_store_matcher_t;
+#define SDB_STORE_MATCHER(obj) ((sdb_store_matcher_t *)(obj))
+
/*
* Queryable fields of a stored object.
*/
enum {
/*
* Queryable fields of a stored object.
*/
enum {
- SDB_FIELD_LAST_UPDATE = 1, /* datetime */
- SDB_FIELD_AGE, /* datetime */
- SDB_FIELD_INTERVAL, /* datetime */
- SDB_FIELD_BACKEND, /* string */
+ SDB_FIELD_NAME = 1, /* string */
+ SDB_FIELD_LAST_UPDATE, /* datetime */
+ SDB_FIELD_AGE, /* datetime */
+ SDB_FIELD_INTERVAL, /* datetime */
+ SDB_FIELD_BACKEND, /* string */
};
#define SDB_FIELD_TO_NAME(f) \
};
#define SDB_FIELD_TO_NAME(f) \
- (((f) == SDB_FIELD_LAST_UPDATE) ? "last-update" \
+ (((f) == SDB_FIELD_NAME) ? "name" \
+ : ((f) == SDB_FIELD_LAST_UPDATE) ? "last-update" \
: ((f) == SDB_FIELD_AGE) ? "age" \
: ((f) == SDB_FIELD_INTERVAL) ? "interval" \
: ((f) == SDB_FIELD_BACKEND) ? "backend" : "unknown")
: ((f) == SDB_FIELD_AGE) ? "age" \
: ((f) == SDB_FIELD_INTERVAL) ? "interval" \
: ((f) == SDB_FIELD_BACKEND) ? "backend" : "unknown")
* specified 'service' object. If the referenced host does not exist, an error
* will be reported. Else, a new entry will be created in the store. Any
* memory required for storing the entry will be allocated an managed by the
* specified 'service' object. If the referenced host does not exist, an error
* will be reported. Else, a new entry will be created in the store. Any
* memory required for storing the entry will be allocated an managed by the
- * store itself. The specified service-object will not be referenced or
- * further accessed.
+ * store itself.
*
* Returns:
* - 0 on success
*
* Returns:
* - 0 on success
sdb_store_service_attr(const char *hostname, const char *service,
const char *key, const sdb_data_t *value, sdb_time_t last_update);
sdb_store_service_attr(const char *hostname, const char *service,
const char *key, const sdb_data_t *value, sdb_time_t last_update);
+/*
+ * A metric store describes how to access a metric's data.
+ */
+typedef struct {
+ const char *type;
+ const char *id;
+} sdb_metric_store_t;
+
+/*
+ * sdb_store_metric:
+ * Add/update a metric in the store. If the metric, identified by its name,
+ * already exists for the specified host, it will be updated according to the
+ * specified 'metric' object. If the referenced host does not exist, an error
+ * will be reported. Else, a new entry will be created in the store. Any
+ * memory required for storing the entry will be allocated an managed by the
+ * store itself.
+ *
+ * If specified, the metric store describes where to access the metric's data.
+ *
+ * Returns:
+ * - 0 on success
+ * - a positive value if the new entry is older than the currently stored
+ * entry (in this case, no update will happen)
+ * - a negative value on error
+ */
+int
+sdb_store_metric(const char *hostname, const char *name,
+ sdb_metric_store_t *store, sdb_time_t last_update);
+
+/*
+ * sdb_store_metric_attr:
+ * Add/update a metric's attribute in the store. If the attribute, identified
+ * by its key, already exists for the specified metric, it will be updated to
+ * the specified value. If the references metric (for the specified host)
+ * does not exist, an error will be reported. Any memory required for storing
+ * the entry will be allocated and managed by the store itself.
+ *
+ * Returns:
+ * - 0 on success
+ * - a positive value if the new entry is older than the currently stored
+ * entry (in this case, no update will happen)
+ * - a negative value on error
+ */
+int
+sdb_store_metric_attr(const char *hostname, const char *metric,
+ const char *key, const sdb_data_t *value, sdb_time_t last_update);
+
+/*
+ * sdb_store_fetch_timeseries:
+ * Fetch the time-series described by the specified host's metric and
+ * serialize it as JSON into the provided string buffer.
+ *
+ * Returns:
+ * - 0 on success
+ * - a negative value else
+ */
+int
+sdb_store_fetch_timeseries(const char *hostname, const char *metric,
+ sdb_timeseries_opts_t *opts, sdb_strbuf_t *buf);
+
/*
* sdb_store_get_field:
* Get the value of a stored object's queryable field. The caller is
* responsible for freeing any dynamically allocated memory possibly stored in
/*
* sdb_store_get_field:
* Get the value of a stored object's queryable field. The caller is
* responsible for freeing any dynamically allocated memory possibly stored in
- * the returned value.
+ * the returned value. If 'res' is NULL, the function will return whether the
+ * field exists.
*
* Note: Retrieving the backend this way is not currently supported.
*
*
* Note: Retrieving the backend this way is not currently supported.
*
sdb_store_get_field(sdb_store_obj_t *obj, int field, sdb_data_t *res);
/*
sdb_store_get_field(sdb_store_obj_t *obj, int field, sdb_data_t *res);
/*
- * Expressions specify arithmetic expressions.
+ * sdb_store_get_attr:
+ * Get the value of a stored object's attribute. The caller is responsible for
+ * freeing any dynamically allocated memory possibly stored in the returned
+ * value. If 'res' is NULL, the function will return whether the attribute
+ * exists. If specified, only attributes matching the filter will be
+ * considered.
*
*
- * A expression object inherits from sdb_object_t and, thus, may safely be
- * cast to a generic object.
+ * Returns:
+ * - 0 if the attribute exists
+ * - a negative value else
*/
*/
-struct sdb_store_expr;
-typedef struct sdb_store_expr sdb_store_expr_t;
-#define SDB_STORE_EXPR(obj) ((sdb_store_expr_t *)(obj))
+int
+sdb_store_get_attr(sdb_store_obj_t *obj, const char *name, sdb_data_t *res,
+ sdb_store_matcher_t *filter);
/*
* sdb_store_expr_create:
/*
* sdb_store_expr_create:
@@ -224,6 +317,18 @@ sdb_store_expr_create(int op, sdb_store_expr_t *left, sdb_store_expr_t *right);
sdb_store_expr_t *
sdb_store_expr_fieldvalue(int field);
sdb_store_expr_t *
sdb_store_expr_fieldvalue(int field);
+/*
+ * sdb_store_expr_attrvalue:
+ * Creates an expression which evaluates to the value of the specified
+ * attribute of a stored object.
+ *
+ * Returns:
+ * - an expression object on success
+ * - NULL else
+ */
+sdb_store_expr_t *
+sdb_store_expr_attrvalue(const char *name);
+
/*
* sdb_store_expr_constvalue:
* Creates an expression which evaluates to the specified constant value.
/*
* sdb_store_expr_constvalue:
* Creates an expression which evaluates to the specified constant value.
* result in 'res'. The result's value will be allocated dynamically if
* necessary and, thus, should be free'd by the caller (e.g. using
* sdb_data_free_datum). The object may be NULL, in which case the expression
* result in 'res'. The result's value will be allocated dynamically if
* necessary and, thus, should be free'd by the caller (e.g. using
* sdb_data_free_datum). The object may be NULL, in which case the expression
- * needs to evaluate to a constant value.
+ * needs to evaluate to a constant value. If specified, only objects matching
+ * the filter will be used during the evaluation.
*
* Returns:
* - 0 on success
*
* Returns:
* - 0 on success
*/
int
sdb_store_expr_eval(sdb_store_expr_t *expr, sdb_store_obj_t *obj,
*/
int
sdb_store_expr_eval(sdb_store_expr_t *expr, sdb_store_obj_t *obj,
- sdb_data_t *res);
+ sdb_data_t *res, sdb_store_matcher_t *filter);
/*
* Conditionals may be used to lookup hosts from the store based on a
/*
* Conditionals may be used to lookup hosts from the store based on a
sdb_store_cond_t *
sdb_store_obj_cond(int field, sdb_store_expr_t *expr);
sdb_store_cond_t *
sdb_store_obj_cond(int field, sdb_store_expr_t *expr);
-/*
- * Store matchers may be used to lookup hosts from the store based on their
- * various attributes. Service and attribute matchers are applied to a host's
- * services and attributes and evaluate to true if *any* service or attribute
- * matches.
- *
- * A store matcher object inherits from sdb_object_t and, thus, may safely be
- * cast to a generic object.
- */
-struct sdb_store_matcher;
-typedef struct sdb_store_matcher sdb_store_matcher_t;
-#define SDB_STORE_MATCHER(obj) ((sdb_store_matcher_t *)(obj))
-
/*
* sdb_store_name_matcher:
* Creates a matcher matching by the specified object type's name. If 're' is
/*
* sdb_store_name_matcher:
* Creates a matcher matching by the specified object type's name. If 're' is
sdb_store_matcher_t *
sdb_store_gt_matcher(sdb_store_cond_t *cond);
sdb_store_matcher_t *
sdb_store_gt_matcher(sdb_store_cond_t *cond);
+sdb_store_matcher_t *
+sdb_store_cmp_lt(sdb_store_expr_t *left, sdb_store_expr_t *right);
+sdb_store_matcher_t *
+sdb_store_cmp_le(sdb_store_expr_t *left, sdb_store_expr_t *right);
+sdb_store_matcher_t *
+sdb_store_cmp_eq(sdb_store_expr_t *left, sdb_store_expr_t *right);
+sdb_store_matcher_t *
+sdb_store_cmp_ge(sdb_store_expr_t *left, sdb_store_expr_t *right);
+sdb_store_matcher_t *
+sdb_store_cmp_gt(sdb_store_expr_t *left, sdb_store_expr_t *right);
+
+/*
+ * sdb_store_parse_object_type_plural:
+ * Parse the type name (plural) of a stored object.
+ *
+ * Returns:
+ * - the object type on success
+ * - a negative value else
+ */
+int
+sdb_store_parse_object_type_plural(const char *name);
+
/*
* sdb_store_parse_field_name:
* Parse the name of a stored object's queryable field.
/*
* sdb_store_parse_field_name:
* Parse the name of a stored object's queryable field.
/*
* Flags for serialization functions.
*
/*
* Flags for serialization functions.
*
- * By default, the full object will be included in the serialized output. When
- * specifying any of the flags, the respective information will be left out.
+ * By default, the full host object will be included in the serialized output.
+ * When specifying any of the flags, the respective information will be left
+ * out. The SKIP_EMPTY flags may be used to skip host objects entirely.
*/
enum {
SDB_SKIP_ATTRIBUTES = 1 << 0,
*/
enum {
SDB_SKIP_ATTRIBUTES = 1 << 0,
SDB_SKIP_METRICS = 1 << 2,
SDB_SKIP_SERVICE_ATTRIBUTES = 1 << 3,
SDB_SKIP_METRICS = 1 << 2,
SDB_SKIP_SERVICE_ATTRIBUTES = 1 << 3,
- SDB_SKIP_ALL = 0xffff,
+ SDB_SKIP_ALL = (1 << 8) - 1,
+
+ /* skip hosts if they do not reference any services/metrics */
+ SDB_SKIP_EMPTY_SERVICES = 1 << 8,
+ SDB_SKIP_EMPTY_METRICS = 1 << 9,
};
/*
};
/*