diff options
Diffstat (limited to 'collectors/tc.plugin')
| -rw-r--r-- | collectors/tc.plugin/Makefile.am | 20 | ||||
| l--------- | collectors/tc.plugin/README.md | 1 | ||||
| -rw-r--r-- | collectors/tc.plugin/integrations/tc_qos_classes.md | 171 | ||||
| -rw-r--r-- | collectors/tc.plugin/metadata.yaml | 148 | ||||
| -rw-r--r-- | collectors/tc.plugin/plugin_tc.c | 1183 | ||||
| -rwxr-xr-x | collectors/tc.plugin/tc-qos-helper.sh.in | 356 |
6 files changed, 0 insertions, 1879 deletions
diff --git a/collectors/tc.plugin/Makefile.am b/collectors/tc.plugin/Makefile.am deleted file mode 100644 index 9bc6cf2de..000000000 --- a/collectors/tc.plugin/Makefile.am +++ /dev/null @@ -1,20 +0,0 @@ -# SPDX-License-Identifier: GPL-3.0-or-later - -AUTOMAKE_OPTIONS = subdir-objects -MAINTAINERCLEANFILES = $(srcdir)/Makefile.in - -CLEANFILES = \ - tc-qos-helper.sh \ - $(NULL) - -include $(top_srcdir)/build/subst.inc -SUFFIXES = .in - -dist_plugins_SCRIPTS = \ - tc-qos-helper.sh \ - $(NULL) - -dist_noinst_DATA = \ - tc-qos-helper.sh.in \ - README.md \ - $(NULL) diff --git a/collectors/tc.plugin/README.md b/collectors/tc.plugin/README.md deleted file mode 120000 index 2a20ff262..000000000 --- a/collectors/tc.plugin/README.md +++ /dev/null @@ -1 +0,0 @@ -integrations/tc_qos_classes.md
\ No newline at end of file diff --git a/collectors/tc.plugin/integrations/tc_qos_classes.md b/collectors/tc.plugin/integrations/tc_qos_classes.md deleted file mode 100644 index 7a6650660..000000000 --- a/collectors/tc.plugin/integrations/tc_qos_classes.md +++ /dev/null @@ -1,171 +0,0 @@ -<!--startmeta -custom_edit_url: "https://github.com/netdata/netdata/edit/master/collectors/tc.plugin/README.md" -meta_yaml: "https://github.com/netdata/netdata/edit/master/collectors/tc.plugin/metadata.yaml" -sidebar_label: "tc QoS classes" -learn_status: "Published" -learn_rel_path: "Data Collection/Linux Systems/Network" -most_popular: False -message: "DO NOT EDIT THIS FILE DIRECTLY, IT IS GENERATED BY THE COLLECTOR'S metadata.yaml FILE" -endmeta--> - -# tc QoS classes - - -<img src="https://netdata.cloud/img/netdata.png" width="150"/> - - -Plugin: tc.plugin -Module: tc.plugin - -<img src="https://img.shields.io/badge/maintained%20by-Netdata-%2300ab44" /> - -## Overview - -Examine tc metrics to gain insights into Linux traffic control operations. Study packet flow rates, queue lengths, and drop rates to optimize network traffic flow. - -The plugin uses `tc` command to collect information about Traffic control. - -This collector is only supported on the following platforms: - -- Linux - -This collector supports collecting metrics from multiple instances of this integration, including remote instances. - -The plugin needs to access command `tc` to get the necessary metrics. To achieve this netdata modifies permission of file `/usr/libexec/netdata/plugins.d/tc-qos-helper.sh`. - -### Default Behavior - -#### Auto-Detection - -This integration doesn't support auto-detection. - -#### Limits - -The default configuration for this integration does not impose any limits on data collection. - -#### Performance Impact - -The default configuration for this integration is not expected to impose a significant performance impact on the system. - - -## Metrics - -Metrics grouped by *scope*. - -The scope defines the instance that the metric belongs to. An instance is uniquely identified by a set of labels. - - - -### Per network device direction - -Metrics related to QoS network device directions. Each direction (in/out) produces its own set of the following metrics. - -Labels: - -| Label | Description | -|:-----------|:----------------| -| device | The network interface. | -| device_name | The network interface name | -| group | The device family | - -Metrics: - -| Metric | Dimensions | Unit | -|:------|:----------|:----| -| tc.qos | a dimension per class | kilobits/s | -| tc.qos_packets | a dimension per class | packets/s | -| tc.qos_dropped | a dimension per class | packets/s | -| tc.qos_tokens | a dimension per class | tokens | -| tc.qos_ctokens | a dimension per class | ctokens | - - - -## Alerts - -There are no alerts configured by default for this integration. - - -## Setup - -### Prerequisites - -#### Create `tc-qos-helper.conf` - -In order to view tc classes, you need to create the file `/etc/netdata/tc-qos-helper.conf` with content: - -```conf -tc_show="class" -``` - - - -### Configuration - -#### File - -The configuration file name for this integration is `netdata.conf`. -Configuration for this specific integration is located in the `[plugin:tc]` section within that file. - -The file format is a modified INI syntax. The general structure is: - -```ini -[section1] - option1 = some value - option2 = some other value - -[section2] - option3 = some third value -``` -You can edit the configuration file using the `edit-config` script from the -Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/configure/nodes.md#the-netdata-config-directory). - -```bash -cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata -sudo ./edit-config netdata.conf -``` -#### Options - - - -<details><summary>Config option</summary> - -| Name | Description | Default | Required | -|:----|:-----------|:-------|:--------:| -| script to run to get tc values | Path to script `tc-qos-helper.sh` | usr/libexec/netdata/plugins.d/tc-qos-helper.s | no | -| enable show all classes and qdiscs for all interfaces | yes/no flag to control what data is presented. | yes | no | - -</details> - -#### Examples - -##### Basic - -A basic example configuration using classes defined in `/etc/iproute2/tc_cls`. - -An example of class IDs mapped to names in that file can be: - -```conf -2:1 Standard -2:8 LowPriorityData -2:10 HighThroughputData -2:16 OAM -2:18 LowLatencyData -2:24 BroadcastVideo -2:26 MultimediaStreaming -2:32 RealTimeInteractive -2:34 MultimediaConferencing -2:40 Signalling -2:46 Telephony -2:48 NetworkControl -``` - -You can read more about setting up the tc rules in rc.local in this [GitHub issue](https://github.com/netdata/netdata/issues/4563#issuecomment-455711973). - - -```yaml -[plugin:tc] - script to run to get tc values = /usr/libexec/netdata/plugins.d/tc-qos-helper.sh - enable show all classes and qdiscs for all interfaces = yes - -``` - diff --git a/collectors/tc.plugin/metadata.yaml b/collectors/tc.plugin/metadata.yaml deleted file mode 100644 index f4039a8c5..000000000 --- a/collectors/tc.plugin/metadata.yaml +++ /dev/null @@ -1,148 +0,0 @@ -plugin_name: tc.plugin -modules: - - meta: - plugin_name: tc.plugin - module_name: tc.plugin - monitored_instance: - name: tc QoS classes - link: "https://wiki.linuxfoundation.org/networking/iproute2" - categories: - - data-collection.linux-systems.network-metrics - icon_filename: "netdata.png" - related_resources: - integrations: - list: [] - info_provided_to_referring_integrations: - description: "" - keywords: [] - most_popular: false - overview: - data_collection: - metrics_description: "Examine tc metrics to gain insights into Linux traffic control operations. Study packet flow rates, queue lengths, and drop rates to optimize network traffic flow." - method_description: "The plugin uses `tc` command to collect information about Traffic control." - supported_platforms: - include: - - Linux - exclude: [] - multi_instance: true - additional_permissions: - description: "The plugin needs to access command `tc` to get the necessary metrics. To achieve this netdata modifies permission of file `/usr/libexec/netdata/plugins.d/tc-qos-helper.sh`." - default_behavior: - auto_detection: - description: "" - limits: - description: "" - performance_impact: - description: "" - setup: - prerequisites: - list: - - title: Create `tc-qos-helper.conf` - description: | - In order to view tc classes, you need to create the file `/etc/netdata/tc-qos-helper.conf` with content: - - ```conf - tc_show="class" - ``` - configuration: - file: - name: "netdata.conf" - section_name: "[plugin:tc]" - description: "The main configuration file." - options: - description: "" - folding: - title: "Config option" - enabled: true - list: - - name: script to run to get tc values - description: Path to script `tc-qos-helper.sh` - default_value: "usr/libexec/netdata/plugins.d/tc-qos-helper.s" - required: false - - name: enable show all classes and qdiscs for all interfaces - description: yes/no flag to control what data is presented. - default_value: "yes" - required: false - examples: - folding: - enabled: false - title: "Config" - list: - - name: Basic - description: | - A basic example configuration using classes defined in `/etc/iproute2/tc_cls`. - - An example of class IDs mapped to names in that file can be: - - ```conf - 2:1 Standard - 2:8 LowPriorityData - 2:10 HighThroughputData - 2:16 OAM - 2:18 LowLatencyData - 2:24 BroadcastVideo - 2:26 MultimediaStreaming - 2:32 RealTimeInteractive - 2:34 MultimediaConferencing - 2:40 Signalling - 2:46 Telephony - 2:48 NetworkControl - ``` - - You can read more about setting up the tc rules in rc.local in this [GitHub issue](https://github.com/netdata/netdata/issues/4563#issuecomment-455711973). - - config: | - [plugin:tc] - script to run to get tc values = /usr/libexec/netdata/plugins.d/tc-qos-helper.sh - enable show all classes and qdiscs for all interfaces = yes - troubleshooting: - problems: - list: [] - alerts: [] - metrics: - folding: - title: Metrics - enabled: false - description: "" - availability: [] - scopes: - - name: network device direction - description: "Metrics related to QoS network device directions. Each direction (in/out) produces its own set of the following metrics." - labels: - - name: device - description: The network interface. - - name: device_name - description: The network interface name - - name: group - description: The device family - metrics: - - name: tc.qos - description: Class Usage - unit: "kilobits/s" - chart_type: stacked - dimensions: - - name: a dimension per class - - name: tc.qos_packets - description: Class Packets - unit: "packets/s" - chart_type: stacked - dimensions: - - name: a dimension per class - - name: tc.qos_dropped - description: Class Dropped Packets - unit: "packets/s" - chart_type: stacked - dimensions: - - name: a dimension per class - - name: tc.qos_tokens - description: Class Tokens - unit: "tokens" - chart_type: line - dimensions: - - name: a dimension per class - - name: tc.qos_ctokens - description: Class cTokens - unit: "ctokens" - chart_type: line - dimensions: - - name: a dimension per class diff --git a/collectors/tc.plugin/plugin_tc.c b/collectors/tc.plugin/plugin_tc.c deleted file mode 100644 index eae70453f..000000000 --- a/collectors/tc.plugin/plugin_tc.c +++ /dev/null @@ -1,1183 +0,0 @@ -// SPDX-License-Identifier: GPL-3.0-or-later - -#include "daemon/common.h" - -#define RRD_TYPE_TC "tc" -#define PLUGIN_TC_NAME "tc.plugin" - -// ---------------------------------------------------------------------------- -// /sbin/tc processor -// this requires the script plugins.d/tc-qos-helper.sh - -#define TC_LINE_MAX 1024 - -struct tc_class { - STRING *id; - STRING *name; - STRING *leafid; - STRING *parentid; - - bool hasparent; - bool isleaf; - bool isqdisc; - bool render; - bool name_updated; - bool updated; - - int unupdated; // the number of times, this has been found un-updated - - unsigned long long bytes; - unsigned long long packets; - unsigned long long dropped; - unsigned long long tokens; - unsigned long long ctokens; - - //unsigned long long overlimits; - //unsigned long long requeues; - //unsigned long long lended; - //unsigned long long borrowed; - //unsigned long long giants; - - RRDDIM *rd_bytes; - RRDDIM *rd_packets; - RRDDIM *rd_dropped; - RRDDIM *rd_tokens; - RRDDIM *rd_ctokens; -}; - -struct tc_device { - STRING *id; - STRING *name; - STRING *family; - - bool name_updated; - bool family_updated; - - char enabled; - char enabled_bytes; - char enabled_packets; - char enabled_dropped; - char enabled_tokens; - char enabled_ctokens; - char enabled_all_classes_qdiscs; - - RRDSET *st_bytes; - RRDSET *st_packets; - RRDSET *st_dropped; - RRDSET *st_tokens; - RRDSET *st_ctokens; - - DICTIONARY *classes; -}; - - -// ---------------------------------------------------------------------------- -// tc_class index - -static void tc_class_free_callback(const DICTIONARY_ITEM *item __maybe_unused, void *value, void *data __maybe_unused) { - // struct tc_device *d = data; - struct tc_class *c = value; - - string_freez(c->id); - string_freez(c->name); - string_freez(c->leafid); - string_freez(c->parentid); -} - -static bool tc_class_conflict_callback(const DICTIONARY_ITEM *item __maybe_unused, void *old_value, void *new_value, void *data __maybe_unused) { - struct tc_device *d = data; (void)d; - struct tc_class *c = old_value; (void)c; - struct tc_class *new_c = new_value; (void)new_c; - - collector_error("TC: class '%s' is already in device '%s'. Ignoring duplicate.", dictionary_acquired_item_name(item), string2str(d->id)); - - tc_class_free_callback(item, new_value, data); - - return true; -} - -static void tc_class_index_init(struct tc_device *d) { - if(!d->classes) { - d->classes = dictionary_create_advanced(DICT_OPTION_DONT_OVERWRITE_VALUE | DICT_OPTION_SINGLE_THREADED, &dictionary_stats_category_collectors, 0); - - dictionary_register_delete_callback(d->classes, tc_class_free_callback, d); - dictionary_register_conflict_callback(d->classes, tc_class_conflict_callback, d); - } -} - -static void tc_class_index_destroy(struct tc_device *d) { - dictionary_destroy(d->classes); - d->classes = NULL; -} - -static struct tc_class *tc_class_index_add(struct tc_device *d, struct tc_class *c) { - return dictionary_set(d->classes, string2str(c->id), c, sizeof(*c)); -} - -static void tc_class_index_del(struct tc_device *d, struct tc_class *c) { - dictionary_del(d->classes, string2str(c->id)); -} - -static inline struct tc_class *tc_class_index_find(struct tc_device *d, const char *id) { - return dictionary_get(d->classes, id); -} - -// ---------------------------------------------------------------------------- -// tc_device index - -static DICTIONARY *tc_device_root_index = NULL; - -static void tc_device_add_callback(const DICTIONARY_ITEM *item __maybe_unused, void *value, void *data __maybe_unused) { - struct tc_device *d = value; - tc_class_index_init(d); -} - -static void tc_device_free_callback(const DICTIONARY_ITEM *item __maybe_unused, void *value, void *data __maybe_unused) { - struct tc_device *d = value; - - tc_class_index_destroy(d); - - string_freez(d->id); - string_freez(d->name); - string_freez(d->family); -} - -static void tc_device_index_init() { - if(!tc_device_root_index) { - tc_device_root_index = dictionary_create_advanced( - DICT_OPTION_DONT_OVERWRITE_VALUE | DICT_OPTION_SINGLE_THREADED | DICT_OPTION_ADD_IN_FRONT, - &dictionary_stats_category_collectors, 0); - - dictionary_register_insert_callback(tc_device_root_index, tc_device_add_callback, NULL); - dictionary_register_delete_callback(tc_device_root_index, tc_device_free_callback, NULL); - } -} - -static void tc_device_index_destroy() { - dictionary_destroy(tc_device_root_index); - tc_device_root_index = NULL; -} - -static struct tc_device *tc_device_index_add(struct tc_device *d) { - return dictionary_set(tc_device_root_index, string2str(d->id), d, sizeof(*d)); -} - -//static struct tc_device *tc_device_index_del(struct tc_device *d) { -// dictionary_del(tc_device_root_index, string2str(d->id)); -// return d; -//} - -static inline struct tc_device *tc_device_index_find(const char *id) { - return dictionary_get(tc_device_root_index, id); -} - -// ---------------------------------------------------------------------------- - -static inline void tc_class_free(struct tc_device *n, struct tc_class *c) { - netdata_log_debug(D_TC_LOOP, "Removing from device '%s' class '%s', parentid '%s', leafid '%s', unused=%d", - string2str(n->id), string2str(c->id), string2str(c->parentid), string2str(c->leafid), - c->unupdated); - - tc_class_index_del(n, c); -} - -static inline void tc_device_classes_cleanup(struct tc_device *d) { - static int cleanup_every = 999; - - if(unlikely(cleanup_every > 0)) { - cleanup_every = (int) config_get_number("plugin:tc", "cleanup unused classes every", 120); - if(cleanup_every < 0) cleanup_every = -cleanup_every; - } - - d->name_updated = false; - d->family_updated = false; - - struct tc_class *c; - dfe_start_write(d->classes, c) { - if(unlikely(cleanup_every && c->unupdated >= cleanup_every)) - tc_class_free(d, c); - - else { - c->updated = false; - c->name_updated = false; - } - } - dfe_done(c); -} - -static inline void tc_device_commit(struct tc_device *d) { - static int enable_new_interfaces = -1, enable_bytes = -1, enable_packets = -1, enable_dropped = -1, enable_tokens = -1, enable_ctokens = -1, enabled_all_classes_qdiscs = -1; - - if(unlikely(enable_new_interfaces == -1)) { - enable_new_interfaces = config_get_boolean_ondemand("plugin:tc", "enable new interfaces detected at runtime", CONFIG_BOOLEAN_YES); - enable_bytes = config_get_boolean_ondemand("plugin:tc", "enable traffic charts for all interfaces", CONFIG_BOOLEAN_AUTO); - enable_packets = config_get_boolean_ondemand("plugin:tc", "enable packets charts for all interfaces", CONFIG_BOOLEAN_AUTO); - enable_dropped = config_get_boolean_ondemand("plugin:tc", "enable dropped charts for all interfaces", CONFIG_BOOLEAN_AUTO); - enable_tokens = config_get_boolean_ondemand("plugin:tc", "enable tokens charts for all interfaces", CONFIG_BOOLEAN_NO); - enable_ctokens = config_get_boolean_ondemand("plugin:tc", "enable ctokens charts for all interfaces", CONFIG_BOOLEAN_NO); - enabled_all_classes_qdiscs = config_get_boolean_ondemand("plugin:tc", "enable show all classes and qdiscs for all interfaces", CONFIG_BOOLEAN_NO); - } - - if(unlikely(d->enabled == (char)-1)) { - char var_name[CONFIG_MAX_NAME + 1]; - snprintfz(var_name, CONFIG_MAX_NAME, "qos for %s", string2str(d->id)); - - d->enabled = (char)config_get_boolean_ondemand("plugin:tc", var_name, enable_new_interfaces); - - snprintfz(var_name, CONFIG_MAX_NAME, "traffic chart for %s", string2str(d->id)); - d->enabled_bytes = (char)config_get_boolean_ondemand("plugin:tc", var_name, enable_bytes); - - snprintfz(var_name, CONFIG_MAX_NAME, "packets chart for %s", string2str(d->id)); - d->enabled_packets = (char)config_get_boolean_ondemand("plugin:tc", var_name, enable_packets); - - snprintfz(var_name, CONFIG_MAX_NAME, "dropped packets chart for %s", string2str(d->id)); - d->enabled_dropped = (char)config_get_boolean_ondemand("plugin:tc", var_name, enable_dropped); - - snprintfz(var_name, CONFIG_MAX_NAME, "tokens chart for %s", string2str(d->id)); - d->enabled_tokens = (char)config_get_boolean_ondemand("plugin:tc", var_name, enable_tokens); - - snprintfz(var_name, CONFIG_MAX_NAME, "ctokens chart for %s", string2str(d->id)); - d->enabled_ctokens = (char)config_get_boolean_ondemand("plugin:tc", var_name, enable_ctokens); - - snprintfz(var_name, CONFIG_MAX_NAME, "show all classes for %s", string2str(d->id)); - d->enabled_all_classes_qdiscs = (char)config_get_boolean_ondemand("plugin:tc", var_name, enabled_all_classes_qdiscs); - } - - // we only need to add leaf classes - struct tc_class *c, *x /*, *root = NULL */; - unsigned long long bytes_sum = 0, packets_sum = 0, dropped_sum = 0, tokens_sum = 0, ctokens_sum = 0; - int active_nodes = 0, updated_classes = 0, updated_qdiscs = 0; - - // prepare all classes - // we set reasonable defaults for the rest of the code below - - dfe_start_read(d->classes, c) { - c->render = false; // do not render this class - c->isleaf = true; // this is a leaf class - c->hasparent = false; // without a parent - - if(unlikely(!c->updated)) - c->unupdated++; // increase its unupdated counter - else { - c->unupdated = 0; // reset its unupdated counter - - // count how many of each kind - if(c->isqdisc) - updated_qdiscs++; - else - updated_classes++; - } - } - dfe_done(c); - - if(unlikely(!d->enabled || (!updated_classes && !updated_qdiscs))) { - netdata_log_debug(D_TC_LOOP, "TC: Ignoring TC device '%s'. It is not enabled/updated.", string2str(d->name?d->name:d->id)); - tc_device_classes_cleanup(d); - return; - } - - if(unlikely(updated_classes && updated_qdiscs)) { - collector_error("TC: device '%s' has active both classes (%d) and qdiscs (%d). Will render only qdiscs.", string2str(d->id), updated_classes, updated_qdiscs); - - // set all classes to !updated - dfe_start_read(d->classes, c) { - if (unlikely(!c->isqdisc && c->updated)) - c->updated = false; - } - dfe_done(c); - updated_classes = 0; - } - - // mark the classes as leafs and parents - // - // TC is hierarchical: - // - classes can have other classes in them - // - the same is true for qdiscs (i.e. qdiscs have classes, that have other qdiscs) - // - // we need to present a chart with leaf nodes only, so that the sum - // of all dimensions of the chart, will be the total utilization - // of the interface. - // - // here we try to find the ones we need to report - // by default all nodes are marked with: isleaf = 1 (see above) - // - // so, here we remove the isleaf flag from nodes in the middle - // and we add the hasparent flag to leaf nodes we found their parent - if(likely(!d->enabled_all_classes_qdiscs)) { - dfe_start_read(d->classes, c) { - if(unlikely(!c->updated)) - continue; - - //netdata_log_debug(D_TC_LOOP, "TC: In device '%s', %s '%s' has leafid: '%s' and parentid '%s'.", - // d->id, - // c->isqdisc?"qdisc":"class", - // c->id, - // c->leafid?c->leafid:"NULL", - // c->parentid?c->parentid:"NULL"); - - // find if c is leaf or not - dfe_start_read(d->classes, x) { - if(unlikely(!x->updated || c == x || !x->parentid)) - continue; - - // classes have both parentid and leafid - // qdiscs have only parentid - // the following works for both (it is an OR) - - if((x->parentid && c->id == x->parentid) || - (c->leafid && x->parentid && c->leafid == x->parentid)) { - // netdata_log_debug(D_TC_LOOP, "TC: In device '%s', %s '%s' (leafid: '%s') has as leaf %s '%s' (parentid: '%s').", d->name?d->name:d->id, c->isqdisc?"qdisc":"class", c->name?c->name:c->id, c->leafid?c->leafid:c->id, x->isqdisc?"qdisc":"class", x->name?x->name:x->id, x->parentid?x->parentid:x->id); - c->isleaf = false; - x->hasparent = true; - } - } - dfe_done(x); - } - dfe_done(c); - } - - dfe_start_read(d->classes, c) { - if(unlikely(!c->updated)) - continue; - - // netdata_log_debug(D_TC_LOOP, "TC: device '%s', %s '%s' isleaf=%d, hasparent=%d", d->id, (c->isqdisc)?"qdisc":"class", c->id, c->isleaf, c->hasparent); - - if(unlikely((c->isleaf && c->hasparent) || d->enabled_all_classes_qdiscs)) { - c->render = true; - active_nodes++; - bytes_sum += c->bytes; - packets_sum += c->packets; - dropped_sum += c->dropped; - tokens_sum += c->tokens; - ctokens_sum += c->ctokens; - } - - //if(unlikely(!c->hasparent)) { - // if(root) collector_error("TC: multiple root class/qdisc for device '%s' (old: '%s', new: '%s')", d->id, root->id, c->id); - // root = c; - // netdata_log_debug(D_TC_LOOP, "TC: found root class/qdisc '%s'", root->id); - //} - } - dfe_done(c); - -#ifdef NETDATA_INTERNAL_CHECKS - // dump all the list to see what we know - - if(unlikely(debug_flags & D_TC_LOOP)) { - dfe_start_read(d->classes, c) { - if(c->render) netdata_log_debug(D_TC_LOOP, "TC: final nodes dump for '%s': class %s, OK", string2str(d->name), string2str(c->id)); - else netdata_log_debug(D_TC_LOOP, "TC: final nodes dump for '%s': class '%s', IGNORE (updated: %d, isleaf: %d, hasparent: %d, parent: '%s')", - string2str(d->name?d->name:d->id), string2str(c->id), c->updated, c->isleaf, c->hasparent, string2str(c->parentid)); - } - dfe_done(c); - } -#endif - - if(unlikely(!active_nodes)) { - netdata_log_debug(D_TC_LOOP, "TC: Ignoring TC device '%s'. No useful classes/qdiscs.", string2str(d->name?d->name:d->id)); - tc_device_classes_cleanup(d); - return; - } - - netdata_log_debug(D_TC_LOOP, "TC: evaluating TC device '%s'. enabled = %d/%d (bytes: %d/%d, packets: %d/%d, dropped: %d/%d, tokens: %d/%d, ctokens: %d/%d, all_classes_qdiscs: %d/%d), classes: (bytes = %llu, packets = %llu, dropped = %llu, tokens = %llu, ctokens = %llu).", - string2str(d->name?d->name:d->id), - d->enabled, enable_new_interfaces, - d->enabled_bytes, enable_bytes, - d->enabled_packets, enable_packets, - d->enabled_dropped, enable_dropped, - d->enabled_tokens, enable_tokens, - d->enabled_ctokens, enable_ctokens, - d->enabled_all_classes_qdiscs, enabled_all_classes_qdiscs, - bytes_sum, - packets_sum, - dropped_sum, - tokens_sum, - ctokens_sum - ); - - // -------------------------------------------------------------------- - // bytes - - if(d->enabled_bytes == CONFIG_BOOLEAN_YES || (d->enabled_bytes == CONFIG_BOOLEAN_AUTO && - (bytes_sum || netdata_zero_metrics_enabled == CONFIG_BOOLEAN_YES))) { - d->enabled_bytes = CONFIG_BOOLEAN_YES; - - if(unlikely(!d->st_bytes)) { - d->st_bytes = rrdset_create_localhost( - RRD_TYPE_TC, - string2str(d->id), - string2str(d->name ? d->name : d->id), - string2str(d->family ? d->family : d->id), - RRD_TYPE_TC ".qos", - "Class Usage", - "kilobits/s", - PLUGIN_TC_NAME, - NULL, - NETDATA_CHART_PRIO_TC_QOS, - localhost->rrd_update_every, - d->enabled_all_classes_qdiscs ? RRDSET_TYPE_LINE : RRDSET_TYPE_STACKED); - - rrdlabels_add(d->st_bytes->rrdlabels, "device", string2str(d->id), RRDLABEL_SRC_AUTO); - rrdlabels_add(d->st_bytes->rrdlabels, "device_name", string2str(d->name?d->name:d->id), RRDLABEL_SRC_AUTO); - rrdlabels_add(d->st_bytes->rrdlabels, "device_group", string2str(d->family?d->family:d->id), RRDLABEL_SRC_AUTO); - } - else { - if(unlikely(d->name_updated)) - rrdset_reset_name(d->st_bytes, string2str(d->name)); - - if(d->name && d->name_updated) - rrdlabels_add(d->st_bytes->rrdlabels, "device_name", string2str(d->name), RRDLABEL_SRC_AUTO); - - if(d->family && d->family_updated) - rrdlabels_add(d->st_bytes->rrdlabels, "device_group", string2str(d->family), RRDLABEL_SRC_AUTO); - - // TODO - // update the family - } - - dfe_start_read(d->classes, c) { - if(unlikely(!c->render)) continue; - - if(unlikely(!c->rd_bytes)) - c->rd_bytes = rrddim_add(d->st_bytes, string2str(c->id), string2str(c->name?c->name:c->id), 8, BITS_IN_A_KILOBIT, RRD_ALGORITHM_INCREMENTAL); - else if(unlikely(c->name_updated)) - rrddim_reset_name(d->st_bytes, c->rd_bytes, string2str(c->name)); - - rrddim_set_by_pointer(d->st_bytes, c->rd_bytes, c->bytes); - } - dfe_done(c); - - rrdset_done(d->st_bytes); - } - - // -------------------------------------------------------------------- - // packets - - if(d->enabled_packets == CONFIG_BOOLEAN_YES || (d->enabled_packets == CONFIG_BOOLEAN_AUTO && - (packets_sum || - netdata_zero_metrics_enabled == CONFIG_BOOLEAN_YES))) { - d->enabled_packets = CONFIG_BOOLEAN_YES; - - if(unlikely(!d->st_packets)) { - char id[RRD_ID_LENGTH_MAX + 1]; - char name[RRD_ID_LENGTH_MAX + 1]; - snprintfz(id, RRD_ID_LENGTH_MAX, "%s_packets", string2str(d->id)); - snprintfz(name, RRD_ID_LENGTH_MAX, "%s_packets", string2str(d->name ? d->name : d->id)); - - d->st_packets = rrdset_create_localhost( - RRD_TYPE_TC, - id, - name, - string2str(d->family ? d->family : d->id), - RRD_TYPE_TC ".qos_packets", - "Class Packets", - "packets/s", - PLUGIN_TC_NAME, - NULL, - NETDATA_CHART_PRIO_TC_QOS_PACKETS, - localhost->rrd_update_every, - d->enabled_all_classes_qdiscs ? RRDSET_TYPE_LINE : RRDSET_TYPE_STACKED); - - rrdlabels_add(d->st_packets->rrdlabels, "device", string2str(d->id), RRDLABEL_SRC_AUTO); - rrdlabels_add(d->st_packets->rrdlabels, "device_name", string2str(d->name?d->name:d->id), RRDLABEL_SRC_AUTO); - rrdlabels_add(d->st_packets->rrdlabels, "device_group", string2str(d->family?d->family:d->id), RRDLABEL_SRC_AUTO); - } - else { - if(unlikely(d->name_updated)) { - char name[RRD_ID_LENGTH_MAX + 1]; - snprintfz(name, RRD_ID_LENGTH_MAX, "%s_packets", string2str(d->name?d->name:d->id)); - rrdset_reset_name(d->st_packets, name); - } - - if(d->name && d->name_updated) - rrdlabels_add(d->st_packets->rrdlabels, "device_name", string2str(d->name), RRDLABEL_SRC_AUTO); - - if(d->family && d->family_updated) - rrdlabels_add(d->st_packets->rrdlabels, "device_group", string2str(d->family), RRDLABEL_SRC_AUTO); - - // TODO - // update the family - } - - dfe_start_read(d->classes, c) { - if(unlikely(!c->render)) continue; - - if(unlikely(!c->rd_packets)) - c->rd_packets = rrddim_add(d->st_packets, string2str(c->id), string2str(c->name?c->name:c->id), 1, 1, RRD_ALGORITHM_INCREMENTAL); - else if(unlikely(c->name_updated)) - rrddim_reset_name(d->st_packets, c->rd_packets, string2str(c->name)); - - rrddim_set_by_pointer(d->st_packets, c->rd_packets, c->packets); - } - dfe_done(c); - - rrdset_done(d->st_packets); - } - - // -------------------------------------------------------------------- - // dropped - - if(d->enabled_dropped == CONFIG_BOOLEAN_YES || (d->enabled_dropped == CONFIG_BOOLEAN_AUTO && - (dropped_sum || - netdata_zero_metrics_enabled == CONFIG_BOOLEAN_YES))) { - d->enabled_dropped = CONFIG_BOOLEAN_YES; - - if(unlikely(!d->st_dropped)) { - char id[RRD_ID_LENGTH_MAX + 1]; - char name[RRD_ID_LENGTH_MAX + 1]; - snprintfz(id, RRD_ID_LENGTH_MAX, "%s_dropped", string2str(d->id)); - snprintfz(name, RRD_ID_LENGTH_MAX, "%s_dropped", string2str(d->name ? d->name : d->id)); - - d->st_dropped = rrdset_create_localhost( - RRD_TYPE_TC, - id, - name, - string2str(d->family ? d->family : d->id), - RRD_TYPE_TC ".qos_dropped", - "Class Dropped Packets", - "packets/s", - PLUGIN_TC_NAME, - NULL, - NETDATA_CHART_PRIO_TC_QOS_DROPPED, - localhost->rrd_update_every, - d->enabled_all_classes_qdiscs ? RRDSET_TYPE_LINE : RRDSET_TYPE_STACKED); - - rrdlabels_add(d->st_dropped->rrdlabels, "device", string2str(d->id), RRDLABEL_SRC_AUTO); - rrdlabels_add(d->st_dropped->rrdlabels, "device_name", string2str(d->name?d->name:d->id), RRDLABEL_SRC_AUTO); - rrdlabels_add(d->st_dropped->rrdlabels, "device_group", string2str(d->family?d->family:d->id), RRDLABEL_SRC_AUTO); - } - else { - if(unlikely(d->name_updated)) { - char name[RRD_ID_LENGTH_MAX + 1]; - snprintfz(name, RRD_ID_LENGTH_MAX, "%s_dropped", string2str(d->name?d->name:d->id)); - rrdset_reset_name(d->st_dropped, name); - } - - if(d->name && d->name_updated) - rrdlabels_add(d->st_dropped->rrdlabels, "device_name", string2str(d->name), RRDLABEL_SRC_AUTO); - - if(d->family && d->family_updated) - rrdlabels_add(d->st_dropped->rrdlabels, "device_group", string2str(d->family), RRDLABEL_SRC_AUTO); - - // TODO - // update the family - } - - dfe_start_read(d->classes, c) { - if(unlikely(!c->render)) continue; - - if(unlikely(!c->rd_dropped)) - c->rd_dropped = rrddim_add(d->st_dropped, string2str(c->id), string2str(c->name?c->name:c->id), 1, 1, RRD_ALGORITHM_INCREMENTAL); - else if(unlikely(c->name_updated)) - rrddim_reset_name(d->st_dropped, c->rd_dropped, string2str(c->name)); - - rrddim_set_by_pointer(d->st_dropped, c->rd_dropped, c->dropped); - } - dfe_done(c); - - rrdset_done(d->st_dropped); - } - - // -------------------------------------------------------------------- - // tokens - - if(d->enabled_tokens == CONFIG_BOOLEAN_YES || (d->enabled_tokens == CONFIG_BOOLEAN_AUTO && - (tokens_sum || - netdata_zero_metrics_enabled == CONFIG_BOOLEAN_YES))) { - d->enabled_tokens = CONFIG_BOOLEAN_YES; - - if(unlikely(!d->st_tokens)) { - char id[RRD_ID_LENGTH_MAX + 1]; - char name[RRD_ID_LENGTH_MAX + 1]; - snprintfz(id, RRD_ID_LENGTH_MAX, "%s_tokens", string2str(d->id)); - snprintfz(name, RRD_ID_LENGTH_MAX, "%s_tokens", string2str(d->name ? d->name : d->id)); - - d->st_tokens = rrdset_create_localhost( - RRD_TYPE_TC, - id, - name, - string2str(d->family ? d->family : d->id), - RRD_TYPE_TC ".qos_tokens", - "Class Tokens", - "tokens", - PLUGIN_TC_NAME, - NULL, - NETDATA_CHART_PRIO_TC_QOS_TOKENS, - localhost->rrd_update_every, - RRDSET_TYPE_LINE); - - rrdlabels_add(d->st_tokens->rrdlabels, "device", string2str(d->id), RRDLABEL_SRC_AUTO); - rrdlabels_add(d->st_tokens->rrdlabels, "device_name", string2str(d->name?d->name:d->id), RRDLABEL_SRC_AUTO); - rrdlabels_add(d->st_tokens->rrdlabels, "device_group", string2str(d->family?d->family:d->id), RRDLABEL_SRC_AUTO); - } - else { - if(unlikely(d->name_updated)) { - char name[RRD_ID_LENGTH_MAX + 1]; - snprintfz(name, RRD_ID_LENGTH_MAX, "%s_tokens", string2str(d->name?d->name:d->id)); - rrdset_reset_name(d->st_tokens, name); - } - - if(d->name && d->name_updated) - rrdlabels_add(d->st_tokens->rrdlabels, "device_name", string2str(d->name), RRDLABEL_SRC_AUTO); - - if(d->family && d->family_updated) - rrdlabels_add(d->st_tokens->rrdlabels, "device_group", string2str(d->family), RRDLABEL_SRC_AUTO); - - // TODO - // update the family - } - - dfe_start_read(d->classes, c) { - if(unlikely(!c->render)) continue; - - if(unlikely(!c->rd_tokens)) { - c->rd_tokens = rrddim_add(d->st_tokens, string2str(c->id), string2str(c->name?c->name:c->id), 1, 1, RRD_ALGORITHM_ABSOLUTE); - } - else if(unlikely(c->name_updated)) - rrddim_reset_name(d->st_tokens, c->rd_tokens, string2str(c->name)); - - rrddim_set_by_pointer(d->st_tokens, c->rd_tokens, c->tokens); - } - dfe_done(c); - - rrdset_done(d->st_tokens); - } - - // -------------------------------------------------------------------- - // ctokens - - if(d->enabled_ctokens == CONFIG_BOOLEAN_YES || (d->enabled_ctokens == CONFIG_BOOLEAN_AUTO && - (ctokens_sum || - netdata_zero_metrics_enabled == CONFIG_BOOLEAN_YES))) { - d->enabled_ctokens = CONFIG_BOOLEAN_YES; - - if(unlikely(!d->st_ctokens)) { - char id[RRD_ID_LENGTH_MAX + 1]; - char name[RRD_ID_LENGTH_MAX + 1]; - snprintfz(id, RRD_ID_LENGTH_MAX, "%s_ctokens", string2str(d->id)); - snprintfz(name, RRD_ID_LENGTH_MAX, "%s_ctokens", string2str(d->name ? d->name : d->id)); - - d->st_ctokens = rrdset_create_localhost( - RRD_TYPE_TC, - id, - name, - string2str(d->family ? d->family : d->id), - RRD_TYPE_TC ".qos_ctokens", - "Class cTokens", - "ctokens", - PLUGIN_TC_NAME, - NULL, - NETDATA_CHART_PRIO_TC_QOS_CTOKENS, - localhost->rrd_update_every, - RRDSET_TYPE_LINE); - - rrdlabels_add(d->st_ctokens->rrdlabels, "device", string2str(d->id), RRDLABEL_SRC_AUTO); - rrdlabels_add(d->st_ctokens->rrdlabels, "device_name", string2str(d->name?d->name:d->id), RRDLABEL_SRC_AUTO); - rrdlabels_add(d->st_ctokens->rrdlabels, "device_group", string2str(d->family?d->family:d->id), RRDLABEL_SRC_AUTO); - } - else { - netdata_log_debug(D_TC_LOOP, "TC: Updating _ctokens chart for device '%s'", string2str(d->name?d->name:d->id)); - - if(unlikely(d->name_updated)) { - char name[RRD_ID_LENGTH_MAX + 1]; - snprintfz(name, RRD_ID_LENGTH_MAX, "%s_ctokens", string2str(d->name?d->name:d->id)); - rrdset_reset_name(d->st_ctokens, name); - } - - if(d->name && d->name_updated) - rrdlabels_add(d->st_ctokens->rrdlabels, "device_name", string2str(d->name), RRDLABEL_SRC_AUTO); - - if(d->family && d->family_updated) - rrdlabels_add(d->st_ctokens->rrdlabels, "device_group", string2str(d->family), RRDLABEL_SRC_AUTO); - - // TODO - // update the family - } - - dfe_start_read(d->classes, c) { - if(unlikely(!c->render)) continue; - - if(unlikely(!c->rd_ctokens)) - c->rd_ctokens = rrddim_add(d->st_ctokens, string2str(c->id), string2str(c->name?c->name:c->id), 1, 1, RRD_ALGORITHM_ABSOLUTE); - else if(unlikely(c->name_updated)) - rrddim_reset_name(d->st_ctokens, c->rd_ctokens, string2str(c->name)); - - rrddim_set_by_pointer(d->st_ctokens, c->rd_ctokens, c->ctokens); - } - dfe_done(c); - - rrdset_done(d->st_ctokens); - } - - tc_device_classes_cleanup(d); -} - -static inline void tc_device_set_class_name(struct tc_device *d, char *id, char *name) { - if(unlikely(!name || !*name)) return; - - struct tc_class *c = tc_class_index_find(d, id); - if(likely(c)) { - if(likely(c->name)) { - if(!strcmp(string2str(c->name), name)) return; - string_freez(c->name); - c->name = NULL; - } - - if(likely(name && *name && strcmp(string2str(c->id), name) != 0)) { - netdata_log_debug(D_TC_LOOP, "TC: Setting device '%s', class '%s' name to '%s'", string2str(d->id), id, name); - c->name = string_strdupz(name); - c->name_updated = true; - } - } -} - -static inline void tc_device_set_device_name(struct tc_device *d, char *name) { - if(unlikely(!name || !*name)) return; - - if(d->name) { - if(!strcmp(string2str(d->name), name)) return; - string_freez(d->name); - d->name = NULL; - } - - if(likely(name && *name && strcmp(string2str(d->id), name) != 0)) { - netdata_log_debug(D_TC_LOOP, "TC: Setting device '%s' name to '%s'", string2str(d->id), name); - d->name = string_strdupz(name); - d->name_updated = true; - } -} - -static inline void tc_device_set_device_family(struct tc_device *d, char *family) { - string_freez(d->family); - d->family = NULL; - - if(likely(family && *family && strcmp(string2str(d->id), family) != 0)) { - netdata_log_debug(D_TC_LOOP, "TC: Setting device '%s' family to '%s'", string2str(d->id), family); - d->family = string_strdupz(family); - d->family_updated = true; - } - // no need for null termination - it is already null -} - -static inline struct tc_device *tc_device_create(char *id) { - struct tc_device *d = tc_device_index_find(id); - - if(!d) { - netdata_log_debug(D_TC_LOOP, "TC: Creating device '%s'", id); - - struct tc_device tmp = { - .id = string_strdupz(id), - .enabled = (char)-1, - }; - d = tc_device_index_add(&tmp); - } - - return(d); -} - -static inline struct tc_class *tc_class_add(struct tc_device *n, char *id, bool qdisc, char *parentid, char *leafid) { - struct tc_class *c = tc_class_index_find(n, id); - - if(!c) { - netdata_log_debug(D_TC_LOOP, "TC: Creating in device '%s', class id '%s', parentid '%s', leafid '%s'", - string2str(n->id), id, parentid?parentid:"", leafid?leafid:""); - - struct tc_class tmp = { - .id = string_strdupz(id), - .isqdisc = qdisc, - .parentid = string_strdupz(parentid), - .leafid = string_strdupz(leafid), - }; - - tc_class_index_add(n, &tmp); - } - return(c); -} - -//static inline void tc_device_free(struct tc_device *d) { -// tc_device_index_del(d); -//} - -static inline int tc_space(char c) { - switch(c) { - case ' ': - case '\t': - case '\r': - case '\n': - return 1; - - default: - return 0; - } -} - -static inline void tc_split_words(char *str, char **words, int max_words) { - char *s = str; - int i = 0; - - // skip all white space - while(tc_space(*s)) s++; - - // store the first word - words[i++] = s; - - // while we have something - while(*s) { - // if it is a space - if(unlikely(tc_space(*s))) { - - // terminate the word - *s++ = '\0'; - - // skip all white space - while(tc_space(*s)) s++; - - // if we reached the end, stop - if(!*s) break; - - // store the next word - if(i < max_words) words[i++] = s; - else break; - } - else s++; - } - - // terminate the words - while(i < max_words) words[i++] = NULL; -} - -static pid_t tc_child_pid = 0; - -static void tc_main_cleanup(void *ptr) { - worker_unregister(); - - tc_device_index_destroy(); - - struct netdata_static_thread *static_thread = (struct netdata_static_thread *)ptr; - static_thread->enabled = NETDATA_MAIN_THREAD_EXITING; - - collector_info("cleaning up..."); - - if(tc_child_pid) { - collector_info("TC: killing with SIGTERM tc-qos-helper process %d", tc_child_pid); - if(killpid(tc_child_pid) != -1) { - siginfo_t info; - - collector_info("TC: waiting for tc plugin child process pid %d to exit...", tc_child_pid); - netdata_waitid(P_PID, (id_t) tc_child_pid, &info, WEXITED); - } - - tc_child_pid = 0; - } - - static_thread->enabled = NETDATA_MAIN_THREAD_EXITED; -} - -#define WORKER_TC_CLASS 0 -#define WORKER_TC_BEGIN 1 -#define WORKER_TC_END 2 -#define WORKER_TC_SENT 3 -#define WORKER_TC_LENDED 4 -#define WORKER_TC_TOKENS 5 -#define WORKER_TC_SETDEVICENAME 6 -#define WORKER_TC_SETDEVICEGROUP 7 -#define WORKER_TC_SETCLASSNAME 8 -#define WORKER_TC_WORKTIME 9 -#define WORKER_TC_PLUGIN_TIME 10 -#define WORKER_TC_DEVICES 11 -#define WORKER_TC_CLASSES 12 - -#if WORKER_UTILIZATION_MAX_JOB_TYPES < 13 -#error WORKER_UTILIZATION_MAX_JOB_TYPES has to be at least 10 -#endif - -void *tc_main(void *ptr) { - worker_register("TC"); - worker_register_job_name(WORKER_TC_CLASS, "class"); - worker_register_job_name(WORKER_TC_BEGIN, "begin"); - worker_register_job_name(WORKER_TC_END, "end"); - worker_register_job_name(WORKER_TC_SENT, "sent"); - worker_register_job_name(WORKER_TC_LENDED, "lended"); - worker_register_job_name(WORKER_TC_TOKENS, "tokens"); - worker_register_job_name(WORKER_TC_SETDEVICENAME, "devicename"); - worker_register_job_name(WORKER_TC_SETDEVICEGROUP, "devicegroup"); - worker_register_job_name(WORKER_TC_SETCLASSNAME, "classname"); - worker_register_job_name(WORKER_TC_WORKTIME, "worktime"); - - worker_register_job_custom_metric(WORKER_TC_PLUGIN_TIME, "tc script execution time", "milliseconds/run", WORKER_METRIC_ABSOLUTE); - worker_register_job_custom_metric(WORKER_TC_DEVICES, "number of devices", "devices", WORKER_METRIC_ABSOLUTE); - worker_register_job_custom_metric(WORKER_TC_CLASSES, "number of classes", "classes", WORKER_METRIC_ABSOLUTE); - - tc_device_index_init(); - netdata_thread_cleanup_push(tc_main_cleanup, ptr); - - char command[FILENAME_MAX + 1]; - char *words[PLUGINSD_MAX_WORDS] = { NULL }; - - uint32_t BEGIN_HASH = simple_hash("BEGIN"); - uint32_t END_HASH = simple_hash("END"); - uint32_t QDISC_HASH = simple_hash("qdisc"); - uint32_t CLASS_HASH = simple_hash("class"); - uint32_t SENT_HASH = simple_hash("Sent"); - uint32_t LENDED_HASH = simple_hash("lended:"); - uint32_t TOKENS_HASH = simple_hash("tokens:"); - uint32_t SETDEVICENAME_HASH = simple_hash("SETDEVICENAME"); - uint32_t SETDEVICEGROUP_HASH = simple_hash("SETDEVICEGROUP"); - uint32_t SETCLASSNAME_HASH = simple_hash("SETCLASSNAME"); - uint32_t WORKTIME_HASH = simple_hash("WORKTIME"); - uint32_t first_hash; - - snprintfz(command, TC_LINE_MAX, "%s/tc-qos-helper.sh", netdata_configured_primary_plugins_dir); - char *tc_script = config_get("plugin:tc", "script to run to get tc values", command); - - while(service_running(SERVICE_COLLECTORS)) { - FILE *fp_child_input, *fp_child_output; - struct tc_device *device = NULL; - struct tc_class *class = NULL; - - snprintfz(command, TC_LINE_MAX, "exec %s %d", tc_script, localhost->rrd_update_every); - netdata_log_debug(D_TC_LOOP, "executing '%s'", command); - - fp_child_output = netdata_popen(command, (pid_t *)&tc_child_pid, &fp_child_input); - if(unlikely(!fp_child_output)) { - collector_error("TC: Cannot popen(\"%s\", \"r\").", command); - goto cleanup; - } - - char buffer[TC_LINE_MAX+1] = ""; - while(fgets(buffer, TC_LINE_MAX, fp_child_output) != NULL) { - if(unlikely(!service_running(SERVICE_COLLECTORS))) break; - - buffer[TC_LINE_MAX] = '\0'; - // netdata_log_debug(D_TC_LOOP, "TC: read '%s'", buffer); - - tc_split_words(buffer, words, PLUGINSD_MAX_WORDS); - - if(unlikely(!words[0] || !*words[0])) { - // netdata_log_debug(D_TC_LOOP, "empty line"); - worker_is_idle(); - continue; - } - // else netdata_log_debug(D_TC_LOOP, "First word is '%s'", words[0]); - - first_hash = simple_hash(words[0]); - - if(unlikely(device && ((first_hash == CLASS_HASH && strcmp(words[0], "class") == 0) || (first_hash == QDISC_HASH && strcmp(words[0], "qdisc") == 0)))) { - worker_is_busy(WORKER_TC_CLASS); - - // netdata_log_debug(D_TC_LOOP, "CLASS line on class id='%s', parent='%s', parentid='%s', leaf='%s', leafid='%s'", words[2], words[3], words[4], words[5], words[6]); - - char *type = words[1]; // the class/qdisc type: htb, fq_codel, etc - char *id = words[2]; // the class/qdisc major:minor - char *parent = words[3]; // the word 'parent' or 'root' - char *parentid = words[4]; // parentid - char *leaf = words[5]; // the word 'leaf' - char *leafid = words[6]; // leafid - - int parent_is_root = 0; - int parent_is_parent = 0; - if(likely(parent)) { - parent_is_parent = !strcmp(parent, "parent"); - - if(!parent_is_parent) - parent_is_root = !strcmp(parent, "root"); - } - - if(likely(type && id && (parent_is_root || parent_is_parent))) { - bool qdisc = false; - - if(first_hash == QDISC_HASH) { - qdisc = true; - - if(!strcmp(type, "ingress")) { - // we don't want to get the ingress qdisc - // there should be an IFB interface for this - - class = NULL; - worker_is_idle(); - continue; - } - - if(parent_is_parent && parentid) { - // eliminate the minor number from parentid - // why: parentid is the id of the parent class - // but major: is also the id of the parent qdisc - - char *s = parentid; - while(*s && *s != ':') s++; - if(*s == ':') s[1] = '\0'; - } - } - - if(parent_is_root) { - parentid = NULL; - leafid = NULL; - } - else if(!leaf || strcmp(leaf, "leaf") != 0) - leafid = NULL; - - char leafbuf[20 + 1] = ""; - if(leafid && leafid[strlen(leafid) - 1] == ':') { - strncpyz(leafbuf, leafid, 20 - 1); - strcat(leafbuf, "1"); - leafid = leafbuf; - } - - class = tc_class_add(device, id, qdisc, parentid, leafid); - } - else { - // clear the last class - class = NULL; - } - } - else if(unlikely(first_hash == END_HASH && strcmp(words[0], "END") == 0)) { - worker_is_busy(WORKER_TC_END); - - // netdata_log_debug(D_TC_LOOP, "END line"); - - if(likely(device)) { - netdata_thread_disable_cancelability(); - tc_device_commit(device); - // tc_device_free(device); - netdata_thread_enable_cancelability(); - } - - device = NULL; - class = NULL; - } - else if(unlikely(first_hash == BEGIN_HASH && strcmp(words[0], "BEGIN") == 0)) { - worker_is_busy(WORKER_TC_BEGIN); - - // netdata_log_debug(D_TC_LOOP, "BEGIN line on device '%s'", words[1]); - - if(likely(words[1] && *words[1])) { - device = tc_device_create(words[1]); - } - else { - // tc_device_free(device); - device = NULL; - } - - class = NULL; - } - else if(unlikely(device && class && first_hash == SENT_HASH && strcmp(words[0], "Sent") == 0)) { - worker_is_busy(WORKER_TC_SENT); - - // netdata_log_debug(D_TC_LOOP, "SENT line '%s'", words[1]); - if(likely(words[1] && *words[1])) { - class->bytes = str2ull(words[1], NULL); - class->updated = true; - } - else { - class->updated = false; - } - - if(likely(words[3] && *words[3])) - class->packets = str2ull(words[3], NULL); - - if(likely(words[6] && *words[6])) - class->dropped = str2ull(words[6], NULL); - - //if(likely(words[8] && *words[8])) - // class->overlimits = str2ull(words[8]); - - //if(likely(words[10] && *words[10])) - // class->requeues = str2ull(words[8]); - } - else if(unlikely(device && class && class->updated && first_hash == LENDED_HASH && strcmp(words[0], "lended:") == 0)) { - worker_is_busy(WORKER_TC_LENDED); - - // netdata_log_debug(D_TC_LOOP, "LENDED line '%s'", words[1]); - //if(likely(words[1] && *words[1])) - // class->lended = str2ull(words[1]); - - //if(likely(words[3] && *words[3])) - // class->borrowed = str2ull(words[3]); - - //if(likely(words[5] && *words[5])) - // class->giants = str2ull(words[5]); - } - else if(unlikely(device && class && class->updated && first_hash == TOKENS_HASH && strcmp(words[0], "tokens:") == 0)) { - worker_is_busy(WORKER_TC_TOKENS); - - // netdata_log_debug(D_TC_LOOP, "TOKENS line '%s'", words[1]); - if(likely(words[1] && *words[1])) - class->tokens = str2ull(words[1], NULL); - - if(likely(words[3] && *words[3])) - class->ctokens = str2ull(words[3], NULL); - } - else if(unlikely(device && first_hash == SETDEVICENAME_HASH && strcmp(words[0], "SETDEVICENAME") == 0)) { - worker_is_busy(WORKER_TC_SETDEVICENAME); - - // netdata_log_debug(D_TC_LOOP, "SETDEVICENAME line '%s'", words[1]); - if(likely(words[1] && *words[1])) - tc_device_set_device_name(device, words[1]); - } - else if(unlikely(device && first_hash == SETDEVICEGROUP_HASH && strcmp(words[0], "SETDEVICEGROUP") == 0)) { - worker_is_busy(WORKER_TC_SETDEVICEGROUP); - - // netdata_log_debug(D_TC_LOOP, "SETDEVICEGROUP line '%s'", words[1]); - if(likely(words[1] && *words[1])) - tc_device_set_device_family(device, words[1]); - } - else if(unlikely(device && first_hash == SETCLASSNAME_HASH && strcmp(words[0], "SETCLASSNAME") == 0)) { - worker_is_busy(WORKER_TC_SETCLASSNAME); - - // netdata_log_debug(D_TC_LOOP, "SETCLASSNAME line '%s' '%s'", words[1], words[2]); - char *id = words[1]; - char *path = words[2]; - if(likely(id && *id && path && *path)) - tc_device_set_class_name(device, id, path); - } - else if(unlikely(first_hash == WORKTIME_HASH && strcmp(words[0], "WORKTIME") == 0)) { - worker_is_busy(WORKER_TC_WORKTIME); - worker_set_metric(WORKER_TC_PLUGIN_TIME, str2ll(words[1], NULL)); - - size_t number_of_devices = dictionary_entries(tc_device_root_index); - size_t number_of_classes = 0; - - struct tc_device *d; - dfe_start_read(tc_device_root_index, d) { - number_of_classes += dictionary_entries(d->classes); - } - dfe_done(d); - - worker_set_metric(WORKER_TC_DEVICES, number_of_devices); - worker_set_metric(WORKER_TC_CLASSES, number_of_classes); - } - //else { - // netdata_log_debug(D_TC_LOOP, "IGNORED line"); - //} - - worker_is_idle(); - } - - // fgets() failed or loop broke - int code = netdata_pclose(fp_child_input, fp_child_output, (pid_t)tc_child_pid); - tc_child_pid = 0; - - if(unlikely(device)) { - // tc_device_free(device); - device = NULL; - class = NULL; - } - - if(unlikely(!service_running(SERVICE_COLLECTORS))) - goto cleanup; - - if(code == 1 || code == 127) { - // 1 = DISABLE - // 127 = cannot even run it - collector_error("TC: tc-qos-helper.sh exited with code %d. Disabling it.", code); - goto cleanup; - } - - sleep((unsigned int) localhost->rrd_update_every); - } - -cleanup: ; // added semi-colon to prevent older gcc error: label at end of compound statement - worker_unregister(); - netdata_thread_cleanup_pop(1); - return NULL; -} diff --git a/collectors/tc.plugin/tc-qos-helper.sh.in b/collectors/tc.plugin/tc-qos-helper.sh.in deleted file mode 100755 index 3298c39a3..000000000 --- a/collectors/tc.plugin/tc-qos-helper.sh.in +++ /dev/null @@ -1,356 +0,0 @@ -#!/usr/bin/env bash - -# netdata -# real-time performance and health monitoring, done right! -# (C) 2023 Netdata Inc. -# SPDX-License-Identifier: GPL-3.0-or-later -# -# This script is a helper to allow netdata collect tc data. -# tc output parsing has been implemented in C, inside netdata -# This script allows setting names to dimensions. - -export PATH="${PATH}:/sbin:/usr/sbin:/usr/local/sbin:@sbindir_POST@" -export LC_ALL=C - -cmd_line="'${0}' $(printf "'%s' " "${@}")" - -# ----------------------------------------------------------------------------- -# logging - -PROGRAM_NAME="$(basename "${0}")" -PROGRAM_NAME="${PROGRAM_NAME/.plugin/}" - -# these should be the same with syslog() priorities -NDLP_EMERG=0 # system is unusable -NDLP_ALERT=1 # action must be taken immediately -NDLP_CRIT=2 # critical conditions -NDLP_ERR=3 # error conditions -NDLP_WARN=4 # warning conditions -NDLP_NOTICE=5 # normal but significant condition -NDLP_INFO=6 # informational -NDLP_DEBUG=7 # debug-level messages - -# the max (numerically) log level we will log -LOG_LEVEL=$NDLP_INFO - -set_log_min_priority() { - case "${NETDATA_LOG_LEVEL,,}" in - "emerg" | "emergency") - LOG_LEVEL=$NDLP_EMERG - ;; - - "alert") - LOG_LEVEL=$NDLP_ALERT - ;; - - "crit" | "critical") - LOG_LEVEL=$NDLP_CRIT - ;; - - "err" | "error") - LOG_LEVEL=$NDLP_ERR - ;; - - "warn" | "warning") - LOG_LEVEL=$NDLP_WARN - ;; - - "notice") - LOG_LEVEL=$NDLP_NOTICE - ;; - - "info") - LOG_LEVEL=$NDLP_INFO - ;; - - "debug") - LOG_LEVEL=$NDLP_DEBUG - ;; - esac -} - -set_log_min_priority - -log() { - local level="${1}" - shift 1 - - [[ -n "$level" && -n "$LOG_LEVEL" && "$level" -gt "$LOG_LEVEL" ]] && return - - systemd-cat-native --log-as-netdata --newline="--NEWLINE--" <<EOFLOG -INVOCATION_ID=${NETDATA_INVOCATION_ID} -SYSLOG_IDENTIFIER=${PROGRAM_NAME} -PRIORITY=${level} -THREAD_TAG=tc-qos-helper -ND_LOG_SOURCE=collector -ND_REQUEST=${cmd_line} -MESSAGE=${*//\\n/--NEWLINE--} - -EOFLOG - # AN EMPTY LINE IS NEEDED ABOVE -} - -info() { - log "$NDLP_INFO" "${@}" -} - -warning() { - log "$NDLP_WARN" "${@}" -} - -error() { - log "$NDLP_ERR" "${@}" -} - -fatal() { - log "$NDLP_ALERT" "${@}" - exit 1 -} - -debug() { - log "$NDLP_DEBUG" "${@}" -} - -# ----------------------------------------------------------------------------- -# find /var/run/fireqos - -# the default -fireqos_run_dir="/var/run/fireqos" - -function realdir() { - local r - local t - r="$1" - t="$(readlink "$r")" - - while [ "$t" ]; do - r=$(cd "$(dirname "$r")" && cd "$(dirname "$t")" && pwd -P)/$(basename "$t") - t=$(readlink "$r") - done - - dirname "$r" -} - -if [ ! -d "${fireqos_run_dir}" ]; then - - # the fireqos executable - we will use it to find its config - fireqos="$(command -v fireqos 2>/dev/null)" - - if [ -n "${fireqos}" ]; then - - fireqos_exec_dir="$(realdir "${fireqos}")" - - if [ -n "${fireqos_exec_dir}" ] && [ "${fireqos_exec_dir}" != "." ] && [ -f "${fireqos_exec_dir}/install.config" ]; then - LOCALSTATEDIR= - #shellcheck source=/dev/null - source "${fireqos_exec_dir}/install.config" - - if [ -d "${LOCALSTATEDIR}/run/fireqos" ]; then - fireqos_run_dir="${LOCALSTATEDIR}/run/fireqos" - else - warning "FireQOS is installed as '${fireqos}', its installation config at '${fireqos_exec_dir}/install.config' specifies local state data at '${LOCALSTATEDIR}/run/fireqos', but this directory is not found or is not readable (check the permissions of its parents)." - fi - else - warning "Although FireQOS is installed on this system as '${fireqos}', I cannot find/read its installation configuration at '${fireqos_exec_dir}/install.config'." - fi - else - warning "FireQOS is not installed on this system. Use FireQOS to apply traffic QoS and expose the class names to netdata. Check https://github.com/netdata/netdata/tree/master/collectors/tc.plugin#tcplugin" - fi -fi - -# ----------------------------------------------------------------------------- - -[ -z "${NETDATA_PLUGINS_DIR}" ] && NETDATA_PLUGINS_DIR="$(dirname "${0}")" -[ -z "${NETDATA_USER_CONFIG_DIR}" ] && NETDATA_USER_CONFIG_DIR="@configdir_POST@" -[ -z "${NETDATA_STOCK_CONFIG_DIR}" ] && NETDATA_STOCK_CONFIG_DIR="@libconfigdir_POST@" - -plugins_dir="${NETDATA_PLUGINS_DIR}" -tc="$(command -v tc 2>/dev/null)" - -# ----------------------------------------------------------------------------- -# user configuration - -# time in seconds to refresh QoS class/qdisc names -qos_get_class_names_every=120 - -# time in seconds to exit - netdata will restart the script -qos_exit_every=3600 - -# what to use? classes or qdiscs? -tc_show="qdisc" # can also be "class" - -# ----------------------------------------------------------------------------- -# check if we have a valid number for interval - -t=${1} -update_every=$((t)) -[ $((update_every)) -lt 1 ] && update_every=${NETDATA_UPDATE_EVERY} -[ $((update_every)) -lt 1 ] && update_every=1 - -# ----------------------------------------------------------------------------- -# allow the user to override our defaults - -for CONFIG in "${NETDATA_STOCK_CONFIG_DIR}/tc-qos-helper.conf" "${NETDATA_USER_CONFIG_DIR}/tc-qos-helper.conf"; do - if [ -f "${CONFIG}" ]; then - info "Loading config file '${CONFIG}'..." - #shellcheck source=/dev/null - source "${CONFIG}" || error "Failed to load config file '${CONFIG}'." - else - warning "Cannot find file '${CONFIG}'." - fi -done - -case "${tc_show}" in -qdisc | class) ;; - -*) - error "tc_show variable can be either 'qdisc' or 'class' but is set to '${tc_show}'. Assuming it is 'qdisc'." - tc_show="qdisc" - ;; -esac - -# ----------------------------------------------------------------------------- -# default sleep function - -LOOPSLEEPMS_LASTWORK=0 -loopsleepms() { - sleep "$1" -} - -# if found and included, this file overwrites loopsleepms() -# with a high resolution timer function for precise looping. -#shellcheck source=/dev/null -. "${plugins_dir}/loopsleepms.sh.inc" - -# ----------------------------------------------------------------------------- -# final checks we can run - -if [ -z "${tc}" ] || [ ! -x "${tc}" ]; then - fatal "cannot find command 'tc' in this system." -fi - -tc_devices= -fix_names= - -# ----------------------------------------------------------------------------- - -setclassname() { - if [ "${tc_show}" = "qdisc" ]; then - echo "SETCLASSNAME $4 $2" - else - echo "SETCLASSNAME $3 $2" - fi -} - -show_tc_cls() { - [ "${tc_show}" = "qdisc" ] && return 1 - - local x="${1}" - - if [ -f /etc/iproute2/tc_cls ]; then - local classid name rest - while read -r classid name rest; do - if [ -z "${classid}" ] || - [ -z "${name}" ] || - [ "${classid}" = "#" ] || - [ "${name}" = "#" ] || - [ "${classid:0:1}" = "#" ] || - [ "${name:0:1}" = "#" ]; then - continue - fi - setclassname "" "${name}" "${classid}" - done </etc/iproute2/tc_cls - return 0 - fi - return 1 -} - -show_fireqos_names() { - local x="${1}" name n interface_dev interface_classes_monitor - - if [ -f "${fireqos_run_dir}/ifaces/${x}" ]; then - name="$(<"${fireqos_run_dir}/ifaces/${x}")" - echo "SETDEVICENAME ${name}" || exit - - #shellcheck source=/dev/null - source "${fireqos_run_dir}/${name}.conf" - for n in ${interface_classes_monitor}; do - # shellcheck disable=SC2086 - setclassname ${n//|/ } - done - [ -n "${interface_dev}" ] && echo "SETDEVICEGROUP ${interface_dev}" || exit - - return 0 - fi - - return 1 -} - -show_tc() { - local x="${1}" - - echo "BEGIN ${x}" || exit - - # netdata can parse the output of tc - ${tc} -s ${tc_show} show dev "${x}" - - # check FireQOS names for classes - if [ -n "${fix_names}" ]; then - show_fireqos_names "${x}" || show_tc_cls "${x}" - fi - - echo "END ${x}" || exit -} - -find_tc_devices() { - local count=0 devs dev rest l - - # find all the devices in the system - # without forking - while IFS=":| " read -r dev rest; do - count=$((count + 1)) - [ ${count} -le 2 ] && continue - devs="${devs} ${dev}" - done </proc/net/dev - - # from all the devices find the ones - # that have QoS defined - # unfortunately, one fork per device cannot be avoided - tc_devices= - for dev in ${devs}; do - l="$(${tc} class show dev "${dev}" 2>/dev/null)" - [ -n "${l}" ] && tc_devices="${tc_devices} ${dev}" - done -} - -# update devices and class names -# once every 2 minutes -names_every=$((qos_get_class_names_every / update_every)) - -# exit this script every hour -# it will be restarted automatically -exit_after=$((qos_exit_every / update_every)) - -c=0 -gc=0 -while true; do - fix_names= - c=$((c + 1)) - gc=$((gc + 1)) - - if [ ${c} -le 1 ] || [ ${c} -ge ${names_every} ]; then - c=1 - fix_names="YES" - find_tc_devices - fi - - for d in ${tc_devices}; do - show_tc "${d}" - done - - echo "WORKTIME ${LOOPSLEEPMS_LASTWORK}" || exit - - loopsleepms "${update_every}" - - [ ${gc} -gt ${exit_after} ] && exit 0 -done |