Bump version to 4.9.4; Update ChangeLog.
[collectd.git] / src / openvpn.c
index 62b022a..9c717dd 100644 (file)
 
 struct vpn_status_s
 {
-       char    *file;
+       char *file;
        enum
        {
-               MULTI1 = 1,     /* status-version 1 */
-               MULTI2,         /* status-version 2 */
-               MULTI3,         /* status-version 3 */
-               SINGLE = 10     /* currently no versions for single mode, maybe in the future */
+               MULTI1 = 1, /* status-version 1 */
+               MULTI2,     /* status-version 2 */
+               MULTI3,     /* status-version 3 */
+               SINGLE = 10 /* currently no versions for single mode, maybe in the future */
        } version;
-       char    *name;
+       char *name;
 };
 typedef struct vpn_status_s vpn_status_t;
 
@@ -51,17 +51,19 @@ static vpn_status_t **vpn_list = NULL;
 static int vpn_num = 0;
 
 static int store_compression = 1;
+static int new_naming_schema = 0;
 
 static const char *config_keys[] =
 {
        "StatusFile",
-       "Compression"
+       "Compression",
+       "ImprovedNamingSchema"
 };
 static int config_keys_num = STATIC_ARRAY_SIZE (config_keys);
 
 
-/*                     Helper function                 */
-/*  copy-n-pasted from common.c - changed delim to ","  */
+/* Helper function
+ * copy-n-pasted from common.c - changed delim to ","  */
 static int openvpn_strsplit (char *string, char **fields, size_t size)
 {
        size_t i;
@@ -83,9 +85,8 @@ static int openvpn_strsplit (char *string, char **fields, size_t size)
        return (i);
 } /* int openvpn_strsplit */
 
-
 /* dispatches stats about traffic (TCP or UDP) generated by the tunnel per single endpoint */
-static void iostats_submit (char *name, char *type, counter_t rx, counter_t tx)
+static void iostats_submit (char *pinst, char *tinst, counter_t rx, counter_t tx)
 {
        value_t values[2];
        value_list_t vl = VALUE_LIST_INIT;
@@ -93,24 +94,29 @@ static void iostats_submit (char *name, char *type, counter_t rx, counter_t tx)
        values[0].counter = rx;
        values[1].counter = tx;
 
-       /* NOTE: using plugin_instance to identify each vpn config (and
-        *       status) file; using type_instance to identify the endpoint
-        *       host when in multimode, traffic or overhead when in single.
+       /* NOTE ON THE NEW NAMING SCHEMA:
+        *       using plugin_instance to identify each vpn config (and
+        *       status) file; using type_instance to identify the endpoint
+        *       host when in multimode, traffic or overhead when in single.
         */
 
        vl.values = values;
        vl.values_len = STATIC_ARRAY_SIZE (values);
        sstrncpy (vl.host, hostname_g, sizeof (vl.host));
        sstrncpy (vl.plugin, "openvpn", sizeof (vl.plugin));
-       sstrncpy (vl.plugin_instance, name, sizeof (vl.plugin_instance));
-       sstrncpy (vl.type, "io_octets", sizeof (vl.type));
-       sstrncpy (vl.type_instance, type, sizeof (vl.type_instance));
+       if (pinst != NULL)
+               sstrncpy (vl.plugin_instance, pinst,
+                               sizeof (vl.plugin_instance));
+       sstrncpy (vl.type, "if_octets", sizeof (vl.type));
+       if (tinst != NULL)
+               sstrncpy (vl.type_instance, tinst, sizeof (vl.type_instance));
 
        plugin_dispatch_values (&vl);
 } /* void traffic_submit */
 
 /* dispatches stats about data compression shown when in single mode */
