From: Florian Forster <octo@leeloo.lan.home.verplant.org>
Date: Mon, 22 Mar 2010 18:29:13 +0000 (+0100)
Subject: Merge branch 'fs/openvpn'
X-Git-Tag: collectd-4.10.0~52
X-Git-Url: https://git.octo.it/?a=commitdiff_plain;h=f4c25b4b234ba63fb9b15c2219d55d8af3e3f39d;hp=-c;p=collectd.git

Merge branch 'fs/openvpn'

Conflicts:
	src/collectd.conf.pod
	src/openvpn.c
---

f4c25b4b234ba63fb9b15c2219d55d8af3e3f39d
diff --combined src/collectd.conf.pod
index a12a48b6,b1544e8d..facb0589
--- a/src/collectd.conf.pod
+++ b/src/collectd.conf.pod
@@@ -2776,19 -2776,24 +2776,31 @@@ Available options
  
  Specifies the location of the status file.
  
 +=item B<ImprovedNamingSchema> B<true>|B<false>
 +
 +When enabled, the filename of the status file will be used as plugin instance
 +and the client's "common name" will be used as type instance. This is required
 +when reading multiple status files. Enabling this option is recommended, but to
 +maintain backwards compatibility this option is disabled by default.
 +
- =item B<Compression> B<true>|B<false>
+ =item B<CollectCompression> B<true>|B<false>
  
  Sets whether or not statistics about the compression used by OpenVPN should be
  collected. This information is only available in I<single> mode. Enabled by
  default.
  
+ =item B<CollectIndividualUsers> B<true>|B<false>
+ 
+ Sets whether or not traffic information is collected for each connected client
+ individually. If set to false, currently no traffic data is collected at all
+ because aggregating this data in a save manner is tricky. Defaults to B<true>.
+ 
+ =item B<CollectUserCount> B<true>|B<false>
+ 
+ When enabled, the number of currently connected clients or users is collected.
+ This is expecially interesting when B<CollectIndividualUsers> is disabled, but
+ can be configured independently from that option. Defaults to B<false>.
+ 
  =back
  
  =head2 Plugin C<oracle>
diff --combined src/openvpn.c
index 9c717dd0,8c0f82db..2aca4145
--- a/src/openvpn.c
+++ b/src/openvpn.c
@@@ -3,6 -3,7 +3,7 @@@
   * Copyright (C) 2008  Doug MacEachern
   * Copyright (C) 2009  Florian octo Forster
   * Copyright (C) 2009  Marco Chiappero
+  * Copyright (C) 2009  Fabian Schuh
   *
   * 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
@@@ -21,6 -22,7 +22,7 @@@
   *   Doug MacEachern <dougm at hyperic.com>
   *   Florian octo Forster <octo at verplant.org>
   *   Marco Chiappero <marco at absence.it>
+  *   Fabian Schuh <mail at xeroc.org>
   **/
  
  #include "collectd.h"
@@@ -50,14 -52,19 +52,19 @@@ typedef struct vpn_status_s vpn_status_
  static vpn_status_t **vpn_list = NULL;
  static int vpn_num = 0;
  
- static int store_compression = 1;
- static int new_naming_schema = 0;
+ static _Bool new_naming_schema = 0;
+ static _Bool collect_compression = 1;
+ static _Bool collect_user_count  = 0;
+ static _Bool collect_individual_users  = 1;
  
  static const char *config_keys[] =
  {
  	"StatusFile",
- 	"Compression",
- 	"ImprovedNamingSchema"
+ 	"Compression", /* old, deprecated name */
+ 	"ImprovedNamingSchema",
+ 	"CollectCompression",
+ 	"CollectUserCount",
+ 	"CollectIndividualUsers"
  };
  static int config_keys_num = STATIC_ARRAY_SIZE (config_keys);
  
@@@ -85,6 -92,27 +92,27 @@@ static int openvpn_strsplit (char *stri
  	return (i);
  } /* int openvpn_strsplit */
  
