@cryptotaxi247 / netdata-1 / commits / 1ac0f5cd1

Macos yaml update (#15602)

* macos_yaml: First steps (quotes and multiline) * macos_yaml: Update description * Apply suggestions from code review * macos_plugin: Remove trailling space * macos_plugin: Add description to scope * macos_plugin: Add examples * macos_plugin: Remove section_name * macos_yaml: update icon --------- Co-authored-by: Fotis Voutsas <fotis@netdata.cloud>

thiagoftsm committed Jul 28, 2023 at 13:38 UTC 1ac0f5cd1673d5bcd7465a3c948c6150f82ec539
1 file changed +233 -11
collectors/macos.plugin/multi_metadata.yaml
+233 -11
@@ -1,3 +1,5 @@
1 +# yamllint disable rule:line-length
2 +---
3 plugin_name: macos.plugin
4 modules:
5 - meta:
@@ -8,7 +10,7 @@ modules:
10 link: "https://www.apple.com/macos"
11 categories:
12 - data-collection.macos-systems
11 - icon_filename: "apple.svg"
13 + icon_filename: "macos.svg"
14 related_resources:
15 integrations:
16 list: []
@@ -22,7 +24,11 @@ modules:
24 overview:
25 data_collection:
26 metrics_description: "Monitor MacOS metrics for efficient operating system performance."
25 - method_description: ""
27 + method_description: |
28 + The plugin uses three different methods to collect data:
29 + - The function `sysctlbyname` is called to collect network, swap, loadavg, and boot time.
30 + - The functtion `host_statistic` is called to collect CPU and Virtual memory data;
31 + - The function `IOServiceGetMatchingServices` to collect storage information.
32 supported_platforms:
33 include:
34 - macOS
@@ -42,19 +48,234 @@ modules:
48 list: []
49 configuration:
50 file:
45 - name: ""
46 - description: ""
51 + name: "netdata.conf"
52 + description: "The netdata main configuration file."
53 options:
48 - description: ""
54 + description: |
55 + There are three sections in the file which you can configure:
56 +
57 + - `[plugin:macos:sysctl]` - Enable or disable monitoring for network, swap, loadavg, and boot time.
58 + - `[plugin:macos:mach_smi]` - Enable or disable monitoring for CPU and Virtual memory.
59 + - `[plugin:macos:iokit]` - Enable or disable monitoring for storage device.
60 folding:
50 - title: ""
61 + title: "Config options"
62 enabled: true
52 - list: []
63 + list:
64 + - name: enable load average
65 + section_name: plugin:macos:sysctl
66 + description: Enable or disable monitoring of load average metrics (load1, load5, load15).
67 + default_value: yes
68 + required: false
69 + - name: system swap
70 + section_name: plugin:macos:sysctl
71 + description: Enable or disable monitoring of system swap metrics (free, used).
72 + default_value: yes
73 + required: false
74 + - name: bandwidth
75 + section_name: plugin:macos:sysctl
76 + description: Enable or disable monitoring of network bandwidth metrics (received, sent).
77 + default_value: yes
78 + required: false
79 + - name: ipv4 TCP packets
80 + description: Enable or disable monitoring of IPv4 TCP total packets metrics (received, sent).
81 + section_name: plugin:macos:sysctl
82 + default_value: yes
83 + required: false
84 + - name: ipv4 TCP errors
85 + section_name: plugin:macos:sysctl
86 + description: Enable or disable monitoring of IPv4 TCP packets metrics (Input Errors, Checksum, Retransmission segments).
87 + default_value: yes
88 + required: false
89 + - name: ipv4 TCP handshake issues
90 + section_name: plugin:macos:sysctl
91 + description: Enable or disable monitoring of IPv4 TCP handshake metrics (Established Resets, Active Opens, Passive Opens, Attempt Fails).
92 + default_value: yes
93 + required: false
94 + - name: ECN packets
95 + section_name: plugin:macos:sysctl
96 + description: Enable or disable monitoring of ECN statistics metrics (InCEPkts, InNoECTPkts).
97 + default_value: auto
98 + required: false
99 + - name: TCP SYN cookies
100 + section_name: plugin:macos:sysctl
101 + description: Enable or disable monitoring of TCP SYN cookies metrics (received, sent, failed).
102 + default_value: auto
103 + required: false
104 + - name: TCP out-of-order queue
105 + section_name: plugin:macos:sysctl
106 + description: Enable or disable monitoring of TCP out-of-order queue metrics (inqueue).
107 + default_value: auto
108 + required: false
109 + - name: TCP connection aborts
110 + section_name: plugin:macos:sysctl
111 + description: Enable or disable monitoring of TCP connection aborts metrics (Bad Data, User closed, No memory, Timeout).
112 + default_value: auto
113 + required: false
114 + - name: ipv4 UDP packets
115 + section_name: plugin:macos:sysctl
116 + description: Enable or disable monitoring of ipv4 UDP packets metrics (sent, received.).
117 + default_value: yes
118 + required: false
119 + - name: ipv4 UDP errors
120 + section_name: plugin:macos:sysctl
121 + description: Enable or disable monitoring of ipv4 UDP errors metrics (Recieved Buffer error, Input Errors, No Ports, IN Checksum Errors, Ignore Multi).
122 + default_value: yes
123 + required: false
124 + - name: ipv4 icmp packets
125 + section_name: plugin:macos:sysctl
126 + description: Enable or disable monitoring of IPv4 ICMP packets metrics (sent, received, in error, OUT error, IN Checksum error).
127 + default_value: yes
128 + required: false
129 + - name: ipv4 icmp messages
130 + section_name: plugin:macos:sysctl
131 + description: Enable or disable monitoring of ipv4 ICMP messages metrics (I/O messages, I/O Errors, In Checksum).
132 + default_value: yes
133 + required: false
134 + - name: ipv4 packets
135 + section_name: plugin:macos:sysctl
136 + description: Enable or disable monitoring of ipv4 packets metrics (received, sent, forwarded, delivered).
137 + default_value: yes
138 + required: false
139 + - name: ipv4 fragments sent
140 + section_name: plugin:macos:sysctl
141 + description: Enable or disable monitoring of IPv4 fragments sent metrics (ok, fails, creates).
142 + default_value: yes
143 + required: false
144 + - name: ipv4 fragments assembly
145 + section_name: plugin:macos:sysctl
146 + description: Enable or disable monitoring of IPv4 fragments assembly metrics (ok, failed, all).
147 + default_value: yes
148 + required: false
149 + - name: ipv4 errors
150 + section_name: plugin:macos:sysctl
151 + description: Enable or disable monitoring of IPv4 errors metrics (I/O discard, I/O HDR errors, In Addr errors, In Unknown protos, OUT No Routes).
152 + default_value: yes
153 + required: false
154 + - name: ipv6 packets
155 + section_name: plugin:macos:sysctl
156 + description: Enable or disable monitoring of IPv6 packets metrics (received, sent, forwarded, delivered).
157 + default_value: auto
158 + required: false
159 + - name: ipv6 fragments sent
160 + section_name: plugin:macos:sysctl
161 + description: Enable or disable monitoring of IPv6 fragments sent metrics (ok, failed, all).
162 + default_value: auto
163 + required: false
164 + - name: ipv6 fragments assembly
165 + section_name: plugin:macos:sysctl
166 + description: Enable or disable monitoring of IPv6 fragments assembly metrics (ok, failed, timeout, all).
167 + default_value: auto
168 + required: false
169 + - name: ipv6 errors
170 + section_name: plugin:macos:sysctl
171 + description: Enable or disable monitoring of IPv6 errors metrics (I/O Discards, In Hdr Errors, In Addr Errors, In Truncaedd Packets, I/O No Routes).
172 + default_value: auto
173 + required: false
174 + - name: icmp
175 + section_name: plugin:macos:sysctl
176 + description: Enable or disable monitoring of ICMP metrics (sent, received).
177 + default_value: auto
178 + required: false
179 + - name: icmp redirects
180 + section_name: plugin:macos:sysctl
181 + description: Enable or disable monitoring of ICMP redirects metrics (received, sent).
182 + default_value: auto
183 + required: false
184 + - name: icmp errors
185 + section_name: plugin:macos:sysctl
186 + description: Enable or disable monitoring of ICMP metrics (I/O Errors, In Checksums, In Destination Unreachable, In Packet too big, In Time Exceeds, In Parm Problem, Out Dest Unreachable, Out Timee Exceeds, Out Parm Problems.).
187 + default_value: auto
188 + required: false
189 + - name: icmp echos
190 + section_name: plugin:macos:sysctl
191 + description: Enable or disable monitoring of ICMP echos metrics (I/O Echos, I/O Echo Reply).
192 + default_value: auto
193 + required: false
194 + - name: icmp router
195 + section_name: plugin:macos:sysctl
196 + description: Enable or disable monitoring of ICMP router metrics (I/O Solicits, I/O Advertisements).
197 + default_value: auto
198 + required: false
199 + - name: icmp neighbor
200 + section_name: plugin:macos:sysctl
201 + description: Enable or disable monitoring of ICMP neighbor metrics (I/O Solicits, I/O Advertisements).
202 + default_value: auto
203 + required: false
204 + - name: icmp types
205 + section_name: plugin:macos:sysctl
206 + description: Enable or disable monitoring of ICMP types metrics (I/O Type1, I/O Type128, I/O Type129, Out Type133, Out Type135, In Type136, Out Type145).
207 + default_value: auto
208 + required: false
209 + - name: space usage for all disks
210 + section_name: plugin:macos:sysctl
211 + description: Enable or disable monitoring of space usage for all disks metrics (available, used, reserved for root).
212 + default_value: yes
213 + required: false
214 + - name: inodes usage for all disks
215 + section_name: plugin:macos:sysctl
216 + description: Enable or disable monitoring of inodes usage for all disks metrics (available, used, reserved for root).
217 + default_value: yes
218 + required: false
219 + - name: bandwidth
220 + section_name: plugin:macos:sysctl
221 + description: Enable or disable monitoring of bandwidth metrics (received, sent).
222 + default_value: yes
223 + required: false
224 + - name: system uptime
225 + section_name: plugin:macos:sysctl
226 + description: Enable or disable monitoring of system uptime metrics (uptime).
227 + default_value: yes
228 + required: false
229 + - name: cpu utilization
230 + section_name: plugin:macos:mach_smi
231 + description: Enable or disable monitoring of CPU utilization metrics (user, nice, system, idel).
232 + default_value: yes
233 + required: false
234 + - name: system ram
235 + section_name: plugin:macos:mach_smi
236 + description: Enable or disable monitoring of system RAM metrics (Active, Wired, throttled, compressor, inactive, purgeable, speculative, free).
237 + default_value: yes
238 + required: false
239 + - name: swap i/o
240 + section_name: plugin:macos:mach_smi
241 + description: Enable or disable monitoring of SWAP I/O metrics (I/O Swap).
242 + default_value: yes
243 + required: false
244 + - name: memory page faults
245 + section_name: plugin:macos:mach_smi
246 + description: Enable or disable monitoring of memory page faults metrics (memory, cow, I/O page, compress, decompress, zero fill, reactivate, purge).
247 + default_value: yes
248 + required: false
249 + - name: disk i/o
250 + section_name: plugin:macos:iokit
251 + description: Enable or disable monitoring of disk I/O metrics (In, Out).
252 + default_value: yes
253 + required: false
254 examples:
255 folding:
55 - enabled: true
56 - title: ""
57 - list: []
256 + enabled: false
257 + title: "Config"
258 + list:
259 + - name: Disable swap monitoring.
260 + folding:
261 + enabled: true
262 + description: A basic example that discards swap monitoring
263 + config: |
264 + [plugin:macos:sysctl]
265 + system swap = no
266 + [plugin:macos:mach_smi]
267 + swap i/o = no
268 + - name: Disable complete Machine SMI section.
269 + folding:
270 + enabled: true
271 + description: A basic example that discards swap monitoring
272 + config: |
273 + [plugin:macos:mach_smi]
274 + cpu utilization = no
275 + system ram = no
276 + swap i/o = no
277 + memory page faults = no
278 + disk i/o = no
279 troubleshooting:
280 problems:
281 list: []
@@ -72,7 +293,8 @@ modules:
293 availability: []
294 scopes:
295 - name: global
75 - description: ""
296 + description: |
297 + These metrics refer to hardware and network monitoring.
298 labels: []
299 metrics:
300 - name: system.cpu