Project: Netdata (Observability and Analysis / Observability)
File: fail2ban.md

<!--startmeta customediturl: "https://github.com/netdata/netdata/edit/master/src/go/collectors/go.d.plugin/modules/fail2ban/README.md" meta_yaml: "https://github.com/netdata/netdata/edit/master/src/go/collectors/go.d.plugin/modules/fail2ban/metadata.yaml" sidebar_label: "Fail2ban" learn_status: "Published" learnrelpath: "Collecting Metrics/Authentication and Authorization" most_popular: False message: "DO NOT EDIT THIS FILE DIRECTLY, IT IS GENERATED BY THE COLLECTOR'S metadata.yaml FILE" endmeta--> <img src="https://netdata.cloud/img/fail2ban.png" width="150"/> Plugin: go.d.plugin Module: fail2ban <img src="https://img.shields.io/badge/maintained%20by-Netdata-%2300ab44" /> This collector tracks two main metrics for each jail: currently banned IPs and active failure incidents. It relies on the CLI tool but avoids directly executing the binary. Instead, it utilizes `ndsudo`, a Netdata helper specifically designed to run privileged commands securely within the Netdata environment. This approach eliminates the need to use `sudo`, improving security and potentially simplifying permission management. This collector is supported on all platforms. This collector only supports collecting metrics from a single instance of this integration. This integration doesn't support auto-detection. The default configuration for this integration does not impose any limits on data collection. The default configuration for this integration is not expected to impose a significant performance impact on the system. Metrics grouped by scope. The scope defines the instance that the metric belongs to. An instance is uniquely identified by a set of labels. These metrics refer to the Jail. Labels: | Label | Description | |:--|:-| | jail | Jail's name | Metrics: | Metric | Dimensions | Unit | |:|:-|:-| | fail2ban.jailbannedips | banned | addresses | | fail2ban.jailactivefailures | active_failures | failures | There are no alerts configured by default for this integration. No action required. The configuration file name for this integration is `go.d/fail2ban.conf`. You can edit the configuration file using the `edit-config` script from the Netdata . ```bash cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata sudo ./edit-config go.d/fail2ban.conf ``` The following options can be defined globally: update_every. <details><summary>Config options</summary> | Name | Description | Default | Required | |:-|:--|:-|:--:| | update_every | Data collection frequency. | 10 | no | | timeout | fail2ban-client binary execution timeout. | 2 | no | </details> Allows you to override the default data collection interval. <details><summary>Config</summary> ```yaml jobs: name: fail2ban update_every: 5 # Collect Fail2Ban jails statistics every 5 seconds ``` </details> To troubleshoot issues with the `fail2ban` collector, run the `go.d.plugin` with the debug option enabled. The output should give you clues as to why the collector isn't working. Navigate to the `plugins.d` directory, usually at `/usr/libexec/netdata/plugins.d/`. If that's not the case on your system, open `netdata.conf` and look for the `plugins` setting under `[directories]`. ```bash cd /usr/libexec/netdata/plugins.d/ ``` Switch to the `netdata` user. ```bash sudo -u netdata -s ``` Run the `go.d.plugin` to debug the collector: ```bash ./go.d.plugin -d -m fail2ban ```