File: backrest_last_backup_metrics.go

package info (click to toggle)
prometheus-pgbackrest-exporter 0.19.0%2Bds1-2
  • links: PTS, VCS
  • area: main
  • in suites: sid, trixie
  • size: 480 kB
  • sloc: sh: 141; makefile: 136
file content (379 lines) | stat: -rw-r--r-- 12,438 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
package backrest

import (
	"sync"
	"time"

	"github.com/go-kit/log"
	"github.com/go-kit/log/level"
	"github.com/prometheus/client_golang/prometheus"
	"github.com/prometheus/client_golang/prometheus/promauto"
)

var (
	// Differential backup is always based on last full,
	// if the last backup was full, the metric will take full backup value.
	// Incremental backup is always based on last full or differential,
	// if the last backup was full or differential, the metric will take
	// full or differential backup value.
	pgbrStanzaBackupSinceLastCompletionSecondsMetric = promauto.NewGaugeVec(prometheus.GaugeOpts{
		Name: "pgbackrest_backup_since_last_completion_seconds",
		Help: "Seconds since the last completed full, differential or incremental backup.",
	},
		[]string{
			"backup_type",
			"block_incr",
			"stanza"})
	pgbrStanzaBackupLastDurationMetric = promauto.NewGaugeVec(prometheus.GaugeOpts{
		Name: "pgbackrest_backup_last_duration_seconds",
		Help: "Backup duration for the last full, differential or incremental backup.",
	},
		[]string{
			"backup_type",
			"block_incr",
			"stanza",
		})
	pgbrStanzaBackupLastDatabaseSizeMetric = promauto.NewGaugeVec(prometheus.GaugeOpts{
		Name: "pgbackrest_backup_last_size_bytes",
		Help: "Full uncompressed size of the database in the last full, differential or incremental backup.",
	},
		[]string{
			"backup_type",
			"block_incr",
			"stanza"})
	pgbrStanzaBackupLastDatabaseBackupSizeMetric = promauto.NewGaugeVec(prometheus.GaugeOpts{
		Name: "pgbackrest_backup_last_delta_bytes",
		Help: "Amount of data in the database to actually backup in the last full, differential or incremental backup.",
	},
		[]string{
			"backup_type",
			"block_incr",
			"stanza"})
	pgbrStanzaBackupLastRepoBackupSetSizeMetric = promauto.NewGaugeVec(prometheus.GaugeOpts{
		Name: "pgbackrest_backup_last_repo_size_bytes",
		Help: "Full compressed files size to restore the database from the last full, differential or incremental backup.",
	},
		[]string{
			"backup_type",
			"block_incr",
			"stanza"})
	pgbrStanzaBackupLastRepoBackupSetSizeMapMetric = promauto.NewGaugeVec(prometheus.GaugeOpts{
		Name: "pgbackrest_backup_last_repo_size_map_bytes",
		Help: "Size of block incremental map in the last full, differential or incremental backup.",
	},
		[]string{
			"backup_type",
			"block_incr",
			"stanza"})
	pgbrStanzaBackupLastRepoBackupSizeMetric = promauto.NewGaugeVec(prometheus.GaugeOpts{
		Name: "pgbackrest_backup_last_repo_delta_bytes",
		Help: "Compressed files size in the last full, differential or incremental backup.",
	},
		[]string{
			"backup_type",
			"block_incr",
			"stanza"})
	pgbrStanzaBackupLastRepoBackupSizeMapMetric = promauto.NewGaugeVec(prometheus.GaugeOpts{
		Name: "pgbackrest_backup_last_repo_delta_map_bytes",
		Help: "Size of block incremental delta map in the last full, differential or incremental backup.",
	},
		[]string{
			"backup_type",
			"block_incr",
			"stanza"})
	pgbrStanzaBackupLastErrorMetric = promauto.NewGaugeVec(prometheus.GaugeOpts{
		Name: "pgbackrest_backup_last_error_status",
		Help: "Error status in the last full, differential or incremental backup.",
	},
		[]string{
			"backup_type",
			"block_incr",
			"stanza"})
	pgbrStanzaBackupLastAnnotationsMetric = promauto.NewGaugeVec(prometheus.GaugeOpts{
		Name: "pgbackrest_backup_last_annotations",
		Help: "Number of annotations in the last full, differential or incremental backup.",
	},
		[]string{
			"backup_type",
			"block_incr",
			"stanza",
		})
	// For json pgBackRest output
	pgbrStanzaBackupLastReferencesMetric = promauto.NewGaugeVec(prometheus.GaugeOpts{
		Name: "pgbackrest_backup_last_references",
		Help: "Number of references to another backup (backup reference list) in the last full, differential or incremental backup.",
	},
		[]string{
			// Don't change this order.
			// See function processBackupReferencesCount().
			"ref_backup",
			"backup_type",
			"block_incr",
			"stanza"})
	pgbrStanzaBackupLastDatabasesMetric = promauto.NewGaugeVec(prometheus.GaugeOpts{
		Name: "pgbackrest_backup_last_databases",
		Help: "Number of databases in the last full, differential or incremental backup.",
	},
		[]string{
			// Don't change this order.
			// See function processSpecificBackupData().
			"backup_type",
			"stanza",
			"block_incr",
		})
)

