Code

value match: Add the `DataSource' and `Satisfy' configuration options.
authorFlorian Forster <octo@leeloo.lan.home.verplant.org>
Sat, 3 Jan 2009 14:16:02 +0000 (15:16 +0100)
committerFlorian Forster <octo@leeloo.lan.home.verplant.org>
Sat, 3 Jan 2009 14:16:02 +0000 (15:16 +0100)
This adds quite some flexibility to the match. collectd.conf(5) is kept
up to date, too.

src/collectd.conf.pod
src/match_value.c

index df28cc3b887c11904d5c130d6d00111270b0be4a..5a2536893db6270e8dedac884ffa07214a47bf79 100644 (file)
@@ -2794,7 +2794,28 @@ positive infinity.
 =item B<Invert> B<true>|B<false>
 
 Inverts the selection. If the B<Min> and B<Max> settings result in a match,
-no-match is returned and vice versa.
+no-match is returned and vice versa. Please note that the B<Invert> setting
+only effects how B<Min> and B<Max> are applied to a specific value. Especially
+the B<DataSource> and B<Satisfy> settings (see below) are not inverted.
+
+=item B<DataSource> I<DSName> [I<DSName> ...]
+
+Select one or more of the data sources. If no data source is configured, all
+data sources will be checked. If the type handled by the match does not have a
+data source of the specified name(s), this will always result in no match
+(independent of the B<Invert> setting).
+
+=item B<Satisfy> B<Any>|B<All>
+
+Specifies how checking with several data sources is performed. If set to
+B<Any>, the match succeeds if one of the data sources is in the configured
+range. If set to B<All> the match only succeeds if all data sources are within
+the configured range. Default is B<All>.
+
+Usually B<All> is used for positive matches, B<Any> is used for negative
+matches. This means that with B<All> you usually check that all values are in a
+"good" range, while with B<Any> you check if any value is within a "bad" range
+(or outside the "good" range).
 
 =back
 
@@ -2802,9 +2823,19 @@ Either B<Min> or B<Max>, but not both, may be unset.
 
 Example:
 
- # Match all values smaller than or equal to 100.
+ # Match all values smaller than or equal to 100. Matches only if all data
+ # sources are below 100.
+ <Match "value">
+   Max 100
+   Satisfy "All"
+ </Match>
+ # Match if the value of any data source is outside the range of 0 - 100.
  <Match "value">
+   Min   0
    Max 100
+   Invert true
+   Satisfy "Any"
  </Match>
 
 =back
index b850b777820eb5d76bf04fbb167b34a3c64ee5af..a3eeffd49c4813ad32418d702f327cdbb716df7b 100644 (file)
  */
 
 #include "collectd.h"
+#include "common.h"
 #include "utils_cache.h"
 #include "filter_chain.h"
 
+#define SATISFY_ALL 0
+#define SATISFY_ANY 1
+
 /*
  * private data types
  */
@@ -38,6 +42,10 @@ struct mv_match_s
   gauge_t min;
   gauge_t max;
   int invert;
+  int satisfy;
+
+  char **data_sources;
+  size_t data_sources_num;
 };
 
 /*
@@ -51,6 +59,92 @@ static void mv_free_match (mv_match_t *m) /* {{{ */
   free (m);
 } /* }}} void mv_free_match */
 
