X-Git-Url: https://git.octo.it/?a=blobdiff_plain;f=src%2Fopenvpn.c;h=9ce23b4f4cb9c9e2550e86d337a866a451931404;hb=aff80830f1154a5b6c4da16a0b1033aafde14e24;hp=5a14e9e803c5aabaa1766d309ef2c263bfd24e28;hpb=aca8f06eb3019d334a4c50a5d838bb3e505f33ee;p=collectd.git diff --git a/src/openvpn.c b/src/openvpn.c index 5a14e9e8..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" @@ -50,12 +52,19 @@ 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", - "Compression" + "Compression", /* old, deprecated name */ + "ImprovedNamingSchema", + "CollectCompression", + "CollectUserCount", + "CollectIndividualUsers" }; static int config_keys_num = STATIC_ARRAY_SIZE (config_keys); @@ -83,17 +92,38 @@ 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 + /* 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. */ @@ -102,29 +132,36 @@ static void iostats_submit (char *name, char *type, counter_t rx, counter_t tx) 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 */ @@ -136,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; @@ -212,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); @@ -229,6 +266,7 @@ static int multi1_read (char *name, FILE *fh) char buffer[1024]; char *fields[10]; 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) */ while (fgets (buffer, sizeof (buffer), fh) != NULL) @@ -252,10 +290,35 @@ static int multi1_read (char *name, FILE *fh) if (fields_num < 4) continue; - iostats_submit (name, /* vpn instance */ - fields[0], /* "Common Name" */ - atoll (fields[2]), /* "Bytes Received" */ - atoll (fields[3])); /* "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) + { + 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; } @@ -269,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) { @@ -281,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) { + /* 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" */ - read = 1; + } + 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); @@ -307,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) { @@ -324,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 */ @@ -354,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; } @@ -466,7 +580,7 @@ static int openvpn_config (const char *key, const char *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); } @@ -475,7 +589,7 @@ 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); } @@ -488,7 +602,7 @@ 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; } @@ -516,7 +630,7 @@ static int openvpn_config (const char *key, const char *value) { char errbuf[1024]; ERROR ("openvpn plugin: malloc failed: %s", - sstrerror (errno, errbuf, sizeof (errbuf))); + sstrerror (errno, errbuf, sizeof (errbuf))); sfree (temp->file); sfree (temp); @@ -528,17 +642,41 @@ static int openvpn_config (const char *key, const char *value) DEBUG ("openvpn plugin: status file \"%s\" added", temp->file); - } - else if (strcasecmp ("Compression", 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 (IS_TRUE (value)) - store_compression = 1; + { + DEBUG ("openvpn plugin: using the new naming schema"); + new_naming_schema = 1; + } else { - store_compression = 0; - DEBUG ("openvpn plugin: no 'compression statistcs' collected"); + 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); @@ -563,10 +701,29 @@ static int openvpn_shutdown (void) return (0); } /* int openvpn_shutdown */ +static int openvpn_init (void) +{ + 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_read ("openvpn", openvpn_read); - plugin_register_shutdown ("openvpn", openvpn_shutdown); + plugin_register_init ("openvpn", openvpn_init); } /* void module_register */ + +/* vim: set sw=2 ts=2 : */