Update nfacct yaml (#15535)
nfacct_yaml: Update nfacct yaml
thiagoftsm committed
Jul 26, 2023 at 07:27 UTC
04275c03eb761025d60c852fa5bffb46da6a2037
1 file changed
+19
-9
collectors/nfacct.plugin/metadata.yaml
+19
-9
@@ -3,7 +3,7 @@ meta:
3
module_name: nfacct.plugin
4
monitored_instance:
5
name: Netfilter
6
- link: ''
6
+ link: 'https://www.netfilter.org/'
7
categories:
8
- data-collection.networking-stack-and-network-interfaces
9
icon_filename: 'netfilter.png'
@@ -17,33 +17,43 @@ meta:
17
overview:
18
data_collection:
19
metrics_description: 'Monitor Netfilter metrics for optimal packet filtering and manipulation. Keep tabs on packet counts, dropped packets, and error rates to secure network operations.'
20
- method_description: ''
20
+ method_description: 'Netdata uses libmnl (https://www.netfilter.org/projects/libmnl/index.html) to collect information.'
21
supported_platforms:
22
include: []
23
exclude: []
24
multi_instance: true
25
additional_permissions:
26
- description: ''
26
+ description: 'This plugin needs setuid.'
27
default_behavior:
28
auto_detection:
29
- description: ''
29
+ description: 'This plugin uses socket to connect with netfilter to collect data'
30
limits:
31
description: ''
32
performance_impact:
33
description: ''
34
setup:
35
prerequisites:
36
- list: []
36
+ list: |
37
+ It is necessary to have `libmnl` installed on host.
38
configuration:
39
file:
39
- name: ''
40
- description: ''
40
+ name: 'netdata.conf'
41
+ section_name: '[plugin:nfacct]'
42
+ description: 'This is netdata main configuration file'
43
options:
44
description: ''
45
folding:
44
- title: ''
46
+ title: 'Config options'
47
enabled: true
46
- list: []
48
+ list: |
49
+ - name: update every
50
+ description: Data collection frequency.
51
+ default_value: 1
52
+ required: false
53
+ - name: command options
54
+ description: Additinal parameters for collector
55
+ default_value:
56
+ required: false
57
examples:
58
folding:
59
enabled: true