TC yaml update (#15562)
* tc_yaml: Change quotes ' * tc_yaml: Update information for tc plugin * tc_yaml: Modify tc plugin * tc_yaml: Update additional_description details. * Update metadata.yaml --------- Co-authored-by: Fotis Voutsas <fotis@netdata.cloud>
thiagoftsm committed
Jul 27, 2023 at 19:26 UTC
6852f377840749ec7c49c9c05e5a89df0980a97d
1 file changed
+73
-60
collectors/tc.plugin/metadata.yaml
+73
-60
@@ -1,54 +1,67 @@
1
+# yamllint disable rule:line-length
2
+---
3
meta:
4
plugin_name: tc.plugin
5
module_name: tc.plugin
6
monitored_instance:
5
- name: tc
6
- link: ''
7
+ name: tc QoS classes
8
+ link: "https://wiki.linuxfoundation.org/networking/iproute2"
9
categories:
8
- - data-collection.networking-stack-and-network-interfaces
9
- icon_filename: 'freeradius.png'
10
+ - data-collection.networking-stack-and-network-interfaces
11
+ icon_filename: "netdata.png"
12
related_resources:
13
integrations:
14
list: []
15
info_provided_to_referring_integrations:
14
- description: ''
16
+ description: ""
17
keywords: []
18
most_popular: false
19
overview:
20
data_collection:
19
- 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.'
20
- method_description: ''
21
+ 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."
22
+ method_description: "The plugin uses `tc` command to collect information about Traffic control."
23
supported_platforms:
22
- include: []
24
+ include:
25
+ - Linux
26
exclude: []
27
multi_instance: true
28
additional_permissions:
26
- description: ''
29
+ 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`."
30
default_behavior:
31
auto_detection:
29
- description: ''
32
+ description: ""
33
limits:
31
- description: ''
34
+ description: ""
35
performance_impact:
33
- description: ''
36
+ description: ""
37
setup:
38
prerequisites:
39
list: []
40
configuration:
41
file:
39
- name: ''
40
- description: ''
42
+ name: "netdata.conf"
43
+ section_name: "[plugin:tc]"
44
+ description: "The main configuration file."
45
options:
42
- description: ''
46
+ description: ""
47
folding:
44
- title: ''
48
+ title: "Config option"
49
enabled: true
46
- list: []
50
+ list:
51
+ - name: script to run to get tc values
52
+ description: Path to script `tc-qos-helper.sh`
53
+ default_value: "usr/libexec/netdata/plugins.d/tc-qos-helper.s"
54
+ required: false
55
examples:
56
folding:
49
- enabled: true
50
- title: ''
51
- list: []
57
+ enabled: false
58
+ title: "Config"
59
+ list:
60
+ - name: Basic
61
+ description: A basic example configuration.
62
+ config: |
63
+ [plugin:tc]
64
+ script to run to get tc values = /usr/libexec/netdata/plugins.d/tc-qos-helper.sh
65
troubleshooting:
66
problems:
67
list: []
@@ -60,43 +73,43 @@ metrics:
73
description: ""
74
availability: []
75
scopes:
63
- - name: network device, direction
64
- description: ""
65
- labels:
66
- - name: device
67
- description: TBD
68
- - name: name
69
- description: TBD
70
- - name: family
71
- description: TBD
72
- metrics:
73
- - name: tc.qos
74
- description: Class Usage
75
- unit: "kilobits/s"
76
- chart_type: stacked
77
- dimensions:
78
- - name: a dimension per class
79
- - name: tc.qos_packets
80
- description: Class Packets
81
- unit: "packets/s"
82
- chart_type: stacked
83
- dimensions:
84
- - name: a dimension per class
85
- - name: tc.qos_dropped
86
- description: Class Dropped Packets
87
- unit: "packets/s"
88
- chart_type: stacked
89
- dimensions:
90
- - name: a dimension per class
91
- - name: tc.qos_tokens
92
- description: Class Tokens
93
- unit: "tokens"
94
- chart_type: line
95
- dimensions:
96
- - name: a dimension per class
97
- - name: tc.qos_ctokens
98
- description: Class cTokens
99
- unit: "ctokens"
100
- chart_type: line
101
- dimensions:
102
- - name: a dimension per class
76
+ - name: network device direction
77
+ description: "Metrics related to QoS network device directions. Each direction (in/out) produces its own set of the following metrics."
78
+ labels:
79
+ - name: device
80
+ description: The network interface.
81
+ - name: device_name
82
+ description: The network interface name
83
+ - name: group
84
+ description: The device family
85
+ metrics:
86
+ - name: tc.qos
87
+ description: Class Usage
88
+ unit: "kilobits/s"
89
+ chart_type: stacked
90
+ dimensions:
91
+ - name: a dimension per class
92
+ - name: tc.qos_packets
93
+ description: Class Packets
94
+ unit: "packets/s"
95
+ chart_type: stacked
96
+ dimensions:
97
+ - name: a dimension per class
98
+ - name: tc.qos_dropped
99
+ description: Class Dropped Packets
100
+ unit: "packets/s"
101
+ chart_type: stacked
102
+ dimensions:
103
+ - name: a dimension per class
104
+ - name: tc.qos_tokens
105
+ description: Class Tokens
106
+ unit: "tokens"
107
+ chart_type: line
108
+ dimensions:
109
+ - name: a dimension per class
110
+ - name: tc.qos_ctokens
111
+ description: Class cTokens
112
+ unit: "ctokens"
113
+ chart_type: line
114
+ dimensions:
115
+ - name: a dimension per class