Skip to content

Commit a4ac0e6

Browse files
MarcWortMarcWort
authored
feat: Add safe_wal_size and wal_status to replication_slot (#1027)
* feat: Add safe_wal_size to replication_slot Signed-off-by: MarcWort <[email protected]> * feat: Add wal_status to replication_slot Signed-off-by: MarcWort <[email protected]> --------- Signed-off-by: MarcWort <[email protected]>
1 parent cc0fd2e commit a4ac0e6

File tree

2 files changed

+51
-10
lines changed

2 files changed

+51
-10
lines changed

‎collector/pg_replication_slot.go‎

Lines changed: 38 additions & 2 deletions
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‎

Lines changed: 13 additions & 8 deletions
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)

0 commit comments

Comments
 (0)