src/plugin.[ch]: Store the hostname in a global variable to minimize calls to `gethos...
[collectd.git] / src / traffic.c
index 7bbc481..5c5e4f7 100644 (file)
  *
  * Authors:
  *   Florian octo Forster <octo at verplant.org>
+ *   Sune Marcher <sm at flork.dk>
  **/
 
 #include "collectd.h"
 #include "common.h"
 #include "plugin.h"
+#include "configfile.h"
 
 #if HAVE_SYS_TYPES_H
 #  include <sys/types.h>
 
 #define MODULE_NAME "traffic"
 
+/*
+ * Various people have reported problems with `getifaddrs' and varying versions
+ * of `glibc'. That's why it's disabled by default. Since more statistics are
+ * available this way one may enable it using the `--enable-getifaddrs' option
+ * of the configure script. -octo
+ */
+#if KERNEL_LINUX
+# if !COLLECT_GETIFADDRS
+#  undef HAVE_GETIFADDRS
+# endif /* !COLLECT_GETIFADDRS */
+#endif /* KERNEL_LINUX */
+
 #if HAVE_GETIFADDRS || KERNEL_LINUX || HAVE_LIBKSTAT || HAVE_LIBSTATGRAB
 # define TRAFFIC_HAVE_READ 1
 #else
 
 #define BUFSIZE 512
 
-/* TODO: Move this to `interface-%s/<blah>.rrd' in version 4. */
-static char *bytes_file   = "traffic-%s.rrd";
-static char *packets_file = "if_packets-%s.rrd";
-static char *errors_file  = "if_errors-%s.rrd";
+/*
+ * (Module-)Global variables
+ */
+/* 2^32 = 4294967296 = ~4.2GByte/s = ~34GBit/s */
+static data_source_t octets_dsrc[2] =
+{
+       {"rx", DS_TYPE_COUNTER, 0, 4294967295.0},
+       {"tx", DS_TYPE_COUNTER, 0, 4294967295.0}
+};
 
-static char *bytes_ds_def[] =
+static data_set_t octets_ds =
 {
-       "DS:incoming:COUNTER:"COLLECTD_HEARTBEAT":0:U",
-       "DS:outgoing:COUNTER:"COLLECTD_HEARTBEAT":0:U",
-       NULL
+       "if_octets", 2, octets_dsrc
 };
-static int bytes_ds_num = 2;
 
-static char *packets_ds_def[] =
+static data_source_t packets_dsrc[2] =
 {
-       "DS:rx:COUNTER:"COLLECTD_HEARTBEAT":0:U",
-       "DS:tx:COUNTER:"COLLECTD_HEARTBEAT":0:U",
-       NULL
+       {"rx", DS_TYPE_COUNTER, 0, 4294967295.0},
+       {"tx", DS_TYPE_COUNTER, 0, 4294967295.0}
+};
+
+static data_set_t packets_ds =
+{
+       "if_packets", 2, packets_dsrc
+};
+
+static data_source_t errors_dsrc[2] =
+{
+       {"rx", DS_TYPE_COUNTER, 0, 4294967295.0},
+       {"tx", DS_TYPE_COUNTER, 0, 4294967295.0}
 };
-static int packets_ds_num = 2;
 
-static char *errors_ds_def[] =
+static data_set_t errors_ds =
 {
-       "DS:rx:COUNTER:"COLLECTD_HEARTBEAT":0:U",
-       "DS:tx:COUNTER:"COLLECTD_HEARTBEAT":0:U",
+       "if_errors", 2, errors_dsrc
+};
+
+static const char *config_keys[] =
+{
+       "Interface",
+       "IgnoreSelected",
        NULL
 };
-static int errors_ds_num = 2;
+static int config_keys_num = 2;
+
+static char **if_list = NULL;
+static int    if_list_num = 0;
+/* 
+ * if_list_action:
+ * 0 => default is to collect selected interface
+ * 1 => ignore selcted interfaces
+ */
+static int    if_list_action = 0;
 
 #ifdef HAVE_LIBKSTAT
 #define MAX_NUMIF 256
