Various plugins: Convert more plugins to use "derive" instead of "counter".
[collectd.git] / src / routeros.c
index 48333b5..d61ffe9 100644 (file)
@@ -1,6 +1,6 @@
 /**
  * collectd - src/routeros.c
- * Copyright (C) 2009  Florian octo Forster
+ * Copyright (C) 2009,2010  Florian octo Forster
  *
  * This program is free software; you can redistribute it and/or modify it
  * under the terms of the GNU General Public License as published by the
@@ -16,7 +16,7 @@
  * 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
  *
  * Authors:
- *   Florian octo Forster <octo at verplant.org>
+ *   Florian octo Forster <octo at collectd.org>
  **/
 
 #include "collectd.h"
@@ -33,21 +33,28 @@ struct cr_data_s
   char *service;
   char *username;
   char *password;
+
+  _Bool collect_interface;
+  _Bool collect_regtable;
+  _Bool collect_cpu_load;
+  _Bool collect_memory;
+  _Bool collect_df;
+  _Bool collect_disk;
 };
 typedef struct cr_data_s cr_data_t;
 
-static void cr_submit_io (const char *type, const char *type_instance, /* {{{ */
-    counter_t rx, counter_t tx)
+static void cr_submit_io (cr_data_t *rd, const char *type, /* {{{ */
+    const char *type_instance, derive_t rx, derive_t tx)
 {
        value_t values[2];
        value_list_t vl = VALUE_LIST_INIT;
 
-       values[0].counter = rx;
-       values[1].counter = tx;
+       values[0].derive = rx;
+       values[1].derive = tx;
 
        vl.values = values;
        vl.values_len = STATIC_ARRAY_SIZE (values);
-       sstrncpy (vl.host, hostname_g, sizeof (vl.host));
+       sstrncpy (vl.host, rd->node, sizeof (vl.host));
        sstrncpy (vl.plugin, "routeros", sizeof (vl.plugin));
        sstrncpy (vl.type, type, sizeof (vl.type));
        sstrncpy (vl.type_instance, type_instance, sizeof (vl.type_instance));
@@ -55,37 +62,41 @@ static void cr_submit_io (const char *type, const char *type_instance, /* {{{ */
        plugin_dispatch_values (&vl);
 } /* }}} void cr_submit_io */
 
-static void submit_interface (const ros_interface_t *i) /* {{{ */
+static void submit_interface (cr_data_t *rd, /* {{{ */
+    const ros_interface_t *i)
 {
   if (i == NULL)
     return;
 
   if (!i->running)
   {
-    submit_interface (i->next);
+    submit_interface (rd, i->next);
     return;
   }
 
-  cr_submit_io ("if_packets", i->name,
-      (counter_t) i->rx_packets, (counter_t) i->tx_packets);
-  cr_submit_io ("if_octets", i->name,
-      (counter_t) i->rx_bytes, (counter_t) i->tx_bytes);
-  cr_submit_io ("if_errors", i->name,
-      (counter_t) i->rx_errors, (counter_t) i->tx_errors);
-  cr_submit_io ("if_dropped", i->name,
-      (counter_t) i->rx_drops, (counter_t) i->tx_drops);
+  cr_submit_io (rd, "if_packets", i->name,
+      (derive_t) i->rx_packets, (derive_t) i->tx_packets);
+  cr_submit_io (rd, "if_octets", i->name,
+      (derive_t) i->rx_bytes, (derive_t) i->tx_bytes);
+  cr_submit_io (rd, "if_errors", i->name,
+      (derive_t) i->rx_errors, (derive_t) i->tx_errors);
+  cr_submit_io (rd, "if_dropped", i->name,
+      (derive_t) i->rx_drops, (derive_t) i->tx_drops);
 
-  submit_interface (i->next);
+  submit_interface (rd, i->next);
 } /* }}} void submit_interface */
 
 static int handle_interface (__attribute__((unused)) ros_connection_t *c, /* {{{ */
-    const ros_interface_t *i, __attribute__((unused)) void *user_data)
+    const ros_interface_t *i, void *user_data)
 {
-  submit_interface (i);
+  if ((i == NULL) || (user_data == NULL))
+    return (EINVAL);
+
+  submit_interface (user_data, i);
   return (0);
 } /* }}} int handle_interface */
 
