Merging upstream version 1.42.0.

Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>

2 files changed, 114 insertions, 107 deletions

diff --git a/collectors/tc.plugin/metadata.yaml b/collectors/tc.plugin/metadata.yaml
index 2fca8d1e2..dcd03e470 100644
--- a/collectors/tc.plugin/metadata.yaml
+++ b/collectors/tc.plugin/metadata.yaml
@@ -1,102 +1,115 @@
-meta:
-  plugin_name: tc.plugin
-  module_name: tc.plugin
-  monitored_instance:
-    name: tc
-    link: ''
-    categories:
-    - data-collection.networking-stack-and-network-interfaces
-    icon_filename: 'freeradius.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: ''
-  supported_platforms:
-    include: []
-    exclude: []
-  multi-instance: true
-  additional_permissions:
-    description: ''
-  default_behavior:
-    auto_detection:
-      description: ''
-    limits:
-      description: ''
-    performance_impact:
-      description: ''
-setup:
-  prerequisites:
-    list: []
-  configuration:
-    file:
-      name: ''
-      description: ''
-    options:
-      description: ''
-      folding:
-        title: ''
-        enabled: true
-      list: []
-    examples:
-      folding:
-        enabled: true
-        title: ''
-      list: []
-troubleshooting:
-  problems:
-    list: []
-alerts: []
-metrics:
-  folding:
-    title: Metrics
-    enabled: false
-  description: ""
-  availability: []
-  scopes:
-  - name: network device, direction
-    description: ""
-    labels:
-    - name: device
-      description: TBD
-    - name: name
-      description: TBD
-    - name: family
-      description: TBD
+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: []
+      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
+        examples:
+          folding:
+            enabled: false
+            title: "Config"
+          list:
+            - name: Basic
+              description: A basic example configuration.
+              config: |
+                [plugin:tc]
+                  script to run to get tc values = /usr/libexec/netdata/plugins.d/tc-qos-helper.sh
+    troubleshooting:
+      problems:
+        list: []
+    alerts: []
     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
+      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/metrics.csv b/collectors/tc.plugin/metrics.csv
deleted file mode 100644
index b8e15649a..000000000
--- a/collectors/tc.plugin/metrics.csv
+++ /dev/null
@@ -1,6 +0,0 @@
-metric,scope,dimensions,unit,description,chart_type,labels,plugin,module
-tc.qos,"network device, direction",a dimension per class,kilobits/s,"Class Usage",stacked,"device, name, family",tc.plugin,
-tc.qos_packets,"network device, direction",a dimension per class,packets/s,"Class Packets",stacked,"device, name, family",tc.plugin,
-tc.qos_dropped,"network device, direction",a dimension per class,packets/s,"Class Dropped Packets",stacked,"device, name, family",tc.plugin,
-tc.qos_tokens,"network device, direction",a dimension per class,tokens,"Class Tokens",line,"device, name, family",tc.plugin,
-tc.qos_ctokens,"network device, direction",a dimension per class,ctokens,"Class cTokens",line,"device, name, family",tc.plugin,
\ No newline at end of file