2 * collectd - src/ping.c
3 * Copyright (C) 2005-2009 Florian octo Forster
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.
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.
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
19 * Florian octo Forster <octo at verplant.org>
25 #include "configfile.h"
28 #include <netinet/in.h>
30 # include <netdb.h> /* NI_MAXHOST */
36 # define NI_MAXHOST 1025
39 #if defined(OPING_VERSION) && (OPING_VERSION >= 1003000)
40 # define HAVE_OPING_1_3
55 double latency_squared;
57 struct hostlist_s *next;
59 typedef struct hostlist_s hostlist_t;
64 static hostlist_t *hostlist_head = NULL;
66 static char *ping_source = NULL;
68 static char *ping_device = NULL;
70 static int ping_ttl = PING_DEF_TTL;
71 static double ping_interval = 1.0;
72 static double ping_timeout = 0.9;
73 static int ping_max_missed = -1;
75 static int ping_thread_loop = 0;
76 static int ping_thread_error = 0;
77 static pthread_t ping_thread_id;
78 static pthread_mutex_t ping_lock = PTHREAD_MUTEX_INITIALIZER;
79 static pthread_cond_t ping_cond = PTHREAD_COND_INITIALIZER;
81 static const char *config_keys[] =
93 static int config_keys_num = STATIC_ARRAY_SIZE (config_keys);
98 /* Assure that `ts->tv_nsec' is in the range 0 .. 999999999 */
99 static void time_normalize (struct timespec *ts) /* {{{ */
101 while (ts->tv_nsec < 0)
110 ts->tv_nsec += 1000000000;
113 while (ts->tv_nsec >= 1000000000)
116 ts->tv_nsec -= 1000000000;
118 } /* }}} void time_normalize */
120 /* Add `ts_int' to `tv_begin' and store the result in `ts_dest'. If the result
121 * is larger than `tv_end', copy `tv_end' to `ts_dest' instead. */
122 static void time_calc (struct timespec *ts_dest, /* {{{ */
123 const struct timespec *ts_int,
124 const struct timeval *tv_begin,
125 const struct timeval *tv_end)
127 ts_dest->tv_sec = tv_begin->tv_sec + ts_int->tv_sec;
128 ts_dest->tv_nsec = (tv_begin->tv_usec * 1000) + ts_int->tv_nsec;
129 time_normalize (ts_dest);
131 /* Assure that `(begin + interval) > end'.
132 * This may seem overly complicated, but `tv_sec' is of type `time_t'
133 * which may be `unsigned. *sigh* */
134 if ((tv_end->tv_sec > ts_dest->tv_sec)
135 || ((tv_end->tv_sec == ts_dest->tv_sec)
136 && ((tv_end->tv_usec * 1000) > ts_dest->tv_nsec)))
138 ts_dest->tv_sec = tv_end->tv_sec;
139 ts_dest->tv_nsec = 1000 * tv_end->tv_usec;
142 time_normalize (ts_dest);
143 } /* }}} void time_calc */
145 static void *ping_thread (void *arg) /* {{{ */
147 static pingobj_t *pingobj = NULL;
149 struct timeval tv_begin;
150 struct timeval tv_end;
151 struct timespec ts_wait;
152 struct timespec ts_int;
157 pthread_mutex_lock (&ping_lock);
159 pingobj = ping_construct ();
162 ERROR ("ping plugin: ping_construct failed.");
163 ping_thread_error = 1;
164 pthread_mutex_unlock (&ping_lock);
165 return ((void *) -1);
168 if (ping_source != NULL)
169 if (ping_setopt (pingobj, PING_OPT_SOURCE, (void *) ping_source) != 0)
170 ERROR ("ping plugin: Failed to set source address: %s",
171 ping_get_error (pingobj));
173 #ifdef HAVE_OPING_1_3
174 if (ping_device != NULL)
175 if (ping_setopt (pingobj, PING_OPT_DEVICE, (void *) ping_device) != 0)
176 ERROR ("ping plugin: Failed to set device: %s",
177 ping_get_error (pingobj));
180 ping_setopt (pingobj, PING_OPT_TIMEOUT, (void *) &ping_timeout);
181 ping_setopt (pingobj, PING_OPT_TTL, (void *) &ping_ttl);
183 /* Add all the hosts to the ping object. */
185 for (hl = hostlist_head; hl != NULL; hl = hl->next)
188 status = ping_host_add (pingobj, hl->host);
190 WARNING ("ping plugin: ping_host_add (%s) failed.", hl->host);
197 ERROR ("ping plugin: No host could be added to ping object. Giving up.");
198 ping_thread_error = 1;
199 pthread_mutex_unlock (&ping_lock);
200 return ((void *) -1);
203 /* Set up `ts_int' */
208 temp_nsec = modf (ping_interval, &temp_sec);
209 ts_int.tv_sec = (time_t) temp_sec;
210 ts_int.tv_nsec = (long) (temp_nsec * 1000000000L);
213 while (ping_thread_loop > 0)
215 pingobj_iter_t *iter;
218 if (gettimeofday (&tv_begin, NULL) < 0)
220 ERROR ("ping plugin: gettimeofday failed");
221 ping_thread_error = 1;
225 pthread_mutex_unlock (&ping_lock);
227 status = ping_send (pingobj);
230 ERROR ("ping plugin: ping_send failed: %s", ping_get_error (pingobj));
231 pthread_mutex_lock (&ping_lock);
232 ping_thread_error = 1;
236 pthread_mutex_lock (&ping_lock);
238 if (ping_thread_loop <= 0)
241 for (iter = ping_iterator_get (pingobj);
243 iter = ping_iterator_next (iter))
245 char userhost[NI_MAXHOST];
249 param_size = sizeof (userhost);
250 status = ping_iterator_get_info (iter,
251 #ifdef PING_INFO_USERNAME
256 userhost, ¶m_size);
259 WARNING ("ping plugin: ping_iterator_get_info failed: %s",
260 ping_get_error (pingobj));
264 for (hl = hostlist_head; hl != NULL; hl = hl->next)
265 if (strcmp (userhost, hl->host) == 0)
270 WARNING ("ping plugin: Cannot find host %s.", userhost);
274 param_size = sizeof (latency);
275 status = ping_iterator_get_info (iter, PING_INFO_LATENCY,
276 (void *) &latency, ¶m_size);
279 WARNING ("ping plugin: ping_iterator_get_info failed: %s",
280 ping_get_error (pingobj));
288 hl->latency_total += latency;
289 hl->latency_squared += (latency * latency);
291 /* reset missed packages counter */
296 /* if the host did not answer our last N packages, trigger a resolv. */
297 if (ping_max_missed >= 0 && hl->pkg_missed >= ping_max_missed)
299 /* we reset the missed package counter here, since we only want to
300 * trigger a resolv every N packages and not every package _AFTER_ N
304 WARNING ("ping plugin: host %s has not answered %d PING requests,"
305 " triggering resolve", hl->host, ping_max_missed);
307 /* we trigger the resolv simply be removeing and adding the host to our
309 status = ping_host_remove (pingobj, hl->host);
312 WARNING ("ping plugin: ping_host_remove (%s) failed.", hl->host);
316 status = ping_host_add (pingobj, hl->host);
318 WARNING ("ping plugin: ping_host_add (%s) failed.", hl->host);
320 } /* }}} ping_max_missed */
321 } /* }}} for (iter) */
323 if (gettimeofday (&tv_end, NULL) < 0)
325 ERROR ("ping plugin: gettimeofday failed");
326 ping_thread_error = 1;
330 /* Calculate the absolute time until which to wait and store it in
332 time_calc (&ts_wait, &ts_int, &tv_begin, &tv_end);
334 status = pthread_cond_timedwait (&ping_cond, &ping_lock, &ts_wait);
335 if (ping_thread_loop <= 0)
337 } /* while (ping_thread_loop > 0) */
339 pthread_mutex_unlock (&ping_lock);
340 ping_destroy (pingobj);
343 } /* }}} void *ping_thread */
345 static int start_thread (void) /* {{{ */
349 pthread_mutex_lock (&ping_lock);
351 if (ping_thread_loop != 0)
353 pthread_mutex_unlock (&ping_lock);
357 ping_thread_loop = 1;
358 ping_thread_error = 0;
359 status = pthread_create (&ping_thread_id, /* attr = */ NULL,
360 ping_thread, /* arg = */ (void *) 0);
363 ping_thread_loop = 0;
364 ERROR ("ping plugin: Starting thread failed.");
365 pthread_mutex_unlock (&ping_lock);
369 pthread_mutex_unlock (&ping_lock);
371 } /* }}} int start_thread */
373 static int stop_thread (void) /* {{{ */
377 pthread_mutex_lock (&ping_lock);
379 if (ping_thread_loop == 0)
381 pthread_mutex_unlock (&ping_lock);
385 ping_thread_loop = 0;
386 pthread_cond_broadcast (&ping_cond);
387 pthread_mutex_unlock (&ping_lock);
389 status = pthread_join (ping_thread_id, /* return = */ NULL);
392 ERROR ("ping plugin: Stopping thread failed.");
396 memset (&ping_thread_id, 0, sizeof (ping_thread_id));
397 ping_thread_error = 0;
400 } /* }}} int stop_thread */
402 static int ping_init (void) /* {{{ */
404 if (hostlist_head == NULL)
406 NOTICE ("ping plugin: No hosts have been configured.");
410 if (ping_timeout > ping_interval)
412 ping_timeout = 0.9 * ping_interval;
413 WARNING ("ping plugin: Timeout is greater than interval. "
414 "Will use a timeout of %gs.", ping_timeout);
417 if (start_thread () != 0)
421 } /* }}} int ping_init */
423 static int config_set_string (const char *name, /* {{{ */
424 char **var, const char *value)
428 tmp = strdup (value);
432 ERROR ("ping plugin: Setting `%s' to `%s' failed: strdup failed: %s",
433 name, value, sstrerror (errno, errbuf, sizeof (errbuf)));
441 } /* }}} int config_set_string */
443 static int ping_config (const char *key, const char *value) /* {{{ */
445 if (strcasecmp (key, "Host") == 0)
450 hl = (hostlist_t *) malloc (sizeof (hostlist_t));
454 ERROR ("ping plugin: malloc failed: %s",
455 sstrerror (errno, errbuf, sizeof (errbuf)));
459 host = strdup (value);
464 ERROR ("ping plugin: strdup failed: %s",
465 sstrerror (errno, errbuf, sizeof (errbuf)));
473 hl->latency_total = 0.0;
474 hl->latency_squared = 0.0;
475 hl->next = hostlist_head;
478 else if (strcasecmp (key, "SourceAddress") == 0)
480 int status = config_set_string (key, &ping_source, value);
484 #ifdef HAVE_OPING_1_3
485 else if (strcasecmp (key, "Device") == 0)
487 int status = config_set_string (key, &ping_device, value);
492 else if (strcasecmp (key, "TTL") == 0)
494 int ttl = atoi (value);
495 if ((ttl > 0) && (ttl <= 255))
498 WARNING ("ping plugin: Ignoring invalid TTL %i.", ttl);
500 else if (strcasecmp (key, "Interval") == 0)
508 WARNING ("ping plugin: Ignoring invalid interval %g (%s)",
511 else if (strcasecmp (key, "Timeout") == 0)
519 WARNING ("ping plugin: Ignoring invalid timeout %g (%s)",
522 else if (strcasecmp (key, "MaxMissed") == 0)
524 ping_max_missed = atoi (value);
525 if (ping_max_missed < 0)
526 INFO ("ping plugin: MaxMissed < 0, disabled re-resolving of hosts");
534 } /* }}} int ping_config */
536 static void submit (const char *host, const char *type, /* {{{ */
540 value_list_t vl = VALUE_LIST_INIT;
542 values[0].gauge = value;
546 sstrncpy (vl.host, hostname_g, sizeof (vl.host));
547 sstrncpy (vl.plugin, "ping", sizeof (vl.plugin));
548 sstrncpy (vl.plugin_instance, "", sizeof (vl.plugin_instance));
549 sstrncpy (vl.type_instance, host, sizeof (vl.type_instance));
550 sstrncpy (vl.type, type, sizeof (vl.type));
552 plugin_dispatch_values (&vl);
553 } /* }}} void ping_submit */
555 static int ping_read (void) /* {{{ */
559 if (ping_thread_error != 0)
561 ERROR ("ping plugin: The ping thread had a problem. Restarting it.");
565 for (hl = hostlist_head; hl != NULL; hl = hl->next)
569 hl->latency_total = 0.0;
570 hl->latency_squared = 0.0;
576 } /* if (ping_thread_error != 0) */
578 for (hl = hostlist_head; hl != NULL; hl = hl->next) /* {{{ */
582 double latency_total;
583 double latency_squared;
585 double latency_average;
586 double latency_stddev;
590 /* Locking here works, because the structure of the linked list is only
591 * changed during configure and shutdown. */
592 pthread_mutex_lock (&ping_lock);
594 pkg_sent = hl->pkg_sent;
595 pkg_recv = hl->pkg_recv;
596 latency_total = hl->latency_total;
597 latency_squared = hl->latency_squared;
601 hl->latency_total = 0.0;
602 hl->latency_squared = 0.0;
604 pthread_mutex_unlock (&ping_lock);
606 /* This e. g. happens when starting up. */
609 DEBUG ("ping plugin: No packages for host %s have been sent.",
614 /* Calculate average. Beware of division by zero. */
616 latency_average = NAN;
618 latency_average = latency_total / ((double) pkg_recv);
620 /* Calculate standard deviation. Beware even more of division by zero. */
622 latency_stddev = NAN;
623 else if (pkg_recv == 1)
624 latency_stddev = 0.0;
626 latency_stddev = sqrt (((((double) pkg_recv) * latency_squared)
627 - (latency_total * latency_total))
628 / ((double) (pkg_recv * (pkg_recv - 1))));
630 /* Calculate drop rate. */
631 droprate = ((double) (pkg_sent - pkg_recv)) / ((double) pkg_sent);
633 submit (hl->host, "ping", latency_average);
634 submit (hl->host, "ping_stddev", latency_stddev);
635 submit (hl->host, "ping_droprate", droprate);
636 } /* }}} for (hl = hostlist_head; hl != NULL; hl = hl->next) */
639 } /* }}} int ping_read */
641 static int ping_shutdown (void) /* {{{ */
645 INFO ("ping plugin: Shutting down thread.");
646 if (stop_thread () < 0)
663 } /* }}} int ping_shutdown */
665 void module_register (void)
667 plugin_register_config ("ping", ping_config,
668 config_keys, config_keys_num);
669 plugin_register_init ("ping", ping_init);
670 plugin_register_read ("ping", ping_read);
671 plugin_register_shutdown ("ping", ping_shutdown);
672 } /* void module_register */
674 /* vim: set sw=2 sts=2 et fdm=marker : */