Skip to content

Add option to have /healthz probes to be tied to database(s) connectivity #143

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 8 commits into
base: master
Choose a base branch
from
+44 −5
Open

Add option to have /healthz probes to be tied to database(s) connectivity #143

Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
012d80d
Add option to have /healthz probes to be tied to database(s) connecti…
AlexSinuskinDBG Nov 27, 2024
7e848fb
Just a NL
AlexSinuskinDBG Dec 2, 2024
7c01c9d
Debug-log found connections
AlexSinuskinDBG Dec 3, 2024
34bfd7a
better debug logging
AlexSinuskinDBG Dec 3, 2024
144521f
Fix the /healthz probe handler logic
AlexSinuskinDBG Dec 3, 2024
dc297c7
Revert the NL addition
AlexSinuskinDBG Dec 4, 2024
1104465
Merge branch 'master' into healthz-based-on-db-connectivity
Sep 8, 2025
e4630e3
Make the liveness call fail only when all configured jobs' connection…
Sep 8, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
49 changes: 44 additions & 5 deletions main.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,10 +22,11 @@ func init() {

func main() {
var (
showVersion = flag.Bool("version", false, "Print version information.")
listenAddress = flag.String("web.listen-address", ":9237", "Address to listen on for web interface and telemetry.")
metricsPath = flag.String("web.telemetry-path", "/metrics", "Path under which to expose metrics.")
configFile = flag.String("config.file", os.Getenv("CONFIG"), "SQL Exporter configuration file name.")
showVersion = flag.Bool("version", false, "Print version information.")
listenAddress = flag.String("web.listen-address", ":9237", "Address to listen on for web interface and telemetry.")
metricsPath = flag.String("web.telemetry-path", "/metrics", "Path under which to expose metrics.")
configFile = flag.String("config.file", os.Getenv("CONFIG"), "SQL Exporter configuration file name.")
dbConnectivityAsHealthCheck = flag.Bool("db.connectivity-as-healthz", false, "Use database connectivity check as healthz probe")
)

flag.Parse()
Expand Down Expand Up @@ -66,7 +67,45 @@ func main() {

// setup and start webserver
http.Handle(*metricsPath, promhttp.Handler())
http.HandleFunc("/healthz", func(w http.ResponseWriter, r *http.Request) { http.Error(w, "OK", http.StatusOK) })

if *dbConnectivityAsHealthCheck {
http.HandleFunc("/healthz",
func(w http.ResponseWriter, r *http.Request) {
for _, job := range exporter.jobs {

if job == nil {
continue
}

for _, connection := range job.conns {

if connection == nil {
continue
}

if connection.conn != nil {
if err := connection.conn.Ping(); err != nil {
continue
}
// if we meet at least one successful connection we consider the app healthy
http.Error(w, "OK", http.StatusOK)
return
}

if err := connection.connect(job); err == nil {
// if we meet at least one successful connection we consider the app healthy
http.Error(w, "OK", http.StatusOK)
return
}
}
}
// no successful connections found, fail the /healthz request
http.Error(w, err.Error(), http.StatusInternalServerError)
})
} else {
http.HandleFunc("/healthz", func(w http.ResponseWriter, r *http.Request) { http.Error(w, "OK", http.StatusOK) })
}

http.HandleFunc("/", func(w http.ResponseWriter, r *http.Request) {
w.Write([]byte(`<html>
<head><title>SQL Exporter</title></head>
Expand Down