contrib/exec-nagios.px: Added a Perl script which handles Nagios plugins.
[collectd.git] / src / utils_cache.c
index 20d4deb..0d6961e 100644 (file)
@@ -23,6 +23,8 @@
 #include "common.h"
 #include "plugin.h"
 #include "utils_avltree.h"
+#include "utils_cache.h"
+#include "utils_threshold.h"
 
 #include <assert.h>
 #include <pthread.h>
@@ -42,9 +44,10 @@ typedef struct cache_entry_s
        /* Interval in which the data is collected
         * (for purding old entries) */
        int interval;
+       int state;
 } cache_entry_t;
 
-static avl_tree_t     *cache_tree = NULL;
+static c_avl_tree_t   *cache_tree = NULL;
 static pthread_mutex_t cache_lock = PTHREAD_MUTEX_INITIALIZER;
 
 static int cache_compare (const cache_entry_t *a, const cache_entry_t *b)
@@ -67,8 +70,6 @@ static int uc_send_notification (const char *name)
 
   notification_t n;
 
-  memset (&n, '\0', sizeof (n));
-
   name_copy = strdup (name);
   if (name_copy == NULL)
   {
@@ -85,18 +86,23 @@ static int uc_send_notification (const char *name)
     return (-1);
   }
 
-  n.severity = NOTIF_FAILURE;
-  strncpy (n.host, host, sizeof (n.host));
-  n.host[sizeof (n.host) - 1] = '\0';
+  /* Copy the associative members */
+  notification_init (&n, NOTIF_FAILURE, /* host = */ NULL,
+      host, plugin, plugin_instance, type, type_instance);
 
   sfree (name_copy);
   name_copy = host = plugin = plugin_instance = type = type_instance = NULL;
 
   pthread_mutex_lock (&cache_lock);
 
+  /*
+   * Set the time _after_ getting the lock because we don't know how long
+   * acquiring the lock takes and we will use this time later to decide
+   * whether or not the state is OKAY.
+   */
   n.time = time (NULL);
 
-  status = avl_get (cache_tree, name, (void *) &ce);
+  status = c_avl_get (cache_tree, name, (void *) &ce);
   if (status != 0)
   {
     pthread_mutex_unlock (&cache_lock);
@@ -105,8 +111,9 @@ static int uc_send_notification (const char *name)
   }
     
   /* Check if the entry has been updated in the meantime */
-  if ((n.time - ce->last_update) <= (2 * ce->interval))
+  if ((n.time - ce->last_update) < (2 * ce->interval))
   {
+    ce->state = STATE_OKAY;
     pthread_mutex_unlock (&cache_lock);
     sfree (name_copy);
     return (-1);
@@ -114,7 +121,7 @@ static int uc_send_notification (const char *name)
 
   snprintf (n.message, sizeof (n.message),
       "%s has not been updated for %i seconds.", name,
-      (int) (ce->last_update - n.time));
+      (int) (n.time - ce->last_update));
 
   pthread_mutex_unlock (&cache_lock);
 
