-
Notifications
You must be signed in to change notification settings - Fork 15
/
Copy pathcheck_pgbackrest
executable file
·1246 lines (967 loc) · 41.4 KB
/
check_pgbackrest
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
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
#!/usr/bin/env perl
#-----------------------------------------------------------------------------
# This program is open source, licensed under the PostgreSQL license.
# For license terms, see the LICENSE file.
#
# Author: Stefan Fercot
# Copyright: (c) 2018-2020, Dalibo.
# Copyright: (c) 2020-2021, Stefan Fercot.
#-----------------------------------------------------------------------------
=head1 NAME
check_pgbackrest - pgBackRest backup check plugin for Nagios
=head1 SYNOPSIS
check_pgbackrest [-s|--service SERVICE] [-S|--stanza NAME]
check_pgbackrest [-l|--list]
check_pgbackrest [--help]
=head1 DESCRIPTION
check_pgbackrest is designed to monitor pgBackRest (2.32 and above) backups from Nagios.
=cut
use vars qw($VERSION $PROGRAM $PGBR_SUPPORT $INIT_TIME);
use strict;
use warnings;
use POSIX;
use Data::Dumper;
use File::Basename;
use File::Spec;
use File::Find;
use Getopt::Long qw(:config bundling no_ignore_case_always);
use Pod::Usage;
use Config;
use FindBin;
# Display error message if some specific modules are not loaded
BEGIN {
my(@DBs, @missingDBs, $mod);
@DBs = qw(JSON);
for $mod (@DBs) {
if (eval "require $mod") {
$mod->import();
} else {
push @missingDBs, $mod;
}
}
die "@missingDBs module(s) not loaded.\n" if @missingDBs;
}
# Messing with PATH so pod2usage always finds this script
my @path = split /$Config{'path_sep'}/ => $ENV{'PATH'};
push @path => $FindBin::Bin;
$ENV{'PATH'} = join $Config{'path_sep'} => @path;
undef @path;
# Reference to the output sub
my $output_fmt;
$VERSION = '2.1';
$PROGRAM = 'check_pgbackrest';
$PGBR_SUPPORT = '2.33';
$INIT_TIME = time();
# Available services and descriptions.
#-----------------------------------------------------------------------------
my %services = (
'retention' => {
'sub' => \&check_retention,
'desc' => 'Check the retention policy.',
'stanza-arg' => 1
},
'archives' => {
'sub' => \&check_wal_archives,
'desc' => 'Check WAL archives.',
'stanza-arg' => 1
},
'check_pgb_version' => {
'sub' => \&check_pgb_version,
'desc' => 'Check the version of this check_pgbackrest script.',
'stanza-arg' => 0
}
);
=over
=item B<-s>, B<--service> SERVICE
The Nagios service to run. See section SERVICES for a description of
available services or use C<--list> for a short service and description
list.
=item B<-S>, B<--stanza> NAME
Name of the stanza to check.
=item B<--repo> REPOSITORY
Repository index to operate on. If no C<--repo> argument is provided, the
service will operate on all repositories defined, checking for inconsistencies
across multiple repositories. When using multiple repositories, it is
recommended to also define checks using the C<--repo> argument to verify the
sanity of each repository separately.
=item B<-O>, B<--output> OUTPUT_FORMAT
The output format. Supported outputs are: C<human>, C<json>, C<nagios> (default)
and C<prtg>.
=item B<-C>, B<--command> FILE
pgBackRest executable file (default: "pgbackrest").
=item B<-c>, B<--config> CONFIGURATION_FILE
pgBackRest configuration file.
=item B<-P>, B<--prefix> COMMAND
Some prefix command to execute the pgBackRest info command
(eg: "sudo -iu postgres").
=item B<-l>, B<--list>
List available services.
=item B<--debug>
Print some debug messages.
=item B<-V>, B<--version>
Print version and exit.
=item B<-?>, B<--help>
Show this help page.
=back
=cut
my %args = (
'command' => 'pgbackrest',
'output' => 'nagios',
'wal-segsize' => '16MB',
'default-pgbackrest-config-file' => '/etc/pgbackrest.conf',
);
# Set name of the program without path*
my $orig_name = $0;
$0 = $PROGRAM;
# Die on kill -1, -2, -3 or -15
$SIG{'HUP'} = $SIG{'INT'} = $SIG{'QUIT'} = $SIG{'TERM'} = \&terminate;
# Handle SIG
sub terminate {
my ($signal) = @_;
die ("SIG $signal caught.");
}
# Print the version and exit
sub version {
printf "%s version %s, Perl %vd\n",
$PROGRAM, $VERSION, $^V;
exit 0;
}
# List services that can be performed
sub list_services {
print "List of available services:\n\n";
foreach my $service ( sort keys %services ) {
printf "\t%-17s\t%s\n", $service, $services{$service}{'desc'};
}
exit 0;
}
# Handle output formats
#-----------------------------------------------------------------------------
sub dprint {
return unless $args{'debug'};
foreach (@_) {
print "DEBUG: $_";
}
}
sub unknown($;$$$) {
return $output_fmt->( 3, $_[0], $_[1], $_[2], $_[3] );
}
sub critical($;$$$) {
return $output_fmt->( 2, $_[0], $_[1], $_[2], $_[3] );
}
sub warning($;$$$) {
return $output_fmt->( 1, $_[0], $_[1], $_[2], $_[3] );
}
sub ok($;$$$) {
return $output_fmt->( 0, $_[0], $_[1], $_[2], $_[3] );
}
sub human_output ($$;$$$) {
my $rc = shift;
my $service = shift;
my $ret;
my @msg;
my @longmsg;
my @human_only_longmsg;
@msg = @{ $_[0] } if defined $_[0];
@longmsg = @{ $_[1] } if defined $_[1];
@human_only_longmsg = @{ $_[2] } if defined $_[2];
$ret = sprintf "%-15s: %s\n", 'Service', $service;
$ret .= sprintf "%-15s: 0 (%s)\n", "Returns", "OK" if $rc == 0;
$ret .= sprintf "%-15s: 1 (%s)\n", "Returns", "WARNING" if $rc == 1;
$ret .= sprintf "%-15s: 2 (%s)\n", "Returns", "CRITICAL" if $rc == 2;
$ret .= sprintf "%-15s: 3 (%s)\n", "Returns", "UNKNOWN" if $rc == 3;
$ret .= sprintf "%-15s: %s\n", "Message", $_ foreach @msg;
$ret .= sprintf "%-15s: %s\n", "Long message", $_ foreach @longmsg;
$ret .= sprintf "%-15s: %s\n", "Long message", $_ foreach @human_only_longmsg;
print $ret;
return $rc;
}
sub json_output ($$;$$$) {
my $rc = shift;
my $service = shift;
my @msg;
my @longmsg;
my @human_only_longmsg;
@msg = @{ $_[0] } if defined $_[0];
@longmsg = @{ $_[1] } if defined $_[1];
@human_only_longmsg = @{ $_[2] } if defined $_[2];
my %json_hash = ('service' => $service);
my @rc_long = ("OK", "WARNING", "CRITICAL", "UNKNOWN");
$json_hash{'status'}{'code'} = $rc;
$json_hash{'status'}{'message'} = $rc_long[$rc];
$json_hash{'message'} = join( ', ', @msg ) if @msg;
foreach my $msg_to_split (@longmsg, @human_only_longmsg) {
my ($key, $value) = split(/=/, $msg_to_split);
$json_hash{'long_message'}{$key} = $value;
}
my $json_text = encode_json \%json_hash;
print "[$json_text]";
return $rc;
}
sub nagios_output ($$;$$) {
my $rc = shift;
my $ret = shift;
my @msg;
my @longmsg;
$ret .= " OK" if $rc == 0;
$ret .= " WARNING" if $rc == 1;
$ret .= " CRITICAL" if $rc == 2;
$ret .= " UNKNOWN" if $rc == 3;
@msg = @{ $_[0] } if defined $_[0];
@longmsg = @{ $_[1] } if defined $_[1];
$ret .= " - ". join( ', ', @msg ) if @msg;
$ret .= " | ". join( ' ', @longmsg ) if @longmsg;
print $ret;
return $rc;
}
sub prtg_output ($$;$$) {
my $rc = shift;
my $service = shift;
my $ret;
my @msg;
my @longmsg;
@msg = @{ $_[0] } if defined $_[0];
@longmsg = @{ $_[1] } if defined $_[1];
# Generate TEXT message
my $text = "<text>";
$text .= $service . " OK" if $rc == 0;
$text .= $service . " WARNING" if $rc == 1;
$text .= $service . " CRITICAL" if $rc == 2;
$text .= $service . " UNKNOWN" if $rc == 3;
$text .= " - ". join( ', ', @msg ) if @msg;
# Generate service status result
my $results = "<result><channel>status</channel><value>$rc</value>";
$results .= "<LimitMaxWarning>0</LimitMaxWarning>";
$results .= "<LimitMaxError>1</LimitMaxError>";
$results .= "<LimitMode>1</LimitMode></result>";
# Define which @longmsg keys will use TimeSeconds or Count units.
# Otherwise, it will be added to TEXT message.
my @TimeKeys = ("latest_age", "latest_full_age", "latest_archive_age");
my @CountKeys = ("full", "diff", "incr", "num_unique_archives", "num_missing_archives");
my @textmsg;
foreach my $msg_to_split (@longmsg) {
my ($key, $value) = split(/=/, $msg_to_split);
if ( grep /^$key$/, @TimeKeys ) {
chop($value);
$results .= "<result><channel>$key</channel><value>$value</value><Unit>TimeSeconds</Unit></result>";
} elsif ( grep /^$key$/, @CountKeys ) {
$results .= "<result><channel>$key</channel><value>$value</value><Unit>Count</Unit></result>";
} else {
push @textmsg, $msg_to_split;
}
}
$text .= " - ". join( ', ', @textmsg ) if @textmsg;
$text .= "</text>";
print "<prtg>" . $results . $text. "</prtg>";
return $rc;
}
# Handle time intervals
#-----------------------------------------------------------------------------
sub is_time($){
my $str_time = lc( shift() );
return 1 if ( $str_time
=~ /^(\s*([0-9]\s*[smhd]?\s*))+$/
);
return 0;
}
# Return formatted time string with units.
# Parameter: duration in seconds
sub to_interval($) {
my $val = shift;
my $interval = '';
return $val if $val =~ /^-?inf/i;
$val = int($val);
if ( $val > 604800 ) {
$interval = int( $val / 604800 ) . "w ";
$val %= 604800;
}
if ( $val > 86400 ) {
$interval .= int( $val / 86400 ) . "d ";
$val %= 86400;
}
if ( $val > 3600 ) {
$interval .= int( $val / 3600 ) . "h";
$val %= 3600;
}
if ( $val > 60 ) {
$interval .= int( $val / 60 ) . "m";
$val %= 60;
}
$interval .= "${val}s" if $val > 0;
return "${val}s" unless $interval; # Return a value if $val <= 0
return $interval;
}
sub to_interval_output_dependent($) {
my $val = shift;
my $interval = '';
return $val if $val =~ /^-?inf/i;
$val = int($val);
return to_interval($val) unless $args{'output'} =~ /^(nagios|prtg)$/;
return "${val}s";
}
# Return a duration in seconds from an interval (with units).
sub get_time($) {
my $str_time = lc( shift() );
my $ts = 0;
my @date;
die( "Malformed interval: «$str_time»!\n"
. "Authorized unit are: dD, hH, mM, sS.\n" )
unless is_time($str_time);
# No bad units should exist after this line!
@date = split( /([smhd])/, $str_time );
LOOP_TS: while ( my $val = shift @date ) {
$val = int($val);
die("Wrong value for an interval: «$val»!") unless defined $val;
my $unit = shift(@date) || '';
if ( $unit eq 'm' ) {
$ts += $val * 60;
next LOOP_TS;
}
if ( $unit eq 'h' ) {
$ts += $val * 3600;
next LOOP_TS;
}
if ( $unit eq 'd' ) {
$ts += $val * 86400;
next LOOP_TS;
}
$ts += $val;
}
return $ts;
}
# Handle size units
#-----------------------------------------------------------------------------
# Return a size in bytes from a size with unit.
# If unit is '%', use the second parameter to compute the size in bytes.
sub get_size($;$) {
my $str_size = shift;
my $size = 0;
my $unit = '';
die "Only integers are accepted as size. Adjust the unit to your need.\n"
if $str_size =~ /[.,]/;
$str_size =~ /^([0-9]+)(.*)$/;
$size = int($1);
$unit = lc($2);
return $size unless $unit ne '';
if ( $unit eq '%' ) {
my $ratio = shift;
die("Can't compute a ratio without the factor!\n")
unless defined $unit;
return int( $size * $ratio / 100 );
}
return $size if $unit eq 'b';
return $size * 1024 if $unit =~ '^k[bo]?$';
return $size * 1024**2 if $unit =~ '^m[bo]?$';
return $size * 1024**3 if $unit =~ '^g[bo]?$';
return $size * 1024**4 if $unit =~ '^t[bo]?$';
return $size * 1024**5 if $unit =~ '^p[bo]?$';
return $size * 1024**6 if $unit =~ '^e[bo]?$';
return $size * 1024**7 if $unit =~ '^z[bo]?$';
die("Unknown size unit: $unit\n");
}
# Interact with pgBackRest
#-----------------------------------------------------------------------------
sub pgbackrest_info {
my $infocmd = $args{'command'}." info";
$infocmd .= " --stanza=".$args{'stanza'};
$infocmd .= " --output=json --log-level-console=error";
if(defined $args{'config'}) {
$infocmd .= " --config=".$args{'config'};
}
if(defined $args{'repo'}) {
$infocmd .= " --repo=".$args{'repo'};
}
if(defined $args{'prefix'}) {
$infocmd = $args{'prefix'}." $infocmd";
}
dprint("pgBackRest info command was : '$infocmd'\n");
my $json_output = `$infocmd 2>&1 |grep -v ERROR`;
die("Can't get pgBackRest info.\nCommand was '$infocmd'.\n") unless ($? eq 0);
my $decoded_json = decode_json($json_output);
foreach my $line (@{$decoded_json}) {
return $line if($line->{'name'} eq $args{'stanza'});
}
return;
}
sub pgbackrest_get {
my $args_ref = shift;
my %args = %{ $args_ref };
my $directory = shift;
my $filename = shift;
my $repo_key = shift;
pod2usage(
-message => 'FATAL: Unsupported pgBackRest version.',
-exitval => 127
) if ( pgbackrest_version(\%args) < $PGBR_SUPPORT );
my $getcmd = $args{'command'}." repo-get";
$getcmd .= " --stanza=".$args{'stanza'};
$getcmd .= " ".$directory."/".$filename;
$getcmd .= " --log-level-console=error";
$getcmd .= " --repo=".$repo_key;
if(defined $args{'config'}) {
$getcmd .= " --config=".$args{'config'};
}
if(defined $args{'prefix'}) {
$getcmd = $args{'prefix'}." $getcmd";
}
dprint("pgBackRest get command was : '$getcmd'\n");
my $history_content = `$getcmd 2>&1 |grep -v ERROR`;
die("Can't get pgBackRest file content.\nCommand was '$getcmd'.\n") unless ($? eq 0);
return $history_content;
}
sub pgbackrest_ls {
my $args_ref = shift;
my %args = %{ $args_ref };
my $directory = shift;
my $repo_key = shift;
my $recurse = shift;
pod2usage(
-message => 'FATAL: Unsupported pgBackRest version.',
-exitval => 127
) if ( pgbackrest_version(\%args) < $PGBR_SUPPORT );
my $lscmd = $args{'command'}." repo-ls";
$lscmd .= " --stanza=".$args{'stanza'};
$lscmd .= " ".$directory;
$lscmd .= " --output=json --log-level-console=error";
$lscmd .= " --repo=".$repo_key;
if($recurse) {
$lscmd .= " --recurse";
}
if(defined $args{'config'}) {
$lscmd .= " --config=".$args{'config'};
}
if(defined $args{'prefix'}) {
$lscmd = $args{'prefix'}." $lscmd";
}
dprint("pgBackRest ls command was : '$lscmd'\n");
my $json_output = `$lscmd 2>&1 |grep -v ERROR`;
die("Can't get pgBackRest list.\nCommand was '$lscmd'.\n") unless ($? eq 0);
return decode_json($json_output);
}
sub pgbackrest_version {
my $args_ref = shift;
my %args = %{ $args_ref };
my $version_cmd = $args{'command'}." version";
if(defined $args{'config'}) {
$version_cmd .= " --config=".$args{'config'};
}
if(defined $args{'prefix'}) {
$version_cmd = $args{'prefix'}." $version_cmd";
}
dprint("pgBackRest version command was : '$version_cmd'\n");
my $pgbackrest_version = `$version_cmd | sed -e s/pgBackRest\\ // | sed -e s/dev//`;
die("Can't get pgBackRest version.\nCommand was '$version_cmd'.\n") unless ($? eq 0);
return $pgbackrest_version;
}
# Services
#-----------------------------------------------------------------------------
=head2 SERVICES
Descriptions and parameters of available services.
=over
=item B<retention>
Fail when the number of full backups is less than the
C<--retention-full> argument.
Fail when the newest backup is older than the C<--retention-age>
argument.
Fail when the newest full backup is older than the
C<--retention-age-to-full> argument.
The following units are accepted (not case sensitive): s (second), m
(minute), h (hour), d (day). You can use more than one unit per
given value.
Arguments are not mandatory to only show some information.
=cut
sub check_retention {
my $me = 'BACKUPS_RETENTION';
my %args = %{ $_[0] };
my @msg;
my @warn_msg;
my @crit_msg;
my @longmsg;
# When using the --repo option, pgBackRest info will apply the repository filter
my $backups_info = pgbackrest_info();
die("Can't get pgBackRest info.\n") unless (defined $backups_info);
if($backups_info->{'status'}->{'code'} == 0) {
# List each repository content
my @backups_dir_content;
foreach my $repo (@{$backups_info->{'repo'}}) {
my $backups_dir = "backup/".$args{'stanza'}; # Relative path inside repository
dprint("repo".$repo->{'key'}.", backups_dir: $backups_dir\n");
$backups_dir_content[$repo->{'key'}] = pgbackrest_ls(\%args, $backups_dir, $repo->{'key'}, 0);
}
# List backups per type and check consistency between backup info and real repository content
my @full_bck;
my @diff_bck;
my @incr_bck;
foreach my $line (@{$backups_info->{'backup'}}) {
push @full_bck, $line if($line->{'type'} eq "full");
push @diff_bck, $line if($line->{'type'} eq "diff");
push @incr_bck, $line if($line->{'type'} eq "incr");
my $backup_label = $line->{'label'};
my $repo_key = $line->{'database'}->{'repo-key'};
unless(defined $backups_dir_content[$repo_key]->{$backup_label} and
$backups_dir_content[$repo_key]->{$backup_label}->{'type'} eq 'path') {
push @crit_msg, "$backup_label directory missing in repo$repo_key";
}
}
push @longmsg, "full=".scalar(@full_bck);
push @longmsg, "diff=".scalar(@diff_bck);
push @longmsg, "incr=".scalar(@incr_bck);
# Check retention
if(defined $args{'retention-full'} and scalar(@full_bck) < $args{'retention-full'}) {
push @crit_msg, "not enough full backups, ".$args{'retention-full'}." required";
}
# Check latest age
# Backup age considered at pg_stop_backup
my $latest_bck = @{$backups_info->{'backup'}}[-1];
my $latest_bck_age = time() - $latest_bck->{'timestamp'}->{'stop'};
push @longmsg, "latest=".$latest_bck->{'type'}.",".$latest_bck->{'label'};
push @longmsg, "latest_age=".to_interval_output_dependent($latest_bck_age);
if(defined $args{'retention-age'}){
my $bck_age_limit = get_time($args{'retention-age'} );
push @crit_msg, "backups are too old" if $latest_bck_age >= $bck_age_limit;
}
# Check latest full backup age
if(defined $args{'retention-age-to-full'}){
my $latest_full_bck = $full_bck[-1];
my $latest_full_bck_age = time() - $latest_full_bck->{'timestamp'}->{'stop'};
push @longmsg, "latest_full=".$latest_full_bck->{'label'};
push @longmsg, "latest_full_age=".to_interval_output_dependent($latest_full_bck_age);
my $bck_age_limit = get_time($args{'retention-age-to-full'} );
push @crit_msg, "full backups are too old" if $latest_full_bck_age >= $bck_age_limit;
}
}else{
# Get the exact status code per repository
foreach my $repo (@{$backups_info->{'repo'}}) {
push @crit_msg, "repo".$repo->{'key'}.": ".$repo->{'status'}->{'message'} if $repo->{'status'}->{'code'} gt 0;
}
}
return critical($me, \@crit_msg, \@longmsg) if @crit_msg;
return warning($me, \@warn_msg, \@longmsg) if @warn_msg;
push @msg, "backups policy checks ok";
return ok( $me, \@msg, \@longmsg );
}
=item B<archives>
Check if all archived WALs exist between the oldest and the latest
WAL needed for the recovery.
Archives must be compressed. If needed, use "compress-level=0"
instead of "compress=n".
Use the C<--wal-segsize> argument to set the WAL segment size.
The following units are accepted (not case sensitive):
b (Byte), k (KB), m (MB), g (GB), t (TB), p (PB), e (EB) or Z (ZB). Only
integers are accepted. Eg. C<1.5MB> will be refused, use C<1500kB>.
The factor between units is 1024 bytes. Eg. C<1g = 1G = 1024*1024*1024.>
Use the C<--ignore-archived-before> argument to ignore the archived
WALs generated before the provided interval. Used to only check the
latest archives.
Use the C<--ignore-archived-after> argument to ignore the archived
WALs generated after the provided interval.
The C<--latest-archive-age-alert> argument defines the max age of
the latest archived WAL as an interval before raising a critical
alert.
The following units are accepted as interval (not case sensitive):
s (second), m (minute), h (hour), d (day). You can use more than
one unit per given value. If not set, the last unit is in seconds.
Eg. "1h 55m 6" = "1h55m6s".
All the missing archives are only shown in the C<--debug> mode.
Use C<--list-archives> in addition with C<--debug> to print the list of all the
archived WAL segments.
By default, all the archives older than the oldest backup start archive
or newer than the max_wal returned by the pgBackRest info command
are ignored.
Use the C<--extended-check> argument to force a full check of the found
archives and raise warnings in case of inconsistencies.
When WAL archives on different timelines are found, .history files are parsed to
find the switch point and define the boundary WAL.
Use the C<--max-archives-check-number> to prevent infinite WAL archives check
when boundary WAL can't be defined properly.
=cut
sub get_archived_wal_list {
my $min_wal = shift;
my $max_wal = shift;
my $args_ref = shift;
my %args = %{ $args_ref };
my $archives_dir = shift;
my $suffix = "\.(gz|lz4|zst|xz|bz2)";
my %filelist;
my @branch_wals;
my $filename_re_full = qr/[0-9A-F]{24}.*$suffix$/;
my $start_tl = substr($min_wal, 0, 8);
my $end_tl = substr($max_wal, 0, 8);
my $history_re_full = qr/$end_tl.history$/;
foreach my $repo_key (keys %{$archives_dir}) {
dprint("repo$repo_key, archives_dir: ".$archives_dir->{$repo_key}."\n");
my $list = pgbackrest_ls(\%args, $archives_dir->{$repo_key}, $repo_key, 1);
foreach my $key (keys %{$list}) {
next unless $list->{$key}->{'type'} eq 'file';
my @split_tab = split('/', $key);
my $filename = $split_tab[-1];
if($filename =~ /$filename_re_full/){
# Get stats of the archived WALs
if ( $args{'ignore-archived-after'} or $args{'ignore-archived-before'} ) {
my $diff_epoch = $INIT_TIME - $list->{$key}->{'time'};
if ( $args{'ignore-archived-after'} && $diff_epoch <= get_time($args{'ignore-archived-after'}) ){
dprint ("ignored file ".$filename." as interval since epoch : ".to_interval($diff_epoch)."\n");
next;
}
if ( $args{'ignore-archived-before'} && $diff_epoch >= get_time($args{'ignore-archived-before'}) ){
dprint ("ignored file ".$filename." as interval since epoch : ".to_interval($diff_epoch)."\n");
next;
}
}
my $segname = substr($filename, 0, 24);
if ( ! $args{'extended-check'} && $segname lt $min_wal ){
dprint ("ignored file ".$segname." older than ".$min_wal."\n");
next;
}
if ( ! $args{'extended-check'} && $segname gt $max_wal ){
dprint ("ignored file ".$segname." newer than ".$max_wal."\n");
next;
}
# Only add the file in the list if not already found in a previous loop/repository
unless(defined $filelist{$segname}){
$filelist{$segname} = [$segname, $filename, $list->{$key}->{'time'}, $list->{$key}->{'size'}, $archives_dir->{$repo_key}."/$key"];
}
}elsif($filename =~ /$history_re_full/ && $start_tl ne $end_tl){
# Look for the last history file if needed
dprint("history file to open : ".$archives_dir->{$repo_key}."/$key\n");
my $history_content = pgbackrest_get(\%args, $archives_dir->{$repo_key}, $filename, $repo_key);
my @history_lines = split /\n/, $history_content;
foreach my $line ( @history_lines ){
my $line_re = qr/^\s*(\d)\t([0-9A-F]+)\/([0-9A-F]+)\t.*$/;
$line =~ /$line_re/ || next;
push @branch_wals =>
sprintf("%08d%08s%08X", $1, $2, hex($3)>>24);
}
}
}
}
my @unique_branch_wals = do { my %seen; grep { !$seen{$_}++ } @branch_wals };
return(\%filelist, \@unique_branch_wals);
}
sub generate_needed_wal_archives_list {
my $min_wal = shift;
my $max_wal = shift;
my $branch_wals_ref = shift;
my @branch_wals = @{ $branch_wals_ref };
my $seg_per_wal = shift;
my $start_tl = substr($min_wal, 0, 8);
my $end_tl = substr($max_wal, 0, 8);
my $timeline = hex($start_tl);
my $wal = hex(substr($min_wal, 8, 8));
my $seg = hex(substr($min_wal, 16, 8));
my $args_ref = shift;
my %args = %{ $args_ref };
# Generate list
my $curr = $min_wal;
my @needed_wal_archives_list;
push @needed_wal_archives_list, $min_wal;
for ( my $i=0, my $j=1; $curr lt $max_wal ; $i++, $j++ ) {
$curr = sprintf('%08X%08X%08X',
$timeline,
$wal + int(($seg + $j)/$seg_per_wal),
($seg + $j)%$seg_per_wal
);
if ( grep /$curr/, @branch_wals ) {
dprint("found a boundary @ '$curr' !\n");
$timeline++;
$j--;
next;
}else{
push @needed_wal_archives_list, $curr;
}
# Break the loop in case max-archives-check-number is defined
# Infinite loop might happen when there's a timeline switch but boundary WAL isn't detected correctly
die("max-archives-check-number limit exceeded.\n") if (
defined $args{'max-archives-check-number'} and
scalar(@needed_wal_archives_list) > $args{'max-archives-check-number'}
);
}
my @unique_needed_wal_archives_list = do { my %seen; grep { !$seen{$_}++ } @needed_wal_archives_list };
return sort @unique_needed_wal_archives_list;
}
sub check_wal_archives {
my $me = 'WAL_ARCHIVES';
my %args = %{ $_[0] };
my @msg;
my @warn_msg;
my @crit_msg;
my @longmsg;
my @human_only_longmsg;
# When using the --repo option, pgBackRest info will apply the repository filter
my $start_time = time();
my $backups_info = pgbackrest_info();
die("Can't get pgBackRest info.\n") unless (defined $backups_info);
dprint("!> pgBackRest info took ".(time() - $start_time)."s\n");
if($backups_info->{'status'}->{'code'} == 0) {
my %archives_dir;
my $min_wal;
my $max_wal;
foreach my $line (@{$backups_info->{'archive'}}) {
my $repo_key = $line->{'database'}->{'repo-key'};
$archives_dir{$repo_key} = "archive/".$args{'stanza'}."/".$line->{'id'}; # Relative path inside repository
$min_wal = $line->{'min'} if(not $min_wal or $line->{'min'} lt $min_wal);
$max_wal = $line->{'max'} if(not $max_wal or $line->{'max'} gt $max_wal);
}
# Get the oldest backup info
my $oldest_bck = @{$backups_info->{'backup'}}[0];
my $oldest_bck_archive_start = $oldest_bck->{'archive'}->{'start'};
# Change min_wal to oldest_bck_archive_start
if ( $min_wal lt $oldest_bck_archive_start ) {
$min_wal = $oldest_bck_archive_start;
dprint ("min_wal changed to ".$min_wal."\n");
}
# Get all the WAL archives and history files
$start_time = time();
dprint("Get all the WAL archives and history files...\n");
my ($filelist_ref, $branch_wals_ref) = &get_archived_wal_list($min_wal, $max_wal, \%args, \%archives_dir);
my %filelist;
%filelist = %{ $filelist_ref } if $filelist_ref;
my @filelist_simplified = sort(keys %filelist);
my $first_wal_in_list = $filelist_simplified[0]; # identify first elem of hash array
my $last_wal_in_list = $filelist_simplified[-1]; # identify last elem of hash array
my @branch_wals;
@branch_wals = @{ $branch_wals_ref } if $branch_wals_ref;
return unknown $me, ['no archived WAL found'] unless %filelist;
dprint("!> Get all the WAL archives and history files took ".(time() - $start_time)."s\n");
# Change min_wal if some archives are ignored
if ( $args{'ignore-archived-before'} && $min_wal ) {
$min_wal = $first_wal_in_list;
dprint ("min_wal changed to ".$min_wal."\n");
}
# Change max_wal if some archives are ignored
if ( $args{'ignore-archived-after'} && $max_wal ) {
$max_wal = $last_wal_in_list;
dprint ("max_wal changed to ".$max_wal."\n");
}
# Check min/max exists, start = min, last = max ?
return critical $me, ['min WAL not found: '.$min_wal] if($min_wal && ! grep( /^$min_wal$/, @filelist_simplified ));
return critical $me, ['max WAL not found: '.$max_wal] if($max_wal && ! grep( /^$max_wal$/, @filelist_simplified ));
push @warn_msg, "min WAL is not the oldest archive" if($min_wal && $filelist{$first_wal_in_list}[0] lt $min_wal);
push @warn_msg, "max WAL is not the latest archive" if($max_wal && $filelist{$last_wal_in_list}[0] gt $max_wal);
my $latest_archive_age = time() - $filelist{$last_wal_in_list}[2];
my $num_archives = scalar(@filelist_simplified);
push @longmsg, "latest_archive_age=".to_interval_output_dependent($latest_archive_age);
push @longmsg, "num_unique_archives=$num_archives";
# Is the latest archive too old ?
if ( $args{'latest-archive-age-alert'} && $latest_archive_age > get_time($args{'latest-archive-age-alert'})){
push @crit_msg => "latest_archive_age (".to_interval($latest_archive_age).") exceeded";
}
push @msg, "$num_archives unique WAL archived";
push @msg, "latest archived since ". to_interval($latest_archive_age);
# Get all the needed WAL archives based on min/max pgBackRest info
my $wal_segsize = $args{'wal-segsize'};
my $walsize = '4GB'; # 4 TB -> bytes
my $seg_per_wal = get_size($walsize) / get_size($wal_segsize); #Only for PG >= 9.3
my $dbver=($backups_info->{'db'}[0]->{'version'}+0)*10;
$seg_per_wal-- if $dbver <= 92;
dprint("Get all the needed WAL archives...\n");
$start_time = time();
my @needed_wal_archives_list=&generate_needed_wal_archives_list($min_wal, $max_wal, \@branch_wals, $seg_per_wal, \%args);
dprint("!> Get all the needed WAL archives took ".(time() - $start_time)."s\n");
# Get the latest backup info
my $latest_bck = @{$backups_info->{'backup'}}[-1];
my $latest_bck_archive_start = $latest_bck->{'archive'}->{'start'};
# Print human_only_longmsg
push @human_only_longmsg, "min_wal=$min_wal" if $min_wal;
push @human_only_longmsg, "max_wal=$max_wal" if $max_wal;
push @human_only_longmsg, "latest_archive=".$filelist{$last_wal_in_list}[0];
push @human_only_longmsg, "latest_bck_archive_start=".$latest_bck_archive_start;
push @human_only_longmsg, "latest_bck_type=".$latest_bck->{'type'};