-static void compression_submit (char *name, char *type, counter_t uncompressed, counter_t compressed)
+static void compression_submit (char *pinst, char *tinst,
+               counter_t uncompressed, counter_t compressed)
 {
        value_t values[2];
        value_list_t vl = VALUE_LIST_INIT;
@@ -122,9 +128,12 @@ static void compression_submit (char *name, char *type, counter_t uncompressed,
        vl.values_len = STATIC_ARRAY_SIZE (values);
        sstrncpy (vl.host, hostname_g, sizeof (vl.host));
        sstrncpy (vl.plugin, "openvpn", sizeof (vl.plugin));
-       sstrncpy (vl.plugin_instance, name, sizeof (vl.plugin_instance));
+       if (pinst != NULL)
+               sstrncpy (vl.plugin_instance, pinst,
+                               sizeof (vl.plugin_instance));
        sstrncpy (vl.type, "compression", sizeof (vl.type));
-       sstrncpy (vl.type_instance, type, sizeof (vl.type_instance));
+       if (tinst != NULL)
+               sstrncpy (vl.type_instance, tinst, sizeof (vl.type_instance));
 
        plugin_dispatch_values (&vl);
 } /* void compression_submit */
@@ -153,7 +162,6 @@ static int single_read (char *name, FILE *fh)
        overhead_rx = 0;
        overhead_tx = 0;
 
-
        while (fgets (buffer, sizeof (buffer), fh) != NULL)
        {
                fields_num = openvpn_strsplit (buffer, fields, max_fields);
@@ -168,42 +176,40 @@ static int single_read (char *name, FILE *fh)
                {
                        continue;
                }
-               else
+
+               if (strcmp (fields[0], "TUN/TAP read bytes") == 0)
                {
-                       if (strcmp (fields[0], "TUN/TAP read bytes") == 0)
-                       {
-                               /* read from the system and sent over the tunnel */
-                               tun_tx = atoll (fields[1]);
-                       }
-                       else if (strcmp (fields[0], "TUN/TAP write bytes") == 0)
-                       {
-                               /* read from the tunnel and written in the system */
-                               tun_rx = atoll (fields[1]);
-                       }
-                       else if (strcmp (fields[0], "TCP/UDP read bytes") == 0)
-                       {
-                               link_rx = atoll (fields[1]);
-                       }
-                       else if (strcmp (fields[0], "TCP/UDP write bytes") == 0)
-                       {
-                               link_tx = atoll (fields[1]);
-                       }
-                       else if (strcmp (fields[0], "pre-compress bytes") == 0)
-                       {
-                               pre_compress = atoll (fields[1]);
-                       }
-                       else if (strcmp (fields[0], "post-compress bytes") == 0)
-                       {
-                               post_compress = atoll (fields[1]);
-                       }
-                       else if (strcmp (fields[0], "pre-decompress bytes") == 0)
-                       {
-                               pre_decompress = atoll (fields[1]);
-                       }
-                       else if (strcmp (fields[0], "post-decompress bytes") == 0)
-                       {
-                               post_decompress = atoll (fields[1]);
-                       }
+                       /* read from the system and sent over the tunnel */
+                       tun_tx = atoll (fields[1]);
+               }
+               else if (strcmp (fields[0], "TUN/TAP write bytes") == 0)
+               {
+                       /* read from the tunnel and written in the system */
+                       tun_rx = atoll (fields[1]);
+               }
+               else if (strcmp (fields[0], "TCP/UDP read bytes") == 0)
+               {
+                       link_rx = atoll (fields[1]);
+               }
+               else if (strcmp (fields[0], "TCP/UDP write bytes") == 0)
+               {
+                       link_tx = atoll (fields[1]);
+               }
+               else if (strcmp (fields[0], "pre-compress bytes") == 0)
+               {
+                       pre_compress = atoll (fields[1]);
+               }
+               else if (strcmp (fields[0], "post-compress bytes") == 0)
+               {
+                       post_compress = atoll (fields[1]);
+               }
+               else if (strcmp (fields[0], "pre-decompress bytes") == 0)
+               {
+                       pre_decompress = atoll (fields[1]);
+               }
+               else if (strcmp (fields[0], "post-decompress bytes") == 0)
+               {
+                       post_decompress = atoll (fields[1]);
                }
        }
 
@@ -231,30 +237,46 @@ static int multi1_read (char *name, FILE *fh)
 {
        char buffer[1024];
        char *fields[10];
-       const int max_fields = STATIC_ARRAY_SIZE (fields);
-       int  fields_num, read = 0, skip = 1;
+       int  fields_num, read = 0, found_header = 0;
 
        /* read the file until the "ROUTING TABLE" line is found (no more info after) */
-       for ( ; strcmp (buffer, "ROUTING TABLE\n"); fgets (buffer, sizeof (buffer), fh))
+       while (fgets (buffer, sizeof (buffer), fh) != NULL)
        {
-               if (skip) /* skip the first lines until the client list section is found */
+               if (strcmp (buffer, "ROUTING TABLE\n") == 0)
+                       break;
+
+               if (strcmp (buffer, V1STRING) == 0)
                {
+                       found_header = 1;
+                       continue;
+               }
+
+               /* skip the first lines until the client list section is found */
+               if (found_header == 0)
                        /* we can't start reading data until this string is found */
-                       if (strcmp (buffer, V1STRING) == 0)
-                               skip = 0;
+                       continue;
 
+               fields_num = openvpn_strsplit (buffer,
+                               fields, STATIC_ARRAY_SIZE (fields));
+               if (fields_num < 4)
                        continue;
+
+               if (new_naming_schema)
+               {
+                       iostats_submit (name,               /* vpn instance */
+                                       fields[0],          /* "Common Name" */
+                                       atoll (fields[2]),  /* "Bytes Received" */
+                                       atoll (fields[3])); /* "Bytes Sent" */
                }
                else
                {
-                       fields_num = openvpn_strsplit (buffer, fields, max_fields);
-
-                       iostats_submit (name,                   /* vpn instance */
-                                       fields[0],              /* "Common Name" */
-                                       atoll (fields[2]),      /* "Bytes Received" */
-                                       atoll (fields[3]));     /* "Bytes Sent" */
-                       read = 1;
+                       iostats_submit (fields[0],          /* "Common Name" */
+                                       NULL,               /* unused when in multimode */
+                                       atoll (fields[2]),  /* "Bytes Received" */
+                                       atoll (fields[3])); /* "Bytes Sent" */
                }
+
+               read = 1;
        }
 
        return (read);
@@ -279,20 +301,29 @@ static int multi2_read (char *name, FILE *fh)
                 *  with more or less fields.
                 */
                if (fields_num != 8)
-               {
                        continue;
+
+               if (strcmp (fields[0], "CLIENT_LIST") != 0)
+                       continue;
+
+               if (new_naming_schema)
+               {
+                       /* plugin inst = file name, type inst = fields[1] */
+                       iostats_submit (name,               /* vpn instance */
+                                       fields[1],          /* "Common Name" */
+                                       atoll (fields[4]),  /* "Bytes Received" */
+                                       atoll (fields[5])); /* "Bytes Sent" */
                }
                else
                {
-                       if (strcmp (fields[0], "CLIENT_LIST") == 0)
-                       {
-                               iostats_submit (name,                   /* vpn instance */
-                                               fields[1],              /* "Common Name" */
-                                               atoll (fields[4]),      /* "Bytes Received" */
-                                               atoll (fields[5]));     /* "Bytes Sent" */
-                               read = 1;
-                       }
+                       /* plugin inst = fields[1], type inst = "" */
+                       iostats_submit (fields[1],          /* "Common Name" */
+                                       NULL,               /* unused when in multimode */
+                                       atoll (fields[4]),  /* "Bytes Received" */
+                                       atoll (fields[5])); /* "Bytes Sent" */
                }
+
+               read = 1;
        }
 
        return (read);
@@ -322,14 +353,25 @@ static int multi3_read (char *name, FILE *fh)
                }
                else
                {
-                       if (strcmp (fields[0], "CLIENT_LIST") == 0)
+                       if (strcmp (fields[0], "CLIENT_LIST") != 0)
+                               continue;
+
+                       if (new_naming_schema)
+                       {
+                               iostats_submit (name,               /* vpn instance */
+                                               fields[1],          /* "Common Name" */
+                                               atoll (fields[4]),  /* "Bytes Received" */
+                                               atoll (fields[5])); /* "Bytes Sent" */
+                       }
+                       else
                        {
-                               iostats_submit (name,                   /* vpn instance */
-                                               fields[1],              /* "Common Name" */
-                                               atoll (fields[4]),      /* "Bytes Received" */
-                                               atoll (fields[5]));     /* "Bytes Sent" */
-                               read = 1;
+                               iostats_submit (fields[1],          /* "Common Name" */
+                                               NULL,               /* unused when in multimode */
+                                               atoll (fields[4]),  /* "Bytes Received" */
+                                               atoll (fields[5])); /* "Bytes Sent" */
                        }
+
+                       read = 1;
                }
        }
 