@@ -127,7 +134,7 @@ static int uc_send_notification (const char *name)
 int uc_init (void)
 {
   if (cache_tree == NULL)
-    cache_tree = avl_create ((int (*) (const void *, const void *))
+    cache_tree = c_avl_create ((int (*) (const void *, const void *))
        cache_compare);
 
   return (0);
@@ -142,7 +149,7 @@ int uc_check_timeout (void)
   int keys_len = 0;
 
   char *key;
-  avl_iterator_t *iter;
+  c_avl_iterator_t *iter;
   int i;
   
   pthread_mutex_lock (&cache_lock);
@@ -150,11 +157,11 @@ int uc_check_timeout (void)
   now = time (NULL);
 
   /* Build a list of entries to be flushed */
-  iter = avl_get_iterator (cache_tree);
-  while (avl_iterator_next (iter, (void *) &key, (void *) &ce) == 0)
+  iter = c_avl_get_iterator (cache_tree);
+  while (c_avl_iterator_next (iter, (void *) &key, (void *) &ce) == 0)
   {
     /* If entry has not been updated, add to `keys' array */
-    if ((now - ce->last_update) > (2 * ce->interval))
+    if ((now - ce->last_update) >= (2 * ce->interval))
     {
       char **tmp;
 
@@ -163,7 +170,7 @@ int uc_check_timeout (void)
       if (tmp == NULL)
       {
        ERROR ("uc_purge: realloc failed.");
-       avl_iterator_destroy (iter);
+       c_avl_iterator_destroy (iter);
        return (-1);
       }
 
@@ -176,34 +183,51 @@ int uc_check_timeout (void)
       }
       keys_len++;
     }
-  } /* while (avl_iterator_next) */
+  } /* while (c_avl_iterator_next) */
 
   for (i = 0; i < keys_len; i++)
   {
     int status;
 
-    /* TODO: Check if value interesting:
-     * - Not interesting: Remove value from cache and shut up
-     * - Interesting:     Don't remove value from cache but send a
-     *                    notification.
-     */
-    status = avl_remove (cache_tree, keys[i], (void *) &key, (void *) &ce);
-    if (status != 0)
+    status = ut_check_interesting (keys[i]);
+
+    if (status < 0)
     {
-      ERROR ("uc_check_timeout: avl_remove (%s) failed.", keys[i]);
-      continue;
+      ERROR ("uc_check_timeout: ut_check_interesting failed.");
+      sfree (keys[i]);
     }
+    else if (status == 0) /* ``service'' is uninteresting */
+    {
+      ce = NULL;
+      DEBUG ("uc_check_timeout: %s is missing but ``uninteresting''", keys[i]);
+      status = c_avl_remove (cache_tree, keys[i], (void *) &key, (void *) &ce);
+      if (status != 0)
+      {
+       ERROR ("uc_check_timeout: c_avl_remove (%s) failed.", keys[i]);
+      }
+      sfree (keys[i]);
+      sfree (ce);
+    }
+    else /* (status > 0); ``service'' is interesting */
+    {
+      /*
+       * `keys[i]' is not freed and set to NULL, so that the for-loop below
+       * will send out notifications. There's nothing else to do here.
+       */
+      DEBUG ("uc_check_timeout: %s is missing and ``interesting''", keys[i]);
+      ce->state = STATE_ERROR;
+    }
+  } /* for (keys[i]) */
 
-    sfree (key);
-    sfree (ce);
-  }
-
-  avl_iterator_destroy (iter);
+  c_avl_iterator_destroy (iter);
 
   pthread_mutex_unlock (&cache_lock);
 
   for (i = 0; i < keys_len; i++)
   {
+    if (keys[i] == NULL)
+      continue;
+
     uc_send_notification (keys[i]);
     sfree (keys[i]);
   }