+ /* dispatches number of users */
+ static void numusers_submit (char *pinst, char *tinst, gauge_t value)
+ {
+ 	value_t values[1];
+ 	value_list_t vl = VALUE_LIST_INIT;
+ 
+ 	values[0].gauge = value;
+ 
+ 	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.type, "users", sizeof (vl.type));
+ 	if (pinst != NULL)
+ 		sstrncpy (vl.plugin_instance, pinst, sizeof (vl.plugin_instance));
+ 	if (tinst != NULL)
+ 		sstrncpy (vl.type_instance, tinst, sizeof (vl.type_instance));
+ 
+ 	plugin_dispatch_values (&vl);
+ } /* void numusers_submit */
+ 
  /* dispatches stats about traffic (TCP or UDP) generated by the tunnel per single endpoint */
  static void iostats_submit (char *pinst, char *tinst, counter_t rx, counter_t tx)
  {
@@@ -221,7 -249,7 +249,7 @@@ static int single_read (char *name, FIL
  
  	iostats_submit (name, "overhead", overhead_rx, overhead_tx);
  
- 	if (store_compression)
+ 	if (collect_compression)
  	{
  		compression_submit (name, "data_in", post_decompress, pre_decompress);
  		compression_submit (name, "data_out", pre_compress, post_compress);
@@@ -238,6 -266,7 +266,7 @@@ static int multi1_read (char *name, FIL
  	char buffer[1024];
  	char *fields[10];
  	int  fields_num, read = 0, found_header = 0;
+ 	long long sum_users = 0;
  
  	/* read the file until the "ROUTING TABLE" line is found (no more info after) */
  	while (fgets (buffer, sizeof (buffer), fh) != NULL)
@@@ -261,24 -290,38 +290,38 @@@
  		if (fields_num < 4)
  			continue;
  
- 		if (new_naming_schema)
+ 		if (collect_user_count)
+ 			/* If so, sum all users, ignore the individuals*/
  		{
- 			iostats_submit (name,               /* vpn instance */
- 					fields[0],          /* "Common Name" */
- 					atoll (fields[2]),  /* "Bytes Received" */
- 					atoll (fields[3])); /* "Bytes Sent" */
+ 			sum_users += 1;
  		}
- 		else
+ 		if (collect_individual_users)
  		{
- 			iostats_submit (fields[0],          /* "Common Name" */
- 					NULL,               /* unused when in multimode */
- 					atoll (fields[2]),  /* "Bytes Received" */
- 					atoll (fields[3])); /* "Bytes Sent" */
+ 			if (new_naming_schema)
+ 			{
 -				iostats_submit (fields[0],          /* "Common Name" */
 -						NULL,               /* unused when in multimode */
++				iostats_submit (name,               /* vpn instance */
++						fields[0],          /* "Common Name" */
+ 						atoll (fields[2]),  /* "Bytes Received" */
+ 						atoll (fields[3])); /* "Bytes Sent" */
+ 			}
+ 			else
+ 			{
 -				iostats_submit (name,               /* vpn instance */
 -						fields[0],          /* "Common Name" */
++				iostats_submit (fields[0],          /* "Common Name" */
++						NULL,               /* unused when in multimode */
+ 						atoll (fields[2]),  /* "Bytes Received" */
+ 						atoll (fields[3])); /* "Bytes Sent" */
+ 			}
  		}
  
  		read = 1;
  	}
  
+ 	if (collect_user_count)
+ 	{
+ 		numusers_submit(name, name, sum_users);
+ 		read = 1;
+ 	}
+ 
  	return (read);
  } /* int multi1_read */
  
@@@ -289,6 -332,7 +332,7 @@@ static int multi2_read (char *name, FIL
  	char *fields[10];
  	const int max_fields = STATIC_ARRAY_SIZE (fields);
  	int  fields_num, read = 0;
+ 	long long sum_users    = 0;
  
  	while (fgets (buffer, sizeof (buffer), fh) != NULL)
  	{
@@@ -306,26 -350,40 +350,40 @@@
  		if (strcmp (fields[0], "CLIENT_LIST") != 0)
  			continue;
  
- 		if (new_naming_schema)
+ 		if (collect_user_count)
+ 			/* If so, sum all users, ignore the individuals*/
  		{
- 			/* 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" */
+ 			sum_users += 1;
  		}
- 		else
+ 		if (collect_individual_users)
  		{
- 			/* 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" */
+ 			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
+ 			{
+ 				/* 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;
  	}
  
+ 	if (collect_user_count)
+ 	{
+ 		numusers_submit(name, name, sum_users);
+ 		read = 1;
+ 	}
+ 
  	return (read);
  } /* int multi2_read */
  
@@@ -336,6 -394,7 +394,7 @@@ static int multi3_read (char *name, FIL
  	char *fields[15];
  	const int max_fields = STATIC_ARRAY_SIZE (fields);
  	int  fields_num, read = 0;
+ 	long long sum_users    = 0;
  
  	while (fgets (buffer, sizeof (buffer), fh) != NULL)
  	{
@@@ -356,25 -415,40 +415,40 @@@
  			if (strcmp (fields[0], "CLIENT_LIST") != 0)
  				continue;
  
- 			if (new_naming_schema)
+ 			if (collect_user_count)
+ 				/* If so, sum all users, ignore the individuals*/
  			{
- 				iostats_submit (name,               /* vpn instance */
- 						fields[1],          /* "Common Name" */
- 						atoll (fields[4]),  /* "Bytes Received" */
- 						atoll (fields[5])); /* "Bytes Sent" */
+ 				sum_users += 1;
  			}
- 			else
+ 
+ 			if (collect_individual_users)
  			{
- 				iostats_submit (fields[1],          /* "Common Name" */
- 						NULL,               /* unused when in multimode */
- 						atoll (fields[4]),  /* "Bytes Received" */
- 						atoll (fields[5])); /* "Bytes Sent" */
+ 				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 (fields[1],          /* "Common Name" */
+ 							NULL,               /* unused when in multimode */
+ 							atoll (fields[4]),  /* "Bytes Received" */
+ 							atoll (fields[5])); /* "Bytes Sent" */
+ 				}
  			}
  
  			read = 1;
  		}
  	}
  
+ 	if (collect_user_count)
+ 	{
+ 		numusers_submit(name, name, sum_users);
+ 		read = 1;
+ 	}
+ 
  	return (read);
  } /* int multi3_read */
  
@@@ -394,7 -468,7 +468,7 @@@ static int openvpn_read (void
  		{
  			char errbuf[1024];
  			WARNING ("openvpn plugin: fopen(%s) failed: %s", vpn_list[i]->file,
- 				sstrerror (errno, errbuf, sizeof (errbuf)));
+ 					sstrerror (errno, errbuf, sizeof (errbuf)));
  
  			continue;
  		}
@@@ -506,7 -580,7 +580,7 @@@ static int openvpn_config (const char *
  		if (status_version == 0)
  		{
  			WARNING ("openvpn plugin: unable to detect status version, \
- 				discarding status file \"%s\".", value);
+ 					discarding status file \"%s\".", value);
  			return (1);
  		}
  
@@@ -515,7 -589,7 +589,7 @@@
  		{
  			char errbuf[1024];
  			WARNING ("openvpn plugin: sstrdup failed: %s",
- 				sstrerror (errno, errbuf, sizeof (errbuf)));
+ 					sstrerror (errno, errbuf, sizeof (errbuf)));
  			return (1);
  		}
  
@@@ -556,7 -630,7 +630,7 @@@
  		{
  			char errbuf[1024];
  			ERROR ("openvpn plugin: malloc failed: %s",
- 				sstrerror (errno, errbuf, sizeof (errbuf)));
+ 					sstrerror (errno, errbuf, sizeof (errbuf)));
  
  			sfree (temp->file);
  			sfree (temp);
@@@ -569,16 -643,14 +643,14 @@@
  		DEBUG ("openvpn plugin: status file \"%s\" added", temp->file);
  
  	} /* if (strcasecmp ("StatusFile", key) == 0) */
- 	else if (strcasecmp ("Compression", key) == 0)
+ 	else if ((strcasecmp ("CollectCompression", key) == 0)
+ 		|| (strcasecmp ("Compression", key) == 0)) /* old, deprecated name */
  	{
- 		if (IS_TRUE (value))
- 			store_compression = 1;
+ 		if (IS_FALSE (value))
+ 			collect_compression = 0;
  		else
- 		{
- 			store_compression = 0;
- 			DEBUG ("openvpn plugin: no 'compression statistcs' collected");
- 		}
- 	} /* if (strcasecmp ("Compression", key) == 0) */
+ 			collect_compression = 1;
+ 	} /* if (strcasecmp ("CollectCompression", key) == 0) */
  	else if (strcasecmp ("ImprovedNamingSchema", key) == 0)
  	{
  		if (IS_TRUE (value))
@@@ -591,6 -663,20 +663,20 @@@
  			new_naming_schema = 0;
  		}
  	} /* if (strcasecmp ("ImprovedNamingSchema", key) == 0) */
+ 	else if (strcasecmp("CollectUserCount", key) == 0)
+ 	{
+ 		if (IS_TRUE(value))
+ 			collect_user_count = 1;
+ 		else
+ 			collect_user_count = 0;
+ 	} /* if (strcasecmp("CollectUserCount", key) == 0) */
+ 	else if (strcasecmp("CollectIndividualUsers", key) == 0)
+ 	{
+ 		if (IS_FALSE (value))
+ 			collect_individual_users = 0;
+ 		else
+ 			collect_individual_users = 1;
+ 	} /* if (strcasecmp("CollectIndividualUsers", key) == 0) */
  	else
  	{
  		return (-1);
@@@ -615,12 -701,29 +701,29 @@@ static int openvpn_shutdown (void
  	return (0);
  } /* int openvpn_shutdown */
  
+ static int openvpn_init (void)
+ {
+ 	if (!collect_individual_users
+ 			&& !collect_compression
+ 			&& !collect_user_count)
+ 	{
+ 		WARNING ("OpenVPN plugin: Neither `CollectIndividualUsers', "
+ 				"`CollectCompression', nor `CollectUserCount' is true. There's no "
+ 				"data left to collect.");
+ 		return (-1);
+ 	}
+ 
+ 	plugin_register_read ("openvpn", openvpn_read);
+ 	plugin_register_shutdown ("openvpn", openvpn_shutdown);
+ 
+ 	return (0);
+ } /* int openvpn_init */
+ 
  void module_register (void)
  {
  	plugin_register_config ("openvpn", openvpn_config,
  			config_keys, config_keys_num);
- 	plugin_register_read ("openvpn", openvpn_read);
- 	plugin_register_shutdown ("openvpn", openvpn_shutdown);
+ 	plugin_register_init ("openvpn", openvpn_init);
  } /* void module_register */
  
  /* vim: set sw=2 ts=2 : */