src/ping.c

   1 /**
   2  * collectd - src/ping.c
   3  * Copyright (C) 2005,2006  Florian octo Forster
   4  *
   5  * This program is free software; you can redistribute it and/or modify it
   6  * under the terms of the GNU General Public License as published by the
   7  * Free Software Foundation; only version 2 of the License is applicable.
   8  *
   9  * This program is distributed in the hope that it will be useful, but
  10  * WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12  * General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU General Public License along
  15  * with this program; if not, write to the Free Software Foundation, Inc.,
  16  * 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
  17  *
  18  * Authors:
  19  *   Florian octo Forster <octo at verplant.org>
  20  **/
  21
  22 #include "collectd.h"
  23 #include "common.h"
  24 #include "plugin.h"
  25 #include "configfile.h"
  26 #include "utils_debug.h"
  27
  28 #include <netinet/in.h>
  29 #include "liboping/oping.h"
  30
  31 /*
  32  * Private data types
  33  */
  34 struct hostlist_s
  35 {
  36         char *host;
  37         int   wait_time;
  38         int   wait_left;
  39         struct hostlist_s *next;
  40 };
  41 typedef struct hostlist_s hostlist_t;
  42
  43 /*
  44  * Private variables
  45  */
  46 static pingobj_t *pingobj = NULL;
  47 static hostlist_t *hosts = NULL;
  48
  49 static data_source_t dsrc[1] =
  50 {
  51         {"ping", DS_TYPE_GAUGE, 0, 65535.0},
  52 };
  53
  54 static data_set_t ds =
  55 {
  56         "ping", 1, dsrc
  57 };
  58
  59 static const char *config_keys[] =
  60 {
  61         "Host",
  62         "TTL",
  63         NULL
  64 };
  65 static int config_keys_num = 2;
  66
  67 /*
  68  * Private functions
  69  */
  70 static void add_hosts (void)
  71 {
  72         hostlist_t *hl_this;
  73         hostlist_t *hl_prev;
  74
  75         int step = atoi (COLLECTD_STEP);
  76
  77         hl_this = hosts;
  78         hl_prev = NULL;
  79         while (hl_this != NULL)
  80         {
  81                 DBG ("host = %s, wait_left = %i, wait_time = %i, next = %p",
  82                                 hl_this->host, hl_this->wait_left, hl_this->wait_time, (void *) hl_this->next);
  83
  84                 if (hl_this->wait_left <= 0)
  85                 {
  86                         if (ping_host_add (pingobj, hl_this->host) == 0)
  87                         {
  88                                 DBG ("Successfully added host %s", hl_this->host);
  89                                 /* Remove the host from the linked list */
  90                                 if (hl_prev != NULL)
  91                                         hl_prev->next = hl_this->next;
  92                                 else
  93                                         hosts = hl_this->next;
  94                                 free (hl_this->host);
  95                                 free (hl_this);
  96                                 hl_this = (hl_prev != NULL) ? hl_prev : hosts;
  97                         }
  98                         else
  99                         {
 100                                 hl_this->wait_left = hl_this->wait_time;
 101                                 hl_this->wait_time *= 2;
 102                                 if (hl_this->wait_time > 86400)
 103                                         hl_this->wait_time = 86400;
 104                         }
 105                 }
 106                 else
 107                 {
 108                         hl_this->wait_left -= step;
 109                 }
 110
 111                 if (hl_this != NULL)
 112                 {
 113                         hl_prev = hl_this;
 114                         hl_this = hl_this->next;
 115                 }
 116         }
 117 }
 118
 119 static int ping_init (void)
 120 {
 121         if (hosts != NULL)
 122                 add_hosts ();
 123
 124         return (0);
 125 }
 126
 127 static int ping_config (const char *key, const char *value)
 128 {
 129         if (pingobj == NULL)
 130         {
 131                 if ((pingobj = ping_construct ()) == NULL)
 132                 {
 133                         syslog (LOG_ERR, "ping: `ping_construct' failed: %s",
 134                                         ping_get_error (pingobj));
 135                         return (1);
 136                 }
 137         }
 138
 139         if (strcasecmp (key, "host") == 0)
 140         {
 141                 hostlist_t *hl;
 142                 char *host;
 143                 int step = atoi (COLLECTD_STEP);
 144
 145                 if ((hl = (hostlist_t *) malloc (sizeof (hostlist_t))) == NULL)
 146                 {
 147                         syslog (LOG_ERR, "ping plugin: malloc failed: %s",
 148                                         strerror (errno));
 149                         return (1);
 150                 }
 151                 if ((host = strdup (value)) == NULL)
 152                 {
 153                         free (hl);
 154                         syslog (LOG_ERR, "ping plugin: strdup failed: %s",
 155                                         strerror (errno));
 156                         return (1);
 157                 }
 158
 159                 hl->host = host;
 160                 hl->wait_time = 2 * step;
 161                 hl->wait_left = 0;
 162                 hl->next = hosts;
 163                 hosts = hl;
 164         }
 165         else if (strcasecmp (key, "ttl") == 0)
 166         {
 167                 int ttl = atoi (value);
 168                 if (ping_setopt (pingobj, PING_DEF_TIMEOUT, (void *) &ttl))
 169                 {
 170                         syslog (LOG_WARNING, "ping: liboping did not accept the TTL value %i", ttl);
 171                         return (1);
 172                 }
 173         }
 174         else
 175         {
 176                 return (-1);
 177         }
 178
 179         return (0);
 180 }
 181
 182 static void ping_submit (char *host, double latency)
 183 {
 184         value_t values[1];
 185         value_list_t vl = VALUE_LIST_INIT;
 186
 187         values[0].gauge = latency;
 188
 189         vl.values = values;
 190         vl.values_len = 1;
 191         vl.time = time (NULL);
 192         strcpy (vl.host, hostname);
 193         strcpy (vl.plugin, "ping");
 194         strcpy (vl.plugin_instance, "");
 195         strncpy (vl.type_instance, host, sizeof (vl.type_instance));
 196
 197         plugin_dispatch_values ("ping", &vl);
 198 }
 199
 200 static int ping_read (void)
 201 {
 202         pingobj_iter_t *iter;
 203
 204         char   host[512];
 205         double latency;
 206         size_t buf_len;
 207
 208         if (pingobj == NULL)
 209                 return (-1);
 210
 211         if (hosts != NULL)
 212                 add_hosts ();
 213
 214         if (ping_send (pingobj) < 0)
 215         {
 216                 syslog (LOG_ERR, "ping: `ping_send' failed: %s",
 217                                 ping_get_error (pingobj));
 218                 return (-1);
 219         }
 220
 221         for (iter = ping_iterator_get (pingobj);
 222                         iter != NULL;
 223                         iter = ping_iterator_next (iter))
 224         {
 225                 buf_len = sizeof (host);
 226                 if (ping_iterator_get_info (iter, PING_INFO_HOSTNAME,
 227                                         host, &buf_len))
 228                         continue;
 229
 230                 buf_len = sizeof (latency);
 231                 if (ping_iterator_get_info (iter, PING_INFO_LATENCY,
 232                                         &latency, &buf_len))
 233                         continue;
 234
 235                 DBG ("host = %s, latency = %f", host, latency);
 236                 ping_submit (host, latency);
 237         }
 238
 239         return (0);
 240 } /* int ping_read */
 241
 242 void module_register (void)
 243 {
 244         plugin_register_data_set (&ds);
 245         plugin_register_init ("ping", ping_init);
 246         plugin_register_read ("ping", ping_read);
 247         plugin_register_config ("ping", ping_config, config_keys, config_keys_num);
 248 } /* void module_register */