@@ -217,6 +241,7 @@ int uc_update (const data_set_t *ds, const value_list_t *vl)
 {
   char name[6 * DATA_MAX_NAME_LEN];
   cache_entry_t *ce = NULL;
+  int send_okay_notification = 0;
 
   if (FORMAT_VL (name, sizeof (name), vl, ds) != 0)
   {
@@ -226,7 +251,7 @@ int uc_update (const data_set_t *ds, const value_list_t *vl)
 
   pthread_mutex_lock (&cache_lock);
 
-  if (avl_get (cache_tree, name, (void *) &ce) == 0)
+  if (c_avl_get (cache_tree, name, (void *) &ce) == 0)
   {
     int i;
 
@@ -244,9 +269,8 @@ int uc_update (const data_set_t *ds, const value_list_t *vl)
 
     if ((ce->last_time + ce->interval) < vl->time)
     {
-      /* TODO: Implement a `real' okay notification. Watch out for locking
-       * issues, though! */
-      NOTICE ("uc_insert: Okay notification for %s", name);
+      send_okay_notification = vl->time - ce->last_time;
+      ce->state = STATE_OKAY;
     }
 
     for (i = 0; i < ds->ds_num; i++)
@@ -331,11 +355,14 @@ int uc_update (const data_set_t *ds, const value_list_t *vl)
     } /* for (i) */
 
     ce->last_time = vl->time;
+    ce->last_update = time (NULL);
+    ce->interval = vl->interval;
+    ce->state = STATE_OKAY;
 
-    if (avl_insert (cache_tree, key, ce) != 0)
+    if (c_avl_insert (cache_tree, key, ce) != 0)
     {
       pthread_mutex_unlock (&cache_lock);
-      ERROR ("uc_insert: avl_insert failed.");
+      ERROR ("uc_insert: c_avl_insert failed.");
       return (-1);
     }
 
@@ -344,6 +371,36 @@ int uc_update (const data_set_t *ds, const value_list_t *vl)
 
   pthread_mutex_unlock (&cache_lock);
 
+  /* Do not send okay notifications for uninteresting values, i. e. values for
+   * which no threshold is configured. */
+  if (send_okay_notification > 0)
+  {
+    int status;
+
+    status = ut_check_interesting (name);
+    if (status <= 0)
+      send_okay_notification = 0;
+  }
+
+  if (send_okay_notification > 0)
+  {
+    notification_t n;
+    memset (&n, '\0', sizeof (n));
+
+    /* Copy the associative members */
+    NOTIFICATION_INIT_VL (&n, vl, ds);
+
+    n.severity = NOTIF_OKAY;
+    n.time = vl->time;
+
+    snprintf (n.message, sizeof (n.message),
+       "Received a value for %s. It was missing for %i seconds.",
+       name, send_okay_notification);
+    n.message[sizeof (n.message) - 1] = '\0';
+
+    plugin_dispatch_notification (&n);
+  }
+
   return (0);
 } /* int uc_insert */
 
@@ -361,7 +418,7 @@ gauge_t *uc_get_rate (const data_set_t *ds, const value_list_t *vl)
 
   pthread_mutex_lock (&cache_lock);
 
-  if (avl_get (cache_tree, name, (void *) &ce) == 0)
+  if (c_avl_get (cache_tree, name, (void *) &ce) == 0)
   {
     assert (ce != NULL);
     assert (ce->values_num == ds->ds_num);
@@ -382,4 +439,59 @@ gauge_t *uc_get_rate (const data_set_t *ds, const value_list_t *vl)
   return (ret);
 } /* gauge_t *uc_get_rate */
 
+int uc_get_state (const data_set_t *ds, const value_list_t *vl)
+{
+  char name[6 * DATA_MAX_NAME_LEN];
+  cache_entry_t *ce = NULL;
+  int ret = STATE_ERROR;
+
+  if (FORMAT_VL (name, sizeof (name), vl, ds) != 0)
+  {
+    ERROR ("uc_get_state: FORMAT_VL failed.");
+    return (STATE_ERROR);
+  }
+
+  pthread_mutex_lock (&cache_lock);
+
+  if (c_avl_get (cache_tree, name, (void *) &ce) == 0)
+  {
+    assert (ce != NULL);
+    ret = ce->state;
+  }
+
+  pthread_mutex_unlock (&cache_lock);
+
+  return (ret);
+} /* int uc_get_state */
+
+int uc_set_state (const data_set_t *ds, const value_list_t *vl, int state)
+{
+  char name[6 * DATA_MAX_NAME_LEN];
+  cache_entry_t *ce = NULL;
+  int ret = -1;
+
+  if (state < STATE_OKAY)
+    state = STATE_OKAY;
+  if (state > STATE_ERROR)
+    state = STATE_ERROR;
+
+  if (FORMAT_VL (name, sizeof (name), vl, ds) != 0)
+  {
+    ERROR ("uc_get_state: FORMAT_VL failed.");
+    return (STATE_ERROR);
+  }
+
+  pthread_mutex_lock (&cache_lock);
+
+  if (c_avl_get (cache_tree, name, (void *) &ce) == 0)
+  {
+    assert (ce != NULL);
+    ret = ce->state;
+    ce->state = state;
+  }
+
+  pthread_mutex_unlock (&cache_lock);
+
+  return (ret);
+} /* int uc_set_state */
 /* vim: set sw=2 ts=8 sts=2 tw=78 : */