-static void cr_submit_gauge (const char *type, /* {{{ */
+static void cr_submit_gauge (cr_data_t *rd, const char *type, /* {{{ */
     const char *type_instance, gauge_t value)
 {
        value_t values[1];
@@ -95,15 +106,36 @@ static void cr_submit_gauge (const char *type, /* {{{ */
 
        vl.values = values;
        vl.values_len = STATIC_ARRAY_SIZE (values);
-       sstrncpy (vl.host, hostname_g, sizeof (vl.host));
+       sstrncpy (vl.host, rd->node, sizeof (vl.host));
+       sstrncpy (vl.plugin, "routeros", sizeof (vl.plugin));
+       sstrncpy (vl.type, type, sizeof (vl.type));
+       sstrncpy (vl.type_instance, type_instance, sizeof (vl.type_instance));
+
+       plugin_dispatch_values (&vl);
+} /* }}} void cr_submit_gauge */
+
+#if ROS_VERSION >= ROS_VERSION_ENCODE(1, 1, 0)
+static void cr_submit_counter (cr_data_t *rd, const char *type, /* {{{ */
+    const char *type_instance, derive_t value)
+{
+       value_t values[1];
+       value_list_t vl = VALUE_LIST_INIT;
+
+       values[0].derive = value;
+
+       vl.values = values;
+       vl.values_len = STATIC_ARRAY_SIZE (values);
+       sstrncpy (vl.host, rd->node, sizeof (vl.host));
        sstrncpy (vl.plugin, "routeros", sizeof (vl.plugin));
        sstrncpy (vl.type, type, sizeof (vl.type));
        sstrncpy (vl.type_instance, type_instance, sizeof (vl.type_instance));
 
        plugin_dispatch_values (&vl);
 } /* }}} void cr_submit_gauge */
+#endif
 
-static void submit_regtable (const ros_registration_table_t *r) /* {{{ */
+static void submit_regtable (cr_data_t *rd, /* {{{ */
+    const ros_registration_table_t *r)
 {
   char type_instance[DATA_MAX_NAME_LEN];
 
@@ -113,41 +145,81 @@ static void submit_regtable (const ros_registration_table_t *r) /* {{{ */
   /*** RX ***/
   ssnprintf (type_instance, sizeof (type_instance), "%s-%s-rx",
       r->interface, r->radio_name);
-  cr_submit_gauge ("bitrate", type_instance,
+  cr_submit_gauge (rd, "bitrate", type_instance,
       (gauge_t) (1000000.0 * r->rx_rate));
-  cr_submit_gauge ("signal_power", type_instance,
+  cr_submit_gauge (rd, "signal_power", type_instance,
       (gauge_t) r->rx_signal_strength);
-  cr_submit_gauge ("signal_quality", type_instance,
+  cr_submit_gauge (rd, "signal_quality", type_instance,
       (gauge_t) r->rx_ccq);
 
   /*** TX ***/
   ssnprintf (type_instance, sizeof (type_instance), "%s-%s-tx",
       r->interface, r->radio_name);
-  cr_submit_gauge ("bitrate", type_instance,
+  cr_submit_gauge (rd, "bitrate", type_instance,
       (gauge_t) (1000000.0 * r->tx_rate));
-  cr_submit_gauge ("signal_power", type_instance,
+  cr_submit_gauge (rd, "signal_power", type_instance,
       (gauge_t) r->tx_signal_strength);
-  cr_submit_gauge ("signal_quality", type_instance,
+  cr_submit_gauge (rd, "signal_quality", type_instance,
       (gauge_t) r->tx_ccq);
 
   /*** RX / TX ***/
   ssnprintf (type_instance, sizeof (type_instance), "%s-%s",
       r->interface, r->radio_name);
-  cr_submit_io ("if_octets", type_instance,
-      (counter_t) r->rx_bytes, (counter_t) r->tx_bytes);
-  cr_submit_gauge ("snr", type_instance, (gauge_t) r->signal_to_noise);
+  cr_submit_io (rd, "if_octets", type_instance,
+      (derive_t) r->rx_bytes, (derive_t) r->tx_bytes);
+  cr_submit_gauge (rd, "snr", type_instance, (gauge_t) r->signal_to_noise);
 
-  submit_regtable (r->next);
+  submit_regtable (rd, r->next);
 } /* }}} void submit_regtable */
 
 static int handle_regtable (__attribute__((unused)) ros_connection_t *c, /* {{{ */
-    const ros_registration_table_t *r,
-    __attribute__((unused)) void *user_data)
+    const ros_registration_table_t *r, void *user_data)
 {
-  submit_regtable (r);
+  if ((r == NULL) || (user_data == NULL))
+    return (EINVAL);
+
+  submit_regtable (user_data, r);
   return (0);
 } /* }}} int handle_regtable */
 
+#if ROS_VERSION >= ROS_VERSION_ENCODE(1, 1, 0)
+static int handle_system_resource (__attribute__((unused)) ros_connection_t *c, /* {{{ */
+        const ros_system_resource_t *r,
+       __attribute__((unused)) void *user_data)
+{
+  cr_data_t *rd;
+
+  if ((r == NULL) || (user_data == NULL))
+    return (EINVAL);
+  rd = user_data;
+
+  if (rd->collect_cpu_load)
+    cr_submit_gauge (rd, "gauge", "cpu_load", (gauge_t) r->cpu_load);
+
+  if (rd->collect_memory)
+  {
+    cr_submit_gauge (rd, "memory", "used",
+       (gauge_t) (r->total_memory - r->free_memory));
+    cr_submit_gauge (rd, "memory", "free", (gauge_t) r->free_memory);
+  }
+
+  if (rd->collect_df)
+  {
+    cr_submit_gauge (rd, "df_complex", "used",
+       (gauge_t) (r->total_memory - r->free_memory));
+    cr_submit_gauge (rd, "df_complex", "free", (gauge_t) r->free_memory);
+  }
+
+  if (rd->collect_disk)
+  {
+    cr_submit_counter (rd, "counter", "secors_written", (derive_t) r->write_sect_total);
+    cr_submit_gauge (rd, "gauge", "bad_blocks", (gauge_t) r->bad_blocks);
+  }
+
+  return (0);
+} /* }}} int handle_system_resource */
+#endif
+
 static int cr_read (user_data_t *user_data) /* {{{ */
 {
   int status;
@@ -174,30 +246,56 @@ static int cr_read (user_data_t *user_data) /* {{{ */
   }
   assert (rd->connection != NULL);
 
-  status = ros_interface (rd->connection, handle_interface,
-      /* user data = */ NULL);
-  if (status != 0)
+  if (rd->collect_interface)
   {
-    char errbuf[128];
-    ERROR ("routeros plugin: ros_interface failed: %s",
-       sstrerror (status, errbuf, sizeof (errbuf)));
-    ros_disconnect (rd->connection);
-    rd->connection = NULL;
-    return (-1);
+    status = ros_interface (rd->connection, handle_interface,
+       /* user data = */ rd);
+    if (status != 0)
+    {
+      char errbuf[128];
+      ERROR ("routeros plugin: ros_interface failed: %s",
+         sstrerror (status, errbuf, sizeof (errbuf)));
+      ros_disconnect (rd->connection);
+      rd->connection = NULL;
+      return (-1);
+    }
   }
 
-  status = ros_registration_table (rd->connection, handle_regtable,
-      /* user data = */ NULL);
-  if (status != 0)
+  if (rd->collect_regtable)
   {
-    char errbuf[128];
-    ERROR ("routeros plugin: ros_registration_table failed: %s",
-       sstrerror (status, errbuf, sizeof (errbuf)));
-    ros_disconnect (rd->connection);
-    rd->connection = NULL;
-    return (-1);
+    status = ros_registration_table (rd->connection, handle_regtable,
+       /* user data = */ rd);
+    if (status != 0)
+    {
+      char errbuf[128];
+      ERROR ("routeros plugin: ros_registration_table failed: %s",
+         sstrerror (status, errbuf, sizeof (errbuf)));
+      ros_disconnect (rd->connection);
+      rd->connection = NULL;
+      return (-1);
+    }
   }
 
+#if ROS_VERSION >= ROS_VERSION_ENCODE(1, 1, 0)
+  if (rd->collect_cpu_load
+      || rd->collect_memory
+      || rd->collect_df
+      || rd->collect_disk)
+  {
+    status = ros_system_resource (rd->connection, handle_system_resource,
+       /* user data = */ rd);
+    if (status != 0)
+    {
+      char errbuf[128];
+      ERROR ("routeros plugin: ros_system_resource failed: %s",
+         sstrerror (status, errbuf, sizeof (errbuf)));
+      ros_disconnect (rd->connection);
+      rd->connection = NULL;
+      return (-1);
+    }
+  }
+#endif
+
   return (0);
 } /* }}} int cr_read */
 
@@ -247,7 +345,21 @@ static int cr_config_router (oconfig_item_t *ci) /* {{{ */
     else if (strcasecmp ("User", child->key) == 0)
       status = cf_util_get_string (child, &router_data->username);
     else if (strcasecmp ("Password", child->key) == 0)
-      status = cf_util_get_string (child, &router_data->service);
+      status = cf_util_get_string (child, &router_data->password);
+    else if (strcasecmp ("CollectInterface", child->key) == 0)
+      cf_util_get_boolean (child, &router_data->collect_interface);
+    else if (strcasecmp ("CollectRegistrationTable", child->key) == 0)
+      cf_util_get_boolean (child, &router_data->collect_regtable);
+#if ROS_VERSION >= ROS_VERSION_ENCODE(1, 1, 0)
+    else if (strcasecmp ("CollectCPULoad", child->key) == 0)
+      cf_util_get_boolean (child, &router_data->collect_cpu_load);
+    else if (strcasecmp ("CollectMemory", child->key) == 0)
+      cf_util_get_boolean (child, &router_data->collect_memory);
+    else if (strcasecmp ("CollectDF", child->key) == 0)
+      cf_util_get_boolean (child, &router_data->collect_df);
+    else if (strcasecmp ("CollectDisk", child->key) == 0)
+      cf_util_get_boolean (child, &router_data->collect_disk);
+#endif
     else
     {
       WARNING ("routeros plugin: Unknown config option `%s'.", child->key);
@@ -272,6 +384,14 @@ static int cr_config_router (oconfig_item_t *ci) /* {{{ */
          "How should I authenticate?");
       status = -1;
     }
+
+    if (!router_data->collect_interface
+       && !router_data->collect_regtable)
+    {
+      ERROR ("routeros plugin: No `Collect*' option within a `Router' block. "
+         "What statistics should I collect?");
+      status = -1;
+    }
   }
 
   if ((status == 0) && (router_data->username == NULL))
@@ -288,8 +408,8 @@ static int cr_config_router (oconfig_item_t *ci) /* {{{ */
   user_data.data = router_data;
   user_data.free_func = (void *) cr_free_data;
   if (status == 0)
-    status = plugin_register_complex_read (read_name, cr_read,
-       /* interval = */ NULL, &user_data);
+    status = plugin_register_complex_read (/* group = */ NULL, read_name,
+       cr_read, /* interval = */ NULL, &user_data);
 
   if (status != 0)
     cr_free_data (router_data);