docs: update changelog for release

Resolve "Exporter does not fail when listening fails"

Closes #23

See merge request hectorjsmith/fail2ban-prometheus-exporter!71

CHANGELOG.md

@@ -7,6 +7,16 @@ The format is based on [Keep a Changelog], and this project adheres to [Semantic
 ## [Unreleased]
 *Nothing yet*
 
+## [0.7.1] - 2022-09-18
+
+### Fixed
+- (04b84cc) fix: report failure when server fails to start ([#23](https://gitlab.com/hectorjsmith/fail2ban-prometheus-exporter/issues/23))
+
+## [0.7.0] - 2022-06-19
+
+### Added
+- (fd58b20) feat: option to exit on socket conn error ([#21](https://gitlab.com/hectorjsmith/fail2ban-prometheus-exporter/issues/21))
+
 ## [0.6.0] - 2022-02-20
 *Rewrite CLI flags and environment variables*
 
@@ -105,10 +115,12 @@ The format is based on [Keep a Changelog], and this project adheres to [Semantic
 
 [Keep a Changelog]: https://keepachangelog.com/en/1.0.0/
 [Semantic Versioning]: https://semver.org/spec/v2.0.0.html
-[Unreleased]: https://gitlab.com/hectorjsmith/fail2ban-prometheus-exporter/compare/0.1.0...main
+[Unreleased]: https://gitlab.com/hectorjsmith/fail2ban-prometheus-exporter/compare/0.7.1...main
 [0.1.0]: https://gitlab.com/hectorjsmith/fail2ban-prometheus-exporter/compare/0.0.0...0.1.0
 [0.2.0]: https://gitlab.com/hectorjsmith/fail2ban-prometheus-exporter/compare/0.1.0...0.2.0
 [0.3.0]: https://gitlab.com/hectorjsmith/fail2ban-prometheus-exporter/compare/0.2.0...0.3.0
 [0.4.0]: https://gitlab.com/hectorjsmith/fail2ban-prometheus-exporter/compare/0.3.0...0.4.0
 [0.5.0]: https://gitlab.com/hectorjsmith/fail2ban-prometheus-exporter/compare/0.4.0...0.5.0
 [0.6.0]: https://gitlab.com/hectorjsmith/fail2ban-prometheus-exporter/compare/0.5.0...0.6.0
+[0.7.0]: https://gitlab.com/hectorjsmith/fail2ban-prometheus-exporter/compare/0.6.0...0.7.0
+[0.7.1]: https://gitlab.com/hectorjsmith/fail2ban-prometheus-exporter/compare/0.7.0...0.7.1

README.md

@@ -112,7 +112,7 @@ There are no configuration files.
 
 **CLI flags**
 ```
-usage: fail2ban_exporter [<flags>]
+usage: exporter [<flags>]
 
 Flags:
   -h, --help     Show context-sensitive help (also try --help-long and --help-man).
@@ -127,6 +127,8 @@ Flags:
                  username to use to protect endpoints with basic auth
       --web.basic-auth.password=""  
                  password to use to protect endpoints with basic auth
+      --collector.f2b.exit-on-socket-connection-error  
+                 when set to true the exporter will immediately exit on a fail2ban socket connection error
 ```
 
 **Environment variables**
@@ -135,12 +137,13 @@ Each environment variable corresponds to a CLI flag.
 If both are specified, the CLI flag takes precedence.
 
 | Environment variable            | Corresponding CLI flag                            |
-|---------------------------|----------------------------------|
+|---------------------------------|---------------------------------------------------|
 | `F2B_COLLECTOR_SOCKET`          | `--collector.f2b.socket`                          |
 | `F2B_COLLECTOR_TEXT_PATH`       | `--collector.textfile.directory`                  |
 | `F2B_WEB_LISTEN_ADDRESS`        | `--web.listen-address`                            |
 | `F2B_WEB_BASICAUTH_USER`        | `--web.basic-auth.username`                       |
 | `F2B_WEB_BASICAUTH_PASS`        | `--web.basic-auth.password`                       |
+| `F2B_EXIT_ON_SOCKET_CONN_ERROR` | `--collector.f2b.exit-on-socket-connection-error` |
 
 ## 4. Building from source
 

src/cfg/basicAuth.go

@@ -1,6 +1,6 @@
 package cfg
 
-import "fail2ban-prometheus-exporter/auth"
+import "gitlab.com/hectorjsmith/fail2ban-prometheus-exporter/auth"
 
 type hashedBasicAuth struct {
 	username string

src/cfg/cfg.go

@@ -12,6 +12,7 @@ const (
 	addressEnvName               = "F2B_WEB_LISTEN_ADDRESS"
 	basicAuthUserEnvName         = "F2B_WEB_BASICAUTH_USER"
 	basicAuthPassEnvName         = "F2B_WEB_BASICAUTH_PASS"
+	exitOnSocketConnErrorEnvName = "F2B_EXIT_ON_SOCKET_CONN_ERROR"
 )
 
 type AppSettings struct {
@@ -20,6 +21,7 @@ type AppSettings struct {
 	Fail2BanSocketPath    string
 	FileCollectorPath     string
 	BasicAuthProvider     *hashedBasicAuth
+	ExitOnSocketConnError bool
 }
 
 func init() {
@@ -64,6 +66,11 @@ func readParamsFromCli(settings *AppSettings) {
 		Default("").
 		Envar(basicAuthPassEnvName).
 		String()
+	rawExitOnSocketConnError := kingpin.
+		Flag("collector.f2b.exit-on-socket-connection-error", "when set to true the exporter will immediately exit on a fail2ban socket connection error").
+		Default("false").
+		Envar(exitOnSocketConnErrorEnvName).
+		Bool()
 
 	kingpin.Parse()
 
@@ -72,6 +79,7 @@ func readParamsFromCli(settings *AppSettings) {
 	settings.Fail2BanSocketPath = *socketPath
 	settings.FileCollectorPath = *fileCollectorPath
 	settings.setBasicAuthValues(*rawBasicAuthUsername, *rawBasicAuthPassword)
+	settings.ExitOnSocketConnError = *rawExitOnSocketConnError
 }
 
 func (settings *AppSettings) setBasicAuthValues(rawUsername, rawPassword string) {

src/collector/f2b/collector.go

@@ -1,10 +1,11 @@
 package f2b
 
 import (
-	"fail2ban-prometheus-exporter/cfg"
-	"fail2ban-prometheus-exporter/socket"
 	"github.com/prometheus/client_golang/prometheus"
+	"gitlab.com/hectorjsmith/fail2ban-prometheus-exporter/cfg"
+	"gitlab.com/hectorjsmith/fail2ban-prometheus-exporter/socket"
 	"log"
+	"os"
 )
 
 type Collector struct {
@@ -13,6 +14,7 @@ type Collector struct {
 	lastError                  error
 	socketConnectionErrorCount int
 	socketRequestErrorCount    int
+	exitOnSocketConnError      bool
 }
 
 func NewExporter(appSettings *cfg.AppSettings, exporterVersion string) *Collector {
@@ -23,6 +25,7 @@ func NewExporter(appSettings *cfg.AppSettings, exporterVersion string) *Collecto
 		lastError:                  nil,
 		socketConnectionErrorCount: 0,
 		socketRequestErrorCount:    0,
+		exitOnSocketConnError:      appSettings.ExitOnSocketConnError,
 	}
 }
 
@@ -41,6 +44,9 @@ func (c *Collector) Collect(ch chan<- prometheus.Metric) {
 	if err != nil {
 		log.Printf("error opening socket: %v", err)
 		c.socketConnectionErrorCount++
+		if c.exitOnSocketConnError {
+			os.Exit(1)
+		}
 	} else {
 		defer s.Close()
 	}

src/collector/f2b/socket.go

@@ -1,8 +1,8 @@
 package f2b
 
 import (
-	"fail2ban-prometheus-exporter/socket"
 	"github.com/prometheus/client_golang/prometheus"
+	"gitlab.com/hectorjsmith/fail2ban-prometheus-exporter/socket"
 	"log"
 )
 

src/collector/textfile/collector.go

@@ -1,8 +1,8 @@
 package textfile
 
 import (
-	"fail2ban-prometheus-exporter/cfg"
 	"github.com/prometheus/client_golang/prometheus"
+	"gitlab.com/hectorjsmith/fail2ban-prometheus-exporter/cfg"
 	"log"
 )
 

src/exporter.go

@@ -1,13 +1,13 @@
 package main
 
 import (
-	"fail2ban-prometheus-exporter/auth"
-	"fail2ban-prometheus-exporter/cfg"
-	"fail2ban-prometheus-exporter/collector/f2b"
-	"fail2ban-prometheus-exporter/collector/textfile"
 	"fmt"
 	"github.com/prometheus/client_golang/prometheus"
 	"github.com/prometheus/client_golang/prometheus/promhttp"
+	"gitlab.com/hectorjsmith/fail2ban-prometheus-exporter/auth"
+	"gitlab.com/hectorjsmith/fail2ban-prometheus-exporter/cfg"
+	"gitlab.com/hectorjsmith/fail2ban-prometheus-exporter/collector/f2b"
+	"gitlab.com/hectorjsmith/fail2ban-prometheus-exporter/collector/textfile"
 	"log"
 	"net/http"
 	"os"
@@ -85,7 +85,7 @@ func main() {
 		log.Print("ready")
 
 		err := <-svrErr
-		log.Print(err)
+		log.Fatal(err)
 	}
 }
 

src/go.mod

@@ -1,4 +1,4 @@
-module fail2ban-prometheus-exporter
+module gitlab.com/hectorjsmith/fail2ban-prometheus-exporter
 
 go 1.15