// Set backup metrics:
//   - pgbackrest_backup_since_last_completion_seconds
//   - pgbackrest_backup_last_duration_seconds
//   - pgbackrest_backup_last_size_bytes
//   - pgbackrest_backup_last_delta_bytes
//   - pgbackrest_backup_last_repo_size_bytes
//   - pgbackrest_backup_last_repo_size_map_bytes
//   - pgbackrest_backup_last_repo_delta_bytes
//   - pgbackrest_backup_last_repo_delta_map_bytes
//   - pgbackrest_backup_last_error_status
//   - pgbackrest_backup_last_annotations
func getBackupLastMetrics(stanzaName string, lastBackups lastBackupsStruct, currentUnixTime int64, setUpMetricValueFun setUpMetricValueFunType, logger log.Logger) {
	for _, backup := range []backupStruct{lastBackups.full, lastBackups.diff, lastBackups.incr} {
		// Repo backup map size for last backups.
		setUpMetric(
			pgbrStanzaBackupLastRepoBackupSetSizeMapMetric,
			"pgbackrest_backup_last_repo_size_map_bytes",
			convertInt64PointerToFloat64(backup.backupRepoSizeMap),
			setUpMetricValueFun,
			logger,
			backup.backupType,
			backup.backupBlockIncr,
			stanzaName,
		)
		// Repo backup delta map size for last backups.
		setUpMetric(
			pgbrStanzaBackupLastRepoBackupSizeMapMetric,
			"pgbackrest_backup_last_repo_delta_map_bytes",
			convertInt64PointerToFloat64(backup.backupRepoDeltaMap),
			setUpMetricValueFun,
			logger,
			backup.backupType,
			backup.backupBlockIncr,
			stanzaName,
		)
		// Seconds since the last completed backups.
		setUpMetric(
			pgbrStanzaBackupSinceLastCompletionSecondsMetric,
			"pgbackrest_backup_since_last_completion_seconds",
			time.Unix(currentUnixTime, 0).Sub(backup.backupTime).Seconds(),
			setUpMetricValueFun,
			logger,
			backup.backupType,
			backup.backupBlockIncr,
			stanzaName,
		)
		// Backup durations in seconds for last backups.
		setUpMetric(
			pgbrStanzaBackupLastDurationMetric,
			"pgbackrest_backup_last_duration_seconds",
			backup.backupDuration,
			setUpMetricValueFun,
			logger,
			backup.backupType,
			backup.backupBlockIncr,
			stanzaName,
		)
		// Database size for last backups.
		setUpMetric(
			pgbrStanzaBackupLastDatabaseSizeMetric,
			"pgbackrest_backup_last_size_bytes",
			float64(backup.backupSize),
			setUpMetricValueFun,
			logger,
			backup.backupType,
			backup.backupBlockIncr,
			stanzaName,
		)
		// Database backup size for last backups.
		setUpMetric(
			pgbrStanzaBackupLastDatabaseBackupSizeMetric,
			"pgbackrest_backup_last_delta_bytes",
			float64(backup.backupDelta),
			setUpMetricValueFun,
			logger,
			backup.backupType,
			backup.backupBlockIncr,
			stanzaName,
		)
		// Repo backup set size.
		setUpMetric(
			pgbrStanzaBackupLastRepoBackupSetSizeMetric,
			"pgbackrest_backup_last_repo_size_bytes",
			convertInt64PointerToFloat64(backup.backupRepoSize),
			setUpMetricValueFun,
			logger,
			backup.backupType,
			backup.backupBlockIncr,
			stanzaName,
		)
		// Repo backup size.
		setUpMetric(
			pgbrStanzaBackupLastRepoBackupSizeMetric,
			"pgbackrest_backup_last_repo_delta_bytes",
			float64(backup.backupRepoDelta),
			setUpMetricValueFun,
			logger,
			backup.backupType,
			backup.backupBlockIncr,
			stanzaName,
		)
		// Backup error status.
		setUpMetric(
			pgbrStanzaBackupLastErrorMetric,
			"pgbackrest_backup_last_error_status",
			convertBoolPointerToFloat64(backup.backupError),
			setUpMetricValueFun,
			logger,
			backup.backupType,
			backup.backupBlockIncr,
			stanzaName,
		)
		// Number of backup annotations.
		// Information about number of annotations in backup has appeared since pgBackRest v2.41.
		// If there are no annotations, the metric will be set to 0 for this backup.
		setUpMetric(
			pgbrStanzaBackupLastAnnotationsMetric,
			"pgbackrest_backup_last_annotations",
			convertAnnotationPointerToFloat64(backup.backupAnnotation),
			setUpMetricValueFun,
			logger,
			backup.backupType,
			backup.backupBlockIncr,
			stanzaName,
		)
		// Number of references to another backup (backup reference list).
		// For no-last backups, the metric is collected only if the flag is set.
		// For last backups, the metric is always collected.
		processBackupReferencesCount(
			backup.backupReference,
			"pgbackrest_backup_last_references",
			pgbrStanzaBackupLastReferencesMetric,
			setUpMetricValueFun,
			logger,
			backup.backupType,
			backup.backupBlockIncr,
			stanzaName)
	}
}

