Merge lp:~percona-toolkit-dev/percona-toolkit/pt-stalk-plugin into lp:percona-toolkit/2.1

[Daniel Nichter]

[Daniel Nichter (daniel-nichter)]

review: Approve

=== modified file 'bin/pt-stalk'
--- bin/pt-stalk	2012-09-20 13:59:16 +0000
+++ bin/pt-stalk	2012-10-03 18:33:24 +0000
@@ -933,6 +933,30 @@
 ITER=1
 
 # ###########################################################################
+# Plugin hooks
+# ###########################################################################
+
+before_stalk() {
+   :
+}
+
+before_collect() {
+   :
+}
+
+after_collect() {
+   :
+}
+
+after_collect_sleep() {
+   :
+}
+
+after_stalk() {
+   :
+}
+
+# ###########################################################################
 # Subroutines
 # ###########################################################################
 
@@ -1016,12 +1040,12 @@
 
 oktorun() {
    if [ $OKTORUN -eq 0 ]; then
-      EXIT_REASON="OKTORUN is false"
+      [ -z "$EXIT_REASON" ] && EXIT_REASON="OKTORUN is false"
       return 1  # stop running
    fi
 
    if [ -n "$OPT_ITERATIONS" ] && [ $ITER -gt $OPT_ITERATIONS ]; then
-      EXIT_REASON="no more iterations"
+      [ -z "$EXIT_REASON" ] && EXIT_REASON="no more iterations"
       return 1  # stop running
    fi
 
@@ -1136,6 +1160,9 @@
                log "pt-stalk ran with $RAN_WITH" >> "$OPT_DEST/$prefix-trigger"
                last_prefix="$prefix"
 
+               # Plugin hook:
+               before_collect
+
                # Fork and background the collect subroutine which will
                # run for --run-time seconds.  We (the parent) sleep
                # while its collecting (hopefully --sleep is longer than
@@ -1143,7 +1170,11 @@
                (
                   collect "$OPT_DEST" "$prefix"
                ) >> "$OPT_DEST/$prefix-output" 2>&1 &
-               log "Collector PID $!"
+               local collector_pid=$!
+               log "Collector PID $collector_pid"
+
+               # Plugin hook:
+               after_collect $collector_pid
             else 
                # There will not be enough disk space, so do not collect.
                warn "Collect canceled because there will not be enough disk space after collecting another $margin MB"
@@ -1156,6 +1187,9 @@
          ITER=$((ITER + 1))
          cycles_true=0
          sleep_ok "$OPT_SLEEP" "Sleeping $OPT_SLEEP seconds after collect"
+
+         # Plugin hook:
+         after_collect_sleep
       else
          # Trigger/check/value is ok, sleep until next check.
          sleep_ok "$OPT_INTERVAL"
@@ -1178,7 +1212,7 @@
    # Note: $$ is the parent's PID, but we're a child proc.
    # Bash 4 has $BASHPID but we can't rely on that.  Consequently,
    # we don't know our own PID.  See the usage of $! below.
-   RAN_WITH="--function=$OPT_FUNCTION --variable=$OPT_VARIABLE --threshold=$OPT_THRESHOLD --match=$OPT_MATCH --cycles=$OPT_CYCLES --interval=$OPT_INTERVAL --iterations=$OPT_ITERATIONS --run-time=$OPT_RUN_TIME --sleep=$OPT_SLEEP --dest=$OPT_DEST --prefix=$OPT_PREFIX --notify-by-email=$OPT_NOTIFY_BY_EMAIL --log=$OPT_LOG --pid=$OPT_PID"
+   RAN_WITH="--function=$OPT_FUNCTION --variable=$OPT_VARIABLE --threshold=$OPT_THRESHOLD --match=$OPT_MATCH --cycles=$OPT_CYCLES --interval=$OPT_INTERVAL --iterations=$OPT_ITERATIONS --run-time=$OPT_RUN_TIME --sleep=$OPT_SLEEP --dest=$OPT_DEST --prefix=$OPT_PREFIX --notify-by-email=$OPT_NOTIFY_BY_EMAIL --log=$OPT_LOG --pid=$OPT_PID --plugin=$OPT_PLUGIN"
 
    log "Starting $0 $RAN_WITH"
 
@@ -1190,9 +1224,15 @@
    # Make a secure tmpdir.
    mk_tmpdir
 
+   # Plugin hook:
+   before_stalk
+
    # Stalk while oktorun.
    stalk
 
+   # Plugin hook:
+   after_stalk
+
    # Clean up.
    rm_tmpdir
    remove_pid_file "$OPT_PID"
@@ -1217,6 +1257,15 @@
       option_error "Invalid --function value: $OPT_FUNCTION"
    fi
 
+   # Verify and source the --plugin.
+   if [ "$OPT_PLUGIN" ]; then
+      if [ -f "$OPT_PLUGIN" ]; then
+         . "$OPT_PLUGIN"
+      else
+         option_error "Invalid --plugin value: $OPT_PLUGIN is not a file"
+      fi
+   fi
+
    if [ -z "$OPT_STALK" -a "$OPT_COLLECT" ]; then
       # Not stalking; do immediate collect once.
       OPT_ITERATIONS=1
@@ -1611,6 +1660,66 @@
 
 Create a PID file when daemonized.
 
+=item --plugin
+
+type: string
+
+Load a plugin to hook into the tool and extend is functionality.
+The specified file does not need to be executable, nor does its first line
+need to be shebang line.  It only needs to define one or more of these
+Bash functions:
+
+=over
+
+=item before_stalk
+
+Called before stalking.
+
+=item before_collect
+
+Called when the stalk condition is triggered, before running a collector
+process as a backgrounded subshell.
+
+=item after_collect
+
+Called after running a collector process.  The PID of the collector process
+is passed as the first argument.  This hook is called before
+C<after_collect_sleep>.
+
+=item after_collect_sleep
+
+Called after sleeping L<"--sleep"> seconds for the collector process to finish.
+This hook is called after C<after_collect>.
+
+=item after_stalk
+
+Called after stalking.  Since pt-stalk stalks forever by default,
+this hook is only called if L<"--iterations"> is specified.
+
+=back
+
+For example, a very simple plugin that touches a file when a collector
+process is triggered:
+
+   before_colllect() {
+      touch /tmp/foo
+   }
+
+Since the plugin is completely sourced (imported) into the tool's namespace,
+be careful not to define other functions or global variables that already
+exist in the tool.  You should prefix all plugin-specific functions and
+global variables with C<plugin_> or C<PLUGIN_>.
+
+Plugins have access to all command line options but they should not modify
+them.  Each option is a global variable like C<$OPT_DEST> which corresponds
+to L<"--dest">.  Therefore, the global variable for each command line option
+is C<OPT_> plus the option name in all caps with hyphens replaced by
+underscores.
+
+Plugins can stop the tool by setting the global variable C<OKTORUN>
+to C<1>.  In this case, the global variable C<EXIT_REASON> should also
+be set to indicate why the tool was stopped.
+
 =item --prefix 
 
 type: string

=== added file 't/pt-stalk/plugin.t'
--- t/pt-stalk/plugin.t	1970-01-01 00:00:00 +0000
+++ t/pt-stalk/plugin.t	2012-10-03 18:33:24 +0000
@@ -0,0 +1,74 @@
+#!/usr/bin/env perl
+
+BEGIN {
+   die "The PERCONA_TOOLKIT_BRANCH environment variable is not set.\n"
+      unless $ENV{PERCONA_TOOLKIT_BRANCH} && -d $ENV{PERCONA_TOOLKIT_BRANCH};
+   unshift @INC, "$ENV{PERCONA_TOOLKIT_BRANCH}/lib";
+};
+
+use strict;
+use warnings FATAL => 'all';
+use English qw(-no_match_vars);
+use Test::More;
+use Time::HiRes qw(sleep);
+
+use PerconaTest;
+use DSNParser;
+use Sandbox;
+
+my $dp = new DSNParser(opts=>$dsn_opts);
+my $sb = new Sandbox(basedir => '/tmp', DSNParser => $dp);
+my $dbh = $sb->get_dbh_for('master');
+
+if ( !$dbh ) {
+   plan skip_all => 'Cannot connect to sandbox master';
+}
+
+my $cnf      = "/tmp/12345/my.sandbox.cnf";
+my $pid_file = "/tmp/pt-stalk.pid.$PID";
+my $log_file = "/tmp/pt-stalk.log.$PID";
+my $dest     = "/tmp/pt-stalk.collect.$PID";
+my $output;
+my $retval;
+my $pid;
+
+diag(`rm $pid_file 2>/dev/null`);
+diag(`rm $log_file 2>/dev/null`);
+diag(`mkdir $dest`);
+
+# We'll have to watch Uptime since it's the only status var that's going
+# to be predictable.
+my (undef, $uptime) = $dbh->selectrow_array("SHOW STATUS LIKE 'Uptime'");
+my $threshold = $uptime + 2;
+
+$retval = system("$trunk/bin/pt-stalk --iterations 1 --dest $dest --variable Uptime --threshold $threshold --cycles 1 --run-time 2 --pid $pid_file --plugin $trunk/t/pt-stalk/samples/plugin001.sh -- --defaults-file=$cnf >$log_file 2>&1");
+
+PerconaTest::wait_until(sub { !-f $pid_file });
+
+is(
+   $retval >> 8,
+   0,
+   "Exit 0"
+);
+
+foreach my $hook (qw(
+   before_stalk
+   before_collect
+   after_collect
+   after_collect_sleep
+   after_stalk
+)) {
+   ok(
+      -f "$dest/$hook",
+      "$hook hook called"
+   );
+}
+
+# #############################################################################
+# Done.
+# #############################################################################
+diag(`rm $pid_file 2>/dev/null`);
+diag(`rm $log_file 2>/dev/null`);
+diag(`rm -rf $dest 2>/dev/null`);
+ok($sb->ok(), "Sandbox servers") or BAIL_OUT(__FILE__ . " broke the sandbox");
+done_testing;

=== added file 't/pt-stalk/samples/plugin001.sh'
--- t/pt-stalk/samples/plugin001.sh	1970-01-01 00:00:00 +0000
+++ t/pt-stalk/samples/plugin001.sh	2012-10-03 18:33:24 +0000
@@ -0,0 +1,21 @@
+#!/bin/sh
+
+before_stalk() {
+   date >> "$OPT_DEST/before_stalk"
+}
+
+before_collect() {
+   date >> "$OPT_DEST/before_collect"
+}
+
+after_collect() {
+   date >> "$OPT_DEST/after_collect"
+}
+
+after_collect_sleep() {
+   date >> "$OPT_DEST/after_collect_sleep"
+}
+
+after_stalk() {
+   date >> "$OPT_DEST/after_stalk"
+}