+static int mv_config_add_satisfy (mv_match_t *m, /* {{{ */
+    oconfig_item_t *ci)
+{
+  if ((ci->values_num != 1) || (ci->values[0].type != OCONFIG_TYPE_STRING))
+  {
+    ERROR ("`value' match: `%s' needs exactly one string argument.",
+        ci->key);
+    return (-1);
+  }
+
+  if (strcasecmp ("All", ci->values[0].value.string) == 0)
+    m->satisfy = SATISFY_ALL;
+  else if (strcasecmp ("Any", ci->values[0].value.string) == 0)
+    m->satisfy = SATISFY_ANY;
+  else
+  {
+    ERROR ("`value' match: Passing `%s' to the `%s' option is invalid. "
+        "The argument must either be `All' or `Any'.",
+        ci->values[0].value.string, ci->key);
+    return (-1);
+  }
+
+  return (0);
+} /* }}} int mv_config_add_satisfy */
+
+static int mv_config_add_data_source (mv_match_t *m, /* {{{ */
+    oconfig_item_t *ci)
+{
+  size_t new_data_sources_num;
+  char **temp;
+  int i;
+
+  /* Check number of arbuments. */
+  if (ci->values_num < 1)
+  {
+    ERROR ("`value' match: `%s' needs at least one argument.",
+        ci->key);
+    return (-1);
+  }
+
+  /* Check type of arguments */
+  for (i = 0; i < ci->values_num; i++)
+  {
+    if (ci->values[i].type == OCONFIG_TYPE_STRING)
+      continue;
+
+    ERROR ("`value' match: `%s' accepts only string arguments "
+        "(argument %i is a %s).",
+        ci->key, i + 1,
+        (ci->values[i].type == OCONFIG_TYPE_BOOLEAN)
+        ? "truth value" : "number");
+    return (-1);
+  }
+
+  /* Allocate space for the char pointers */
+  new_data_sources_num = m->data_sources_num + ((size_t) ci->values_num);
+  temp = (char **) realloc (m->data_sources,
+      new_data_sources_num * sizeof (char *));
+  if (temp == NULL)
+  {
+    ERROR ("`value' match: realloc failed.");
+    return (-1);
+  }
+  m->data_sources = temp;
+
+  /* Copy the strings, allocating memory as needed. */
+  for (i = 0; i < ci->values_num; i++)
+  {
+    size_t j;
+
+    /* If we get here, there better be memory for us to write to. */
+    assert (m->data_sources_num < new_data_sources_num);
+
+    j = m->data_sources_num;
+    m->data_sources[j] = sstrdup (ci->values[i].value.string);
+    if (m->data_sources[j] == NULL)
+    {
+      ERROR ("`value' match: sstrdup failed.");
+      continue;
+    }
+    m->data_sources_num++;
+  }
+
+  return (0);
+} /* }}} int mv_config_add_data_source */
+
 static int mv_config_add_gauge (gauge_t *ret_value, /* {{{ */
     oconfig_item_t *ci)
 {
@@ -103,6 +197,9 @@ static int mv_create (const oconfig_item_t *ci, void **user_data) /* {{{ */
   m->min = NAN;
   m->max = NAN;
   m->invert = 0;
+  m->satisfy = SATISFY_ALL;
+  m->data_sources = NULL;
+  m->data_sources_num = 0;
 
   status = 0;
   for (i = 0; i < ci->children_num; i++)
@@ -115,6 +212,10 @@ static int mv_create (const oconfig_item_t *ci, void **user_data) /* {{{ */
       status = mv_config_add_gauge (&m->max, child);
     else if (strcasecmp ("Invert", child->key) == 0)
       status = mv_config_add_boolean (&m->invert, child);
+    else if (strcasecmp ("Satisfy", child->key) == 0)
+      status = mv_config_add_satisfy (m, child);
+    else if (strcasecmp ("DataSource", child->key) == 0)
+      status = mv_config_add_data_source (m, child);
     else
     {
       ERROR ("`value' match: The `%s' configuration option is not "
@@ -177,28 +278,57 @@ static int mv_match (const data_set_t *ds, const value_list_t *vl, /* {{{ */
     return (-1);
   }
 
-  status = FC_MATCH_MATCHES;
+  status = FC_MATCH_NO_MATCH;
+
   for (i = 0; i < ds->ds_num; i++)
   {
+    int value_matches = 0;
+
+    /* Check if this data source is relevant. */
+    if (m->data_sources != NULL)
+    {
+      size_t j;
+
+      for (j = 0; j < m->data_sources_num; j++)
+        if (strcasecmp (ds->ds[i].name, m->data_sources[j]) == 0)
+          break;
+
+      /* No match, ignore this data source. */
+      if (j >=  m->data_sources_num)
+        continue;
+    }
+
     DEBUG ("`value' match: current = %g; min = %g; max = %g; invert = %s;",
         values[i], m->min, m->max,
         m->invert ? "true" : "false");
 
     if ((!isnan (m->min) && (values[i] < m->min))
         || (!isnan (m->max) && (values[i] > m->max)))
+      value_matches = 0;
+    else
+      value_matches = 1;
+
+    if (m->invert)
     {
-      status = FC_MATCH_NO_MATCH;
-      break;
+      if (value_matches)
+        value_matches = 0;
+      else
+        value_matches = 1;
     }
-  }
 
-  if (m->invert)
-  {
-    if (status == FC_MATCH_MATCHES)
-      status = FC_MATCH_NO_MATCH;
-    else
+    if (value_matches != 0)
+    {
       status = FC_MATCH_MATCHES;
-  }
+      if (m->satisfy == SATISFY_ANY)
+        break;
+    }
+    else if (value_matches == 0)
+    {
+      status = FC_MATCH_NO_MATCH;
+      if (m->satisfy == SATISFY_ALL)
+        break;
+    }
+  } /* for (i = 0; i < ds->ds_num; i++) */
 
   free (values);
   return (status);