@@ -91,24 +130,55 @@ static kstat_t *ksp[MAX_NUMIF];
 static int numif = 0;
 #endif /* HAVE_LIBKSTAT */
 
-static void traffic_init (void)
+static int interface_config (const char *key, const char *value)
 {
-#if HAVE_GETIFADDRS
-       /* nothing */
-/* #endif HAVE_GETIFADDRS */
+       char **temp;
 
-#elif KERNEL_LINUX
-       /* nothing */
-/* #endif KERNEL_LINUX */
+       if (strcasecmp (key, "Interface") == 0)
+       {
+               temp = (char **) realloc (if_list, (if_list_num + 1) * sizeof (char *));
+               if (temp == NULL)
+               {
+                       syslog (LOG_EMERG, "Cannot allocate more memory.");
+                       return (1);
+               }
+               if_list = temp;
+
+               if ((if_list[if_list_num] = strdup (value)) == NULL)
+               {
+                       syslog (LOG_EMERG, "Cannot allocate memory.");
+                       return (1);
+               }
+               if_list_num++;
+       }
+       else if (strcasecmp (key, "IgnoreSelected") == 0)
+       {
+               if ((strcasecmp (value, "True") == 0)
+                               || (strcasecmp (value, "Yes") == 0)
+                               || (strcasecmp (value, "On") == 0))
+                       if_list_action = 1;
+               else
+                       if_list_action = 0;
+       }
+       else
+       {
+               return (-1);
+       }
 
-#elif HAVE_LIBKSTAT
+       return (0);
+}
+
+#if HAVE_LIBKSTAT
+static int traffic_init (void)
+{
+#if HAVE_LIBKSTAT
        kstat_t *ksp_chain;
        unsigned long long val;
 
        numif = 0;
 
        if (kc == NULL)
-               return;
+               return (-1);
 
        for (numif = 0, ksp_chain = kc->kc_chain;
                        (numif < MAX_NUMIF) && (ksp_chain != NULL);
@@ -124,92 +194,58 @@ static void traffic_init (void)
                        continue;
                ksp[numif++] = ksp_chain;
        }
-/* #endif HAVE_LIBKSTAT */
-
-#elif HAVE_LIBSTATG
-       /* nothing */
-#endif /* HAVE_LIBSTATG */
-
-       return;
-}
-
-static void generic_write (char *host, char *inst, char *val,
-               char *file_template,
-               char **ds_def, int ds_num)
-{
-       char file[512];
-       int status;
-
-       status = snprintf (file, BUFSIZE, file_template, inst);
-       if (status < 1)
-               return;
-       else if (status >= 512)
-               return;
+#endif /* HAVE_LIBKSTAT */
 
-       rrd_update_file (host, file, val, ds_def, ds_num);
-}
+       return (0);
+} /* int traffic_init */
+#endif /* HAVE_LIBKSTAT */
 
-static void bytes_write (char *host, char *inst, char *val)
+/*
+ * Check if this interface/instance should be ignored. This is called from
+ * both, `submit' and `write' to give client and server the ability to
+ * ignore certain stuff..
+ */
+static int check_ignore_if (const char *interface)
 {
-       generic_write (host, inst, val, bytes_file, bytes_ds_def, bytes_ds_num);
-}
+       int i;
 
-static void packets_write (char *host, char *inst, char *val)
-{
-       generic_write (host, inst, val, packets_file, packets_ds_def, packets_ds_num);
-}
+       /* If no interfaces are given collect all interfaces. Mostly to be
+        * backwards compatible, but also because this is much easier. */
+       if (if_list_num < 1)
+               return (0);
 
