2 * collectd - src/openvpn.c
3 * Copyright (C) 2008 Doug MacEachern
4 * Copyright (C) 2009,2010 Florian octo Forster
5 * Copyright (C) 2009 Marco Chiappero
6 * Copyright (C) 2009 Fabian Schuh
8 * This program is free software; you can redistribute it and/or modify it
9 * under the terms of the GNU General Public License as published by the
10 * Free Software Foundation; only version 2 of the License is applicable.
12 * This program is distributed in the hope that it will be useful, but
13 * WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * General Public License for more details.
17 * You should have received a copy of the GNU General Public License along
18 * with this program; if not, write to the Free Software Foundation, Inc.,
19 * 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
22 * Doug MacEachern <dougm at hyperic.com>
23 * Florian octo Forster <octo at collectd.org>
24 * Marco Chiappero <marco at absence.it>
25 * Fabian Schuh <mail at xeroc.org>
32 #define V1STRING "Common Name,Real Address,Bytes Received,Bytes Sent,Connected Since\n"
33 #define V2STRING "HEADER,CLIENT_LIST,Common Name,Real Address,Virtual Address,Bytes Received,Bytes Sent,Connected Since,Connected Since (time_t)\n"
34 #define V3STRING "HEADER CLIENT_LIST Common Name Real Address Virtual Address Bytes Received Bytes Sent Connected Since Connected Since (time_t)\n"
35 #define VSSTRING "OpenVPN STATISTICS\n"
43 MULTI1 = 1, /* status-version 1 */
44 MULTI2, /* status-version 2 */
45 MULTI3, /* status-version 3 */
46 SINGLE = 10 /* currently no versions for single mode, maybe in the future */
50 typedef struct vpn_status_s vpn_status_t;
52 static vpn_status_t **vpn_list = NULL;
53 static int vpn_num = 0;
55 static _Bool new_naming_schema = 0;
56 static _Bool collect_compression = 1;
57 static _Bool collect_user_count = 0;
58 static _Bool collect_individual_users = 1;
60 static const char *config_keys[] =
63 "Compression", /* old, deprecated name */
64 "ImprovedNamingSchema",
67 "CollectIndividualUsers"
69 static int config_keys_num = STATIC_ARRAY_SIZE (config_keys);
73 * copy-n-pasted from common.c - changed delim to "," */
74 static int openvpn_strsplit (char *string, char **fields, size_t size)
83 while ((fields[i] = strtok_r (ptr, ",", &saveptr)) != NULL)
93 } /* int openvpn_strsplit */
95 /* dispatches number of users */
96 static void numusers_submit (char *pinst, char *tinst, gauge_t value)
99 value_list_t vl = VALUE_LIST_INIT;
101 values[0].gauge = value;
104 vl.values_len = STATIC_ARRAY_SIZE (values);
105 sstrncpy (vl.host, hostname_g, sizeof (vl.host));
106 sstrncpy (vl.plugin, "openvpn", sizeof (vl.plugin));
107 sstrncpy (vl.type, "users", sizeof (vl.type));
109 sstrncpy (vl.plugin_instance, pinst, sizeof (vl.plugin_instance));
111 sstrncpy (vl.type_instance, tinst, sizeof (vl.type_instance));
113 plugin_dispatch_values (&vl);
114 } /* void numusers_submit */
116 /* dispatches stats about traffic (TCP or UDP) generated by the tunnel per single endpoint */
117 static void iostats_submit (char *pinst, char *tinst, derive_t rx, derive_t tx)
120 value_list_t vl = VALUE_LIST_INIT;
122 values[0].derive = rx;
123 values[1].derive = tx;
125 /* NOTE ON THE NEW NAMING SCHEMA:
126 * using plugin_instance to identify each vpn config (and
127 * status) file; using type_instance to identify the endpoint
128 * host when in multimode, traffic or overhead when in single.
132 vl.values_len = STATIC_ARRAY_SIZE (values);
133 sstrncpy (vl.host, hostname_g, sizeof (vl.host));
134 sstrncpy (vl.plugin, "openvpn", sizeof (vl.plugin));
136 sstrncpy (vl.plugin_instance, pinst,
137 sizeof (vl.plugin_instance));
138 sstrncpy (vl.type, "if_octets", sizeof (vl.type));
140 sstrncpy (vl.type_instance, tinst, sizeof (vl.type_instance));
142 plugin_dispatch_values (&vl);
143 } /* void traffic_submit */
145 /* dispatches stats about data compression shown when in single mode */
146 static void compression_submit (char *pinst, char *tinst,
147 derive_t uncompressed, derive_t compressed)
150 value_list_t vl = VALUE_LIST_INIT;
152 values[0].derive = uncompressed;
153 values[1].derive = compressed;
156 vl.values_len = STATIC_ARRAY_SIZE (values);
157 sstrncpy (vl.host, hostname_g, sizeof (vl.host));
158 sstrncpy (vl.plugin, "openvpn", sizeof (vl.plugin));
160 sstrncpy (vl.plugin_instance, pinst,
161 sizeof (vl.plugin_instance));
162 sstrncpy (vl.type, "compression", sizeof (vl.type));
164 sstrncpy (vl.type_instance, tinst, sizeof (vl.type_instance));
166 plugin_dispatch_values (&vl);
167 } /* void compression_submit */
169 static int single_read (char *name, FILE *fh)
173 const int max_fields = STATIC_ARRAY_SIZE (fields);
174 int fields_num, read = 0;
176 derive_t link_rx, link_tx;
177 derive_t tun_rx, tun_tx;
178 derive_t pre_compress, post_compress;
179 derive_t pre_decompress, post_decompress;
180 derive_t overhead_rx, overhead_tx;
191 while (fgets (buffer, sizeof (buffer), fh) != NULL)
193 fields_num = openvpn_strsplit (buffer, fields, max_fields);
195 /* status file is generated by openvpn/sig.c:print_status()
196 * http://svn.openvpn.net/projects/openvpn/trunk/openvpn/sig.c
198 * The line we're expecting has 2 fields. We ignore all lines
199 * with more or less fields.
206 if (strcmp (fields[0], "TUN/TAP read bytes") == 0)
208 /* read from the system and sent over the tunnel */
209 tun_tx = atoll (fields[1]);
211 else if (strcmp (fields[0], "TUN/TAP write bytes") == 0)
213 /* read from the tunnel and written in the system */
214 tun_rx = atoll (fields[1]);
216 else if (strcmp (fields[0], "TCP/UDP read bytes") == 0)
218 link_rx = atoll (fields[1]);
220 else if (strcmp (fields[0], "TCP/UDP write bytes") == 0)
222 link_tx = atoll (fields[1]);
224 else if (strcmp (fields[0], "pre-compress bytes") == 0)
226 pre_compress = atoll (fields[1]);
228 else if (strcmp (fields[0], "post-compress bytes") == 0)
230 post_compress = atoll (fields[1]);
232 else if (strcmp (fields[0], "pre-decompress bytes") == 0)
234 pre_decompress = atoll (fields[1]);
236 else if (strcmp (fields[0], "post-decompress bytes") == 0)
238 post_decompress = atoll (fields[1]);
242 iostats_submit (name, "traffic", link_rx, link_tx);
244 /* we need to force this order to avoid negative values with these unsigned */
245 overhead_rx = (((link_rx - pre_decompress) + post_decompress) - tun_rx);
246 overhead_tx = (((link_tx - post_compress) + pre_compress) - tun_tx);
248 iostats_submit (name, "overhead", overhead_rx, overhead_tx);
250 if (collect_compression)
252 compression_submit (name, "data_in", post_decompress, pre_decompress);
253 compression_submit (name, "data_out", pre_compress, post_compress);
259 } /* int single_read */
261 /* for reading status version 1 */
262 static int multi1_read (char *name, FILE *fh)
266 int fields_num, found_header = 0;
267 long long sum_users = 0;
269 /* read the file until the "ROUTING TABLE" line is found (no more info after) */
270 while (fgets (buffer, sizeof (buffer), fh) != NULL)
272 if (strcmp (buffer, "ROUTING TABLE\n") == 0)
275 if (strcmp (buffer, V1STRING) == 0)
281 /* skip the first lines until the client list section is found */
282 if (found_header == 0)
283 /* we can't start reading data until this string is found */
286 fields_num = openvpn_strsplit (buffer,
287 fields, STATIC_ARRAY_SIZE (fields));
291 if (collect_user_count)
292 /* If so, sum all users, ignore the individuals*/
296 if (collect_individual_users)
298 if (new_naming_schema)
300 iostats_submit (name, /* vpn instance */
301 fields[0], /* "Common Name" */
302 atoll (fields[2]), /* "Bytes Received" */
303 atoll (fields[3])); /* "Bytes Sent" */
307 iostats_submit (fields[0], /* "Common Name" */
308 NULL, /* unused when in multimode */
309 atoll (fields[2]), /* "Bytes Received" */
310 atoll (fields[3])); /* "Bytes Sent" */
318 if (collect_user_count)
319 numusers_submit(name, name, sum_users);
322 } /* int multi1_read */
324 /* for reading status version 2 */
325 static int multi2_read (char *name, FILE *fh)
329 const int max_fields = STATIC_ARRAY_SIZE (fields);
330 int fields_num, read = 0;
331 long long sum_users = 0;
333 while (fgets (buffer, sizeof (buffer), fh) != NULL)
335 fields_num = openvpn_strsplit (buffer, fields, max_fields);
337 /* status file is generated by openvpn/multi.c:multi_print_status()
338 * http://svn.openvpn.net/projects/openvpn/trunk/openvpn/multi.c
340 * The line we're expecting has 8 fields. We ignore all lines
341 * with more or less fields.
346 if (strcmp (fields[0], "CLIENT_LIST") != 0)
349 if (collect_user_count)
350 /* If so, sum all users, ignore the individuals*/
354 if (collect_individual_users)
356 if (new_naming_schema)
358 /* plugin inst = file name, type inst = fields[1] */
359 iostats_submit (name, /* vpn instance */
360 fields[1], /* "Common Name" */
361 atoll (fields[4]), /* "Bytes Received" */
362 atoll (fields[5])); /* "Bytes Sent" */
366 /* plugin inst = fields[1], type inst = "" */
367 iostats_submit (fields[1], /* "Common Name" */
368 NULL, /* unused when in multimode */
369 atoll (fields[4]), /* "Bytes Received" */
370 atoll (fields[5])); /* "Bytes Sent" */
377 if (collect_user_count)
379 numusers_submit(name, name, sum_users);
384 } /* int multi2_read */
386 /* for reading status version 3 */
387 static int multi3_read (char *name, FILE *fh)
391 const int max_fields = STATIC_ARRAY_SIZE (fields);
392 int fields_num, read = 0;
393 long long sum_users = 0;
395 while (fgets (buffer, sizeof (buffer), fh) != NULL)
397 fields_num = strsplit (buffer, fields, max_fields);
399 /* status file is generated by openvpn/multi.c:multi_print_status()
400 * http://svn.openvpn.net/projects/openvpn/trunk/openvpn/multi.c
402 * The line we're expecting has 12 fields. We ignore all lines
403 * with more or less fields.
405 if (fields_num != 12)
411 if (strcmp (fields[0], "CLIENT_LIST") != 0)
414 if (collect_user_count)
415 /* If so, sum all users, ignore the individuals*/
420 if (collect_individual_users)
422 if (new_naming_schema)
424 iostats_submit (name, /* vpn instance */
425 fields[1], /* "Common Name" */
426 atoll (fields[4]), /* "Bytes Received" */
427 atoll (fields[5])); /* "Bytes Sent" */
431 iostats_submit (fields[1], /* "Common Name" */
432 NULL, /* unused when in multimode */
433 atoll (fields[4]), /* "Bytes Received" */
434 atoll (fields[5])); /* "Bytes Sent" */
442 if (collect_user_count)
444 numusers_submit(name, name, sum_users);
449 } /* int multi3_read */
452 static int openvpn_read (void)
459 /* call the right read function for every status entry in the list */
460 for (i = 0; i < vpn_num; i++)
462 fh = fopen (vpn_list[i]->file, "r");
466 WARNING ("openvpn plugin: fopen(%s) failed: %s", vpn_list[i]->file,
467 sstrerror (errno, errbuf, sizeof (errbuf)));
472 switch (vpn_list[i]->version)
475 read = single_read(vpn_list[i]->name, fh);
479 read = multi1_read(vpn_list[i]->name, fh);
483 read = multi2_read(vpn_list[i]->name, fh);
487 read = multi3_read(vpn_list[i]->name, fh);
494 return (read ? 0 : -1);
495 } /* int openvpn_read */
497 static int version_detect (const char *filename)
503 /* Sanity checking. We're called from the config handling routine, so
504 * better play it save. */
505 if ((filename == NULL) || (*filename == 0))
508 fh = fopen (filename, "r");
512 WARNING ("openvpn plugin: Unable to read \"%s\": %s", filename,
513 sstrerror (errno, errbuf, sizeof (errbuf)));
517 /* now search for the specific multimode data format */
518 while ((fgets (buffer, sizeof (buffer), fh)) != NULL)
520 /* we look at the first line searching for SINGLE mode configuration */
521 if (strcmp (buffer, VSSTRING) == 0)
523 DEBUG ("openvpn plugin: found status file version SINGLE");
527 /* searching for multi version 1 */
528 else if (strcmp (buffer, V1STRING) == 0)
530 DEBUG ("openvpn plugin: found status file version MULTI1");
534 /* searching for multi version 2 */
535 else if (strcmp (buffer, V2STRING) == 0)
537 DEBUG ("openvpn plugin: found status file version MULTI2");
541 /* searching for multi version 3 */
542 else if (strcmp (buffer, V3STRING) == 0)
544 DEBUG ("openvpn plugin: found status file version MULTI3");
552 /* This is only reached during configuration, so complaining to
553 * the user is in order. */
554 NOTICE ("openvpn plugin: %s: Unknown file format, please "
555 "report this as bug. Make sure to include "
556 "your status file, so the plugin can "
557 "be adapted.", filename);
563 } /* int version_detect */
565 static int openvpn_config (const char *key, const char *value)
567 if (strcasecmp ("StatusFile", key) == 0)
569 char *status_file, *status_name, *filename;
570 int status_version, i;
573 /* try to detect the status file format */
574 status_version = version_detect (value);
576 if (status_version == 0)
578 WARNING ("openvpn plugin: unable to detect status version, \
579 discarding status file \"%s\".", value);
583 status_file = sstrdup (value);
584 if (status_file == NULL)
587 WARNING ("openvpn plugin: sstrdup failed: %s",
588 sstrerror (errno, errbuf, sizeof (errbuf)));
592 /* it determines the file name as string starting at location filename + 1 */
593 filename = strrchr (status_file, (int) '/');
594 if (filename == NULL)
596 /* status_file is already the file name only */
597 status_name = status_file;
601 /* doesn't waste memory, uses status_file starting at filename + 1 */
602 status_name = filename + 1;
605 /* scan the list looking for a clone */
606 for (i = 0; i < vpn_num; i++)
608 if (strcasecmp (vpn_list[i]->name, status_name) == 0)
610 WARNING ("openvpn plugin: status filename \"%s\" "
611 "already used, please choose a "
612 "different one.", status_name);
618 /* create a new vpn element since file, version and name are ok */
619 temp = (vpn_status_t *) malloc (sizeof (vpn_status_t));
623 ERROR ("openvpn plugin: malloc failed: %s",
624 sstrerror (errno, errbuf, sizeof (errbuf)));
628 temp->file = status_file;
629 temp->version = status_version;
630 temp->name = status_name;
632 vpn_list = (vpn_status_t **) realloc (vpn_list, (vpn_num + 1) * sizeof (vpn_status_t *));
633 if (vpn_list == NULL)
636 ERROR ("openvpn plugin: realloc failed: %s",
637 sstrerror (errno, errbuf, sizeof (errbuf)));
644 vpn_list[vpn_num] = temp;
647 DEBUG ("openvpn plugin: status file \"%s\" added", temp->file);
649 } /* if (strcasecmp ("StatusFile", key) == 0) */
650 else if ((strcasecmp ("CollectCompression", key) == 0)
651 || (strcasecmp ("Compression", key) == 0)) /* old, deprecated name */
653 if (IS_FALSE (value))
654 collect_compression = 0;
656 collect_compression = 1;
657 } /* if (strcasecmp ("CollectCompression", key) == 0) */
658 else if (strcasecmp ("ImprovedNamingSchema", key) == 0)
662 DEBUG ("openvpn plugin: using the new naming schema");
663 new_naming_schema = 1;
667 new_naming_schema = 0;
669 } /* if (strcasecmp ("ImprovedNamingSchema", key) == 0) */
670 else if (strcasecmp("CollectUserCount", key) == 0)
673 collect_user_count = 1;
675 collect_user_count = 0;
676 } /* if (strcasecmp("CollectUserCount", key) == 0) */
677 else if (strcasecmp("CollectIndividualUsers", key) == 0)
679 if (IS_FALSE (value))
680 collect_individual_users = 0;
682 collect_individual_users = 1;
683 } /* if (strcasecmp("CollectIndividualUsers", key) == 0) */
690 } /* int openvpn_config */
692 /* shutdown callback */
693 static int openvpn_shutdown (void)
697 for (i = 0; i < vpn_num; i++)
699 sfree (vpn_list[i]->file);
706 } /* int openvpn_shutdown */
708 static int openvpn_init (void)
710 if (!collect_individual_users
711 && !collect_compression
712 && !collect_user_count)
714 WARNING ("OpenVPN plugin: Neither `CollectIndividualUsers', "
715 "`CollectCompression', nor `CollectUserCount' is true. There's no "
716 "data left to collect.");
720 plugin_register_read ("openvpn", openvpn_read);
721 plugin_register_shutdown ("openvpn", openvpn_shutdown);
724 } /* int openvpn_init */
726 void module_register (void)
728 plugin_register_config ("openvpn", openvpn_config,
729 config_keys, config_keys_num);
730 plugin_register_init ("openvpn", openvpn_init);
731 } /* void module_register */
733 /* vim: set sw=2 ts=2 : */