From: Florian Forster Date: Thu, 21 Sep 2017 20:00:14 +0000 (+0200) Subject: Merge remote-tracking branch 'github/pr/2434' X-Git-Tag: collectd-5.8.0~88 X-Git-Url: https://git.octo.it/?p=collectd.git;a=commitdiff_plain;h=23d34e73bdbdf0ef5b9221ad821c9560d4d8e0bb;hp=2330d3babccf9d32fec4c5a56075692ce47228ab Merge remote-tracking branch 'github/pr/2434' --- diff --git a/contrib/redhat/collectd.spec b/contrib/redhat/collectd.spec index 66d1914e..23cac9a0 100644 --- a/contrib/redhat/collectd.spec +++ b/contrib/redhat/collectd.spec @@ -521,8 +521,8 @@ the byte- and packet-counters of selected rules and submit them to collectd. Summary: Java plugin for collectd Group: System Environment/Daemons Requires: %{name}%{?_isa} = %{version}-%{release} -BuildRequires: java-devel, jpackage-utils -Requires: java, jpackage-utils +BuildRequires: java-devel >= 1.6, jpackage-utils >= 1.6 +Requires: java >= 1.6, jpackage-utils >= 1.6 %description java This plugin for collectd allows plugins to be written in Java and executed in an embedded JVM. diff --git a/src/collectd.conf.in b/src/collectd.conf.in index 86ea1a67..f35f3284 100644 --- a/src/collectd.conf.in +++ b/src/collectd.conf.in @@ -1348,6 +1348,7 @@ # # +# #Plugin "table" # Instance "slabinfo" # Separator " " # diff --git a/src/collectd.conf.pod b/src/collectd.conf.pod index a98a8be6..63e62efb 100644 --- a/src/collectd.conf.pod +++ b/src/collectd.conf.pod @@ -5656,15 +5656,12 @@ The OpenVPN plugin reads a status file maintained by OpenVPN and gathers traffic statistics about connected clients. To set up OpenVPN to write to the status file periodically, use the -B<--status> option of OpenVPN. Since OpenVPN can write two different formats, -you need to set the required format, too. This is done by setting -B<--status-version> to B<2>. +B<--status> option of OpenVPN. So, in a nutshell you need: openvpn $OTHER_OPTIONS \ - --status "/var/run/openvpn-status" 10 \ - --status-version 2 + --status "/var/run/openvpn-status" 10 Available options: @@ -7563,6 +7560,7 @@ filesystem or CSV (comma separated values) files.
+ #Plugin "slab" Instance "slabinfo" Separator " " @@ -7589,10 +7587,14 @@ The following options are available inside a B
block: =over 4 +=item B I + +If specified, I is used as the plugin name when submitting values. +Defaults to B
. + =item B I -If specified, I is used as the plugin instance. So, in the above -example, the plugin name C would be used. If omitted, the +If specified, I is used as the plugin instance. If omitted, the filename of the table is used instead, with all special characters replaced with an underscore (C<_>). diff --git a/src/collectd.pod b/src/collectd.pod index 8e68fc01..1dd899b8 100644 --- a/src/collectd.pod +++ b/src/collectd.pod @@ -40,11 +40,17 @@ the read callbacks once. A return code not equal to zero indicates an error. =item B<-P> Ipid-fileE> -Specify an alternative pid file. This overwrites any settings in the config +Specify an alternative pid file. This overwrites any settings in the config file. This is thought for init-scripts that require the PID-file in a certain directory to work correctly. For everyday-usage use the B config-option. +=item B<-B> + +If set, collectd will I try to create its base directory. If the base +directory does not exist, it will exit rather than trying to create the +directory. + =item B<-f> Don't fork to the background. I will also B close standard file diff --git a/src/daemon/collectd.c b/src/daemon/collectd.c index 2edfa377..af8fb568 100644 --- a/src/daemon/collectd.c +++ b/src/daemon/collectd.c @@ -158,7 +158,7 @@ static int init_global_variables(void) { return 0; } /* int init_global_variables */ -static int change_basedir(const char *orig_dir) { +static int change_basedir(const char *orig_dir, _Bool create) { char *dir; size_t dirlen; int status; @@ -183,7 +183,7 @@ static int change_basedir(const char *orig_dir) { if (status == 0) { free(dir); return 0; - } else if (errno != ENOENT) { + } else if (!create || (errno != ENOENT)) { char errbuf[1024]; ERROR("change_basedir: chdir (%s): %s", dir, sstrerror(errno, errbuf, sizeof(errbuf))); @@ -250,6 +250,7 @@ __attribute__((noreturn)) static void exit_usage(int status) { #if COLLECT_DAEMON " -f Don't fork to the background.\n" #endif + " -B Don't create the BaseDir\n" " -h Display help (this message)\n" "\nBuiltin defaults:\n" " Config file " CONFIGFILE "\n" @@ -459,6 +460,7 @@ int main(int argc, char **argv) { int test_config = 0; int test_readall = 0; const char *basedir; + _Bool opt_create_basedir = 1; #if COLLECT_DAEMON pid_t pid; int daemonize = 1; @@ -469,7 +471,7 @@ int main(int argc, char **argv) { while (1) { int c; - c = getopt(argc, argv, "htTC:" + c = getopt(argc, argv, "BhtTC:" #if COLLECT_DAEMON "fP:" #endif @@ -479,6 +481,9 @@ int main(int argc, char **argv) { break; switch (c) { + case 'B': + opt_create_basedir = 0; + break; case 'C': configfile = optarg; break; @@ -533,7 +538,7 @@ int main(int argc, char **argv) { fprintf(stderr, "Don't have a basedir to use. This should not happen. Ever."); return 1; - } else if (change_basedir(basedir)) { + } else if (change_basedir(basedir, opt_create_basedir)) { fprintf(stderr, "Error: Unable to change to directory `%s'.\n", basedir); return 1; } diff --git a/src/network.c b/src/network.c index 375da847..4e684215 100644 --- a/src/network.c +++ b/src/network.c @@ -1230,9 +1230,9 @@ static int parse_part_encr_aes256(sockent_t *se, /* {{{ */ part_size - buffer_offset, /* in = */ NULL, /* in len = */ 0); if (err != 0) { - sfree(pea.username); ERROR("network plugin: gcry_cipher_decrypt returned: %s. Username: %s", gcry_strerror(err), pea.username); + sfree(pea.username); return -1; } @@ -1254,8 +1254,6 @@ static int parse_part_encr_aes256(sockent_t *se, /* {{{ */ parse_packet(se, buffer + buffer_offset, payload_len, flags | PP_ENCRYPTED, pea.username); - /* XXX: Free pea.username?!? */ - /* Update return values */ *ret_buffer = buffer + part_size; *ret_buffer_len = buffer_len - part_size; @@ -2652,10 +2650,10 @@ static int network_write(const data_set_t *ds, const value_list_t *vl, pthread_mutex_lock(&send_buffer_lock); - status = add_to_buffer(send_buffer_ptr, - network_config_packet_size - - (send_buffer_fill + BUFF_SIG_SIZE), - &send_buffer_vl, ds, vl); + status = + add_to_buffer(send_buffer_ptr, network_config_packet_size - + (send_buffer_fill + BUFF_SIG_SIZE), + &send_buffer_vl, ds, vl); if (status >= 0) { /* status == bytes added to the buffer */ send_buffer_fill += status; @@ -2666,10 +2664,10 @@ static int network_write(const data_set_t *ds, const value_list_t *vl, } else { flush_buffer(); - status = add_to_buffer(send_buffer_ptr, - network_config_packet_size - - (send_buffer_fill + BUFF_SIG_SIZE), - &send_buffer_vl, ds, vl); + status = + add_to_buffer(send_buffer_ptr, network_config_packet_size - + (send_buffer_fill + BUFF_SIG_SIZE), + &send_buffer_vl, ds, vl); if (status >= 0) { send_buffer_fill += status; diff --git a/src/ntpd.c b/src/ntpd.c index a19d05c1..48d7aa72 100644 --- a/src/ntpd.c +++ b/src/ntpd.c @@ -846,9 +846,9 @@ static int ntpd_read(void) { } /* kerninfo -> estimated error */ - offset_loop = scale_loop * ((gauge_t)ntohl(ik->offset)); + offset_loop = (gauge_t)((int32_t)ntohl(ik->offset) * scale_loop); freq_loop = ntpd_read_fp(ik->freq); - offset_error = scale_error * ((gauge_t)ntohl(ik->esterror)); + offset_error = (gauge_t)((int32_t)ntohl(ik->esterror) * scale_error); DEBUG("info_kernel:\n" " pll offset = %.8g\n" diff --git a/src/openvpn.c b/src/openvpn.c index 143a770b..a98649b6 100644 --- a/src/openvpn.c +++ b/src/openvpn.c @@ -23,6 +23,7 @@ * Florian octo Forster * Marco Chiappero * Fabian Schuh + * Pavel Rochnyak **/ #include "collectd.h" @@ -30,35 +31,55 @@ #include "common.h" #include "plugin.h" -#define V1STRING \ +/** + * There is two main kinds of OpenVPN status file: + * - for 'single' mode (point-to-point or client mode) + * - for 'multi' mode (server with multiple clients) + * + * For 'multi' there is 3 versions of status file format: + * - version 1 - First version of status file: without line type tokens, + * comma delimited for easy machine parsing. Currently used by default. + * Added in openvpn-2.0-beta3. + * - version 2 - with line type tokens, with 'HEADER' line type, uses comma + * as a delimiter. + * Added in openvpn-2.0-beta15. + * - version 3 - The only difference from version 2 is delimiter: in version 3 + * tabs are used instead of commas. Set of fields is the same. + * Added in openvpn-2.1_rc14. + * + * For versions 2/3 there may be different sets of fields in different + * OpenVPN versions. + * + * Versions 2.0, 2.1, 2.2: + * Common Name,Real Address,Virtual Address, + * Bytes Received,Bytes Sent,Connected Since,Connected Since (time_t) + * + * Version 2.3: + * Common Name,Real Address,Virtual Address, + * Bytes Received,Bytes Sent,Connected Since,Connected Since (time_t),Username + * + * Version 2.4: + * Common Name,Real Address,Virtual Address,Virtual IPv6 Address, + * Bytes Received,Bytes Sent,Connected Since,Connected Since (time_t),Username, + * Client ID,Peer ID + * + * Current Collectd code tries to handle changes in this field set, + * if they are backward-compatible. + **/ + +#define TITLE_SINGLE "OpenVPN STATISTICS\n" +#define TITLE_V1 "OpenVPN CLIENT LIST\n" +#define TITLE_V2 "TITLE" + +#define V1HEADER \ "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 V4STRING \ - "HEADER,CLIENT_LIST,Common Name,Real Address,Virtual Address,Bytes " \ - "Received,Bytes Sent,Connected Since,Connected Since (time_t),Username\n" -#define VSSTRING "OpenVPN STATISTICS\n" struct vpn_status_s { char *file; - enum { - MULTI1 = 1, /* status-version 1 */ - MULTI2, /* status-version 2 */ - MULTI3, /* status-version 3 */ - MULTI4, /* status-version 4 */ - SINGLE = 10 /* currently no versions for single mode, maybe in the future */ - } version; char *name; }; typedef struct vpn_status_s vpn_status_t; -static vpn_status_t **vpn_list = NULL; -static int vpn_num = 0; - static _Bool new_naming_schema = 0; static _Bool collect_compression = 1; static _Bool collect_user_count = 0; @@ -71,16 +92,13 @@ static const char *config_keys[] = { static int config_keys_num = STATIC_ARRAY_SIZE(config_keys); /* Helper function - * copy-n-pasted from common.c - changed delim to "," */ + * copy-n-pasted from common.c - changed delim to ",\t" */ static int openvpn_strsplit(char *string, char **fields, size_t size) { - size_t i; - char *ptr; - char *saveptr; - - i = 0; - ptr = string; - saveptr = NULL; - while ((fields[i] = strtok_r(ptr, ",", &saveptr)) != NULL) { + size_t i = 0; + char *ptr = string; + char *saveptr = NULL; + + while ((fields[i] = strtok_r(ptr, ",\t", &saveptr)) != NULL) { ptr = NULL; i++; @@ -91,6 +109,13 @@ static int openvpn_strsplit(char *string, char **fields, size_t size) { return i; } /* int openvpn_strsplit */ +static void openvpn_free(void *arg) { + vpn_status_t *st = arg; + + sfree(st->file); + sfree(st); +} /* void openvpn_free */ + /* dispatches number of users */ static void numusers_submit(const char *pinst, const char *tinst, gauge_t value) { @@ -159,25 +184,14 @@ static int single_read(const char *name, FILE *fh) { char buffer[1024]; char *fields[4]; const int max_fields = STATIC_ARRAY_SIZE(fields); - int fields_num, read = 0; - - 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; - tun_rx = 0; - tun_tx = 0; - pre_compress = 0; - post_compress = 0; - pre_decompress = 0; - post_decompress = 0; + + derive_t link_rx = 0, link_tx = 0; + derive_t tun_rx = 0, tun_tx = 0; + derive_t pre_compress = 0, post_compress = 0; + derive_t pre_decompress = 0, post_decompress = 0; while (fgets(buffer, sizeof(buffer), fh) != NULL) { - fields_num = openvpn_strsplit(buffer, fields, max_fields); + int fields_num = openvpn_strsplit(buffer, fields, max_fields); /* status file is generated by openvpn/sig.c:print_status() * http://svn.openvpn.net/projects/openvpn/trunk/openvpn/sig.c @@ -213,8 +227,9 @@ static int single_read(const char *name, FILE *fh) { iostats_submit(name, "traffic", link_rx, link_tx); /* we need to force this order to avoid negative values with these unsigned */ - overhead_rx = (((link_rx - pre_decompress) + post_decompress) - tun_rx); - overhead_tx = (((link_tx - post_compress) + pre_compress) - tun_tx); + derive_t overhead_rx = + (((link_rx - pre_decompress) + post_decompress) - tun_rx); + derive_t overhead_tx = (((link_tx - post_compress) + pre_compress) - tun_tx); iostats_submit(name, "overhead", overhead_rx, overhead_tx); @@ -223,17 +238,16 @@ static int single_read(const char *name, FILE *fh) { compression_submit(name, "data_out", pre_compress, post_compress); } - read = 1; - - return read; + return 0; } /* int single_read */ /* for reading status version 1 */ static int multi1_read(const char *name, FILE *fh) { char buffer[1024]; char *fields[10]; - int fields_num, found_header = 0; + const int max_fields = STATIC_ARRAY_SIZE(fields); long long sum_users = 0; + _Bool found_header = 0; /* read the file until the "ROUTING TABLE" line is found (no more info after) */ @@ -241,7 +255,7 @@ static int multi1_read(const char *name, FILE *fh) { if (strcmp(buffer, "ROUTING TABLE\n") == 0) break; - if (strcmp(buffer, V1STRING) == 0) { + if (strcmp(buffer, V1HEADER) == 0) { found_header = 1; continue; } @@ -251,7 +265,7 @@ static int multi1_read(const char *name, FILE *fh) { /* we can't start reading data until this string is found */ continue; - fields_num = openvpn_strsplit(buffer, fields, STATIC_ARRAY_SIZE(fields)); + int fields_num = openvpn_strsplit(buffer, fields, max_fields); if (fields_num < 4) continue; @@ -276,325 +290,196 @@ static int multi1_read(const char *name, FILE *fh) { } if (ferror(fh)) - return 0; + return -1; + + if (found_header == 0) { + NOTICE("openvpn plugin: Unknown file format in instance %s, please " + "report this as bug. Make sure to include " + "your status file, so the plugin can " + "be adapted.", + name); + return -1; + } if (collect_user_count) numusers_submit(name, name, sum_users); - return 1; + return 0; } /* int multi1_read */ -/* for reading status version 2 */ +/* for reading status version 2 / version 3 + * status file is generated by openvpn/multi.c:multi_print_status() + * http://svn.openvpn.net/projects/openvpn/trunk/openvpn/multi.c + */ static int multi2_read(const char *name, FILE *fh) { char buffer[1024]; - char *fields[10]; + /* OpenVPN-2.4 has 11 fields of data + 2 fields for "HEADER" and "CLIENT_LIST" + * So, set array size to 20 elements, to support future extensions. + */ + char *fields[20]; 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) { - fields_num = openvpn_strsplit(buffer, fields, max_fields); - - /* status file is generated by openvpn/multi.c:multi_print_status() - * http://svn.openvpn.net/projects/openvpn/trunk/openvpn/multi.c - * - * The line we're expecting has 8 fields. We ignore all lines - * 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; - } - if (collect_individual_users) { - 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 */ - -/* for reading status version 3 */ -static int multi3_read(const char *name, FILE *fh) { - char buffer[1024]; - char *fields[15]; - const int max_fields = STATIC_ARRAY_SIZE(fields); - int fields_num, read = 0; - long long sum_users = 0; + _Bool found_header = 0; + int idx_cname = 0; + int idx_bytes_recv = 0; + int idx_bytes_sent = 0; + int columns = 0; while (fgets(buffer, sizeof(buffer), fh) != NULL) { - fields_num = strsplit(buffer, fields, max_fields); + int fields_num = openvpn_strsplit(buffer, fields, max_fields); - /* status file is generated by openvpn/multi.c:multi_print_status() - * http://svn.openvpn.net/projects/openvpn/trunk/openvpn/multi.c - * - * The line we're expecting has 12 fields. We ignore all lines - * with more or less fields. - */ - if (fields_num != 12) { - continue; - } else { - if (strcmp(fields[0], "CLIENT_LIST") != 0) + /* Try to find section header */ + if (found_header == 0) { + if (fields_num < 2) + continue; + if (strcmp(fields[0], "HEADER") != 0) + continue; + if (strcmp(fields[1], "CLIENT_LIST") != 0) continue; - if (collect_user_count) - /* If so, sum all users, ignore the individuals*/ - { - 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" */ + for (int i = 2; i < fields_num; i++) { + if (strcmp(fields[i], "Common Name") == 0) { + idx_cname = i - 1; + } else if (strcmp(fields[i], "Bytes Received") == 0) { + idx_bytes_recv = i - 1; + } else if (strcmp(fields[i], "Bytes Sent") == 0) { + idx_bytes_sent = i - 1; } } - read = 1; - } - } - - if (collect_user_count) { - numusers_submit(name, name, sum_users); - read = 1; - } + DEBUG("openvpn plugin: found MULTI v2/v3 HEADER. " + "Column idx: cname: %d, bytes_recv: %d, bytes_sent: %d", + idx_cname, idx_bytes_recv, idx_bytes_sent); - return read; -} /* int multi3_read */ + if (idx_cname == 0 || idx_bytes_recv == 0 || idx_bytes_sent == 0) + break; -/* for reading status version 4 */ -static int multi4_read(const char *name, FILE *fh) { - char buffer[1024]; - char *fields[11]; - const int max_fields = STATIC_ARRAY_SIZE(fields); - int fields_num, read = 0; - long long sum_users = 0; + /* Data row has 1 field ("HEADER") less than header row */ + columns = fields_num - 1; - while (fgets(buffer, sizeof(buffer), fh) != NULL) { - fields_num = openvpn_strsplit(buffer, fields, max_fields); + found_header = 1; + continue; + } - /* status file is generated by openvpn/multi.c:multi_print_status() - * http://svn.openvpn.net/projects/openvpn/trunk/openvpn/multi.c - * - * The line we're expecting has 9 fields. We ignore all lines - * with more or less fields. + /* Header already found. Check if the line is the section data. + * If no match, then section was finished and there is no more data. + * Empty section is OK too. */ - if (fields_num != 9) - continue; + if (fields_num == 0 || strcmp(fields[0], "CLIENT_LIST") != 0) + break; - if (strcmp(fields[0], "CLIENT_LIST") != 0) - continue; + /* Check if the data line fields count matches header line. */ + if (fields_num != columns) { + ERROR("openvpn plugin: File format error in instance %s: Fields count " + "mismatch.", + name); + return -1; + } + + DEBUG("openvpn plugin: found MULTI v2/v3 CLIENT_LIST. " + "Columns: cname: %s, bytes_recv: %s, bytes_sent: %s", + fields[idx_cname], fields[idx_bytes_recv], fields[idx_bytes_sent]); if (collect_user_count) - /* If so, sum all users, ignore the individuals*/ - { sum_users += 1; - } + if (collect_individual_users) { 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" */ + iostats_submit(name, /* vpn instance */ + fields[idx_cname], /* "Common Name" */ + atoll(fields[idx_bytes_recv]), /* "Bytes Received" */ + atoll(fields[idx_bytes_sent])); /* "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" */ + /* plugin inst = fields[idx_cname], type inst = "" */ + iostats_submit(fields[idx_cname], /* "Common Name" */ + NULL, /* unused when in multimode */ + atoll(fields[idx_bytes_recv]), /* "Bytes Received" */ + atoll(fields[idx_bytes_sent])); /* "Bytes Sent" */ } } + } + + if (ferror(fh)) + return -1; - read = 1; + if (found_header == 0) { + NOTICE("openvpn plugin: Unknown file format in instance %s, please " + "report this as bug. Make sure to include " + "your status file, so the plugin can " + "be adapted.", + name); + return -1; } if (collect_user_count) { numusers_submit(name, name, sum_users); - read = 1; } - return read; -} /* int multi4_read */ + return 0; +} /* int multi2_read */ /* read callback */ -static int openvpn_read(void) { - FILE *fh; - int read; - - read = 0; - - if (vpn_num == 0) - return 0; - - /* call the right read function for every status entry in the list */ - for (int i = 0; i < vpn_num; i++) { - int vpn_read = 0; - - fh = fopen(vpn_list[i]->file, "r"); - if (fh == NULL) { - char errbuf[1024]; - WARNING("openvpn plugin: fopen(%s) failed: %s", vpn_list[i]->file, - sstrerror(errno, errbuf, sizeof(errbuf))); - - continue; - } - - switch (vpn_list[i]->version) { - case SINGLE: - vpn_read = single_read(vpn_list[i]->name, fh); - break; - - case MULTI1: - vpn_read = multi1_read(vpn_list[i]->name, fh); - break; - - case MULTI2: - vpn_read = multi2_read(vpn_list[i]->name, fh); - break; - - case MULTI3: - vpn_read = multi3_read(vpn_list[i]->name, fh); - break; - - case MULTI4: - vpn_read = multi4_read(vpn_list[i]->name, fh); - break; - } - - fclose(fh); - read += vpn_read; - } - - return read ? 0 : -1; -} /* int openvpn_read */ - -static int version_detect(const char *filename) { - FILE *fh; +static int openvpn_read(user_data_t *user_data) { char buffer[1024]; - int version = 0; + int read = 0; - /* Sanity checking. We're called from the config handling routine, so - * better play it save. */ - if ((filename == NULL) || (*filename == 0)) - return 0; + vpn_status_t *st = user_data->data; - fh = fopen(filename, "r"); + FILE *fh = fopen(st->file, "r"); if (fh == NULL) { char errbuf[1024]; - WARNING("openvpn plugin: Unable to read \"%s\": %s", filename, + WARNING("openvpn plugin: fopen(%s) failed: %s", st->file, sstrerror(errno, errbuf, sizeof(errbuf))); - return 0; + + return -1; } - /* 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) { - 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; - } - /* searching for multi version 4 */ - else if (strcmp(buffer, V4STRING) == 0) { - DEBUG("openvpn plugin: found status file version MULTI4"); - version = MULTI4; - break; - } + // Try to detect file format by its first line + if ((fgets(buffer, sizeof(buffer), fh)) == NULL) { + WARNING("openvpn plugin: failed to get data from: %s", st->file); + fclose(fh); + return -1; } - if (version == 0) { - /* This is only reached during configuration, so complaining to - * the user is in order. */ + if (strcmp(buffer, TITLE_SINGLE) == 0) { // OpenVPN STATISTICS + DEBUG("openvpn plugin: found status file SINGLE"); + read = single_read(st->name, fh); + } else if (strcmp(buffer, TITLE_V1) == 0) { // OpenVPN CLIENT LIST + DEBUG("openvpn plugin: found status file MULTI version 1"); + read = multi1_read(st->name, fh); + } else if (strncmp(buffer, TITLE_V2, strlen(TITLE_V2)) == 0) { // TITLE + DEBUG("openvpn plugin: found status file MULTI version 2/3"); + read = multi2_read(st->name, fh); + } else { 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); + st->file); + read = -1; } - fclose(fh); - - return version; -} /* int version_detect */ + return read; +} /* int openvpn_read */ static int openvpn_config(const char *key, const char *value) { if (strcasecmp("StatusFile", key) == 0) { - char *status_file, *status_name, *filename; - int status_version; - vpn_status_t *temp; + char callback_name[3 * DATA_MAX_NAME_LEN]; + char *status_name; - /* 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); - return 1; - } - - status_file = sstrdup(value); + char *status_file = strdup(value); if (status_file == NULL) { char errbuf[1024]; - WARNING("openvpn plugin: sstrdup failed: %s", - sstrerror(errno, errbuf, sizeof(errbuf))); + ERROR("openvpn plugin: strdup failed: %s", + sstrerror(errno, errbuf, sizeof(errbuf))); return 1; } /* it determines the file name as string starting at location filename + 1 */ - filename = strrchr(status_file, (int)'/'); + char *filename = strrchr(status_file, (int)'/'); if (filename == NULL) { /* status_file is already the file name only */ status_name = status_file; @@ -603,50 +488,38 @@ static int openvpn_config(const char *key, const char *value) { status_name = filename + 1; } - /* scan the list looking for a clone */ - for (int i = 0; i < vpn_num; i++) { - if (strcasecmp(vpn_list[i]->name, status_name) == 0) { - 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, version and name are ok */ - temp = malloc(sizeof(*temp)); - if (temp == NULL) { + /* create a new vpn element */ + vpn_status_t *instance = calloc(1, sizeof(*instance)); + if (instance == NULL) { char errbuf[1024]; ERROR("openvpn plugin: malloc failed: %s", sstrerror(errno, errbuf, sizeof(errbuf))); sfree(status_file); return 1; } - temp->file = status_file; - temp->version = status_version; - temp->name = status_name; - - vpn_status_t **tmp_list = - realloc(vpn_list, (vpn_num + 1) * sizeof(*vpn_list)); - if (tmp_list == NULL) { - char errbuf[1024]; - ERROR("openvpn plugin: realloc failed: %s", - sstrerror(errno, errbuf, sizeof(errbuf))); - - sfree(vpn_list); - sfree(temp->file); - sfree(temp); - return 1; + instance->file = status_file; + instance->name = status_name; + + snprintf(callback_name, sizeof(callback_name), "openvpn/%s", status_name); + + int status = plugin_register_complex_read( + /* group = */ "openvpn", + /* name = */ callback_name, + /* callback = */ openvpn_read, + /* interval = */ 0, + &(user_data_t){ + .data = instance, .free_func = openvpn_free, + }); + + if (status == EINVAL) { + WARNING("openvpn plugin: status filename \"%s\" " + "already used, please choose a " + "different one.", + status_name); + return -1; } - vpn_list = tmp_list; - - vpn_list[vpn_num] = temp; - vpn_num++; - - DEBUG("openvpn plugin: status file \"%s\" added", temp->file); + DEBUG("openvpn plugin: status file \"%s\" added", instance->file); } /* if (strcasecmp ("StatusFile", key) == 0) */ else if ((strcasecmp("CollectCompression", key) == 0) || (strcasecmp("Compression", key) == 0)) /* old, deprecated name */ @@ -683,18 +556,6 @@ static int openvpn_config(const char *key, const char *value) { return 0; } /* int openvpn_config */ -/* shutdown callback */ -static int openvpn_shutdown(void) { - for (int i = 0; i < vpn_num; i++) { - sfree(vpn_list[i]->file); - sfree(vpn_list[i]); - } - - sfree(vpn_list); - - return 0; -} /* int openvpn_shutdown */ - static int openvpn_init(void) { if (!collect_individual_users && !collect_compression && !collect_user_count) { @@ -704,9 +565,6 @@ static int openvpn_init(void) { return -1; } - plugin_register_read("openvpn", openvpn_read); - plugin_register_shutdown("openvpn", openvpn_shutdown); - return 0; } /* int openvpn_init */ diff --git a/src/perl.c b/src/perl.c index a1ac8d76..d2a00bfd 100644 --- a/src/perl.c +++ b/src/perl.c @@ -2616,6 +2616,12 @@ static int perl_config_plugin(pTHX_ oconfig_item_t *ci) { char *plugin; HV *config; + if (NULL == perl_threads) { + log_err("A `Plugin' block was encountered but no plugin was loaded yet. " + "Put the appropriate `LoadPlugin' option in front of it."); + return -1; + } + dSP; if ((1 != ci->values_num) || (OCONFIG_TYPE_STRING != ci->values[0].type)) { diff --git a/src/table.c b/src/table.c index 578e019e..5fb51512 100644 --- a/src/table.c +++ b/src/table.c @@ -55,6 +55,7 @@ typedef struct { typedef struct { char *file; char *sep; + char *plugin_name; char *instance; tbl_result_t *results; @@ -92,6 +93,7 @@ static void tbl_result_clear(tbl_result_t *res) { static void tbl_setup(tbl_t *tbl, char *file) { tbl->file = sstrdup(file); tbl->sep = NULL; + tbl->plugin_name = NULL; tbl->instance = NULL; tbl->results = NULL; @@ -103,6 +105,7 @@ static void tbl_setup(tbl_t *tbl, char *file) { static void tbl_clear(tbl_t *tbl) { sfree(tbl->file); sfree(tbl->sep); + sfree(tbl->plugin_name); sfree(tbl->instance); for (size_t i = 0; i < tbl->results_num; ++i) @@ -256,6 +259,8 @@ static int tbl_config_table(oconfig_item_t *ci) { if (0 == strcasecmp(c->key, "Separator")) tbl_config_set_s(c->key, &tbl->sep, c); + else if (0 == strcasecmp(c->key, "Plugin")) + tbl_config_set_s(c->key, &tbl->plugin_name, c); else if (0 == strcasecmp(c->key, "Instance")) tbl_config_set_s(c->key, &tbl->instance, c); else if (0 == strcasecmp(c->key, "Result")) @@ -367,7 +372,8 @@ static int tbl_result_dispatch(tbl_t *tbl, tbl_result_t *res, char **fields, vl.values = values; vl.values_len = STATIC_ARRAY_SIZE(values); - sstrncpy(vl.plugin, "table", sizeof(vl.plugin)); + sstrncpy(vl.plugin, (tbl->plugin_name != NULL) ? tbl->plugin_name : "table", + sizeof(vl.plugin)); sstrncpy(vl.plugin_instance, tbl->instance, sizeof(vl.plugin_instance)); sstrncpy(vl.type, res->type, sizeof(vl.type));