@cryptotaxi247 / netdata
Code Commits Issues Pulls Sessions CI/CD
master
master
md 131 lines 3.27 KB
Rendered Raw
1 <!--startmeta
2 custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/collectors/freebsd.plugin/integrations/ipfw.md"
3 meta_yaml: "https://github.com/netdata/netdata/edit/master/src/collectors/freebsd.plugin/metadata.yaml"
4 sidebar_label: "ipfw"
5 learn_status: "Published"
6 learn_rel_path: "Collecting Metrics/Collectors/Networking"
7 message: "DO NOT EDIT THIS FILE DIRECTLY, IT IS GENERATED BY THE COLLECTOR'S metadata.yaml FILE"
8 endmeta-->
9
10 # ipfw
11
12
13 <img src="https://netdata.cloud/img/firewall.svg" width="150"/>
14
15
16 Plugin: freebsd.plugin
17 Module: ipfw
18
19 <img src="https://img.shields.io/badge/maintained%20by-Netdata-%2300ab44" />
20
21 ## Overview
22
23 Collect information about FreeBSD firewall.
24
25 The plugin uses RAW socket to communicate with kernel and collect data.
26
27 This collector is supported on all platforms.
28
29 This collector supports collecting metrics from multiple instances of this integration, including remote instances.
30
31
32 ### Default Behavior
33
34 #### Auto-Detection
35
36 This integration doesn't support auto-detection.
37
38 #### Limits
39
40 The default configuration for this integration does not impose any limits on data collection.
41
42 #### Performance Impact
43
44 The default configuration for this integration is not expected to impose a significant performance impact on the system.
45
46 ## Setup
47
48
49 ### Prerequisites
50
51 No action required.
52
53 ### Configuration
54
55 #### Options
56
57
58
59 <details open><summary>Config options</summary>
60
61
62
63 | Option | Description | Default | Required |
64 |:-----|:------------|:--------|:---------:|
65 | counters for static rules | Enable or disable counters for static rules metric. | yes | no |
66 | number of dynamic rules | Enable or disable number of dynamic rules metric. | yes | no |
67 | allocated memory | Enable or disable allocated memory metric. | yes | no |
68
69
70 </details>
71
72
73
74 #### via File
75
76 The configuration file name for this integration is `netdata.conf`.
77 Configuration for this specific integration is located in the `[plugin:freebsd:ipfw]` section within that file.
78
79 The file format is a modified INI syntax. The general structure is:
80
81 ```ini
82 [section1]
83 option1 = some value
84 option2 = some other value
85
86 [section2]
87 option3 = some third value
88 ```
89 You can edit the configuration file using the [`edit-config`](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#edit-configuration-files) script from the
90 Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#locate-your-config-directory).
91
92 ```bash
93 cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
94 sudo ./edit-config netdata.conf
95 ```
96
97 ##### Examples
98 There are no configuration examples.
99
100
101
102 ## Alerts
103
104 There are no alerts configured by default for this integration.
105
106
107 ## Metrics
108
109 Metrics grouped by *scope*.
110
111 The scope defines the instance that the metric belongs to. An instance is uniquely identified by a set of labels.
112
113
114
115 ### Per ipfw instance
116
117 Theese metrics show FreeBSD firewall statistics.
118
119 This scope has no labels.
120
121 Metrics:
122
123 | Metric | Dimensions | Unit |
124 |:------|:----------|:----|
125 | ipfw.mem | dynamic, static | bytes |
126 | ipfw.packets | a dimension per static rule | packets/s |
127 | ipfw.bytes | a dimension per static rule | bytes/s |
128 | ipfw.active | a dimension per dynamic rule | rules |
129 | ipfw.expired | a dimension per dynamic rule | rules |
130
131