Merge branch 'remote-awr-pierce' into 'oramain'

Add awr_replication_cmd for automatic replication of results to remote host.

See merge request rwp/rwloadsim!27

Author: bengsig

bin/mtitplot

@@ -5,6 +5,7 @@
 
 # Changes:
 #
+# lpierce  17-oct-2024 added awr_replication_cmd execution
 # bengsig   8-may-2024 global osstat
 # bengsig   2-may-2024 --fractiles-dropped option to oltpplot
 # bengsig  28-apr-2024 osstat
@@ -437,3 +438,6 @@ $osstatembed
 <embed src="${runnumber}_instdist.svg"><br>
 END
 
+if [ -n "$awr_replication_cmd" ]; then
+  eval $awr_replication_cmd
+fi

bin/oltpplot

@@ -5,6 +5,7 @@
 
 # Changes:
 #
+# lpierce  17-oct-2024 - added awr_replication_cmd execution
 # bengsig  23-jul-2024 - ping->connping
 # bengsig  22-jul-2024 - Show min/max pool when xc changes
 # bengsig  22-jul-2024 - Add cstorm logoff time
@@ -1174,3 +1175,6 @@ then
   echo '<embed src="'$ashimg'"><br>' >> $awrdirectory$subdir$runnumber/index.html
 fi
 
+if [ -n "$awr_replication_cmd" ]; then
+  eval $awr_replication_cmd
+fi

man/man2rwl/oltpsetup.2rwl

@@ -662,6 +662,31 @@ If the procedure is not declared, the following will be used
 .P
 implying rwloadsim will be started locally.
 This is always used for process number 1, as it must run locally.
+.SH "REMOTE REPORT REPLICATION"
+.P
+When \fBrwloadsim\fR is running on a machine that cannot host a webservice, it may be useful to replicate the report data to a remote machine. This can be achieved by setting the \fBawr_replication_cmd\fR parameter to a custom command that replicates the data after the report is generated. By default, \fBawr_replication_cmd\fR is not set, so no replication occurs.
+.P
+If \fBawr_replication_cmd\fR is defined, it will be executed each time a report is generated, allowing automated replication to the specified remote machine. The command typically uses \fBrsync\fR to securely copy the report data. Below is an example of how to configure \fBawr_replication_cmd\fR with \fBrsync\fR:
+.P
+.nf
+rsync -avz -e "ssh -i /path/to/identity" \\
+      --rsync-path="mkdir -p /path/to/replicate${subdir}${runnumber} \\
+      && rsync" $awrdirectory${subdir}${runnumber} \\
+      user@host:/path/to/replicate${subdir}${runnumber}
+.fi
+.P
+In this example:
+.IP
+- \fB-avz\fR options enable archive mode (preserving file permissions, timestamps, etc.), verbose output, and compression during transfer.
+.IP
+- \fB-e\fR specifies the SSH command, here with a custom identity file (\fI/path/to/identity\fR).
+.IP
+- \fB--rsync-path\fR is used to ensure that the remote directory structure exists by creating the necessary directories with \fBmkdir -p\fR before starting the transfer.
+.IP
+- The path variables \fI$subdir\fR and \fI$runnumber\fR dynamically set the subdirectory and run number for replication, creating an organized directory structure on the remote machine.
+.P
+This approach ensures that the report data is replicated to the specified path on the remote host, facilitating centralized data access even when \fBrwloadsim\fR is executed on a machine without webservice capabilities.
+
 .SH "SAVING PASSWORDS IN KEYRING"
 If you have gnome keyring available, you can use that to save passwords rather than having them 
 in your $RWLOLTP_NAME.rwl file.

oltp/oltp.rwl

@@ -18,6 +18,11 @@
 awrdirectory := "/NOTSET/var/www/html/key";
 resultsdir:="/NOTSET/home/results/key";
 
+# Specify a command for awr results replication.
+# The awr_replication_cmd is evaluated in bash as a single quoted string, meaning no variables will be injected directly.
+
+# awr_replication_cmd := "rsync -avz -e \"ssh -i /path/to/identity\" --rsync-path=\"mkdir -p /path/to/replicate${subdir}${runnumber} && rsync\" ${awrdirectory}${subdir}${runnumber} user@host:/path/to/replicate${subdir}${runnumber}";
+
 # The rwloltp suite uses several different connect
 # strings for different purposes. In many casess
 # they can have the same value.

oltp/parameters.rwl

@@ -2,6 +2,7 @@
 # Licensed under the Universal Permissive License v 1.0
 # as shown at https://oss.oracle.com/licenses/upl/
 
+# lpierce  17-oct-2024 - added awr_replication_cmd
 # bengsig  10-oct-2023 - sessionpool max use/lifetime
 # bengsig  31-jul-2023 - rategradientstep
 # bengsig  17-jun-2023 - add mtit_partitions parameter
@@ -284,6 +285,7 @@ double pool_size_interval := 300;
 # These are the ones that MUST be set by the user:
 
 string awrdirectory := "/nowhere";
+string(1000) awr_replication_cmd := "";
 string resultsdir := "/nowhere";
 string subdir := "/r"||runnumber/1000||"/";
 string system_connect := "//machine/database";

oltp/parameters2shell.rwl

@@ -2,6 +2,7 @@
 # Licensed under the Universal Permissive License v 1.0
 # as shown at https://oss.oracle.com/licenses/upl/
 
+# lpierce  17-oct-2024 - added export of awr_replication_cmd
 # bengsig  19-mar-2024 - cstorm
 # bengsig  24-apr-2023 - mtit 
 # bengsig  25-oct-2022 - External control
@@ -102,6 +103,10 @@ if only_directories or !only_plus then
   printline "rwloadsimdir='"||rwloadsimdir||"'";
 end if;
 
+if !only_directories and !only_plus then
+  printline "awr_replication_cmd='"||awr_replication_cmd||"'";
+end if;
+
 if only_plus or !only_directories then
   if passwords then
     printline "#AWR: sqlplus " sysawr_username "/" sysawr_password "@" sysawr_connect;