// Set backup metrics:
//   - pgbackrest_backup_last_databases
func getBackupLastDBCountMetrics(config, configIncludePath, stanzaName string, lastBackups lastBackupsStruct, setUpMetricValueFun setUpMetricValueFunType, logger log.Logger) {
	// For diff and incr run in parallel.
	var wg sync.WaitGroup
	// If name for diff backup is equal to full, there is no point in re-receiving data.
	if lastBackups.diff.backupLabel != lastBackups.full.backupLabel {
		wg.Add(1)
		go func(backupLabel, backupType, backupBlockIncr string) {
			defer wg.Done()
			processSpecificBackupData(
				config,
				configIncludePath,
				stanzaName,
				backupLabel,
				backupType,
				"pgbackrest_backup_last_databases",
				pgbrStanzaBackupLastDatabasesMetric,
				setUpMetricValueFun,
				logger,
				backupBlockIncr,
			)
		}(lastBackups.diff.backupLabel, lastBackups.diff.backupType, lastBackups.diff.backupBlockIncr)
	}
	// If name for diff backup is equal to full, there is no point in re-receiving data.
	if lastBackups.incr.backupLabel != lastBackups.diff.backupLabel {
		wg.Add(1)
		go func(backupLabel, backupType, backupBlockIncr string) {
			defer wg.Done()
			processSpecificBackupData(
				config,
				configIncludePath,
				stanzaName,
				backupLabel,
				backupType,
				"pgbackrest_backup_last_databases",
				pgbrStanzaBackupLastDatabasesMetric,
				setUpMetricValueFun,
				logger,
				backupBlockIncr,
			)
		}(lastBackups.incr.backupLabel, lastBackups.incr.backupType, lastBackups.incr.backupBlockIncr)
	}
	var metricValue float64 = 0
	// Try to get info for full backup.
	parseStanzaDataSpecific, err := getParsedSpecificBackupInfoData(config, configIncludePath, stanzaName, lastBackups.full.backupLabel, logger)
	if err != nil {
		level.Error(logger).Log(
			"msg", "Get data from pgBackRest failed",
			"stanza", stanzaName,
			"backup", lastBackups.full.backupLabel,
			"err", err,
		)
	}
	if (len(parseStanzaDataSpecific) != 0 && len(parseStanzaDataSpecific[0].Backup) != 0) &&
		parseStanzaDataSpecific[0].Backup[0].DatabaseRef != nil {
		metricValue = convertDatabaseRefPointerToFloat(parseStanzaDataSpecific[0].Backup[0].DatabaseRef)
	} else {
		level.Warn(logger).Log("msg", "No backup data returned",
			"stanza", stanzaName,
			"backup", lastBackups.full.backupLabel,
		)
	}
	// Number of databases in the last full backup.
	setUpMetric(
		pgbrStanzaBackupLastDatabasesMetric,
		"pgbackrest_backup_last_databases",
		metricValue,
		setUpMetricValueFun,
		logger,
		lastBackups.full.backupType,
		stanzaName,
		lastBackups.full.backupBlockIncr,
	)
	if lastBackups.diff.backupLabel == lastBackups.full.backupLabel {
		setUpMetric(
			pgbrStanzaBackupLastDatabasesMetric,
			"pgbackrest_backup_last_databases",
			metricValue,
			setUpMetricValueFun,
			logger,
			lastBackups.diff.backupType,
			stanzaName,
			lastBackups.diff.backupBlockIncr,
		)
	}
	if lastBackups.incr.backupLabel == lastBackups.diff.backupLabel {
		setUpMetric(
			pgbrStanzaBackupLastDatabasesMetric,
			"pgbackrest_backup_last_databases",
			metricValue,
			setUpMetricValueFun,
			logger,
			lastBackups.incr.backupType,
			stanzaName,
			lastBackups.incr.backupBlockIncr,
		)
	}
}

func resetLastBackupMetrics() {
	pgbrStanzaBackupSinceLastCompletionSecondsMetric.Reset()
	pgbrStanzaBackupLastDatabasesMetric.Reset()
	pgbrStanzaBackupLastDurationMetric.Reset()
	pgbrStanzaBackupLastDatabaseSizeMetric.Reset()
	pgbrStanzaBackupLastDatabaseBackupSizeMetric.Reset()
	pgbrStanzaBackupLastRepoBackupSetSizeMetric.Reset()
	pgbrStanzaBackupLastRepoBackupSetSizeMapMetric.Reset()
	pgbrStanzaBackupLastRepoBackupSizeMetric.Reset()
	pgbrStanzaBackupLastRepoBackupSizeMapMetric.Reset()
	pgbrStanzaBackupLastErrorMetric.Reset()
	pgbrStanzaBackupLastAnnotationsMetric.Reset()
	pgbrStanzaBackupLastReferencesMetric.Reset()
}