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;
56 static const char *config_keys[] =
60 "ImprovedNamingSchema"
62 static int config_keys_num = STATIC_ARRAY_SIZE (config_keys);
66 * copy-n-pasted from common.c - changed delim to "," */
67 static int openvpn_strsplit (char *string, char **fields, size_t size)
76 while ((fields[i] = strtok_r (ptr, ",", &saveptr)) != NULL)
86 } /* int openvpn_strsplit */
89 /* dispatches stats about traffic (TCP or UDP) generated by the tunnel per single endpoint */
90 static void iostats_submit (char *name, char *type, counter_t rx, counter_t tx)
93 value_list_t vl = VALUE_LIST_INIT;
95 values[0].counter = rx;
96 values[1].counter = tx;
98 /* NOTE ON THE NEW NAMING SCHEMA:
99 * using plugin_instance to identify each vpn config (and
100 * status) file; using type_instance to identify the endpoint
101 * host when in multimode, traffic or overhead when in single.
105 vl.values_len = STATIC_ARRAY_SIZE (values);
106 sstrncpy (vl.host, hostname_g, sizeof (vl.host));
107 sstrncpy (vl.plugin, "openvpn", sizeof (vl.plugin));
108 sstrncpy (vl.plugin_instance, name, sizeof (vl.plugin_instance));
110 if (type) /* new naming schema - improved naming schema option */
112 sstrncpy (vl.type, "io_octets", sizeof (vl.type));
113 sstrncpy (vl.type_instance, type, sizeof (vl.type_instance));
115 else /* old naming schema (multicontext only): plugin_instance = hostname rather than filename */
117 sstrncpy (vl.type, "if_octets", sizeof (vl.type));
120 plugin_dispatch_values (&vl);
121 } /* void traffic_submit */
123 /* dispatches stats about data compression shown when in single mode */
124 static void compression_submit (char *name, char *type, counter_t uncompressed, counter_t compressed)
127 value_list_t vl = VALUE_LIST_INIT;
129 values[0].counter = uncompressed;
130 values[1].counter = compressed;
133 vl.values_len = STATIC_ARRAY_SIZE (values);
134 sstrncpy (vl.host, hostname_g, sizeof (vl.host));
135 sstrncpy (vl.plugin, "openvpn", sizeof (vl.plugin));
136 sstrncpy (vl.plugin_instance, name, sizeof (vl.plugin_instance));
137 sstrncpy (vl.type, "compression", sizeof (vl.type));
138 sstrncpy (vl.type_instance, type, sizeof (vl.type_instance));
140 plugin_dispatch_values (&vl);
141 } /* void compression_submit */
143 static int single_read (char *name, FILE *fh)
147 const int max_fields = STATIC_ARRAY_SIZE (fields);
148 int fields_num, read = 0;
150 counter_t link_rx, link_tx;
151 counter_t tun_rx, tun_tx;
152 counter_t pre_compress, post_compress;
153 counter_t pre_decompress, post_decompress;
154 counter_t overhead_rx, overhead_tx;
167 while (fgets (buffer, sizeof (buffer), fh) != NULL)
169 fields_num = openvpn_strsplit (buffer, fields, max_fields);
171 /* status file is generated by openvpn/sig.c:print_status()
172 * http://svn.openvpn.net/projects/openvpn/trunk/openvpn/sig.c
174 * The line we're expecting has 2 fields. We ignore all lines
175 * with more or less fields.
182 if (strcmp (fields[0], "TUN/TAP read bytes") == 0)
184 /* read from the system and sent over the tunnel */
185 tun_tx = atoll (fields[1]);
187 else if (strcmp (fields[0], "TUN/TAP write bytes") == 0)
189 /* read from the tunnel and written in the system */
190 tun_rx = atoll (fields[1]);
192 else if (strcmp (fields[0], "TCP/UDP read bytes") == 0)
194 link_rx = atoll (fields[1]);
196 else if (strcmp (fields[0], "TCP/UDP write bytes") == 0)
198 link_tx = atoll (fields[1]);
200 else if (strcmp (fields[0], "pre-compress bytes") == 0)
202 pre_compress = atoll (fields[1]);
204 else if (strcmp (fields[0], "post-compress bytes") == 0)
206 post_compress = atoll (fields[1]);
208 else if (strcmp (fields[0], "pre-decompress bytes") == 0)
210 pre_decompress = atoll (fields[1]);
212 else if (strcmp (fields[0], "post-decompress bytes") == 0)
214 post_decompress = atoll (fields[1]);
218 iostats_submit (name, "traffic", link_rx, link_tx);
220 /* we need to force this order to avoid negative values with these unsigned */
221 overhead_rx = (((link_rx - pre_decompress) + post_decompress) - tun_rx);
222 overhead_tx = (((link_tx - post_compress) + pre_compress) - tun_tx);
224 iostats_submit (name, "overhead", overhead_rx, overhead_tx);
226 if (store_compression)
228 compression_submit (name, "data_in", post_decompress, pre_decompress);
229 compression_submit (name, "data_out", pre_compress, post_compress);
235 } /* int single_read */
237 /* for reading status version 1 */
238 static int multi1_read (char *name, FILE *fh)
242 int fields_num, read = 0, found_header = 0;
244 /* read the file until the "ROUTING TABLE" line is found (no more info after) */
245 while (fgets (buffer, sizeof (buffer), fh) != NULL)
247 if (strcmp (buffer, "ROUTING TABLE\n") == 0)
250 if (strcmp (buffer, V1STRING) == 0)
256 /* skip the first lines until the client list section is found */
257 if (found_header == 0)
258 /* we can't start reading data until this string is found */
261 fields_num = openvpn_strsplit (buffer,
262 fields, STATIC_ARRAY_SIZE (fields));
266 if (new_naming_schema)
268 iostats_submit (fields[0], /* "Common Name" */
269 NULL, /* unused when in multimode */
270 atoll (fields[2]), /* "Bytes Received" */
271 atoll (fields[3])); /* "Bytes Sent" */
275 iostats_submit (name, /* vpn instance */
276 fields[0], /* "Common Name" */
277 atoll (fields[2]), /* "Bytes Received" */
278 atoll (fields[3])); /* "Bytes Sent" */
285 } /* int multi1_read */
287 /* for reading status version 2 */
288 static int multi2_read (char *name, FILE *fh)
292 const int max_fields = STATIC_ARRAY_SIZE (fields);
293 int fields_num, read = 0;
295 while (fgets (buffer, sizeof (buffer), fh) != NULL)
297 fields_num = openvpn_strsplit (buffer, fields, max_fields);
299 /* status file is generated by openvpn/multi.c:multi_print_status()
300 * http://svn.openvpn.net/projects/openvpn/trunk/openvpn/multi.c
302 * The line we're expecting has 8 fields. We ignore all lines
303 * with more or less fields.
311 if (strcmp (fields[0], "CLIENT_LIST") == 0)
313 if (new_naming_schema)
315 iostats_submit (name, /* vpn instance */
316 fields[1], /* "Common Name" */
317 atoll (fields[4]), /* "Bytes Received" */
318 atoll (fields[5])); /* "Bytes Sent" */
322 iostats_submit (fields[1], /* "Common Name" */
323 NULL, /* unused when in multimode */
324 atoll (fields[4]), /* "Bytes Received" */
325 atoll (fields[5])); /* "Bytes Sent" */
334 } /* int multi2_read */
336 /* for reading status version 3 */
337 static int multi3_read (char *name, FILE *fh)
341 const int max_fields = STATIC_ARRAY_SIZE (fields);
342 int fields_num, read = 0;
344 while (fgets (buffer, sizeof (buffer), fh) != NULL)
346 fields_num = strsplit (buffer, fields, max_fields);
348 /* status file is generated by openvpn/multi.c:multi_print_status()
349 * http://svn.openvpn.net/projects/openvpn/trunk/openvpn/multi.c
351 * The line we're expecting has 12 fields. We ignore all lines
352 * with more or less fields.
354 if (fields_num != 12)
360 if (strcmp (fields[0], "CLIENT_LIST") == 0)
362 if (new_naming_schema)
364 iostats_submit (name, /* vpn instance */
365 fields[1], /* "Common Name" */
366 atoll (fields[4]), /* "Bytes Received" */
367 atoll (fields[5])); /* "Bytes Sent" */
371 iostats_submit (fields[1], /* "Common Name" */
372 NULL, /* unused when in multimode */
373 atoll (fields[4]), /* "Bytes Received" */
374 atoll (fields[5])); /* "Bytes Sent" */
383 } /* int multi3_read */
386 static int openvpn_read (void)
393 /* call the right read function for every status entry in the list */
394 for (i = 0; i < vpn_num; i++)
396 fh = fopen (vpn_list[i]->file, "r");
400 WARNING ("openvpn plugin: fopen(%s) failed: %s", vpn_list[i]->file,
401 sstrerror (errno, errbuf, sizeof (errbuf)));
406 switch (vpn_list[i]->version)
409 read = single_read(vpn_list[i]->name, fh);
413 read = multi1_read(vpn_list[i]->name, fh);
417 read = multi2_read(vpn_list[i]->name, fh);
421 read = multi3_read(vpn_list[i]->name, fh);
428 return (read ? 0 : -1);
429 } /* int openvpn_read */
431 static int version_detect (const char *filename)
437 /* Sanity checking. We're called from the config handling routine, so
438 * better play it save. */
439 if ((filename == NULL) || (*filename == 0))
442 fh = fopen (filename, "r");
446 WARNING ("openvpn plugin: Unable to read \"%s\": %s", filename,
447 sstrerror (errno, errbuf, sizeof (errbuf)));
451 /* now search for the specific multimode data format */
452 while ((fgets (buffer, sizeof (buffer), fh)) != NULL)
454 /* we look at the first line searching for SINGLE mode configuration */
455 if (strcmp (buffer, VSSTRING) == 0)
457 DEBUG ("openvpn plugin: found status file version SINGLE");
461 /* searching for multi version 1 */
462 else if (strcmp (buffer, V1STRING) == 0)
464 DEBUG ("openvpn plugin: found status file version MULTI1");
468 /* searching for multi version 2 */
469 else if (strcmp (buffer, V2STRING) == 0)
471 DEBUG ("openvpn plugin: found status file version MULTI2");
475 /* searching for multi version 3 */
476 else if (strcmp (buffer, V3STRING) == 0)
478 DEBUG ("openvpn plugin: found status file version MULTI3");
486 /* This is only reached during configuration, so complaining to
487 * the user is in order. */
488 NOTICE ("openvpn plugin: %s: Unknown file format, please "
489 "report this as bug. Make sure to include "
490 "your status file, so the plugin can "
491 "be adapted.", filename);
497 } /* int version_detect */
499 static int openvpn_config (const char *key, const char *value)
501 if (strcasecmp ("StatusFile", key) == 0)
503 char *status_file, *status_name, *filename;
504 int status_version, i;
507 /* try to detect the status file format */
508 status_version = version_detect (value);
510 if (status_version == 0)
512 WARNING ("openvpn plugin: unable to detect status version, \
513 discarding status file \"%s\".", value);
517 status_file = sstrdup (value);
518 if (status_file == NULL)
521 WARNING ("openvpn plugin: sstrdup failed: %s",
522 sstrerror (errno, errbuf, sizeof (errbuf)));
526 /* it determines the file name as string starting at location filename + 1 */
527 filename = strrchr (status_file, (int) '/');
528 if (filename == NULL)
530 /* status_file is already the file name only */
531 status_name = status_file;
535 /* doesn't waste memory, uses status_file starting at filename + 1 */
536 status_name = filename + 1;
539 /* scan the list looking for a clone */
540 for (i = 0; i < vpn_num; i++)
542 if (strcasecmp (vpn_list[i]->name, status_name) == 0)
544 WARNING ("openvpn plugin: status filename \"%s\" "
545 "already used, please choose a "
546 "different one.", status_name);
552 /* create a new vpn element since file, version and name are ok */
553 temp = (vpn_status_t *) malloc (sizeof (vpn_status_t));
554 temp->file = status_file;
555 temp->version = status_version;
556 temp->name = status_name;
558 vpn_list = (vpn_status_t **) realloc (vpn_list, (vpn_num + 1) * sizeof (vpn_status_t *));
559 if (vpn_list == NULL)
562 ERROR ("openvpn plugin: malloc failed: %s",
563 sstrerror (errno, errbuf, sizeof (errbuf)));
570 vpn_list[vpn_num] = temp;
573 DEBUG ("openvpn plugin: status file \"%s\" added", temp->file);
576 else if (strcasecmp ("Compression", key) == 0)
579 store_compression = 1;
582 store_compression = 0;
583 DEBUG ("openvpn plugin: no 'compression statistcs' collected");
586 else if (strcasecmp ("ImprovedNamingSchema", key) == 0)
590 DEBUG ("openvpn plugin: using the new naming schema");
591 new_naming_schema = 1;
595 new_naming_schema = 0;
604 } /* int openvpn_config */
606 /* shutdown callback */
607 static int openvpn_shutdown (void)
611 for (i = 0; i < vpn_num; i++)
613 sfree (vpn_list[i]->file);
620 } /* int openvpn_shutdown */
622 void module_register (void)
624 plugin_register_config ("openvpn", openvpn_config,
625 config_keys, config_keys_num);
626 plugin_register_read ("openvpn", openvpn_read);
627 plugin_register_shutdown ("openvpn", openvpn_shutdown);
628 } /* void module_register */