X-Git-Url: https://git.octo.it/?a=blobdiff_plain;f=src%2Fopenvpn.c;h=9ce23b4f4cb9c9e2550e86d337a866a451931404;hb=aff80830f1154a5b6c4da16a0b1033aafde14e24;hp=bf8511c312b920082077351b60684c8df40e7913;hpb=596abb464fcbf1eced599019cd107d28917bdd3f;p=collectd.git diff --git a/src/openvpn.c b/src/openvpn.c index bf8511c3..9ce23b4f 100644 --- a/src/openvpn.c +++ b/src/openvpn.c @@ -1,8 +1,9 @@ /** * collectd - src/openvpn.c - * Copyright (C) 2008 Doug MacEachern - * Copyright (C) 2009 Florian octo Forster - * Copyright (C) 2009 Marco Chiappero + * Copyright (C) 2008 Doug MacEachern + * Copyright (C) 2009,2010 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 @@ -19,8 +20,9 @@ * * Authors: * Doug MacEachern - * Florian octo Forster + * Florian octo Forster * Marco Chiappero + * Fabian Schuh **/ #include "collectd.h" @@ -30,37 +32,45 @@ #define V1STRING "Common Name,Real Address,Bytes Received,Bytes Sent,Connected Since\n" #define V2STRING "HEADER,CLIENT_LIST,Common Name,Real Address,Virtual Address,Bytes Received,Bytes Sent,Connected Since,Connected Since (time_t)\n" #define V3STRING "HEADER CLIENT_LIST Common Name Real Address Virtual Address Bytes Received Bytes Sent Connected Since Connected Since (time_t)\n" +#define VSSTRING "OpenVPN STATISTICS\n" 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; static vpn_status_t **vpn_list = NULL; static int vpn_num = 0; -static int store_compression = 1; +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", - "NoCompression" + "Compression", /* old, deprecated name */ + "ImprovedNamingSchema", + "CollectCompression", + "CollectUserCount", + "CollectIndividualUsers" }; 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; @@ -82,48 +92,76 @@ static int openvpn_strsplit (char *string, char **fields, size_t size) 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 *name, char *type, counter_t rx, counter_t tx) +static void iostats_submit (char *pinst, char *tinst, derive_t rx, derive_t tx) { value_t values[2]; value_list_t vl = VALUE_LIST_INIT; - values[0].counter = rx; - values[1].counter = tx; + values[0].derive = rx; + values[1].derive = 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, + derive_t uncompressed, derive_t compressed) { value_t values[2]; value_list_t vl = VALUE_LIST_INIT; - values[0].counter = uncompressed; - values[1].counter = compressed; + values[0].derive = uncompressed; + values[1].derive = compressed; 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)); + 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 */ @@ -135,11 +173,11 @@ static int single_read (char *name, FILE *fh) const int max_fields = STATIC_ARRAY_SIZE (fields); int fields_num, read = 0; - counter_t link_rx, link_tx; - counter_t tun_rx, tun_tx; - counter_t pre_compress, post_compress; - counter_t pre_decompress, post_decompress; - counter_t overhead_rx, overhead_tx; + derive_t link_rx, link_tx; + derive_t tun_rx, tun_tx; + derive_t pre_compress, post_compress; + derive_t pre_decompress, post_decompress; + derive_t overhead_rx, overhead_tx; link_rx = 0; link_tx = 0; @@ -152,7 +190,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); @@ -167,42 +204,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]); } } @@ -214,7 +249,7 @@ static int single_read (char *name, FILE *fh) 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); @@ -230,30 +265,61 @@ 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; + long long sum_users = 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 (collect_user_count) + /* If so, sum all users, ignore the individuals*/ + { + sum_users += 1; } - else + if (collect_individual_users) { - 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; + if (new_naming_schema) + { + iostats_submit (name, /* vpn instance */ + fields[0], /* "Common Name" */ + atoll (fields[2]), /* "Bytes Received" */ + atoll (fields[3])); /* "Bytes Sent" */ + } + else + { + 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); @@ -266,6 +332,7 @@ static int multi2_read (char *name, FILE *fh) 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) { @@ -278,20 +345,43 @@ 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 (collect_user_count) + /* If so, sum all users, ignore the individuals*/ + { + sum_users += 1; } - else + if (collect_individual_users) { - if (strcmp (fields[0], "CLIENT_LIST") == 0) + if (new_naming_schema) { - iostats_submit (name, /* vpn instance */ - fields[1], /* "Common Name" */ - atoll (fields[4]), /* "Bytes Received" */ - atoll (fields[5])); /* "Bytes Sent" */ - read = 1; + /* 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); @@ -304,6 +394,7 @@ static int multi3_read (char *name, FILE *fh) 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) { @@ -321,17 +412,43 @@ 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 (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" */ - read = 1; + sum_users += 1; } + + if (collect_individual_users) + { + 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 */ @@ -351,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; } @@ -381,52 +498,71 @@ static int openvpn_read (void) return (read ? 0 : -1); } /* int openvpn_read */ -static int version_detect (FILE *fh) +static int version_detect (const char *filename) { + FILE *fh; char buffer[1024]; int version = 0; - /* we look at the first line searching for SINGLE mode configuration */ - if ((fscanf (fh, "%*s %s", buffer) == 1) && (strcmp (buffer, "STATISTICS") == 0)) + /* Sanity checking. We're called from the config handling routine, so + * better play it save. */ + if ((filename == NULL) || (*filename == 0)) + return (0); + + fh = fopen (filename, "r"); + if (fh == NULL) { - DEBUG ("openvpn plugin: found status file version SINGLE"); - version = SINGLE; + char errbuf[1024]; + WARNING ("openvpn plugin: Unable to read \"%s\": %s", filename, + sstrerror (errno, errbuf, sizeof (errbuf))); + return (0); } - else /* else multimode */ + + /* now search for the specific multimode data format */ + while ((fgets (buffer, sizeof (buffer), fh)) != NULL) { - /* now search for the specific multimode data format */ - while ((fgets (buffer, sizeof (buffer), fh)) != NULL) + /* we look at the first line searching for SINGLE mode configuration */ + if (strcmp (buffer, VSSTRING) == 0) { - - /* searching for multi version 1 */ - if (strcmp (buffer, V1STRING) == 0) - { - DEBUG ("openvpn plugin: found status file version MULTI1"); - version = MULTI1; - break; - } - /* searching for multi version 2 */ - else if (strcmp (buffer, V2STRING) == 0) - { - DEBUG ("openvpn plugin: found status file version MULTI2"); - version = MULTI2; - break; - } - /* searching for multi version 3 */ - else if (strcmp (buffer, V3STRING) == 0) - { - DEBUG ("openvpn plugin: found status file version MULTI3"); - version = MULTI3; - break; - } + DEBUG ("openvpn plugin: found status file version SINGLE"); + version = SINGLE; + break; + } + /* searching for multi version 1 */ + else if (strcmp (buffer, V1STRING) == 0) + { + DEBUG ("openvpn plugin: found status file version MULTI1"); + version = MULTI1; + break; + } + /* searching for multi version 2 */ + else if (strcmp (buffer, V2STRING) == 0) + { + DEBUG ("openvpn plugin: found status file version MULTI2"); + version = MULTI2; + break; + } + /* searching for multi version 3 */ + else if (strcmp (buffer, V3STRING) == 0) + { + DEBUG ("openvpn plugin: found status file version MULTI3"); + version = MULTI3; + break; } } if (version == 0) { - DEBUG ("openvpn plugin: unknown file format, please report this as bug"); + /* This is only reached during configuration, so complaining to + * the user is in order. */ + NOTICE ("openvpn plugin: %s: Unknown file format, please " + "report this as bug. Make sure to include " + "your status file, so the plugin can " + "be adapted.", filename); } + fclose (fh); + return version; } /* int version_detect */ @@ -434,30 +570,17 @@ static int openvpn_config (const char *key, const char *value) { if (strcasecmp ("StatusFile", key) == 0) { - FILE *fh; char *status_file, *status_name, *filename; int status_version, i; vpn_status_t *temp; - /* check whether the status file provided is readable */ - fh = fopen (value, "r"); - if (fh == NULL) - { - char errbuf[1024]; - WARNING ("openvpn plugin: unable to read \"%s\": %s", - value, sstrerror (errno, errbuf, sizeof (errbuf))); - return (1); - } - - /* once open try to detect the status file format */ - status_version = version_detect (fh); - - fclose (fh); + /* try to detect the status file format */ + status_version = version_detect (value); if (status_version == 0) - { + { WARNING ("openvpn plugin: unable to detect status version, \ - discarding status file \"%s\".", value); + discarding status file \"%s\".", value); return (1); } @@ -466,10 +589,10 @@ static int openvpn_config (const char *key, const char *value) { char errbuf[1024]; WARNING ("openvpn plugin: sstrdup failed: %s", - sstrerror (errno, errbuf, sizeof (errbuf))); + sstrerror (errno, errbuf, sizeof (errbuf))); return (1); } - + /* it determines the file name as string starting at location filename + 1 */ filename = strrchr (status_file, (int) '/'); if (filename == NULL) @@ -479,25 +602,24 @@ 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; } - /* if not empty, it scans the list looking for a clone */ - if (vpn_num) + /* scan the list looking for a clone */ + for (i = 0; i < vpn_num; i++) { - for (i = 0; i < vpn_num; i++) + if (strcasecmp (vpn_list[i]->name, status_name) == 0) { - if (strcasecmp (vpn_list[i]->name, status_name) == 0) - { - WARNING ("status filename \"%s\" already used, \ - please choose a different one.", status_name); - return (1); - } + WARNING ("openvpn plugin: status filename \"%s\" " + "already used, please choose a " + "different one.", status_name); + sfree (status_file); + return (1); } } - /* create a new vpn element since file and version are ok */ + /* create a new vpn element since file, version and name are ok */ temp = (vpn_status_t *) malloc (sizeof (vpn_status_t)); temp->file = status_file; temp->version = status_version; @@ -506,10 +628,13 @@ static int openvpn_config (const char *key, const char *value) vpn_list = (vpn_status_t **) realloc (vpn_list, (vpn_num + 1) * sizeof (vpn_status_t *)); if (vpn_list == NULL) { - char errbuf[1024]; - ERROR ("openvpn plugin: malloc failed: %s", - sstrerror (errno, errbuf, sizeof (errbuf))); - return (1); + char errbuf[1024]; + ERROR ("openvpn plugin: malloc failed: %s", + sstrerror (errno, errbuf, sizeof (errbuf))); + + sfree (temp->file); + sfree (temp); + return (1); } vpn_list[vpn_num] = temp; @@ -517,21 +642,41 @@ static int openvpn_config (const char *key, const char *value) DEBUG ("openvpn plugin: status file \"%s\" added", temp->file); - } - else if (strcasecmp ("NoCompression", key) == 0) + } /* if (strcasecmp ("StatusFile", key) == 0) */ + else if ((strcasecmp ("CollectCompression", key) == 0) + || (strcasecmp ("Compression", key) == 0)) /* old, deprecated name */ + { + if (IS_FALSE (value)) + collect_compression = 0; + else + collect_compression = 1; + } /* if (strcasecmp ("CollectCompression", key) == 0) */ + else if (strcasecmp ("ImprovedNamingSchema", key) == 0) { - if ((strcasecmp ("True", value) == 0) - || (strcasecmp ("Yes", value) == 0) - || (strcasecmp ("On", value) == 0)) + if (IS_TRUE (value)) { - store_compression = 0; - DEBUG ("openvpn plugin: no 'compression statistcs' collected"); + DEBUG ("openvpn plugin: using the new naming schema"); + new_naming_schema = 1; } else { - store_compression = 1; + 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); @@ -544,7 +689,7 @@ static int openvpn_config (const char *key, const char *value) static int openvpn_shutdown (void) { int i; - + for (i = 0; i < vpn_num; i++) { sfree (vpn_list[i]->file); @@ -556,10 +701,29 @@ static int openvpn_shutdown (void) return (0); } /* int openvpn_shutdown */ -void module_register (void) +static int openvpn_init (void) { - plugin_register_config ("openvpn", openvpn_config, - config_keys, config_keys_num); + 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_init ("openvpn", openvpn_init); } /* void module_register */ + +/* vim: set sw=2 ts=2 : */