]> git.8kb.co.uk Git - slony-i/pgbouncer_follower/blob - pgbouncer_follower.pl
399ca65309ddb0c6b526ffd69d1e7d5a47ff8a37
[slony-i/pgbouncer_follower] / pgbouncer_follower.pl
1 #!/usr/bin/perl
2
3 # Script:   pgbouncer_follower.pl
4 # Copyright:    22/04/2012: v1.0.1 Glyn Astill <glyn@8kb.co.uk>
5 # Requires: Perl 5.10.1+, PostgreSQL 9.0+ Slony-I 2.0+
6 #
7 # This script is a command-line utility to monitor Slony-I clusters
8 # and reconfigure pgbouncer to follow replication sets.
9 #
10 # This script is free software: you can redistribute it and/or modify
11 # it under the terms of the GNU General Public License as published by
12 # the Free Software Foundation, either version 3 of the License, or
13 # (at your option) any later version.
14 #
15 # This script is distributed in the hope that it will be useful,
16 # but WITHOUT ANY WARRANTY; without even the implied warranty of
17 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18 # GNU General Public License for more details.
19 #
20 # You should have received a copy of the GNU General Public License
21 # along with this script.  If not, see <http://www.gnu.org/licenses/>.
22
23 use strict;
24 use warnings;
25 use DBI;
26 use v5.10.1;
27 use Getopt::Long qw/GetOptions/;
28 use Digest::MD5 qw/md5 md5_hex md5_base64/;
29 use Sys::Hostname;
30 use IO::Socket;
31 use Time::HiRes qw/usleep/;
32 use sigtrap 'handler' => \&cleanExit, 'HUP', 'INT','ABRT','QUIT','TERM';
33 Getopt::Long::Configure qw/no_ignore_case/;
34
35 use vars qw{%opt};
36
37 use constant false => 0;
38 use constant true  => 1;
39
40 my $g_usage = 'Pass configuration file: pool_follower.pl -f <configuration_path> [-D]  ';
41 my $g_debug = false;
42 my $g_pidfile = "/tmp/pgbouncer_follower_%mode.pid";
43 my $g_logfile = "/tmp/pgbouncer_follower_%mode.log";
44 my $g_poll_interval = 1000;
45 my $g_user = "slony";
46 my $g_pass;
47 my $g_clname = "replication";
48 my $g_clsets = "1";
49 my @g_conninfos;
50 my @g_cluster;                  # no_id, no_comment, no_prov, orig_sets, conninfo, dbname, host, port
51 my $g_status_file = "/tmp/pgbouncer_follower_%mode.status";
52 my $g_conf_template = "/etc/pgbouncer/pgbouncer_%mode.template";
53 my $g_conf_target = "/etc/pgbouncer/pgbouncer_%mode.ini";
54 my $g_reload_command = "/etc/init.d/pgbouncer_%mode reload";
55 my $g_mode = 'rw';
56 my $g_all_databases=false;
57 my ($year, $month, $day, $hour, $min, $sec);
58 my $change_time;
59 my $g_host = hostname;
60 my ($g_addr)=inet_ntoa((gethostbyname(hostname))[4]);
61 my $g_origins_only = false;
62
63 die $g_usage unless GetOptions(\%opt, 'config_file|f=s', 'daemon|D',) and keys %opt and ! @ARGV;
64
65 unless (getConfig($opt{config_file})){
66     print ("There was a problem reading the configuration.\n");
67 }
68  
69 if ($g_debug) {
70     printLogLn($g_logfile, "DEBUG: Logging to my '$g_logfile'");
71     printLogLn($g_logfile, "\t Watching sets $g_clsets in Slony-I cluster '$g_clname' polling every ${g_poll_interval}ms"); 
72     printLogLn($g_logfile, "\t Following " . ($g_all_databases ? "all databases" : "replicated database only") . " on an '$g_mode' node for the above replicated sets");
73     printLogLn($g_logfile, "\t Template config '$g_conf_template' Target config '$g_conf_target'");
74     printLogLn($g_logfile, "\t Reload command is '$g_reload_command'");
75     printLogLn($g_logfile, "\t Status stored in '$g_status_file'");
76     printLogLn($g_logfile, "\t Using local address for '$g_host' as '$g_addr'");
77     #printLogLn($g_logfile, "\t '$g_user' as '$g_pass'");
78 }
79
80 if (defined($opt{daemon})) {
81     printLogLn($g_logfile, "pgbouncer_follower starting up");   
82     if (writePID($g_pidfile)) {
83         while (true) {
84             doAll();
85             if ($g_debug) {
86                 printLogLn($g_logfile, "DEBUG: Sleeping for ${g_poll_interval}ms");
87             }
88             usleep($g_poll_interval * 1000);
89         }
90     }
91 }
92 else {
93     doAll();
94 }
95
96 cleanExit(0);
97
98 sub cleanExit {
99     if (defined($opt{daemon})) {
100         printLogLn($g_logfile, "pgbouncer_follower shutting down");    
101         removePID($g_pidfile);
102     }
103     exit(0);
104 }
105
106 sub doAll {
107     my $node_to;
108
109     foreach my $conninfo (@g_conninfos) {
110         eval {
111             @g_cluster = loadCluster($g_clname, $conninfo, $g_user, $g_pass, $g_addr, $g_clsets);
112             if ($g_debug) {
113                 printLogLn($g_logfile, "DEBUG: Cluster with " . scalar(@g_cluster) . " nodes read from conninfo: $conninfo");
114                 foreach (@g_cluster) {
115                     printLogLn($g_logfile, "DEBUG: Node #" . @$_[0] . " DETAIL: " . @$_[1] . " " . @$_[2] . " " . (@$_[3] // "<NONE>") . " " . @$_[4] . " " . (@$_[5] // "<NONE>") . " " . @$_[6] . " " . @$_[7] . " " . @$_[8] . " " . @$_[9] . " " );
116                 }
117             }
118         };
119         if ($@) {
120             printLogLn($g_logfile, "ERROR: Failed using conninfo: $conninfo DETAIL: $@");
121         }
122         else {
123             last;
124         } 
125     }
126     unless (checkCluster($g_status_file)) {
127         if ($g_debug) {
128              printLogLn ($g_logfile, "DEBUG: Cluster status unchanged");
129         }
130     }
131     else {
132         printLogLn ($g_logfile, "Cluster status changed");
133         $node_to = generateConfig($g_conf_template, $g_conf_target, $g_mode, $g_all_databases, $g_clsets);
134         if (reloadConfig($g_reload_command)) {
135             printLogLn ($g_logfile, "Pool repointed to node #$node_to");
136         }
137     }
138 }
139
140 sub reloadConfig {
141     my $reload_command = shift;
142     my $success = true;
143     if(length($reload_command // '')) {
144         printLogLn($g_logfile, "Running '$reload_command'");
145         eval {
146             open(RELOAD, "-|", $reload_command . " 2>&1");
147             while (<RELOAD>) {
148                 printLogLn($g_logfile, $_);
149             }
150             close(RELOAD);
151             printLogLn($g_logfile, "Reload command has been run.");
152         };
153         if ($@) {
154             printLogLn($g_logfile, "ERROR: Failed to run reload command DETAIL: $@");
155             $success = false;
156         }
157     }
158     return $success;
159 }
160
161 sub generateConfig {
162     my $template = shift;
163     my $target = shift;
164     my $mode = shift;
165     my $all_databases = shift;
166     my $clsets = shift;
167
168     my $success = false;
169     my @sets_to_follow;
170     my @sets_origin;
171     my @sets_subscribed;
172     my $target_node_id;
173     my $target_db;
174     my $target_host;
175     my $target_sets;
176     my $target_port = 5432;
177     my $target_is_origin;
178
179     if ($g_debug) {
180         printLogLn($g_logfile, "DEBUG: All databases = " . ($g_all_databases ? 'true' : 'false'));
181     }
182
183     if (open(INFILE, "<", $template)) {
184         if (open(OUTFILE, ">", $target)) {
185             print OUTFILE "# Configuration file autogenerated at " . getRuntime() . " from $template\n";
186             foreach (<INFILE>) {
187                if (m/\[databases]/) {
188
189                     # Try and choose a node; we always assign the origin initially regardless of rw/ro status
190                     # when in ro mode and if we then  find a suitable subscriber we'll reassign to it.
191                     foreach my $node (@g_cluster) {
192                         if ($clsets ne 'all') {
193                             @sets_to_follow = split(',', $clsets);
194                             if (defined($node->[3])) {
195                                 @sets_origin =  split(',', $node->[3]);
196                             }
197                             else {
198                                 undef @sets_origin;
199                             }
200                             if (defined($node->[5])) {
201                                 @sets_subscribed =  split(',', $node->[5]);
202                             }
203                             else {
204                                 undef @sets_subscribed;
205                             }
206                         }
207
208                         if (($clsets eq 'all' && defined($node->[3])) || (@sets_to_follow && @sets_origin && checkProvidesAllSets(\@sets_to_follow, \@sets_origin))) {
209                             if (defined($node->[8])) {
210                                 $target_db = $node->[7];
211                                 $target_host = $node->[8];
212                                 $target_node_id = $node->[0];
213                                 $target_sets = $node->[3];
214                                 $target_is_origin = true;
215                             }
216                             if (defined($node->[9])) {
217                                 $target_port = $node->[9];
218                             }
219                             if ($mode eq "rw") {
220                                 last;
221                             }
222                         }
223                         elsif (($mode eq "ro") && (($clsets eq 'all') || (@sets_to_follow && @sets_subscribed && checkProvidesAllSets(\@sets_to_follow, \@sets_subscribed)))) {    
224                             if (defined($node->[8])) {
225                                 $target_db = $node->[7];
226                                 $target_host = $node->[8];
227                                 $target_node_id = $node->[0];
228                                 $target_sets = ($node->[5] // $node->[3]);
229                                 $target_is_origin = false;
230                             }
231                             if (defined($node->[9])) {
232                                 $target_port = $node->[9];
233                             }
234                             last;
235                         }
236                     }
237                     if (defined($target_host)) {
238                         $_ = "# Configuration for " . ($target_is_origin ? "origin" : "subscriber") . " of sets $target_sets node #$target_node_id $target_host:$target_port\n" . $_;
239                         if ($g_debug) {
240                             printLogLn ($g_logfile, "DEBUG: Configuration for " . ($target_is_origin ? "origin" : "subscriber") . " of sets $target_sets node #$target_node_id $target_host:$target_port");
241                         }
242                         if ($all_databases) {
243                             $_ =~ s/(\[databases\])/$1\n\* = host=$target_host port=$target_port/;
244                         }
245                         else {
246                             $_ =~ s/(\[databases\])/$1\n$target_db = host=$target_host port=$target_port dbname=$target_db/;
247                         }
248                     }
249                     else {
250                             $_ = "# Could not find any node providing sets $g_clsets in mode $mode\n";
251                             printLogLn ($g_logfile, "DEBUG: Could not find any node providing sets $g_clsets in mode $mode");
252                     }
253                     
254                } 
255                print OUTFILE $_;
256             }
257             close (OUTFILE); 
258         }
259         else {
260             print ("ERROR: Can't open file $target\n");
261         }
262         close(INFILE);
263     }
264     else {
265         print ("ERROR: Can't open file $template\n");
266     }
267     return $target_node_id;
268 }
269
270 sub checkCluster {
271     my $infile = shift;
272     my $changed = false;
273     my $current_cluster;
274     my $previous_cluster;
275     foreach (@g_cluster) {
276         if (!$g_origins_only || defined($_->[3])) {
277             $current_cluster = md5_hex(($current_cluster // "") . $_->[0] . $_->[2] . (defined($_->[3]) ? 't' : 'f') . $_->[6]);
278             if ($g_debug) {
279                 printLogLn($g_logfile, "DEBUG: Node " . $_->[0] . " detail = " . $_->[2] . (defined($_->[3]) ? 't' : 'f') . $_->[6]);
280             }
281         }
282     }
283    
284     if (-f $infile) {
285         if (open(CLUSTERFILE, "<", $infile)) {
286             $previous_cluster = <CLUSTERFILE>;
287             close(CLUSTERFILE);
288         }
289         else {
290             printLogLn ($g_logfile, "ERROR: Can't open file $infile for reading");
291         }
292     }
293
294     unless (-f $infile && ($current_cluster eq $previous_cluster)) {
295         if ($g_debug) {
296                 printLogLn($g_logfile, "DEBUG: Writing to status file");
297         }
298         if (open(CLUSTERFILE, ">", $infile)) {
299             print CLUSTERFILE $current_cluster;
300             close(CLUSTERFILE);
301         }
302         else {
303             printLogLn ($g_logfile, "ERROR: Can't open file $infile for writing");
304         }
305     }
306
307     if ((($previous_cluster // "") ne "") && (($current_cluster // "") ne "") && ($current_cluster ne $previous_cluster)){
308         $changed = true;
309     }
310
311     return $changed
312 }
313
314 sub loadCluster {
315     my $clname = shift;
316     my $conninfo = shift;
317     my $dbuser = shift;
318     my $dbpass = shift;
319     my $addr = shift;
320     my $clsets = shift;
321     my $param_on = 1;
322
323     my $dsn;
324     my $dbh;
325     my $sth;
326     my $query;
327     my $version;
328     my $qw_clname;
329     my @cluster;
330
331     $dsn = "DBI:Pg:$conninfo};";
332
333     eval {
334         $dbh = DBI->connect($dsn, $dbuser, $dbpass, {RaiseError => 1});
335         $qw_clname = $dbh->quote_identifier("_" . $clname);
336
337         $query = "SELECT $qw_clname.getModuleVersion()";
338         $sth = $dbh->prepare($query);
339         $sth->execute();
340         ($version) = $sth->fetchrow; 
341         $sth->finish;
342
343         $query = "WITH x AS (
344                 SELECT a.no_id, 
345                     a.no_comment, 
346                     COALESCE(b.sub_provider, 0) AS no_prov, 
347                     NULLIF(array_to_string(array(SELECT set_id FROM $qw_clname.sl_set WHERE set_origin = a.no_id" .
348                     ($clsets ne "all" ? " AND set_id IN (" . substr('?, ' x scalar(split(',', $clsets)), 0, -2) . ")" : "") 
349                     . " ORDER BY set_id), ','), '') AS origin_sets,
350                     CASE " . ((substr($version,0,3) >= 2.2) ? "WHEN a.no_failed THEN 'FAILED' " : "") . "WHEN a.no_active THEN 'ACTIVE' ELSE 'INACTIVE' END AS no_status,
351                     string_agg(CASE WHEN b.sub_receiver = a.no_id AND b.sub_forward AND b.sub_active" .
352                     ($clsets ne "all" ? " AND b.sub_set IN (" . substr('?, ' x scalar(split(',', $clsets)), 0, -2) . ")" : "") 
353                     . " THEN b.sub_set::text END, ',' ORDER BY b.sub_set) AS prov_sets,
354                     COALESCE(c.pa_conninfo,(SELECT pa_conninfo FROM $qw_clname.sl_path WHERE pa_server = $qw_clname.getlocalnodeid(?) LIMIT 1)) AS no_conninfo
355                 FROM $qw_clname.sl_node a
356                 LEFT JOIN $qw_clname.sl_subscribe b ON a.no_id = b.sub_receiver AND b.sub_set <> 999 
357                 LEFT JOIN $qw_clname.sl_path c ON c.pa_server = a.no_id AND c.pa_client = $qw_clname.getlocalnodeid(?)
358                 LEFT JOIN $qw_clname.sl_set d ON d.set_origin = a.no_id
359                 GROUP BY b.sub_provider, a.no_id, a.no_comment, c.pa_conninfo, a.no_active
360                 ORDER BY (COALESCE(b.sub_provider, 0) = 0) DESC, a.no_id ASC
361                 ), z AS (
362                 SELECT *,  
363                     CASE WHEN x.no_conninfo ilike '%dbname=%' THEN(regexp_matches(x.no_conninfo, E'dbname=(.+?)\\\\M', 'ig'))[1] END AS database,
364                     CASE WHEN x.no_conninfo ilike '%host=%' THEN(regexp_matches(x.no_conninfo, E'host=(.+?)(?=\\\\s|\$)', 'ig'))[1] END AS host,
365                     CASE WHEN x.no_conninfo ilike '%port=%' THEN(regexp_matches(x.no_conninfo, E'port=(.+?)\\\\M', 'ig'))[1] ELSE '5432' END AS port
366                 FROM x 
367                 )
368                 SELECT * FROM z 
369                 ORDER BY origin_sets, @(CASE WHEN (host ~ '^[0-9]{1,3}(.[0-9]{1,3}){3}\$') THEN host::inet ELSE '255.255.255.255'::inet END - ?::inet) ASC";
370
371         if ($g_debug) { 
372             printLogLn($g_logfile, "DEBUG: " . $query);
373         }
374
375         $sth = $dbh->prepare($query);
376
377         if ($clsets ne "all") {
378             for (0..1) { 
379                 foreach my $param (split(",", $clsets)) {
380                     $sth->bind_param($param_on, $param);
381                     $param_on++;
382                 } 
383             }
384         }
385         $sth->bind_param($param_on, "_" . $clname);
386         $param_on++;
387         $sth->bind_param($param_on, "_" . $clname);
388         $param_on++;
389         $sth->bind_param($param_on, (isInet($addr) ? $addr : '255.255.255.255'));
390         $sth->execute();
391
392         while (my @node = $sth->fetchrow) {
393             push(@cluster,  \@node);
394         }
395
396         $sth->finish;
397         $dbh->disconnect();
398     };
399     if ($@) { 
400         printLogLn($g_logfile, "ERROR: Failed to execute query against Postgres server: $@");
401     }
402
403     return @cluster;
404 }
405
406 sub getConfig {
407     my @fields;
408     my $success = false;
409     my $infile = shift;
410     my $value;
411
412     if (open(CFGFILE, "<", $infile)) {
413         foreach (<CFGFILE>) {
414             chomp $_;
415             for ($_) {
416                 s/\r//;
417                 #s/\#.*//;
418                 s/#(?=(?:(?:[^']|[^"]*+'){2})*+[^']|[^"]*+\z).*//;
419             } 
420             if (length(trim($_))) {
421                 @fields = split('=', $_, 2);
422                 $value = qtrim(trim($fields[1]));
423                 given(lc($fields[0])) {
424                     when(/\bdebug\b/i) {
425                         $g_debug = checkBoolean($value);
426                     }
427                     when(/\bpid_file\b/i) {
428                         $g_pidfile = $value;
429                     }
430                     when(/\blog_file\b/i) {
431                         $g_logfile = $value;
432                     }
433                     when(/\bslony_user\b/i) {
434                         $g_user = $value;
435                     }
436                     when(/\bslony_pass\b/i) {
437                         $g_pass = $value;
438                     }
439                     when(/\bslony_cluster_name\b/i) {
440                         $g_clname = $value;
441                     }
442                     when(/\bslony_sets_to_follow\b/i) {
443                         $g_clsets = $value;
444                     }
445                     when(/\bserver_conninfo\b/i) {
446                         push(@g_conninfos, $value);
447                     }
448                     when(/\bfollower_poll_interval\b/i) {
449                         $g_poll_interval = checkInteger($value);
450                     }
451                     when(/\bstatus_file\b/i) {
452                         $g_status_file = $value;
453                     } 
454                     when(/\bpool_conf_template\b/i) {
455                         $g_conf_template = $value;
456                     } 
457                     when(/\bpool_conf_target\b/i) {
458                         $g_conf_target = $value;
459                     } 
460                     when(/\bpool_reload_command\b/i) {
461                         $g_reload_command = $value;
462                     } 
463                     when(/\bpool_mode\b/i) {
464                         $g_mode = lc($value);
465                     } 
466                     when(/\bpool_all_databases\b/i) {
467                         $g_all_databases = checkBoolean($value);
468                     }
469                     when(/\bonly_follow_origins\b/i) {
470                         $g_origins_only = checkBoolean($value);
471                     }
472                 }  
473             }
474         }
475         close (CFGFILE);
476         if (defined($g_user) && (scalar(@g_conninfos) > 0)) {
477            $success = true;
478         }
479         # Replace %mode and %clname here for actual value
480         for ($g_pidfile, $g_logfile, $g_status_file, $g_conf_template, $g_conf_target, $g_reload_command) {
481             s/\%mode/$g_mode/g;
482             s/\%clname/$g_clname/g;
483         }
484
485
486     }
487     else {
488         printLogLn($g_logfile, "ERROR: Could not read configuration from '$infile'");
489     }
490     return $success;
491 }
492
493 sub writePID {
494     my $pidfile = shift;
495     my $success = true;
496
497     eval {
498         open (PIDFILE, ">", $pidfile);
499         print PIDFILE $$;
500         close (PIDFILE);
501         if ($g_debug) {
502             printLogLn($g_logfile, "DEBUG: Created PID file '$pidfile' for process $$");
503         }
504     };
505     if ($@) {
506         printLogLn($g_logfile, "ERROR: unable to write pidfile at '$pidfile' DETAIL $!");       
507         $success = false;
508     }
509     return $success;
510 }
511
512 sub removePID {
513     my $pidfile = shift;
514     my $success = true;
515
516     eval {
517         if (-f $pidfile) {
518             unlink $pidfile;
519             if ($g_debug) {
520                 printLogLn($g_logfile, "DEBUG: Removed PID file '$pidfile'");
521             }
522         }
523         elsif ($g_debug){
524             printLogLn($g_logfile, "DEBUG: PID file '$pidfile' never existed to be removed");
525         } 
526     };
527     if ($@) {
528         printLogLn($g_logfile, "ERROR: unable to remove pidfile at '$pidfile' DETAIL $!");       
529         $success = false;
530     }
531     return $success
532 }
533
534 sub checkBoolean {
535     my $text = shift;
536     my $value = undef;
537     if ( grep /^$text$/i, ("y","yes","t","true","on") ) {
538         $value = true;
539     }
540     elsif ( grep /^$text$/i, ("n","no","f","false","off") ) {
541         $value = false;
542     }
543     return $value;
544 }
545
546 sub checkInteger {
547     my $integer = shift;
548     my $value = undef;
549
550     if (($integer * 1) eq $integer) {
551         $value = int($integer);
552     }
553     return $value;
554 }
555
556 sub checkProvidesAllSets { 
557     my ($originSets, $providerSets) = @_;
558     my %test_hash;
559
560     undef @test_hash{@$originSets};       # add a hash key for each element of @$originSets
561     delete @test_hash{@$providerSets};    # remove all keys for elements of @$providerSets
562
563     return !%test_hash;              # return false if any keys are left in the hash
564 }
565
566 sub isInet {
567     my $address = shift;
568     my $success = true;
569
570     my(@octets) = $address =~ /^(\d{1,3})\.(\d{1,3})\.(\d{1,3})\.(\d{1,3})$/;
571     if (@octets == 4) {
572         foreach (@octets) {
573             unless ($_ <= 255) {
574                 $success = false;
575             }
576         }
577     }
578     else {
579         $success = false;
580     }
581
582     return $success;
583 }
584
585 sub qtrim {
586     my $string = shift;
587     $string =~ s/^('|")+//;
588     $string =~ s/('|")+$//;
589     return $string;
590 }
591
592 sub trim {
593     my $string = shift;
594     $string =~ s/^\s+//;
595     $string =~ s/\s+$//;
596     return $string;
597 }
598
599 sub getRuntime {
600     my ($year, $month, $day, $hour, $min, $sec) = (localtime(time))[5,4,3,2,1,0];
601     my $time = sprintf ("%02d:%02d:%02d on %02d/%02d/%04d", $hour, $min, $sec, $day, $month+1, $year+1900);
602     return $time;
603 }
604
605 sub printLog {
606     my $logfile = shift;
607     my $message = shift;
608
609     print $message;
610
611     if (open(LOGFILE, ">>", $logfile)) {
612         print LOGFILE getRuntime() . " " . $message;
613         close (LOGFILE);
614     }
615     else {
616         printLn("ERROR: Unable to write to logfile $logfile");
617     }
618 }
619
620 sub printLogLn {
621     printLog ($_[0], $_[1] . $/);
622 }
623
624 sub printLn {
625     print ((@_ ? join($/, @_) : $_), $/);
626 }