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 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464
|
package backrest
import (
"strconv"
"sync"
"time"
"github.com/go-kit/log"
"github.com/prometheus/client_golang/prometheus"
"github.com/prometheus/client_golang/prometheus/promauto"
)
var (
pgbrStanzaBackupInfoMetric = promauto.NewGaugeVec(prometheus.GaugeOpts{
Name: "pgbackrest_backup_info",
Help: "Backup info.",
},
[]string{
"backrest_ver",
"backup_name",
"backup_type",
"block_incr",
"database_id",
"lsn_start",
"lsn_stop",
"pg_version",
"prior",
"repo_key",
"stanza",
"wal_start",
"wal_stop"})
pgbrStanzaBackupDurationMetric = promauto.NewGaugeVec(prometheus.GaugeOpts{
Name: "pgbackrest_backup_duration_seconds",
Help: "Backup duration.",
},
[]string{
"backup_name",
"backup_type",
"block_incr",
"database_id",
"repo_key",
"stanza",
"start_time",
"stop_time"})
// The 'database size' for text pgBackRest output
// (or "backup":"info":"size" for json pgBackRest output)
// is the full uncompressed size of the database.
pgbrStanzaBackupDatabaseSizeMetric = promauto.NewGaugeVec(prometheus.GaugeOpts{
Name: "pgbackrest_backup_size_bytes",
Help: "Full uncompressed size of the database.",
},
[]string{
"backup_name",
"backup_type",
"block_incr",
"database_id",
"repo_key",
"stanza"})
// The 'database backup size' for text pgBackRest output
// (or "backup":"info":"delta" for json pgBackRest output)
// is the amount of data in the database
// to actually backup (these will be the same for full backups).
pgbrStanzaBackupDatabaseBackupSizeMetric = promauto.NewGaugeVec(prometheus.GaugeOpts{
Name: "pgbackrest_backup_delta_bytes",
Help: "Amount of data in the database to actually backup.",
},
[]string{
"backup_name",
"backup_type",
"block_incr",
"database_id",
"repo_key",
"stanza"})
// The 'backup set size' for text pgBackRest output
// (or "backup":"info":"repository":"size" for json pgBackRest output)
// includes all the files from this backup and
// any referenced backups in the repository that are required
// to restore the database from this backup.
// Repository 'backup set size' reflect compressed file sizes
// if compression is enabled in pgBackRest.
// Before pgBackRest v2.38 - reflect compressed file sizes
// if compression is enabled in pgBackRest or filesystem.
// From pgbackRest v2.38 the logic that tried
// to determine additional file system compression was removed.
pgbrStanzaBackupRepoBackupSetSizeMetric = promauto.NewGaugeVec(prometheus.GaugeOpts{
Name: "pgbackrest_backup_repo_size_bytes",
Help: "Full compressed files size to restore the database from backup.",
},
[]string{
"backup_name",
"backup_type",
"block_incr",
"database_id",
"repo_key",
"stanza"})
// For json pgBackRest output
// "backup":"info":"repository":"size-map"
// Size of block incremental map (0 if no map).
pgbrStanzaBackupRepoBackupSetSizeMapMetric = promauto.NewGaugeVec(prometheus.GaugeOpts{
Name: "pgbackrest_backup_repo_size_map_bytes",
Help: "Size of block incremental map.",
},
[]string{
"backup_name",
"backup_type",
"block_incr",
"database_id",
"repo_key",
"stanza"})
// The 'backup size' for text pgBackRest output
// (or "backup":"info":"repository":"delta" for json pgBackRest output)
// includes only the files in this backup
// (these will also be the same for full backups).
// Repository 'backup size' reflect compressed file sizes
// if compression is enabled in pgBackRest.
// Before pgBackRest v2.38 - reflect compressed file sizes
// if compression is enabled in pgBackRest or filesystem.
// From pgbackRest v2.38 the logic that tried
// to determine additional file system compression was removed.
pgbrStanzaBackupRepoBackupSizeMetric = promauto.NewGaugeVec(prometheus.GaugeOpts{
Name: "pgbackrest_backup_repo_delta_bytes",
Help: "Compressed files size in backup.",
},
[]string{
"backup_name",
"backup_type",
"block_incr",
"database_id",
"repo_key",
"stanza"})
// For json pgBackRest output
// "backup":"info":"repository":"delta-map"
// Size of block incremental delta map if block incremental.
pgbrStanzaBackupRepoBackupSizeMapMetric = promauto.NewGaugeVec(prometheus.GaugeOpts{
Name: "pgbackrest_backup_repo_delta_map_bytes",
Help: "Size of block incremental delta map.",
},
[]string{
"backup_name",
"backup_type",
"block_incr",
"database_id",
"repo_key",
"stanza"})
pgbrStanzaBackupErrorMetric = promauto.NewGaugeVec(prometheus.GaugeOpts{
Name: "pgbackrest_backup_error_status",
Help: "Backup error status.",
},
[]string{
"backup_name",
"backup_type",
"block_incr",
"database_id",
"repo_key",
"stanza"})
pgbrStanzaBackupAnnotationsMetric = promauto.NewGaugeVec(prometheus.GaugeOpts{
Name: "pgbackrest_backup_annotations",
Help: "Number of annotations in backup.",
},
[]string{
"backup_name",
"backup_type",
"block_incr",
"database_id",
"repo_key",
"stanza"})
// For json pgBackRest output
// "backup":"reference"
// Number of references to another backups (backup reference list).
pgbrStanzaBackupReferencesMetric = promauto.NewGaugeVec(prometheus.GaugeOpts{
Name: "pgbackrest_backup_references",
Help: "Number of references to another backup (backup reference list).",
},
[]string{
// Don't change this order.
// See function processBackupReferencesCount().
"ref_backup",
"backup_name",
"backup_type",
"block_incr",
"database_id",
"repo_key",
"stanza"})
pgbrStanzaBackupDatabasesMetric = promauto.NewGaugeVec(prometheus.GaugeOpts{
Name: "pgbackrest_backup_databases",
Help: "Number of databases in backup.",
},
[]string{
// Don't change this order.
// See function processSpecificBackupData().
"backup_type",
"stanza",
"backup_name",
"block_incr",
"database_id",
"repo_key"})
)
// Set backup metrics:
// - pgbackrest_backup_info
// - pgbackrest_backup_duration_seconds
// - pgbackrest_backup_size_bytes
// - pgbackrest_backup_delta_bytes
// - pgbackrest_backup_references
// - pgbackrest_backup_repo_size_bytes
// - pgbackrest_backup_repo_size_map_bytes
// - pgbackrest_backup_repo_delta_bytes
// - pgbackrest_backup_repo_delta_map_bytes
// - pgbackrest_backup_error_status
// - pgbackrest_backup_annotations
//
// And returns info about last backups.
func getBackupMetrics(stanzaName string, backupRefCount bool, backupData []backup, dbData []db, setUpMetricValueFun setUpMetricValueFunType, logger log.Logger) lastBackupsStruct {
lastBackups := initLastBackupStruct()
// Each backup for current stanza.
for _, backup := range backupData {
// For pgBackRest >= v2.44 the functionality to perform a block incremental backup has appeared.
// The block size is determined based on the file size and age.
// Very old or very small files will not use block incremental.
// By default, the block incremental is disable for backups. See `--repo-block` option.
blockIncr := backup.checkBackupIncremental()
// Backup info.
// 1 - info about backup is exist.
setUpMetric(
pgbrStanzaBackupInfoMetric,
"pgbackrest_backup_info",
1,
setUpMetricValueFun,
logger,
backup.BackrestInfo.Version,
backup.Label,
backup.Type,
blockIncr,
strconv.Itoa(backup.Database.ID),
convertEmptyLSNValueLabel(backup.Lsn.StartLSN),
convertEmptyLSNValueLabel(backup.Lsn.StopLSN),
getPGVersion(backup.Database.ID, backup.Database.RepoKey, dbData),
backup.Prior,
strconv.Itoa(backup.Database.RepoKey),
stanzaName,
backup.Archive.StartWAL,
backup.Archive.StopWAL,
)
// Backup durations in seconds.
setUpMetric(
pgbrStanzaBackupDurationMetric,
"pgbackrest_backup_duration_seconds",
time.Unix(backup.Timestamp.Stop, 0).Sub(time.Unix(backup.Timestamp.Start, 0)).Seconds(),
setUpMetricValueFun,
logger,
backup.Label,
backup.Type,
blockIncr,
strconv.Itoa(backup.Database.ID),
strconv.Itoa(backup.Database.RepoKey),
stanzaName,
time.Unix(backup.Timestamp.Start, 0).Format(layout),
time.Unix(backup.Timestamp.Stop, 0).Format(layout),
)
// Database size.
setUpMetric(
pgbrStanzaBackupDatabaseSizeMetric,
"pgbackrest_backup_size_bytes",
float64(backup.Info.Size),
setUpMetricValueFun,
logger,
backup.Label,
backup.Type,
blockIncr,
strconv.Itoa(backup.Database.ID),
strconv.Itoa(backup.Database.RepoKey),
stanzaName,
)
// Database backup size.
setUpMetric(
pgbrStanzaBackupDatabaseBackupSizeMetric,
"pgbackrest_backup_delta_bytes",
float64(backup.Info.Delta),
setUpMetricValueFun,
logger,
backup.Label,
backup.Type,
blockIncr,
strconv.Itoa(backup.Database.ID),
strconv.Itoa(backup.Database.RepoKey),
stanzaName,
)
// Repo backup set size.
// Starting from pgBackRest v2.45, there is no 'backup set size' value
// for block incremental backups.
// See https://github.com/pgbackrest/pgbackrest/commit/6252c0e4485caee362edec13302a5f735a69bff4
// and https://github.com/pgbackrest/pgbackrest/projects/2#card-87759001
// This behavior may change in future pgBackRest releases.
// If value is absent, metric will be set to 0.
setUpMetric(
pgbrStanzaBackupRepoBackupSetSizeMetric,
"pgbackrest_backup_repo_size_bytes",
convertInt64PointerToFloat64(backup.Info.Repository.Size),
setUpMetricValueFun,
logger,
backup.Label,
backup.Type,
blockIncr,
strconv.Itoa(backup.Database.ID),
strconv.Itoa(backup.Database.RepoKey),
stanzaName,
)
// Repo backup size.
setUpMetric(
pgbrStanzaBackupRepoBackupSizeMetric,
"pgbackrest_backup_repo_delta_bytes",
float64(backup.Info.Repository.Delta),
setUpMetricValueFun,
logger,
backup.Label,
backup.Type,
blockIncr,
strconv.Itoa(backup.Database.ID),
strconv.Itoa(backup.Database.RepoKey),
stanzaName,
)
// Repo backup map size.
// If value is absent, metric will be set to 0.
setUpMetric(
pgbrStanzaBackupRepoBackupSetSizeMapMetric,
"pgbackrest_backup_repo_size_map_bytes",
convertInt64PointerToFloat64(backup.Info.Repository.SizeMap),
setUpMetricValueFun,
logger,
backup.Label,
backup.Type,
blockIncr,
strconv.Itoa(backup.Database.ID),
strconv.Itoa(backup.Database.RepoKey),
stanzaName,
)
// Repo backup delta map size.
// If value is absent, metric will be set to 0.
// It's necessary to avoid flapping time series.
setUpMetric(
pgbrStanzaBackupRepoBackupSizeMapMetric,
"pgbackrest_backup_repo_delta_map_bytes",
convertInt64PointerToFloat64(backup.Info.Repository.DeltaMap),
setUpMetricValueFun,
logger,
backup.Label,
backup.Type,
blockIncr,
strconv.Itoa(backup.Database.ID),
strconv.Itoa(backup.Database.RepoKey),
stanzaName,
)
// Backup error status.
// Information about error in backup (page checksum error) has appeared since pgBackRest v2.36.
// In versions < v2.36 this field is missing and the metric will be set to 0.
setUpMetric(
pgbrStanzaBackupErrorMetric,
"pgbackrest_backup_error_status",
convertBoolPointerToFloat64(backup.Error),
setUpMetricValueFun,
logger,
backup.Label,
backup.Type,
blockIncr,
strconv.Itoa(backup.Database.ID),
strconv.Itoa(backup.Database.RepoKey),
stanzaName,
)
// Number of backup annotations.
// Information about 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(
pgbrStanzaBackupAnnotationsMetric,
"pgbackrest_backup_annotations",
convertAnnotationPointerToFloat64(backup.Annotation),
setUpMetricValueFun,
logger,
backup.Label,
backup.Type,
blockIncr,
strconv.Itoa(backup.Database.ID),
strconv.Itoa(backup.Database.RepoKey),
stanzaName,
)
// Number of references to another backup (backup reference list).
// This metric could be a little bit annoying because it will be set for each backup.
// For no-last backups, the metric is collected only if the flag is set.
// For last backups, the metric is always collected.
if backupRefCount {
processBackupReferencesCount(
backup.Reference,
"pgbackrest_backup_references",
pgbrStanzaBackupReferencesMetric,
setUpMetricValueFun,
logger,
backup.Label,
backup.Type,
blockIncr,
strconv.Itoa(backup.Database.ID),
strconv.Itoa(backup.Database.RepoKey),
stanzaName)
}
compareLastBackups(&lastBackups, backup, blockIncr)
}
return lastBackups
}
// Set backup metrics:
// - pgbackrest_backup_databases
func getBackupDBCountMetrics(maxParallelProcesses int, config, configIncludePath, stanzaName string, backupData []backup, setUpMetricValueFun setUpMetricValueFunType, logger log.Logger) {
// Create a buffered channel to enforce maximum parallelism.
ch := make(chan struct{}, maxParallelProcesses)
var wg sync.WaitGroup
for _, backup := range backupData {
// Wait for an available slot.
ch <- struct{}{}
wg.Add(1)
go func(backupLabel, backupType, backupRepoID, backupRepoKey, backupBlockIncr string) {
defer func() {
wg.Done()
<-ch
}()
processSpecificBackupData(
config,
configIncludePath,
stanzaName,
backupLabel,
backupType,
"pgbackrest_backup_databases",
pgbrStanzaBackupDatabasesMetric,
setUpMetricValueFun,
logger,
backupLabel,
backupBlockIncr,
backupRepoID,
backupRepoKey)
}(backup.Label, backup.Type, strconv.Itoa(backup.Database.ID), strconv.Itoa(backup.Database.RepoKey), backup.checkBackupIncremental())
}
wg.Wait()
}
func resetBackupMetrics() {
pgbrStanzaBackupInfoMetric.Reset()
pgbrStanzaBackupDurationMetric.Reset()
pgbrStanzaBackupDatabaseSizeMetric.Reset()
pgbrStanzaBackupDatabaseBackupSizeMetric.Reset()
pgbrStanzaBackupRepoBackupSetSizeMetric.Reset()
pgbrStanzaBackupRepoBackupSetSizeMapMetric.Reset()
pgbrStanzaBackupRepoBackupSizeMetric.Reset()
pgbrStanzaBackupRepoBackupSizeMapMetric.Reset()
pgbrStanzaBackupErrorMetric.Reset()
pgbrStanzaBackupDatabasesMetric.Reset()
pgbrStanzaBackupAnnotationsMetric.Reset()
pgbrStanzaBackupReferencesMetric.Reset()
}
func initLastBackupStruct() lastBackupsStruct {
lastBackups := lastBackupsStruct{}
lastBackups.full.backupType = fullLabel
lastBackups.diff.backupType = diffLabel
lastBackups.incr.backupType = incrLabel
return lastBackups
}
|