2 * collectd - src/openvpn.c
3 * Copyright (C) 2008 Doug MacEachern
4 * Copyright (C) 2009 Florian octo Forster
5 * Copyright (C) 2009 Marco Chiappero
7 * This program is free software; you can redistribute it and/or modify it
8 * under the terms of the GNU General Public License as published by the
9 * Free Software Foundation; only version 2 of the License is applicable.
11 * This program is distributed in the hope that it will be useful, but
12 * WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * General Public License for more details.
16 * You should have received a copy of the GNU General Public License along
17 * with this program; if not, write to the Free Software Foundation, Inc.,
18 * 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
21 * Doug MacEachern <dougm at hyperic.com>
22 * Florian octo Forster <octo at verplant.org>
23 * Marco Chiappero <marco at absence.it>
30 #define V1STRING "Common Name,Real Address,Bytes Received,Bytes Sent,Connected Since\n"
31 #define V2STRING "HEADER,CLIENT_LIST,Common Name,Real Address,Virtual Address,Bytes Received,Bytes Sent,Connected Since,Connected Since (time_t)\n"
32 #define V3STRING "HEADER CLIENT_LIST Common Name Real Address Virtual Address Bytes Received Bytes Sent Connected Since Connected Since (time_t)\n"
33 #define VSSTRING "OpenVPN STATISTICS\n"
41 MULTI1 = 1, /* status-version 1 */
42 MULTI2, /* status-version 2 */
43 MULTI3, /* status-version 3 */
44 SINGLE = 10 /* currently no versions for single mode, maybe in the future */
48 typedef struct vpn_status_s vpn_status_t;
50 static vpn_status_t **vpn_list = NULL;
51 static int vpn_num = 0;
53 static int store_compression = 1;
54 static int new_naming_schema = 0;
55 static int sumover_allusers = 0;
56 static long long sum_rx = 0;
57 static long long sum_tx = 0;
59 static const char *config_keys[] =
63 "ImprovedNamingSchema",
66 static int config_keys_num = STATIC_ARRAY_SIZE (config_keys);
70 * copy-n-pasted from common.c - changed delim to "," */
71 static int openvpn_strsplit (char *string, char **fields, size_t size)
80 while ((fields[i] = strtok_r (ptr, ",", &saveptr)) != NULL)
90 } /* int openvpn_strsplit */
92 /* dispatches stats about traffic (TCP or UDP) generated by the tunnel per single endpoint */
93 static void iostats_submit (char *pinst, char *tinst, counter_t rx, counter_t tx)
96 value_list_t vl = VALUE_LIST_INIT;
98 values[0].counter = rx;
99 values[1].counter = tx;
101 /* NOTE ON THE NEW NAMING SCHEMA:
102 * using plugin_instance to identify each vpn config (and
103 * status) file; using type_instance to identify the endpoint
104 * host when in multimode, traffic or overhead when in single.
108 vl.values_len = STATIC_ARRAY_SIZE (values);
109 sstrncpy (vl.host, hostname_g, sizeof (vl.host));
110 sstrncpy (vl.plugin, "openvpn", sizeof (vl.plugin));
112 sstrncpy (vl.plugin_instance, pinst,
113 sizeof (vl.plugin_instance));
114 sstrncpy (vl.type, "if_octets", sizeof (vl.type));
116 sstrncpy (vl.type_instance, tinst, sizeof (vl.type_instance));
118 plugin_dispatch_values (&vl);
119 } /* void traffic_submit */
121 /* dispatches stats about data compression shown when in single mode */
122 static void compression_submit (char *pinst, char *tinst,
123 counter_t uncompressed, counter_t compressed)
126 value_list_t vl = VALUE_LIST_INIT;
128 values[0].counter = uncompressed;
129 values[1].counter = compressed;
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, "compression", sizeof (vl.type));
140 sstrncpy (vl.type_instance, tinst, sizeof (vl.type_instance));
142 plugin_dispatch_values (&vl);
143 } /* void compression_submit */
145 static int single_read (char *name, FILE *fh)
149 const int max_fields = STATIC_ARRAY_SIZE (fields);
150 int fields_num, read = 0;
152 counter_t link_rx, link_tx;
153 counter_t tun_rx, tun_tx;
154 counter_t pre_compress, post_compress;
155 counter_t pre_decompress, post_decompress;
156 counter_t overhead_rx, overhead_tx;
169 while (fgets (buffer, sizeof (buffer), fh) != NULL)
171 fields_num = openvpn_strsplit (buffer, fields, max_fields);
173 /* status file is generated by openvpn/sig.c:print_status()
174 * http://svn.openvpn.net/projects/openvpn/trunk/openvpn/sig.c
176 * The line we're expecting has 2 fields. We ignore all lines
177 * with more or less fields.
184 if (strcmp (fields[0], "TUN/TAP read bytes") == 0)
186 /* read from the system and sent over the tunnel */
187 tun_tx = atoll (fields[1]);
189 else if (strcmp (fields[0], "TUN/TAP write bytes") == 0)
191 /* read from the tunnel and written in the system */
192 tun_rx = atoll (fields[1]);
194 else if (strcmp (fields[0], "TCP/UDP read bytes") == 0)
196 link_rx = atoll (fields[1]);
198 else if (strcmp (fields[0], "TCP/UDP write bytes") == 0)
200 link_tx = atoll (fields[1]);
202 else if (strcmp (fields[0], "pre-compress bytes") == 0)
204 pre_compress = atoll (fields[1]);
206 else if (strcmp (fields[0], "post-compress bytes") == 0)
208 post_compress = atoll (fields[1]);
210 else if (strcmp (fields[0], "pre-decompress bytes") == 0)
212 pre_decompress = atoll (fields[1]);
214 else if (strcmp (fields[0], "post-decompress bytes") == 0)
216 post_decompress = atoll (fields[1]);
220 iostats_submit (name, "traffic", link_rx, link_tx);
222 /* we need to force this order to avoid negative values with these unsigned */
223 overhead_rx = (((link_rx - pre_decompress) + post_decompress) - tun_rx);
224 overhead_tx = (((link_tx - post_compress) + pre_compress) - tun_tx);
226 iostats_submit (name, "overhead", overhead_rx, overhead_tx);
228 if (store_compression)
230 compression_submit (name, "data_in", post_decompress, pre_decompress);
231 compression_submit (name, "data_out", pre_compress, post_compress);
237 } /* int single_read */
239 /* for reading status version 1 */
240 static int multi1_read (char *name, FILE *fh)
244 int fields_num, read = 0, found_header = 0;
246 /* read the file until the "ROUTING TABLE" line is found (no more info after) */
247 while (fgets (buffer, sizeof (buffer), fh) != NULL)
249 if (strcmp (buffer, "ROUTING TABLE\n") == 0)
252 if (strcmp (buffer, V1STRING) == 0)
258 /* skip the first lines until the client list section is found */
259 if (found_header == 0)
260 /* we can't start reading data until this string is found */
263 fields_num = openvpn_strsplit (buffer,
264 fields, STATIC_ARRAY_SIZE (fields));
268 if (sumover_allusers)
269 /* If so, sum over all users, ignore the individuals*/
271 sum_rx += atoll(fields[2]);
272 sum_tx += atoll(fields[3]);
276 if (new_naming_schema)
278 iostats_submit (fields[0], /* "Common Name" */
279 NULL, /* unused when in multimode */
280 atoll (fields[2]), /* "Bytes Received" */
281 atoll (fields[3])); /* "Bytes Sent" */
285 iostats_submit (name, /* vpn instance */
286 fields[0], /* "Common Name" */
287 atoll (fields[2]), /* "Bytes Received" */
288 atoll (fields[3])); /* "Bytes Sent" */
295 if (sumover_allusers)
297 iostats_submit (name, /* vpn instance */
298 "OverAllTraffic", /* "Common Name" */
299 sum_rx, /* "Bytes Received" */
300 sum_rx); /* "Bytes Sent" */
304 } /* int multi1_read */
306 /* for reading status version 2 */
307 static int multi2_read (char *name, FILE *fh)
311 const int max_fields = STATIC_ARRAY_SIZE (fields);
312 int fields_num, read = 0;
314 while (fgets (buffer, sizeof (buffer), fh) != NULL)
316 fields_num = openvpn_strsplit (buffer, fields, max_fields);
318 /* status file is generated by openvpn/multi.c:multi_print_status()
319 * http://svn.openvpn.net/projects/openvpn/trunk/openvpn/multi.c
321 * The line we're expecting has 8 fields. We ignore all lines
322 * with more or less fields.
327 if (strcmp (fields[0], "CLIENT_LIST") != 0)
330 if (sumover_allusers)
331 /* If so, sum over all users, ignore the individuals*/
333 sum_rx += atoll(fields[2]);
334 sum_tx += atoll(fields[3]);
338 if (new_naming_schema)
340 /* plugin inst = file name, type inst = fields[1] */
341 iostats_submit (name, /* vpn instance */
342 fields[1], /* "Common Name" */
343 atoll (fields[4]), /* "Bytes Received" */
344 atoll (fields[5])); /* "Bytes Sent" */
348 /* plugin inst = fields[1], type inst = "" */
349 iostats_submit (fields[1], /* "Common Name" */
350 NULL, /* unused when in multimode */
351 atoll (fields[4]), /* "Bytes Received" */
352 atoll (fields[5])); /* "Bytes Sent" */
358 if (sumover_allusers)
360 iostats_submit (name, /* vpn instance */
361 "OverAllTraffic", /* "Common Name" */
362 sum_rx, /* "Bytes Received" */
363 sum_rx); /* "Bytes Sent" */
367 } /* int multi2_read */
369 /* for reading status version 3 */
370 static int multi3_read (char *name, FILE *fh)
374 const int max_fields = STATIC_ARRAY_SIZE (fields);
375 int fields_num, read = 0;
377 while (fgets (buffer, sizeof (buffer), fh) != NULL)
379 fields_num = strsplit (buffer, fields, max_fields);
381 /* status file is generated by openvpn/multi.c:multi_print_status()
382 * http://svn.openvpn.net/projects/openvpn/trunk/openvpn/multi.c
384 * The line we're expecting has 12 fields. We ignore all lines
385 * with more or less fields.
387 if (fields_num != 12)
393 if (strcmp (fields[0], "CLIENT_LIST") != 0)
396 if (sumover_allusers)
397 /* If so, sum over all users, ignore the individuals*/
399 sum_rx += atoll(fields[2]);
400 sum_tx += atoll(fields[3]);
404 if (new_naming_schema)
406 iostats_submit (name, /* vpn instance */
407 fields[1], /* "Common Name" */
408 atoll (fields[4]), /* "Bytes Received" */
409 atoll (fields[5])); /* "Bytes Sent" */
413 iostats_submit (fields[1], /* "Common Name" */
414 NULL, /* unused when in multimode */
415 atoll (fields[4]), /* "Bytes Received" */
416 atoll (fields[5])); /* "Bytes Sent" */
424 if (sumover_allusers)
426 iostats_submit (name, /* vpn instance */
427 "OverAllTraffic", /* "Common Name" */
428 sum_rx, /* "Bytes Received" */
429 sum_rx); /* "Bytes Sent" */
433 } /* int multi3_read */
436 static int openvpn_read (void)
443 /* call the right read function for every status entry in the list */
444 for (i = 0; i < vpn_num; i++)
446 fh = fopen (vpn_list[i]->file, "r");
450 WARNING ("openvpn plugin: fopen(%s) failed: %s", vpn_list[i]->file,
451 sstrerror (errno, errbuf, sizeof (errbuf)));
456 switch (vpn_list[i]->version)
459 read = single_read(vpn_list[i]->name, fh);
463 read = multi1_read(vpn_list[i]->name, fh);
467 read = multi2_read(vpn_list[i]->name, fh);
471 read = multi3_read(vpn_list[i]->name, fh);
478 return (read ? 0 : -1);
479 } /* int openvpn_read */
481 static int version_detect (const char *filename)
487 /* Sanity checking. We're called from the config handling routine, so
488 * better play it save. */
489 if ((filename == NULL) || (*filename == 0))
492 fh = fopen (filename, "r");
496 WARNING ("openvpn plugin: Unable to read \"%s\": %s", filename,
497 sstrerror (errno, errbuf, sizeof (errbuf)));
501 /* now search for the specific multimode data format */
502 while ((fgets (buffer, sizeof (buffer), fh)) != NULL)
504 /* we look at the first line searching for SINGLE mode configuration */
505 if (strcmp (buffer, VSSTRING) == 0)
507 DEBUG ("openvpn plugin: found status file version SINGLE");
511 /* searching for multi version 1 */
512 else if (strcmp (buffer, V1STRING) == 0)
514 DEBUG ("openvpn plugin: found status file version MULTI1");
518 /* searching for multi version 2 */
519 else if (strcmp (buffer, V2STRING) == 0)
521 DEBUG ("openvpn plugin: found status file version MULTI2");
525 /* searching for multi version 3 */
526 else if (strcmp (buffer, V3STRING) == 0)
528 DEBUG ("openvpn plugin: found status file version MULTI3");
536 /* This is only reached during configuration, so complaining to
537 * the user is in order. */
538 NOTICE ("openvpn plugin: %s: Unknown file format, please "
539 "report this as bug. Make sure to include "
540 "your status file, so the plugin can "
541 "be adapted.", filename);
547 } /* int version_detect */
549 static int openvpn_config (const char *key, const char *value)
551 if (strcasecmp ("StatusFile", key) == 0)
553 char *status_file, *status_name, *filename;
554 int status_version, i;
557 /* try to detect the status file format */
558 status_version = version_detect (value);
560 if (status_version == 0)
562 WARNING ("openvpn plugin: unable to detect status version, \
563 discarding status file \"%s\".", value);
567 status_file = sstrdup (value);
568 if (status_file == NULL)
571 WARNING ("openvpn plugin: sstrdup failed: %s",
572 sstrerror (errno, errbuf, sizeof (errbuf)));
576 /* it determines the file name as string starting at location filename + 1 */
577 filename = strrchr (status_file, (int) '/');
578 if (filename == NULL)
580 /* status_file is already the file name only */
581 status_name = status_file;
585 /* doesn't waste memory, uses status_file starting at filename + 1 */
586 status_name = filename + 1;
589 /* scan the list looking for a clone */
590 for (i = 0; i < vpn_num; i++)
592 if (strcasecmp (vpn_list[i]->name, status_name) == 0)
594 WARNING ("openvpn plugin: status filename \"%s\" "
595 "already used, please choose a "
596 "different one.", status_name);
602 /* create a new vpn element since file, version and name are ok */
603 temp = (vpn_status_t *) malloc (sizeof (vpn_status_t));
604 temp->file = status_file;
605 temp->version = status_version;
606 temp->name = status_name;
608 vpn_list = (vpn_status_t **) realloc (vpn_list, (vpn_num + 1) * sizeof (vpn_status_t *));
609 if (vpn_list == NULL)
612 ERROR ("openvpn plugin: malloc failed: %s",
613 sstrerror (errno, errbuf, sizeof (errbuf)));
620 vpn_list[vpn_num] = temp;
623 DEBUG ("openvpn plugin: status file \"%s\" added", temp->file);
625 } /* if (strcasecmp ("StatusFile", key) == 0) */
626 else if (strcasecmp ("Compression", key) == 0)
629 store_compression = 1;
632 store_compression = 0;
633 DEBUG ("openvpn plugin: no 'compression statistcs' collected");
635 } /* if (strcasecmp ("Compression", key) == 0) */
636 else if (strcasecmp ("ImprovedNamingSchema", key) == 0)
640 DEBUG ("openvpn plugin: using the new naming schema");
641 new_naming_schema = 1;
645 new_naming_schema = 0;
647 } /* if (strcasecmp ("ImprovedNamingSchema", key) == 0) */
648 else if (strcasecmp("SumOverAllUsers", key) == 0)
652 DEBUG ("openvpn plugin: Summing up over all users");
653 sumover_allusers = 1;
657 sumover_allusers = 1;
659 } /* if (strcasecmp("SumOverAllUsers", key) == 0) */
666 } /* int openvpn_config */
668 /* shutdown callback */
669 static int openvpn_shutdown (void)
673 for (i = 0; i < vpn_num; i++)
675 sfree (vpn_list[i]->file);
682 } /* int openvpn_shutdown */
684 void module_register (void)
686 plugin_register_config ("openvpn", openvpn_config,
687 config_keys, config_keys_num);
688 plugin_register_read ("openvpn", openvpn_read);
689 plugin_register_shutdown ("openvpn", openvpn_shutdown);
690 } /* void module_register */
692 /* vim: set sw=2 ts=2 : */