-static void errors_write (char *host, char *inst, char *val)
-{
-       generic_write (host, inst, val, errors_file, errors_ds_def, errors_ds_num);
-}
+       for (i = 0; i < if_list_num; i++)
+               if (strcasecmp (interface, if_list[i]) == 0)
+                       return (if_list_action);
+       return (1 - if_list_action);
+} /* int check_ignore_if */
 
 #if TRAFFIC_HAVE_READ
-static void bytes_submit (char *device,
-               unsigned long long incoming,
-               unsigned long long outgoing)
-{
-       char buf[BUFSIZE];
-
-       if (snprintf (buf, BUFSIZE, "%u:%lld:%lld", (unsigned int) curtime, incoming, outgoing) >= BUFSIZE)
-               return;
-
-       plugin_submit (MODULE_NAME, device, buf);
-}
-
-#if HAVE_GETIFADDRS
-static void packets_submit (char *dev,
+static void if_submit (const char *dev, const char *type,
                unsigned long long rx,
                unsigned long long tx)
 {
-       char buf[512];
-       int  status;
+       value_t values[2];
+       value_list_t vl = VALUE_LIST_INIT;
 
-       status = snprintf (buf, 512, "%u:%lld:%lld",
-                       (unsigned int) curtime,
-                       rx, tx);
-       if ((status >= 512) || (status < 1))
+       if (check_ignore_if (dev))
                return;
-       plugin_submit ("if_packets", dev, buf);
-}
 
-static void errors_submit (char *dev,
-               unsigned long long rx,
-               unsigned long long tx)
-{
-       char buf[512];
-       int  status;
+       values[0].counter = rx;
+       values[1].counter = tx;
 
-       status = snprintf (buf, 512, "%u:%lld:%lld",
-                       (unsigned int) curtime,
-                       rx, tx);
-       if ((status >= 512) || (status < 1))
-               return;
-       plugin_submit ("if_errors", dev, buf);
-}
-#endif /* HAVE_GETIFADDRS */
+       vl.values = values;
+       vl.values_len = 2;
+       vl.time = time (NULL);
+       strcpy (vl.host, hostname);
+       strcpy (vl.plugin, "interface");
+       strcpy (vl.plugin_instance, "");
+       strncpy (vl.type_instance, dev, sizeof (vl.type_instance));
+
+       plugin_dispatch_values (type, &vl);
+} /* void if_submit */
 
