Skip to content

Commit e854076

Browse files
tjhopSuperQ
tjhop
and
SuperQ
authored
chore!: adopt log/slog, drop go-kit/log (prometheus-community#1073)
* ci: update go to version 1.23 Signed-off-by: TJ Hoplock <[email protected]> * build(deps): bump prometheus/{client_golang,common,exporter-toolkit} Signed-off-by: TJ Hoplock <[email protected]> * chore!: adopt log/slog, drop go-kit/log The bulk of this change set was automated by the following script which is being used to aid in converting the various exporters/projects to use slog: https://gist.github.com/tjhop/49f96fb7ebbe55b12deee0b0312d8434 Signed-off-by: TJ Hoplock <[email protected]> --------- Signed-off-by: TJ Hoplock <[email protected]> Co-authored-by: Ben Kochie <[email protected]>
1 parent 3743987 commit e854076

32 files changed

+206
-228
lines changed

‎.circleci/config.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ executors:
88
# This must match .promu.yml.
99
golang:
1010
docker:
11-
- image: cimg/go:1.21
11+
- image: cimg/go:1.23
1212

1313
jobs:
1414
test:
@@ -23,7 +23,7 @@ jobs:
2323

2424
integration:
2525
docker:
26-
- image: cimg/go:1.20
26+
- image: cimg/go:1.23
2727
- image: << parameters.postgres_image >>
2828
environment:
2929
POSTGRES_DB: circle_test

‎.promu.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
go:
22
# This must match .circle/config.yml.
3-
version: 1.21
3+
version: 1.23
44
repository:
55
path: github.com/prometheus-community/postgres_exporter
66
build:

‎cmd/postgres_exporter/datasource.go

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,6 @@ import (
2020
"regexp"
2121
"strings"
2222

23-
"github.com/go-kit/log/level"
2423
"github.com/prometheus/client_golang/prometheus"
2524
)
2625

@@ -39,19 +38,19 @@ func (e *Exporter) discoverDatabaseDSNs() []string {
3938
var err error
4039
dsnURI, err = url.Parse(dsn)
4140
if err != nil {
42-
level.Error(logger).Log("msg", "Unable to parse DSN as URI", "dsn", loggableDSN(dsn), "err", err)
41+
logger.Error("Unable to parse DSN as URI", "dsn", loggableDSN(dsn), "err", err)
4342
continue
4443
}
4544
} else if connstringRe.MatchString(dsn) {
4645
dsnConnstring = dsn
4746
} else {
48-
level.Error(logger).Log("msg", "Unable to parse DSN as either URI or connstring", "dsn", loggableDSN(dsn))
47+
logger.Error("Unable to parse DSN as either URI or connstring", "dsn", loggableDSN(dsn))
4948
continue
5049
}
5150

5251
server, err := e.servers.GetServer(dsn)
5352
if err != nil {
54-
level.Error(logger).Log("msg", "Error opening connection to database", "dsn", loggableDSN(dsn), "err", err)
53+
logger.Error("Error opening connection to database", "dsn", loggableDSN(dsn), "err", err)
5554
continue
5655
}
5756
dsns[dsn] = struct{}{}
@@ -61,7 +60,7 @@ func (e *Exporter) discoverDatabaseDSNs() []string {
6160

6261
databaseNames, err := queryDatabases(server)
6362
if err != nil {
64-
level.Error(logger).Log("msg", "Error querying databases", "dsn", loggableDSN(dsn), "err", err)
63+
logger.Error("Error querying databases", "dsn", loggableDSN(dsn), "err", err)
6564
continue
6665
}
6766
for _, databaseName := range databaseNames {
@@ -109,7 +108,7 @@ func (e *Exporter) scrapeDSN(ch chan<- prometheus.Metric, dsn string) error {
109108

110109
// Check if map versions need to be updated
111110
if err := e.checkMapVersions(ch, server); err != nil {
112-
level.Warn(logger).Log("msg", "Proceeding with outdated query maps, as the Postgres version could not be determined", "err", err)
111+
logger.Warn("Proceeding with outdated query maps, as the Postgres version could not be determined", "err", err)
113112
}
114113

115114
return server.Scrape(ch, e.disableSettingsMetrics)

‎cmd/postgres_exporter/main.go

Lines changed: 17 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -20,14 +20,13 @@ import (
2020
"strings"
2121

2222
"github.com/alecthomas/kingpin/v2"
23-
"github.com/go-kit/log"
24-
"github.com/go-kit/log/level"
2523
"github.com/prometheus-community/postgres_exporter/collector"
2624
"github.com/prometheus-community/postgres_exporter/config"
2725
"github.com/prometheus/client_golang/prometheus"
26+
versioncollector "github.com/prometheus/client_golang/prometheus/collectors/version"
2827
"github.com/prometheus/client_golang/prometheus/promhttp"
29-
"github.com/prometheus/common/promlog"
30-
"github.com/prometheus/common/promlog/flag"
28+
"github.com/prometheus/common/promslog"
29+
"github.com/prometheus/common/promslog/flag"
3130
"github.com/prometheus/common/version"
3231
"github.com/prometheus/exporter-toolkit/web"
3332
"github.com/prometheus/exporter-toolkit/web/kingpinflag"
@@ -50,7 +49,7 @@ var (
5049
excludeDatabases = kingpin.Flag("exclude-databases", "A list of databases to remove when autoDiscoverDatabases is enabled (DEPRECATED)").Default("").Envar("PG_EXPORTER_EXCLUDE_DATABASES").String()
5150
includeDatabases = kingpin.Flag("include-databases", "A list of databases to include when autoDiscoverDatabases is enabled (DEPRECATED)").Default("").Envar("PG_EXPORTER_INCLUDE_DATABASES").String()
5251
metricPrefix = kingpin.Flag("metric-prefix", "A metric prefix can be used to have non-default (not \"pg\") prefixes for each of the metrics").Default("pg").Envar("PG_EXPORTER_METRIC_PREFIX").String()
53-
logger = log.NewNopLogger()
52+
logger = promslog.NewNopLogger()
5453
)
5554

5655
// Metric name parts.
@@ -70,11 +69,11 @@ const (
7069

7170
func main() {
7271
kingpin.Version(version.Print(exporterName))
73-
promlogConfig := &promlog.Config{}
74-
flag.AddFlags(kingpin.CommandLine, promlogConfig)
72+
promslogConfig := &promslog.Config{}
73+
flag.AddFlags(kingpin.CommandLine, promslogConfig)
7574
kingpin.HelpFlag.Short('h')
7675
kingpin.Parse()
77-
logger = promlog.New(promlogConfig)
76+
logger = promslog.New(promslogConfig)
7877

7978
if *onlyDumpMaps {
8079
dumpMaps()
@@ -83,28 +82,28 @@ func main() {
8382

8483
if err := c.ReloadConfig(*configFile, logger); err != nil {
8584
// This is not fatal, but it means that auth must be provided for every dsn.
86-
level.Warn(logger).Log("msg", "Error loading config", "err", err)
85+
logger.Warn("Error loading config", "err", err)
8786
}
8887

8988
dsns, err := getDataSources()
9089
if err != nil {
91-
level.Error(logger).Log("msg", "Failed reading data sources", "err", err.Error())
90+
logger.Error("Failed reading data sources", "err", err.Error())
9291
os.Exit(1)
9392
}
9493

9594
excludedDatabases := strings.Split(*excludeDatabases, ",")
96-
level.Info(logger).Log("msg", "Excluded databases", "databases", fmt.Sprintf("%v", excludedDatabases))
95+
logger.Info("Excluded databases", "databases", fmt.Sprintf("%v", excludedDatabases))
9796

9897
if *queriesPath != "" {
99-
level.Warn(logger).Log("msg", "The extended queries.yaml config is DEPRECATED", "file", *queriesPath)
98+
logger.Warn("The extended queries.yaml config is DEPRECATED", "file", *queriesPath)
10099
}
101100

102101
if *autoDiscoverDatabases || *excludeDatabases != "" || *includeDatabases != "" {
103-
level.Warn(logger).Log("msg", "Scraping additional databases via auto discovery is DEPRECATED")
102+
logger.Warn("Scraping additional databases via auto discovery is DEPRECATED")
104103
}
105104

106105
if *constantLabelsList != "" {
107-
level.Warn(logger).Log("msg", "Constant labels on all metrics is DEPRECATED")
106+
logger.Warn("Constant labels on all metrics is DEPRECATED")
108107
}
109108

110109
opts := []ExporterOpt{
@@ -122,7 +121,7 @@ func main() {
122121
exporter.servers.Close()
123122
}()
124123

125-
prometheus.MustRegister(version.NewCollector(exporterName))
124+
prometheus.MustRegister(versioncollector.NewCollector(exporterName))
126125

127126
prometheus.MustRegister(exporter)
128127

@@ -139,7 +138,7 @@ func main() {
139138
[]string{},
140139
)
141140
if err != nil {
142-
level.Warn(logger).Log("msg", "Failed to create PostgresCollector", "err", err.Error())
141+
logger.Warn("Failed to create PostgresCollector", "err", err.Error())
143142
} else {
144143
prometheus.MustRegister(pe)
145144
}
@@ -160,7 +159,7 @@ func main() {
160159
}
161160
landingPage, err := web.NewLandingPage(landingConfig)
162161
if err != nil {
163-
level.Error(logger).Log("err", err)
162+
logger.Error("error creating landing page", "err", err)
164163
os.Exit(1)
165164
}
166165
http.Handle("/", landingPage)
@@ -170,7 +169,7 @@ func main() {
170169

171170
srv := &http.Server{}
172171
if err := web.ListenAndServe(srv, webConfig, logger); err != nil {
173-
level.Error(logger).Log("msg", "Error running HTTP server", "err", err)
172+
logger.Error("Error running HTTP server", "err", err)
174173
os.Exit(1)
175174
}
176175
}

‎cmd/postgres_exporter/namespace.go

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,6 @@ import (
2020
"time"
2121

2222
"github.com/blang/semver/v4"
23-
"github.com/go-kit/log/level"
2423
"github.com/lib/pq"
2524
"github.com/prometheus/client_golang/prometheus"
2625
)
@@ -190,10 +189,10 @@ func queryNamespaceMappings(ch chan<- prometheus.Metric, server *Server) map[str
190189
scrapeStart := time.Now()
191190

192191
for namespace, mapping := range server.metricMap {
193-
level.Debug(logger).Log("msg", "Querying namespace", "namespace", namespace)
192+
logger.Debug("Querying namespace", "namespace", namespace)
194193

195194
if mapping.master && !server.master {
196-
level.Debug(logger).Log("msg", "Query skipped...")
195+
logger.Debug("Query skipped...")
197196
continue
198197
}
199198

@@ -202,7 +201,7 @@ func queryNamespaceMappings(ch chan<- prometheus.Metric, server *Server) map[str
202201
serVersion, _ := semver.Parse(server.lastMapVersion.String())
203202
runServerRange, _ := semver.ParseRange(server.runonserver)
204203
if !runServerRange(serVersion) {
205-
level.Debug(logger).Log("msg", "Query skipped for this database version", "version", server.lastMapVersion.String(), "target_version", server.runonserver)
204+
logger.Debug("Query skipped for this database version", "version", server.lastMapVersion.String(), "target_version", server.runonserver)
206205
continue
207206
}
208207
}
@@ -233,12 +232,12 @@ func queryNamespaceMappings(ch chan<- prometheus.Metric, server *Server) map[str
233232
// Serious error - a namespace disappeared
234233
if err != nil {
235234
namespaceErrors[namespace] = err
236-
level.Info(logger).Log("err", err)
235+
logger.Info("error finding namespace", "err", err)
237236
}
238237
// Non-serious errors - likely version or parsing problems.
239238
if len(nonFatalErrors) > 0 {
240239
for _, err := range nonFatalErrors {
241-
level.Info(logger).Log("err", err)
240+
logger.Info("error querying namespace", "err", err)
242241
}
243242
}
244243

‎cmd/postgres_exporter/pg_setting.go

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,6 @@ import (
1919
"strconv"
2020
"strings"
2121

22-
"github.com/go-kit/log/level"
2322
"github.com/prometheus/client_golang/prometheus"
2423
)
2524

@@ -32,7 +31,7 @@ var (
3231

3332
// Query the pg_settings view containing runtime variables
3433
func querySettings(ch chan<- prometheus.Metric, server *Server) error {
35-
level.Debug(logger).Log("msg", "Querying pg_setting view", "server", server)
34+
logger.Debug("Querying pg_setting view", "server", server)
3635

3736
// pg_settings docs: https://www.postgresql.org/docs/current/static/view-pg-settings.html
3837
//

‎cmd/postgres_exporter/postgres_exporter.go

Lines changed: 10 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,6 @@ import (
2525
"time"
2626

2727
"github.com/blang/semver/v4"
28-
"github.com/go-kit/log/level"
2928
"github.com/prometheus/client_golang/prometheus"
3029
)
3130

@@ -284,7 +283,7 @@ func makeDescMap(pgVersion semver.Version, serverLabels prometheus.Labels, metri
284283
if !columnMapping.supportedVersions(pgVersion) {
285284
// It's very useful to be able to see what columns are being
286285
// rejected.
287-
level.Debug(logger).Log("msg", "Column is being forced to discard due to version incompatibility", "column", columnName)
286+
logger.Debug("Column is being forced to discard due to version incompatibility", "column", columnName)
288287
thisMap[columnName] = MetricMap{
289288
discard: true,
290289
conversion: func(_ interface{}) (float64, bool) {
@@ -371,7 +370,7 @@ func makeDescMap(pgVersion semver.Version, serverLabels prometheus.Labels, metri
371370
case string:
372371
durationString = t
373372
default:
374-
level.Error(logger).Log("msg", "Duration conversion metric was not a string")
373+
logger.Error("Duration conversion metric was not a string")
375374
return math.NaN(), false
376375
}
377376

@@ -381,7 +380,7 @@ func makeDescMap(pgVersion semver.Version, serverLabels prometheus.Labels, metri
381380

382381
d, err := time.ParseDuration(durationString)
383382
if err != nil {
384-
level.Error(logger).Log("msg", "Failed converting result to metric", "column", columnName, "in", in, "err", err)
383+
logger.Error("Failed converting result to metric", "column", columnName, "in", in, "err", err)
385384
return math.NaN(), false
386385
}
387386
return float64(d / time.Millisecond), true
@@ -491,7 +490,7 @@ func parseConstLabels(s string) prometheus.Labels {
491490
for _, p := range parts {
492491
keyValue := strings.Split(strings.TrimSpace(p), "=")
493492
if len(keyValue) != 2 {
494-
level.Error(logger).Log(`Wrong constant labels format, should be "key=value"`, "input", p)
493+
logger.Error(`Wrong constant labels format, should be "key=value"`, "input", p)
495494
continue
496495
}
497496
key := strings.TrimSpace(keyValue[0])
@@ -582,7 +581,7 @@ func newDesc(subsystem, name, help string, labels prometheus.Labels) *prometheus
582581
}
583582

584583
func checkPostgresVersion(db *sql.DB, server string) (semver.Version, string, error) {
585-
level.Debug(logger).Log("msg", "Querying PostgreSQL version", "server", server)
584+
logger.Debug("Querying PostgreSQL version", "server", server)
586585
versionRow := db.QueryRow("SELECT version();")
587586
var versionString string
588587
err := versionRow.Scan(&versionString)
@@ -605,12 +604,12 @@ func (e *Exporter) checkMapVersions(ch chan<- prometheus.Metric, server *Server)
605604
}
606605

607606
if !e.disableDefaultMetrics && semanticVersion.LT(lowestSupportedVersion) {
608-
level.Warn(logger).Log("msg", "PostgreSQL version is lower than our lowest supported version", "server", server, "version", semanticVersion, "lowest_supported_version", lowestSupportedVersion)
607+
logger.Warn("PostgreSQL version is lower than our lowest supported version", "server", server, "version", semanticVersion, "lowest_supported_version", lowestSupportedVersion)
609608
}
610609

611610
// Check if semantic version changed and recalculate maps if needed.
612611
if semanticVersion.NE(server.lastMapVersion) || server.metricMap == nil {
613-
level.Info(logger).Log("msg", "Semantic version changed", "server", server, "from", server.lastMapVersion, "to", semanticVersion)
612+
logger.Info("Semantic version changed", "server", server, "from", server.lastMapVersion, "to", semanticVersion)
614613
server.mappingMtx.Lock()
615614

616615
// Get Default Metrics only for master database
@@ -631,13 +630,13 @@ func (e *Exporter) checkMapVersions(ch chan<- prometheus.Metric, server *Server)
631630
// Calculate the hashsum of the useQueries
632631
userQueriesData, err := os.ReadFile(e.userQueriesPath)
633632
if err != nil {
634-
level.Error(logger).Log("msg", "Failed to reload user queries", "path", e.userQueriesPath, "err", err)
633+
logger.Error("Failed to reload user queries", "path", e.userQueriesPath, "err", err)
635634
e.userQueriesError.WithLabelValues(e.userQueriesPath, "").Set(1)
636635
} else {
637636
hashsumStr := fmt.Sprintf("%x", sha256.Sum256(userQueriesData))
638637

639638
if err := addQueries(userQueriesData, semanticVersion, server); err != nil {
640-
level.Error(logger).Log("msg", "Failed to reload user queries", "path", e.userQueriesPath, "err", err)
639+
logger.Error("Failed to reload user queries", "path", e.userQueriesPath, "err", err)
641640
e.userQueriesError.WithLabelValues(e.userQueriesPath, hashsumStr).Set(1)
642641
} else {
643642
// Mark user queries as successfully loaded
@@ -679,7 +678,7 @@ func (e *Exporter) scrape(ch chan<- prometheus.Metric) {
679678
if err := e.scrapeDSN(ch, dsn); err != nil {
680679
errorsCount++
681680

682-
level.Error(logger).Log("err", err)
681+
logger.Error("error scraping dsn", "err", err, "dsn", dsn)
683682

684683
if _, ok := err.(*ErrorConnectToServer); ok {
685684
connectionErrorsCount++

‎cmd/postgres_exporter/probe.go

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -15,17 +15,16 @@ package main
1515

1616
import (
1717
"fmt"
18+
"log/slog"
1819
"net/http"
1920

20-
"github.com/go-kit/log"
21-
"github.com/go-kit/log/level"
2221
"github.com/prometheus-community/postgres_exporter/collector"
2322
"github.com/prometheus-community/postgres_exporter/config"
2423
"github.com/prometheus/client_golang/prometheus"
2524
"github.com/prometheus/client_golang/prometheus/promhttp"
2625
)
2726

28-
func handleProbe(logger log.Logger, excludeDatabases []string) http.HandlerFunc {
27+
func handleProbe(logger *slog.Logger, excludeDatabases []string) http.HandlerFunc {
2928
return func(w http.ResponseWriter, r *http.Request) {
3029
ctx := r.Context()
3130
conf := c.GetConfig()
@@ -38,7 +37,7 @@ func handleProbe(logger log.Logger, excludeDatabases []string) http.HandlerFunc
3837
var authModule config.AuthModule
3938
authModuleName := params.Get("auth_module")
4039
if authModuleName == "" {
41-
level.Info(logger).Log("msg", "no auth_module specified, using default")
40+
logger.Info("no auth_module specified, using default")
4241
} else {
4342
var ok bool
4443
authModule, ok = conf.AuthModules[authModuleName]
@@ -54,14 +53,14 @@ func handleProbe(logger log.Logger, excludeDatabases []string) http.HandlerFunc
5453

5554
dsn, err := authModule.ConfigureTarget(target)
5655
if err != nil {
57-
level.Error(logger).Log("msg", "failed to configure target", "err", err)
56+
logger.Error("failed to configure target", "err", err)
5857
http.Error(w, fmt.Sprintf("could not configure dsn for target: %v", err), http.StatusBadRequest)
5958
return
6059
}
6160

6261
// TODO(@sysadmind): Timeout
6362

64-
tl := log.With(logger, "target", target)
63+
tl := logger.With("target", target)
6564

6665
registry := prometheus.NewRegistry()
6766

@@ -85,7 +84,7 @@ func handleProbe(logger log.Logger, excludeDatabases []string) http.HandlerFunc
8584
// Run the probe
8685
pc, err := collector.NewProbeCollector(tl, excludeDatabases, registry, dsn)
8786
if err != nil {
88-
level.Error(logger).Log("msg", "Error creating probe collector", "err", err)
87+
logger.Error("Error creating probe collector", "err", err)
8988
http.Error(w, err.Error(), http.StatusInternalServerError)
9089
return
9190
}

0 commit comments

Comments
 (0)