@@ -486,7 +528,7 @@ static int openvpn_config (const char *key, const char *value)
                }
                else
                {
-                       /* doesn't waist memory, uses status_file starting at filename + 1 */
+                       /* doesn't waste memory, uses status_file starting at filename + 1 */
                        status_name = filename + 1;
                }
 
@@ -526,7 +568,7 @@ static int openvpn_config (const char *key, const char *value)
 
                DEBUG ("openvpn plugin: status file \"%s\" added", temp->file);
 
-       }
+       } /* if (strcasecmp ("StatusFile", key) == 0) */
        else if (strcasecmp ("Compression", key) == 0)
        {
                if (IS_TRUE (value))
@@ -536,7 +578,19 @@ static int openvpn_config (const char *key, const char *value)
                        store_compression = 0;
                        DEBUG ("openvpn plugin: no 'compression statistcs' collected");
                }
-       }
+       } /* if (strcasecmp ("Compression", key) == 0) */
+       else if (strcasecmp ("ImprovedNamingSchema", key) == 0)
+       {
+               if (IS_TRUE (value))
+               {
+                       DEBUG ("openvpn plugin: using the new naming schema");
+                       new_naming_schema = 1;
+               }
+               else
+               {
+                       new_naming_schema = 0;
+               }
+       } /* if (strcasecmp ("ImprovedNamingSchema", key) == 0) */
        else
        {
                return (-1);
@@ -564,7 +618,9 @@ static int openvpn_shutdown (void)
 void module_register (void)
 {
        plugin_register_config ("openvpn", openvpn_config,
-                               config_keys, config_keys_num);
+                       config_keys, config_keys_num);
        plugin_register_read ("openvpn", openvpn_read);
        plugin_register_shutdown ("openvpn", openvpn_shutdown);
 } /* void module_register */
+
+/* vim: set sw=2 ts=2 : */