Skip to content

Commit 30b5144

Browse files
fw bouncer metrics (#621)
* up * up * enhance: spellcheck and add a info to specify a min ver --------- Co-authored-by: Laurence <[email protected]>
1 parent 1dc7633 commit 30b5144

File tree

2 files changed

+29
-0
lines changed

2 files changed

+29
-0
lines changed
56.8 KB
Loading

crowdsec-docs/unversioned/bouncers/firewall.mdx

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -166,6 +166,35 @@ table ip6 crowdsec6 {
166166
```
167167

168168

169+
## Metrics
170+
171+
:::info
172+
CrowdSec v1.6.3 and Firewall Remediation Component v0.0.30 are minimum versions required to have metrics.
173+
:::
174+
175+
You can check the metrics generated by the firewall-bouncer using the command `cscli metrics show bouncers`.
176+
177+
![firewall-bouncer-metrics](/img/firewall-bouncer-metrics.png)
178+
179+
Each line in the output represents a different source of blocked IPs, along with detailed metrics.
180+
181+
- `Origin` refers to the name of the source, which could be:
182+
- `CAPI` - The community blocklist that you receive in exchange for the information you provide to the network
183+
- `crowdsec (security engine)` - The decisions made by your Security Engine based on triggered scenarios
184+
- `lists:*` - Various lists to which you are subscribed
185+
- `active_decisions IPs` represents the number of IPs contained in the respective list
186+
- `dropped bytes & packets` indicates the number of bytes and packets dropped by the firewall due to the actions of the specified origin
187+
- `processed bytes & packets` is only present for the `Total` line, as it denotes the overall number of bytes and packets processed by your firewall.
188+
189+
190+
As the firewall bouncer operates at the network level, most malicious programs will not progress beyond attempting to establish a connection (and being denied). Therefore, metrics cannot reflect the "potentially saved traffic."
191+
192+
### Ipset only mode
193+
194+
If you are running ipset only mode, crowdsec-firewall-bouncer tries parsing the output to produce metrics, but:
195+
- "managed" firewalls such ufw might confuse parser and lead to inconsistent metrics.
196+
- "total" counters amount since the machine start, or iptables counter are reset, which can lead to inconsistent metrics.
197+
169198
## Configuration Reference
170199

171200
You can find a default configuration hosted on the [Github Repository](https://github.com/crowdsecurity/cs-firewall-bouncer/blob/main/config/crowdsec-firewall-bouncer.yaml) this is provided with the installation package.

0 commit comments

Comments
 (0)