Improve description about tc.plugin (#16068)
thiagoftsm committed
Sep 28, 2023 at 14:53 UTC
0759dbaf5561ef3cb10bc3ab66d7470e4dab0d98
1 file changed
+35
-2
collectors/tc.plugin/metadata.yaml
+35
-2
@@ -36,7 +36,14 @@ modules:
36
description: ""
37
setup:
38
prerequisites:
39
- list: []
39
+ list:
40
+ - title: Create `tc-qos-helper.conf`
41
+ description: |
42
+ In order to view tc classes, you need to create the file `/etc/netdata/tc-qos-helper.conf` with content:
43
+
44
+ ```conf
45
+ tc_show="class"
46
+ ```
47
configuration:
48
file:
49
name: "netdata.conf"
@@ -52,16 +59,42 @@ modules:
59
description: Path to script `tc-qos-helper.sh`
60
default_value: "usr/libexec/netdata/plugins.d/tc-qos-helper.s"
61
required: false
62
+ - name: enable show all classes and qdiscs for all interfaces
63
+ description: yes/no flag to control what data is presented.
64
+ default_value: "yes"
65
+ required: false
66
examples:
67
folding:
68
enabled: false
69
title: "Config"
70
list:
71
- name: Basic
61
- description: A basic example configuration.
72
+ description: |
73
+ A basic example configuration using classes defined in `/etc/iproute2/tc_cls`.
74
+
75
+ An example of class IDs mapped to names in that file can be:
76
+
77
+ ```conf
78
+ 2:1 Standard
79
+ 2:8 LowPriorityData
80
+ 2:10 HighThroughputData
81
+ 2:16 OAM
82
+ 2:18 LowLatencyData
83
+ 2:24 BroadcastVideo
84
+ 2:26 MultimediaStreaming
85
+ 2:32 RealTimeInteractive
86
+ 2:34 MultimediaConferencing
87
+ 2:40 Signalling
88
+ 2:46 Telephony
89
+ 2:48 NetworkControl
90
+ ```
91
+
92
+ 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).
93
+
94
config: |
95
[plugin:tc]
96
script to run to get tc values = /usr/libexec/netdata/plugins.d/tc-qos-helper.sh
97
+ enable show all classes and qdiscs for all interfaces = yes
98
troubleshooting:
99
problems:
100
list: []