Skip to content

Commit f59d4af

Browse files
author
Muhammad Shahzeb
authored
Merge branch 'prometheus-community:master' into master
2 parents 4ab5783 + 3c5ef40 commit f59d4af

7 files changed

+165
-81
lines changed

‎README.md

+21-2
Original file line numberDiff line numberDiff line change
@@ -17,10 +17,29 @@ docker run --net=host -it --rm -e POSTGRES_PASSWORD=password postgres
1717
# Connect to it
1818
docker run \
1919
--net=host \
20-
-e DATA_SOURCE_NAME="postgresql://postgres:password@localhost:5432/postgres?sslmode=disable" \
20+
-e DATA_SOURCE_URI="localhost:5432/postgres?sslmode=disable" \
21+
-e DATA_SOURCE_USER=postgres \
22+
-e DATA_SOURCE_PASS=password \
2123
quay.io/prometheuscommunity/postgres-exporter
2224
```
2325

26+
Test with:
27+
```bash
28+
curl "http://localhost:9187/metrics"
29+
```
30+
31+
Example Prometheus config:
32+
```yaml
33+
scrape_configs:
34+
- job_name: postgres
35+
static_configs:
36+
- targets: ["127.0.0.1:9187"] # Replace IP with the hostname of the docker container if you're running the container in a separate network
37+
```
38+
39+
Now use the DATA_SOURCE_PASS_FILE with a mounted file containing the password to prevent having the password in an environment variable.
40+
41+
The container process runs with uid/gid 65534 (important for file permissions).
42+
2443
## Multi-Target Support (BETA)
2544
**This Feature is in beta and may require changes in future releases. Feedback is welcome.**
2645
@@ -208,7 +227,7 @@ The following environment variables configure the exporter:
208227
* `DATA_SOURCE_URI`
209228
an alternative to `DATA_SOURCE_NAME` which exclusively accepts the hostname
210229
without a username and password component. For example, `my_pg_hostname` or
211-
`my_pg_hostname?sslmode=disable`.
230+
`my_pg_hostname:5432/postgres?sslmode=disable`.
212231

213232
* `DATA_SOURCE_URI_FILE`
214233
The same as above but reads the URI from a file.

‎collector/pg_replication_slot.go

+38-2
Original file line numberDiff line numberDiff line change
@@ -63,6 +63,24 @@ var (
6363
"whether the replication slot is active or not",
6464
[]string{"slot_name", "slot_type"}, nil,
6565
)
66+
pgReplicationSlotSafeWal = prometheus.NewDesc(
67+
prometheus.BuildFQName(
68+
namespace,
69+
replicationSlotSubsystem,
70+
"safe_wal_size_bytes",
71+
),
72+
"number of bytes that can be written to WAL such that this slot is not in danger of getting in state lost",
73+
[]string{"slot_name", "slot_type"}, nil,
74+
)
75+
pgReplicationSlotWalStatus = prometheus.NewDesc(
76+
prometheus.BuildFQName(
77+
namespace,
78+
replicationSlotSubsystem,
79+
"wal_status",
80+
),
81+
"availability of WAL files claimed by this slot",
82+
[]string{"slot_name", "slot_type", "wal_status"}, nil,
83+
)
6684

6785
pgReplicationSlotQuery = `SELECT
6886
slot_name,
@@ -73,7 +91,9 @@ var (
7391
pg_current_wal_lsn() - '0/0'
7492
END AS current_wal_lsn,
7593
COALESCE(confirmed_flush_lsn, '0/0') - '0/0' AS confirmed_flush_lsn,
76-
active
94+
active,
95+
safe_wal_size,
96+
wal_status
7797
FROM pg_replication_slots;`
7898
)
7999

@@ -92,7 +112,9 @@ func (PGReplicationSlotCollector) Update(ctx context.Context, instance *instance
92112
var walLSN sql.NullFloat64
93113
var flushLSN sql.NullFloat64
94114
var isActive sql.NullBool
95-
if err := rows.Scan(&slotName, &slotType, &walLSN, &flushLSN, &isActive); err != nil {
115+
var safeWalSize sql.NullInt64
116+
var walStatus sql.NullString
117+
if err := rows.Scan(&slotName, &slotType, &walLSN, &flushLSN, &isActive, &safeWalSize, &walStatus); err != nil {
96118
return err
97119
}
98120

@@ -131,6 +153,20 @@ func (PGReplicationSlotCollector) Update(ctx context.Context, instance *instance
131153
pgReplicationSlotIsActiveDesc,
132154
prometheus.GaugeValue, isActiveValue, slotNameLabel, slotTypeLabel,
133155
)
156+
157+
if safeWalSize.Valid {
158+
ch <- prometheus.MustNewConstMetric(
159+
pgReplicationSlotSafeWal,
160+
prometheus.GaugeValue, float64(safeWalSize.Int64), slotNameLabel, slotTypeLabel,
161+
)
162+
}
163+
164+
if walStatus.Valid {
165+
ch <- prometheus.MustNewConstMetric(
166+
pgReplicationSlotWalStatus,
167+
prometheus.GaugeValue, 1, slotNameLabel, slotTypeLabel, walStatus.String,
168+
)
169+
}
134170
}
135171
return rows.Err()
136172
}

‎collector/pg_replication_slot_test.go

+13-8
Original file line numberDiff line numberDiff line change
@@ -31,9 +31,9 @@ func TestPgReplicationSlotCollectorActive(t *testing.T) {
3131

3232
inst := &instance{db: db}
3333

34-
columns := []string{"slot_name", "slot_type", "current_wal_lsn", "confirmed_flush_lsn", "active"}
34+
columns := []string{"slot_name", "slot_type", "current_wal_lsn", "confirmed_flush_lsn", "active", "safe_wal_size", "wal_status"}
3535
rows := sqlmock.NewRows(columns).
36-
AddRow("test_slot", "physical", 5, 3, true)
36+
AddRow("test_slot", "physical", 5, 3, true, 323906992, "reserved")
3737
mock.ExpectQuery(sanitizeQuery(pgReplicationSlotQuery)).WillReturnRows(rows)
3838

3939
ch := make(chan prometheus.Metric)
@@ -50,6 +50,8 @@ func TestPgReplicationSlotCollectorActive(t *testing.T) {
5050
{labels: labelMap{"slot_name": "test_slot", "slot_type": "physical"}, value: 5, metricType: dto.MetricType_GAUGE},
5151
{labels: labelMap{"slot_name": "test_slot", "slot_type": "physical"}, value: 3, metricType: dto.MetricType_GAUGE},
5252
{labels: labelMap{"slot_name": "test_slot", "slot_type": "physical"}, value: 1, metricType: dto.MetricType_GAUGE},
53+
{labels: labelMap{"slot_name": "test_slot", "slot_type": "physical"}, value: 323906992, metricType: dto.MetricType_GAUGE},
54+
{labels: labelMap{"slot_name": "test_slot", "slot_type": "physical", "wal_status": "reserved"}, value: 1, metricType: dto.MetricType_GAUGE},
5355
}
5456

5557
convey.Convey("Metrics comparison", t, func() {
@@ -72,9 +74,9 @@ func TestPgReplicationSlotCollectorInActive(t *testing.T) {
7274

7375
inst := &instance{db: db}
7476

75-
columns := []string{"slot_name", "slot_type", "current_wal_lsn", "confirmed_flush_lsn", "active"}
77+
columns := []string{"slot_name", "slot_type", "current_wal_lsn", "confirmed_flush_lsn", "active", "safe_wal_size", "wal_status"}
7678
rows := sqlmock.NewRows(columns).
77-
AddRow("test_slot", "physical", 6, 12, false)
79+
AddRow("test_slot", "physical", 6, 12, false, -4000, "extended")
7880
mock.ExpectQuery(sanitizeQuery(pgReplicationSlotQuery)).WillReturnRows(rows)
7981

8082
ch := make(chan prometheus.Metric)
@@ -90,6 +92,8 @@ func TestPgReplicationSlotCollectorInActive(t *testing.T) {
9092
expected := []MetricResult{
9193
{labels: labelMap{"slot_name": "test_slot", "slot_type": "physical"}, value: 6, metricType: dto.MetricType_GAUGE},
9294
{labels: labelMap{"slot_name": "test_slot", "slot_type": "physical"}, value: 0, metricType: dto.MetricType_GAUGE},
95+
{labels: labelMap{"slot_name": "test_slot", "slot_type": "physical"}, value: -4000, metricType: dto.MetricType_GAUGE},
96+
{labels: labelMap{"slot_name": "test_slot", "slot_type": "physical", "wal_status": "extended"}, value: 1, metricType: dto.MetricType_GAUGE},
9397
}
9498

9599
convey.Convey("Metrics comparison", t, func() {
@@ -113,9 +117,9 @@ func TestPgReplicationSlotCollectorActiveNil(t *testing.T) {
113117

114118
inst := &instance{db: db}
115119

116-
columns := []string{"slot_name", "slot_type", "current_wal_lsn", "confirmed_flush_lsn", "active"}
120+
columns := []string{"slot_name", "slot_type", "current_wal_lsn", "confirmed_flush_lsn", "active", "safe_wal_size", "wal_status"}
117121
rows := sqlmock.NewRows(columns).
118-
AddRow("test_slot", "physical", 6, 12, nil)
122+
AddRow("test_slot", "physical", 6, 12, nil, nil, "lost")
119123
mock.ExpectQuery(sanitizeQuery(pgReplicationSlotQuery)).WillReturnRows(rows)
120124

121125
ch := make(chan prometheus.Metric)
@@ -131,6 +135,7 @@ func TestPgReplicationSlotCollectorActiveNil(t *testing.T) {
131135
expected := []MetricResult{
132136
{labels: labelMap{"slot_name": "test_slot", "slot_type": "physical"}, value: 6, metricType: dto.MetricType_GAUGE},
133137
{labels: labelMap{"slot_name": "test_slot", "slot_type": "physical"}, value: 0, metricType: dto.MetricType_GAUGE},
138+
{labels: labelMap{"slot_name": "test_slot", "slot_type": "physical", "wal_status": "lost"}, value: 1, metricType: dto.MetricType_GAUGE},
134139
}
135140

136141
convey.Convey("Metrics comparison", t, func() {
@@ -153,9 +158,9 @@ func TestPgReplicationSlotCollectorTestNilValues(t *testing.T) {
153158

154159
inst := &instance{db: db}
155160

156-
columns := []string{"slot_name", "slot_type", "current_wal_lsn", "confirmed_flush_lsn", "active"}
161+
columns := []string{"slot_name", "slot_type", "current_wal_lsn", "confirmed_flush_lsn", "active", "safe_wal_size", "wal_status"}
157162
rows := sqlmock.NewRows(columns).
158-
AddRow(nil, nil, nil, nil, true)
163+
AddRow(nil, nil, nil, nil, true, nil, nil)
159164
mock.ExpectQuery(sanitizeQuery(pgReplicationSlotQuery)).WillReturnRows(rows)
160165

161166
ch := make(chan prometheus.Metric)

‎collector/pg_stat_database.go

+54-37
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,10 @@ package collector
1616
import (
1717
"context"
1818
"database/sql"
19+
"fmt"
20+
"strings"
1921

22+
"github.com/blang/semver/v4"
2023
"github.com/go-kit/log"
2124
"github.com/go-kit/log/level"
2225
"github.com/prometheus/client_golang/prometheus"
@@ -215,37 +218,44 @@ var (
215218
[]string{"datid", "datname"},
216219
prometheus.Labels{},
217220
)
218-
219-
statDatabaseQuery = `
220-
SELECT
221-
datid
222-
,datname
223-
,numbackends
224-
,xact_commit
225-
,xact_rollback
226-
,blks_read
227-
,blks_hit
228-
,tup_returned
229-
,tup_fetched
230-
,tup_inserted
231-
,tup_updated
232-
,tup_deleted
233-
,conflicts
234-
,temp_files
235-
,temp_bytes
236-
,deadlocks
237-
,blk_read_time
238-
,blk_write_time
239-
,active_time
240-
,stats_reset
241-
FROM pg_stat_database;
242-
`
243221
)
244222

223+
func statDatabaseQuery(columns []string) string {
224+
return fmt.Sprintf("SELECT %s FROM pg_stat_database;", strings.Join(columns, ","))
225+
}
226+
245227
func (c *PGStatDatabaseCollector) Update(ctx context.Context, instance *instance, ch chan<- prometheus.Metric) error {
246228
db := instance.getDB()
229+
230+
columns := []string{
231+
"datid",
232+
"datname",
233+
"numbackends",
234+
"xact_commit",
235+
"xact_rollback",
236+
"blks_read",
237+
"blks_hit",
238+
"tup_returned",
239+
"tup_fetched",
240+
"tup_inserted",
241+
"tup_updated",
242+
"tup_deleted",
243+
"conflicts",
244+
"temp_files",
245+
"temp_bytes",
246+
"deadlocks",
247+
"blk_read_time",
248+
"blk_write_time",
249+
"stats_reset",
250+
}
251+
252+
activeTimeAvail := instance.version.GTE(semver.MustParse("14.0.0"))
253+
if activeTimeAvail {
254+
columns = append(columns, "active_time")
255+
}
256+
247257
rows, err := db.QueryContext(ctx,
248-
statDatabaseQuery,
258+
statDatabaseQuery(columns),
249259
)
250260
if err != nil {
251261
return err
@@ -257,7 +267,7 @@ func (c *PGStatDatabaseCollector) Update(ctx context.Context, instance *instance
257267
var numBackends, xactCommit, xactRollback, blksRead, blksHit, tupReturned, tupFetched, tupInserted, tupUpdated, tupDeleted, conflicts, tempFiles, tempBytes, deadlocks, blkReadTime, blkWriteTime, activeTime sql.NullFloat64
258268
var statsReset sql.NullTime
259269

260-
err := rows.Scan(
270+
r := []any{
261271
&datid,
262272
&datname,
263273
&numBackends,
@@ -276,9 +286,14 @@ func (c *PGStatDatabaseCollector) Update(ctx context.Context, instance *instance
276286
&deadlocks,
277287
&blkReadTime,
278288
&blkWriteTime,
279-
&activeTime,
280289
&statsReset,
281-
)
290+
}
291+
292+
if activeTimeAvail {
293+
r = append(r, &activeTime)
294+
}
295+
296+
err := rows.Scan(r...)
282297
if err != nil {
283298
return err
284299
}
@@ -355,7 +370,7 @@ func (c *PGStatDatabaseCollector) Update(ctx context.Context, instance *instance
355370
level.Debug(c.log).Log("msg", "Skipping collecting metric because it has no blk_write_time")
356371
continue
357372
}
358-
if !activeTime.Valid {
373+
if activeTimeAvail && !activeTime.Valid {
359374
level.Debug(c.log).Log("msg", "Skipping collecting metric because it has no active_time")
360375
continue
361376
}
@@ -482,19 +497,21 @@ func (c *PGStatDatabaseCollector) Update(ctx context.Context, instance *instance
482497
labels...,
483498
)
484499

485-
ch <- prometheus.MustNewConstMetric(
486-
statDatabaseActiveTime,
487-
prometheus.CounterValue,
488-
activeTime.Float64/1000.0,
489-
labels...,
490-
)
491-
492500
ch <- prometheus.MustNewConstMetric(
493501
statDatabaseStatsReset,
494502
prometheus.CounterValue,
495503
statsResetMetric,
496504
labels...,
497505
)
506+
507+
if activeTimeAvail {
508+
ch <- prometheus.MustNewConstMetric(
509+
statDatabaseActiveTime,
510+
prometheus.CounterValue,
511+
activeTime.Float64/1000.0,
512+
labels...,
513+
)
514+
}
498515
}
499516
return nil
500517
}

0 commit comments

Comments
 (0)