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

102 lines
2.5 KiB
Go
Raw Normal View History

initial commit
2021-02-05 22:49:47 +00:00
package main
feat: initial setup of metric exporter Add dependency on the prometheus library to start exporting metrics. Add a new `up` metric that always returns `1` to ensure the exporter is working as expected.
2021-02-05 23:01:00 +00:00
import (
feat: add cli parameters for db path and metrics port (#4) Add support for configuring CLI parameters in the application using a new `cfg` package. The `cfg` package exports an `AppSettings` struct that contains the settings the application was run with. Update the application to use the new CLI parameters to set the db to open and the port to use for the metrics server. Add support for setting the app version during build. The app includes a `-version` flag to print the stored version data.
2021-02-06 15:17:35 +00:00
"fmt"
feat: correctly handle shutdown signals Add a new method to the application startup to listen for OS shutdown signals and handle them appropriately. A shutdown signal will cause the app to exit immediately. Use correct syntax for the `ENTRYPOINT` field in the Dockerfile to ensure that OS signals get passed down to the running application.
2022-02-20 08:17:06 +00:00
"log"
"net/http"
"os"
"os/signal"
"syscall"
refactor: rewrite auth handler code (!89) * Rewrite the code handling basic auth to make it easier to extend for other types of auth. * The behaviour of the existing code is maintained. * No changes to how basic auth is configured from a user's perspective. https://gitlab.com/hectorjsmith/fail2ban-prometheus-exporter/-/merge_requests/89
2023-06-21 10:31:33 +00:00
"github.com/prometheus/client_golang/prometheus"
"github.com/prometheus/client_golang/prometheus/promhttp"
"gitlab.com/hectorjsmith/fail2ban-prometheus-exporter/cfg"
"gitlab.com/hectorjsmith/fail2ban-prometheus-exporter/collector/f2b"
"gitlab.com/hectorjsmith/fail2ban-prometheus-exporter/collector/textfile"
"gitlab.com/hectorjsmith/fail2ban-prometheus-exporter/server"
feat: initial setup of metric exporter Add dependency on the prometheus library to start exporting metrics. Add a new `up` metric that always returns `1` to ensure the exporter is working as expected.
2021-02-05 23:01:00 +00:00
)
feat: improve startup logging Update the exporter startup to add more log messages. The server address, port, and metrics path are now logged on startup. A "ready" log message is printed when the server is up and running.
2021-09-21 08:34:23 +00:00
const (
metricsPath = "/metrics"
)
feat: connect to fail2ban db and extract total bad ips Add dependencies on `sqlite` to allow connecting to the fail2ban database. Add a new `db` module to handle all the database connections and data queries used to generate metrics. Export a new metric for the total number of bad IPs stored in the fail2ban database.
2021-02-06 11:45:46 +00:00
var (
feat: add cli parameters for db path and metrics port (#4) Add support for configuring CLI parameters in the application using a new `cfg` package. The `cfg` package exports an `AppSettings` struct that contains the settings the application was run with. Update the application to use the new CLI parameters to set the db to open and the port to use for the metrics server. Add support for setting the app version during build. The app includes a `-version` flag to print the stored version data.
2021-02-06 15:17:35 +00:00
version = "dev"
commit = "none"
date = "unknown"
builtBy = "unknown"
feat: initial setup of metric exporter Add dependency on the prometheus library to start exporting metrics. Add a new `up` metric that always returns `1` to ensure the exporter is working as expected.
2021-02-05 23:01:00 +00:00
)
feat: add cli parameters for db path and metrics port (#4) Add support for configuring CLI parameters in the application using a new `cfg` package. The `cfg` package exports an `AppSettings` struct that contains the settings the application was run with. Update the application to use the new CLI parameters to set the db to open and the port to use for the metrics server. Add support for setting the app version during build. The app includes a `-version` flag to print the stored version data.
2021-02-06 15:17:35 +00:00
func printAppVersion() {
fmt.Println(version)
fmt.Printf(" build date: %s\r\n commit hash: %s\r\n built by: %s\r\n", date, commit, builtBy)
}
feat: render basic html page at root url Add a new request handler for the root URL (`/`) to render a simple HTML page with a link to the metrics page. This follows the convention of other metric exporters.
2021-09-25 21:23:28 +00:00
func rootHtmlHandler(w http.ResponseWriter, r *http.Request) {
_, err := w.Write([]byte(
`<html>
<head><title>Fail2Ban Exporter</title></head>
<body>
<h1>Fail2Ban Exporter</h1>
<p><a href="` + metricsPath + `">Metrics</a></p>
</body>
</html>`))
if err != nil {
log.Printf("error handling root url: %v", err)
w.WriteHeader(http.StatusInternalServerError)
}
}
refactor: update imports in exporter.go Remove unnecessary name from the textfile import. Remove the sqlite3 dependency which is no longer required.
2021-10-18 18:32:08 +00:00
func metricHandler(w http.ResponseWriter, r *http.Request, collector *textfile.Collector) {
feat: support for textfile metrics (#13) Add support for collecting arbitrary metrics from a textfile as well as metrics collected from fail2ban. This allows other data to be exported along with the fail2ban metrics (e.g. instance metadata). Update the docker image to allow mounting a folder with a collection of metric files to be exported. Only files ending in `.prom` with be read. Update project README with the new functionality.
2021-10-12 20:38:26 +00:00
promhttp.Handler().ServeHTTP(w, r)
collector.WriteTextFileMetrics(w, r)
}
initial commit
2021-02-05 22:49:47 +00:00
func main() {
feat: add cli parameters for db path and metrics port (#4) Add support for configuring CLI parameters in the application using a new `cfg` package. The `cfg` package exports an `AppSettings` struct that contains the settings the application was run with. Update the application to use the new CLI parameters to set the db to open and the port to use for the metrics server. Add support for setting the app version during build. The app includes a `-version` flag to print the stored version data.
2021-02-06 15:17:35 +00:00
appSettings := cfg.Parse()
if appSettings.VersionMode {
printAppVersion()
} else {
feat: correctly handle shutdown signals Add a new method to the application startup to listen for OS shutdown signals and handle them appropriately. A shutdown signal will cause the app to exit immediately. Use correct syntax for the `ENTRYPOINT` field in the Dockerfile to ensure that OS signals get passed down to the running application.
2022-02-20 08:17:06 +00:00
handleGracefulShutdown()
feat: improve logging on startup Update the exporter logging on startup to include the exporter version, the path to the fail2ban socket, and whether basic-auth is enabled or not. Fix code printing error messages on invalid CLI parameters to correct line breaks and correctly print the "usage" information.
2022-02-19 11:21:58 +00:00
log.Printf("fail2ban exporter version %s", version)
feat: rewrite cli flags and environment variables Replace existing CLI flags to make them more consistent and follow a more standard format. Remove CLI flags and environment variables that are no longer relevant. Add short `-v` option for version flag. Update README with new documentation. BREAKING CHANGE: Replace `--socket` flag with `--collector.f2b.socket`. BREAKING CHANGE: Merge `--port` flag and `--web.listen-address` into a single flag. BREAKING CHANGE: Remove `--collector.textfile` flag, its value is now derived from `--collector.textfile.directory`. BREAKING CHANGE: Remove `F2B_COLLECTOR_TEXT` and `F2B_WEB_PORT` environment variables.
2022-02-19 17:01:49 +00:00
log.Printf("starting server at %s", appSettings.MetricsAddress)
feat: initial setup of metric exporter Add dependency on the prometheus library to start exporting metrics. Add a new `up` metric that always returns `1` to ensure the exporter is working as expected.
2021-02-05 23:01:00 +00:00
refactor: create new collector folder Create a new `collector` folder to store the code for the different collectors. Move the existing f2b and textfile collectors to this folder. Minor refactors to the f2b collector to better match the code style of the newer textfile collector.
2021-10-13 20:33:49 +00:00
f2bCollector := f2b.NewExporter(appSettings, version)
prometheus.MustRegister(f2bCollector)
feat: initial setup of metric exporter Add dependency on the prometheus library to start exporting metrics. Add a new `up` metric that always returns `1` to ensure the exporter is working as expected.
2021-02-05 23:01:00 +00:00
refactor: update imports in exporter.go Remove unnecessary name from the textfile import. Remove the sqlite3 dependency which is no longer required.
2021-10-18 18:32:08 +00:00
textFileCollector := textfile.NewCollector(appSettings)
feat: support for textfile metrics (#13) Add support for collecting arbitrary metrics from a textfile as well as metrics collected from fail2ban. This allows other data to be exported along with the fail2ban metrics (e.g. instance metadata). Update the docker image to allow mounting a folder with a collection of metric files to be exported. Only files ending in `.prom` with be read. Update project README with the new functionality.
2021-10-12 20:38:26 +00:00
prometheus.MustRegister(textFileCollector)
refactor: rewrite auth handler code (!89) * Rewrite the code handling basic auth to make it easier to extend for other types of auth. * The behaviour of the existing code is maintained. * No changes to how basic auth is configured from a user's perspective. https://gitlab.com/hectorjsmith/fail2ban-prometheus-exporter/-/merge_requests/89
2023-06-21 10:31:33 +00:00
http.HandleFunc("/", server.BasicAuthMiddleware(rootHtmlHandler, appSettings.AuthProvider))
http.HandleFunc(metricsPath, server.BasicAuthMiddleware(
feat: add support for basic auth (#16) Add new CLI parameters to enable protecting the API endpoints with basic auth authentication. Wrap the server endpoints in a new auth middleware that protects it using the provided basic auth credentials (if set). Store the provided basic auth credentials as hashed values to prevent them from being accidentally leaked. Add unit tests to ensure the new functionality works as expected.
2022-01-14 21:36:49 +00:00
func(w http.ResponseWriter, r *http.Request) {
metricHandler(w, r, textFileCollector)
},
refactor: rewrite auth handler code (!89) * Rewrite the code handling basic auth to make it easier to extend for other types of auth. * The behaviour of the existing code is maintained. * No changes to how basic auth is configured from a user's perspective. https://gitlab.com/hectorjsmith/fail2ban-prometheus-exporter/-/merge_requests/89
2023-06-21 10:31:33 +00:00
appSettings.AuthProvider,
feat: add support for basic auth (#16) Add new CLI parameters to enable protecting the API endpoints with basic auth authentication. Wrap the server endpoints in a new auth middleware that protects it using the provided basic auth credentials (if set). Store the provided basic auth credentials as hashed values to prevent them from being accidentally leaked. Add unit tests to ensure the new functionality works as expected.
2022-01-14 21:36:49 +00:00
))
feat: improve startup logging Update the exporter startup to add more log messages. The server address, port, and metrics path are now logged on startup. A "ready" log message is printed when the server is up and running.
2021-09-21 08:34:23 +00:00
log.Printf("metrics available at '%s'", metricsPath)
svrErr := make(chan error)
go func() {
feat: rewrite cli flags and environment variables Replace existing CLI flags to make them more consistent and follow a more standard format. Remove CLI flags and environment variables that are no longer relevant. Add short `-v` option for version flag. Update README with new documentation. BREAKING CHANGE: Replace `--socket` flag with `--collector.f2b.socket`. BREAKING CHANGE: Merge `--port` flag and `--web.listen-address` into a single flag. BREAKING CHANGE: Remove `--collector.textfile` flag, its value is now derived from `--collector.textfile.directory`. BREAKING CHANGE: Remove `F2B_COLLECTOR_TEXT` and `F2B_WEB_PORT` environment variables.
2022-02-19 17:01:49 +00:00
svrErr <- http.ListenAndServe(appSettings.MetricsAddress, nil)
feat: improve startup logging Update the exporter startup to add more log messages. The server address, port, and metrics path are now logged on startup. A "ready" log message is printed when the server is up and running.
2021-09-21 08:34:23 +00:00
}()
log.Print("ready")
err := <-svrErr
fix: report failure when server fails to start (#23) Exit with an error when the server startup reports an error. For example, when the server fails to bind to the provided port.
2022-09-18 20:26:22 +00:00
log.Fatal(err)
feat: add cli parameters for db path and metrics port (#4) Add support for configuring CLI parameters in the application using a new `cfg` package. The `cfg` package exports an `AppSettings` struct that contains the settings the application was run with. Update the application to use the new CLI parameters to set the db to open and the port to use for the metrics server. Add support for setting the app version during build. The app includes a `-version` flag to print the stored version data.
2021-02-06 15:17:35 +00:00
}
initial commit
2021-02-05 22:49:47 +00:00
}
feat: correctly handle shutdown signals Add a new method to the application startup to listen for OS shutdown signals and handle them appropriately. A shutdown signal will cause the app to exit immediately. Use correct syntax for the `ENTRYPOINT` field in the Dockerfile to ensure that OS signals get passed down to the running application.
2022-02-20 08:17:06 +00:00
func handleGracefulShutdown() {
var signals = make(chan os.Signal)
signal.Notify(signals, syscall.SIGTERM)
signal.Notify(signals, syscall.SIGINT)
go func() {
sig := <-signals
log.Printf("caught signal: %+v", sig)
os.Exit(0)
}()
}
Reference in New Issue Copy Permalink