volker.raschek/prometheus-fail2ban-exporter
1
0
Fork 0
Code Issues Pull Requests 2 Actions Packages Projects Releases Wiki Activity

update readme content

Browse Source
This commit is contained in:
Hector 2021-08-31 10:40:52 +00:00
parent 9dee6d2ae8
commit 5039325714
1 changed files with 85 additions and 50 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

135
README.md
View File

@ -3,36 +3,75 @@
Go tool to collect and export metrics on Fail2Ban Go tool to collect and export metrics on Fail2Ban
## Table of Contents ## Table of Contents
1. How to use 1. Introduction
2. Docker 2. Running the Exporter
3. CLI usage 3. Running in Docker
4. Metrics 4. Metrics
## 1. How to use ## 1. Introduction
The exporter can collect metrics from 2 locations: the fail2ban server socket, and the fail2ban server database. The exporter can collect metrics from 2 locations: the fail2ban server socket and the fail2ban server database.
Once the exporter is running, metrics are available at `localhost:9191/metrics`. Once the exporter is running, metrics are available at `localhost:9191/metrics`.
The default port is `9191`, but this can be modified with the `-port` flag.
(The default port is `9191` but can be modified with the `-port` flag)
### 1.1. Socket ### 1.1. Socket
The recommended way to run the exporter is to point it at the fail2ban server socket. The recommended way to run the exporter is to point it at the fail2ban server socket.
This allows the exporter to communicate with the server in the same way `fail2ban-client` does and ensures the metrics it collects are exactly the same as the values reported by `fail2ban-client status <jail>`. This allows the exporter to communicate with the server the same way `fail2ban-client` does and ensures the metrics it collects align with the values reported by `fail2ban-client status <jail>`.
The default path to the socket is: `/var/run/fail2ban/fail2ban.sock` The default path to the socket is: `/var/run/fail2ban/fail2ban.sock`
### 1.2. Deprecated: Database ### 1.2. Deprecated: Database
Reading metrics from the database has been deprecated in favour of using the socket. The original way to collect metrics is to read them from the fail2ban database.
This has now been deprecated in favour of using the socket.
The reason being that database metrics do not always align with the output of `fail2ban-client status <jail>` and cause confusion. The reason being that database metrics do not always align with the output of `fail2ban-client status <jail>` and cause confusion.
See [#11]() for more details. See [#11](https://gitlab.com/hectorjsmith/fail2ban-prometheus-exporter/-/issues/11) for more details.
*To run the exporter in this mode:* If necessary, these metrics can still be exported by providing the database path to the exporter.
Run the exporter with the path to the fail2ban database. The default path to the fail2ban database is: `/var/lib/fail2ban/fail2ban.sqlite3`
The default path to the database is: `/var/lib/fail2ban/fail2ban.sqlite3`
## 2. Docker ## 2. Running the Exporter
An official docker image is available on the Gitlab container registry. The exporter is compiled and released as a single binary.
This makes it very easy to run in any environment.
No additional runtime dependencies are required.
Compiled binaries for various platforms are provided in each release.
See the [releases page](https://gitlab.com/hectorjsmith/fail2ban-prometheus-exporter/-/releases) for more information.
**Usage**
```
$ fail2ban-prometheus-exporter -h
-db string
path to the fail2ban sqlite database (deprecated)
-port int
port to use for the metrics server (default 9191)
-socket string
path to the fail2ban server socket
-version
show version info and exit
```
**Example**
```
fail2ban-prometheus-exporter -socket /var/run/fail2ban/fail2ban.sock -port 9191
```
Note that the exporter will need read access to the fail2ban socket or database.
### 2.1. Compile from Source
The code can be compiled from source by running `go build` inside the `src/` folder.
Go version `1.15` or greater is required.
Run `go mod download` to download all necessary dependencies before running the build.
## 3. Running in Docker
If use of docker is desired, an official docker image is available on the Gitlab container registry.
Use it by pulling the following image: Use it by pulling the following image:
``` ```
@ -42,7 +81,7 @@ registry.gitlab.com/hectorjsmith/fail2ban-prometheus-exporter:latest
Use the `:latest` tag to get the most up to date code (less stable) or use one of the version tagged images to use a specific release. Use the `:latest` tag to get the most up to date code (less stable) or use one of the version tagged images to use a specific release.
See the [registry page](https://gitlab.com/hectorjsmith/fail2ban-prometheus-exporter/container_registry) for all available tags. See the [registry page](https://gitlab.com/hectorjsmith/fail2ban-prometheus-exporter/container_registry) for all available tags.
### 2.1. Volumes ### 3.1. Volumes
The docker image is designed to run by mounting either the fail2ban sqlite3 database of the fail2ban run folder. The docker image is designed to run by mounting either the fail2ban sqlite3 database of the fail2ban run folder.
- The database should be mounted at: `/app/fail2ban.sqlite3` - The database should be mounted at: `/app/fail2ban.sqlite3`
@ -52,21 +91,22 @@ Both paths can be mounted with readonly (`ro`) permissions.
**NOTE:** While it is possible to mount the `fail2ban.sock` file directly, I recommend mounting the parent folder instead. **NOTE:** While it is possible to mount the `fail2ban.sock` file directly, I recommend mounting the parent folder instead.
The `.sock` file is deleted by fail2ban on shutdown and then re-created on startup and this causes problems for the docker mount. The `.sock` file is deleted by fail2ban on shutdown and then re-created on startup and this causes problems for the docker mount.
See [this reply](https://gitlab.com/hectorjsmith/fail2ban-prometheus-exporter/-/issues/11#note_665003499) for more details.
### 2.2. Docker run ### 3.2. Docker run
Use the following command to run the forwarder as a docker container. Use the following command to run the exporter as a docker container.
``` ```
docker run -d \ docker run -d \
--name "fail2ban-exporter" \ --name "fail2ban-exporter" \
-v /var/lib/fail2ban/fail2ban.sqlite3:/app/fail2ban.sqlite3:ro \ -v /var/lib/fail2ban/fail2ban.sqlite3:/app/fail2ban.sqlite3:ro \
-v /var/run/fail2ban:/var/run/fail2ban:ro \ -v /var/run/fail2ban:/var/run/fail2ban:ro \
-p "9191:9191" -p "9191:9191" \
registry.gitlab.com/hectorjsmith/fail2ban-prometheus-exporter:latest registry.gitlab.com/hectorjsmith/fail2ban-prometheus-exporter:latest
``` ```
### 2.3. Docker compose ### 3.3. Docker compose
The following is a simple docker-compose file to run the exporter. The following is a simple docker-compose file to run the exporter.
@ -82,26 +122,11 @@ services:
- "9191:9191" - "9191:9191"
``` ```
## 3. CLI usage
```
$ fail2ban-prometheus-exporter -h
-db string
path to the fail2ban sqlite database (deprecated)
-port int
port to use for the metrics server (default 9191)
-socket string
path to the fail2ban server socket
-version
show version info and exit
```
## 4. Metrics ## 4. Metrics
Access exported metrics at `/metrics` (on the provided port). Access exported metrics at the `/metrics` path on the configured port.
**Fail2Ban Jails** **Note on Fail2Ban Jails**
fail2ban can be configured to process different log files and use different rules for each one. fail2ban can be configured to process different log files and use different rules for each one.
These separate configurations are referred to as *jails*. These separate configurations are referred to as *jails*.
@ -112,7 +137,10 @@ In this configuration, there will be two jails - one for IPs banned from the SSH
This tool exports several metrics *per jail*, meaning that it is possible to track how many IPs are being banned in each jail as well as the overall total. This tool exports several metrics *per jail*, meaning that it is possible to track how many IPs are being banned in each jail as well as the overall total.
This can be useful to track what services are seeing more failed logins. This can be useful to track what services are seeing more failed logins.
### 4.1. Socket Metrics ### 4.1. Socket-based Metrics
These are the metrics exported by reading data from the fail2ban server socket.
All metrics are prefixed with `f2b_`.
Exposed metrics: Exposed metrics:
* `up` - Returns 1 if the fail2ban server is up and connection succeeds * `up` - Returns 1 if the fail2ban server is up and connection succeeds
@ -172,6 +200,13 @@ Status for the jail: sshd|- Filter
### 4.2. Database Metrics (deprecated) ### 4.2. Database Metrics (deprecated)
These are the original metrics exported by the initial release of the exporter.
They are all based on the data stored in the fail2ban sqlite3 database.
*These metrics are deprecated and will be removed in a future release.*
All metrics are prefixed with `fail2ban_`.
Exposed metrics: Exposed metrics:
* `up` - Returns 1 if the service is up * `up` - Returns 1 if the service is up
* `errors` - Returns the number of errors found since startup * `errors` - Returns the number of errors found since startup
@ -186,22 +221,22 @@ Exposed metrics:
**Sample** **Sample**
``` ```
# HELP fail2ban_bad_ips Number of bad IPs stored in the database (per jail). # HELP fail2ban_bad_ips (Deprecated) Number of bad IPs stored in the database (per jail).
# TYPE fail2ban_bad_ips gauge # TYPE fail2ban_bad_ips gauge
fail2ban_bad_ips{jail="jail1"} 6 fail2ban_bad_ips{jail="recidive"} 0
fail2ban_bad_ips{jail="jail2"} 8 fail2ban_bad_ips{jail="sshd"} 0
# HELP fail2ban_banned_ips Number of banned IPs stored in the database (per jail). # HELP fail2ban_banned_ips (Deprecated) Number of banned IPs stored in the database (per jail).
# TYPE fail2ban_banned_ips gauge # TYPE fail2ban_banned_ips gauge
fail2ban_banned_ips{jail="jail1"} 3 fail2ban_banned_ips{jail="recidive"} 0
fail2ban_banned_ips{jail="jail2"} 2 fail2ban_banned_ips{jail="sshd"} 0
# HELP fail2ban_up Was the last fail2ban query successful. # HELP fail2ban_enabled_jails (Deprecated) Enabled jails.
# TYPE fail2ban_up gauge
fail2ban_up 1
# HELP fail2ban_enabled_jails Enabled jails.
# TYPE fail2ban_enabled_jails gauge # TYPE fail2ban_enabled_jails gauge
fail2ban_enabled_jails{jail="jail1"} 1 fail2ban_enabled_jails{jail="recidive"} 1
fail2ban_enabled_jails{jail="jail2"} 1 fail2ban_enabled_jails{jail="sshd"} 1
# HELP fail2ban_errors Number of errors found since startup. # HELP fail2ban_errors (Deprecated) Number of errors found since startup.
# TYPE fail2ban_errors counter # TYPE fail2ban_errors counter
fail2ban_errors{type="db"} 0 fail2ban_errors{type="db"} 0
# HELP fail2ban_up (Deprecated) Was the last fail2ban query successful.
# TYPE fail2ban_up gauge
fail2ban_up 1
``` ```