master
yaml 132 lines 4.33 KB
Raw
1 plugin_name: nfacct.plugin
2 modules:
3 - meta:
4 plugin_name: nfacct.plugin
5 module_name: nfacct.plugin
6 monitored_instance:
7 name: Netfilter
8 link: 'https://www.netfilter.org/'
9 categories:
10 - data-collection.networking
11 icon_filename: 'netfilter.png'
12 related_resources:
13 integrations:
14 list: []
15 info_provided_to_referring_integrations:
16 description: ''
17 keywords: []
18 overview:
19 data_collection:
20 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.'
21 method_description: 'Netdata uses libmnl (https://www.netfilter.org/projects/libmnl/index.html) to collect information.'
22 supported_platforms:
23 include: []
24 exclude: []
25 multi_instance: true
26 additional_permissions:
27 description: 'This plugin needs setuid.'
28 default_behavior:
29 auto_detection:
30 description: 'This plugin uses socket to connect with netfilter to collect data'
31 limits:
32 description: ''
33 performance_impact:
34 description: ''
35 setup:
36 prerequisites:
37 list:
38 - title: Install required packages
39 description: |
40 Install `libmnl-dev` and `libnetfilter-acct-dev` using the package manager of your system.
41 configuration:
42 file:
43 name: 'netdata.conf'
44 section_name: '[plugin:nfacct]'
45 description: 'This is netdata main configuration file'
46 options:
47 description: ''
48 folding:
49 title: 'Config options'
50 enabled: true
51 list:
52 - name: update every
53 description: Data collection frequency.
54 default_value: 1
55 required: false
56 - name: command options
57 description: Additinal parameters for collector
58 default_value: ""
59 required: false
60 examples:
61 folding:
62 enabled: true
63 title: ''
64 list: []
65 troubleshooting:
66 problems:
67 list: []
68 alerts: []
69 metrics:
70 folding:
71 title: Metrics
72 enabled: false
73 description: ""
74 availability: []
75 scopes:
76 - name: global
77 description: ""
78 labels: []
79 metrics:
80 - name: netfilter.netlink_new
81 description: Connection Tracker New Connections
82 unit: "connections/s"
83 chart_type: line
84 dimensions:
85 - name: new
86 - name: ignore
87 - name: invalid
88 - name: netfilter.netlink_changes
89 description: Connection Tracker Changes
90 unit: "changes/s"
91 chart_type: line
92 dimensions:
93 - name: insert
94 - name: delete
95 - name: delete_list
96 - name: netfilter.netlink_search
97 description: Connection Tracker Searches
98 unit: "searches/s"
99 chart_type: line
100 dimensions:
101 - name: searched
102 - name: search_restart
103 - name: found
104 - name: netfilter.netlink_errors
105 description: Connection Tracker Errors
106 unit: "events/s"
107 chart_type: line
108 dimensions:
109 - name: icmp_error
110 - name: insert_failed
111 - name: drop
112 - name: early_drop
113 - name: netfilter.netlink_expect
114 description: Connection Tracker Expectations
115 unit: "expectations/s"
116 chart_type: line
117 dimensions:
118 - name: created
119 - name: deleted
120 - name: new
121 - name: netfilter.nfacct_packets
122 description: Netfilter Accounting Packets
123 unit: "packets/s"
124 chart_type: line
125 dimensions:
126 - name: a dimension per nfacct object
127 - name: netfilter.nfacct_bytes
128 description: Netfilter Accounting Bandwidth
129 unit: "kilobytes/s"
130 chart_type: line
131 dimensions:
132 - name: a dimension per nfacct object