-static void traffic_read (void)
+static int traffic_read (void)
 {
 #if HAVE_GETIFADDRS
        struct ifaddrs *if_list;
@@ -248,13 +284,13 @@ static void traffic_read (void)
                if ((if_data = (struct IFA_DATA *) if_ptr->ifa_data) == NULL)
                        continue;
 
-               bytes_submit (if_ptr->ifa_name,
+               if_submit (if_ptr->ifa_name, "if_octets",
                                if_data->IFA_RX_BYTES,
                                if_data->IFA_TX_BYTES);
-               packets_submit (if_ptr->ifa_name,
+               if_submit (if_ptr->ifa_name, "if_packets",
                                if_data->IFA_RX_PACKT,
                                if_data->IFA_TX_PACKT);
-               errors_submit (if_ptr->ifa_name,
+               if_submit (if_ptr->ifa_name, "if_errors",
                                if_data->IFA_RX_ERROR,
                                if_data->IFA_TX_ERROR);
        }
@@ -275,14 +311,15 @@ static void traffic_read (void)
        if ((fh = fopen ("/proc/net/dev", "r")) == NULL)
        {
                syslog (LOG_WARNING, "traffic: fopen: %s", strerror (errno));
-               return;
+               return (-1);
        }
 
        while (fgets (buffer, 1024, fh) != NULL)
        {
-               if (buffer[6] != ':')
+               if (!(dummy = strchr(buffer, ':')))
                        continue;
-               buffer[6] = '\0';
+               dummy[0] = '\0';
+               dummy++;
 
                device = buffer;
                while (device[0] == ' ')
@@ -291,24 +328,31 @@ static void traffic_read (void)
                if (device[0] == '\0')
                        continue;
                
-               dummy = buffer + 7;
                numfields = strsplit (dummy, fields, 16);
 
-               if (numfields < 9)
+               if (numfields < 11)
                        continue;
 
                incoming = atoll (fields[0]);
                outgoing = atoll (fields[8]);
+               if_submit (device, "if_octets", incoming, outgoing);
+
+               incoming = atoll (fields[1]);
+               outgoing = atoll (fields[9]);
+               if_submit (device, "if_packets", incoming, outgoing);
 
-               bytes_submit (device, incoming, outgoing);
+               incoming = atoll (fields[2]);
+               outgoing = atoll (fields[10]);
+               if_submit (device, "if_errors", incoming, outgoing);
        }
 
        fclose (fh);
 /* #endif KERNEL_LINUX */
 
-#elif defined(HAVE_LIBKSTAT)
+#elif HAVE_LIBKSTAT
        int i;
-       unsigned long long incoming, outgoing;
+       unsigned long long rx;
+       unsigned long long tx;
 
        if (kc == NULL)
                return;
@@ -318,12 +362,20 @@ static void traffic_read (void)
                if (kstat_read (kc, ksp[i], NULL) == -1)
                        continue;
 
-               if ((incoming = get_kstat_value (ksp[i], "rbytes")) == -1LL)
-                       continue;
-               if ((outgoing = get_kstat_value (ksp[i], "obytes")) == -1LL)
-                       continue;
+               rx = get_kstat_value (ksp[i], "rbytes");
+               tx = get_kstat_value (ksp[i], "obytes");
+               if ((rx != -1LL) || (tx != -1LL))
+                       if_submit (ksp[i]->ks_name, "if_octets", rx, tx);
+
+               rx = get_kstat_value (ksp[i], "ipackets");
+               tx = get_kstat_value (ksp[i], "opackets");
+               if ((rx != -1LL) || (tx != -1LL))
+                       if_submit (ksp[i]->ks_name, "if_packets", rx, tx);
 
-               bytes_submit (ksp[i]->ks_name, incoming, outgoing);
+               rx = get_kstat_value (ksp[i], "ierrors");
+               tx = get_kstat_value (ksp[i], "oerrors");
+               if ((rx != -1LL) || (tx != -1LL))
+                       if_submit (ksp[i]->ks_name, "if_errors", rx, tx);
        }
 /* #endif HAVE_LIBKSTAT */
 
@@ -334,18 +386,29 @@ static void traffic_read (void)
        ios = sg_get_network_io_stats (&num);
 
        for (i = 0; i < num; i++)
-               bytes_submit (ios[i].interface_name, ios[i].rx, ios[i].tx);
+               if_submit (ios[i].interface_name, "if_octets", ios[i].rx, ios[i].tx);
 #endif /* HAVE_LIBSTATGRAB */
-}
-#else
-#define traffic_read NULL
+
+       return (0);
+} /* int traffic_read */
 #endif /* TRAFFIC_HAVE_READ */
 
 void module_register (void)
 {
-       plugin_register (MODULE_NAME, traffic_init, traffic_read, bytes_write);
-       plugin_register ("if_packets", NULL, NULL, packets_write);
-       plugin_register ("if_errors",  NULL, NULL, errors_write);
+       plugin_register_data_set (&octets_ds);
+       plugin_register_data_set (&packets_ds);
+       plugin_register_data_set (&errors_ds);
+
+       plugin_register_config ("interface", interface_config,
+                       config_keys, config_keys_num);
+
+#if HAVE_LIBKSTAT
+       plugin_register_init ("interface", traffic_init);
+#endif
+
+#if TRAFFIC_HAVE_READ
+       plugin_register_read ("interface", traffic_read);
+#endif
 }
 
 #undef BUFSIZE