Add key option to oltpplot, oltpdirectory

Author: bengsig

bin/mtitplot

@@ -21,6 +21,7 @@ help=no
 markerfile=`mktemp`
 trap "rm -f $markerfile" 0 int
 xcolor=''
+runnumber=0
 
 while test $1 != '--'
 do

bin/oltpdirectory

@@ -20,9 +20,11 @@ help=no
 awr=no
 scalekey=''
 runnumber=''
+mykey="$RWLOLTP_NAME"
+wantlatest=no
 
-usage="Usage: $commandname [-a|--awrdirectory] [-h|-H|--help] [-s|--scalekey key] [-r|--runnumber N] [-l|--latest]"
-options='aAhHs:r:l -l latest,awrdirectory,help,scalekey:,runnumber:'
+usage="Usage: $commandname [-a|--awrdirectory] [-h|-H|--help] [-s|--scalekey key] [-k|--key key] [-r|--runnumber N] [-l|--latest]"
+options='aAhHs:r:lk: -l key:,latest,awrdirectory,help,scalekey:,runnumber:'
 
 # Get directory names from parameters.rwl
 
@@ -34,19 +36,26 @@ set -- `getopt -u -n $commandname -o $options -- "$@"`
 while test $1 != '--'
 do
   case $1 in
-    -l|--latest) runnumber=`rwloadsim latest.rwl`; shift;
-    ;;
     -r|--runnumber) runnumber=`expr 0 + $2`; shift; shift;
     ;;
+    -k|--key) mykey=$2; shift; shift;
+    ;;
     -s|--scalekey) scalekey=$2; shift; shift;
     ;;
+    -l|--latest) wantlatest=yes; shift;
+    ;;
     -a|-A|--awrdirectory) awr=yes; shift;
     ;;
     --help|-h|-H) help=yes; shift;
     ;;
   esac
 done
 
+if test $wantlatest = yes
+then
+    runnumber=`rwloadsim --mykey=$mykey latest.rwl`
+fi
+
 shift # removes --
 
 if test $# -ge 1 -o x$help = xyes

bin/oltpplot

@@ -24,8 +24,8 @@
 
 . oltp-setup-env
 
-options="-o lhHX:x:c:r: -l xfile:,Xfile:,latest,help,xmarker:,xline:,xcolor:,ses-y2range:,ses-yrange:,ash-yrange:,res-yrange:,res-y2range:"
-usage="$commandname [-x|-X|--xmarker|--xline 'time text'] [--xcolor=rgbname] [-l|--latest|[-r] runnumber] [{gnuplot range settings}]"
+options="-o lhHX:x:c:r:k: -l key:,xfile:,Xfile:,latest,help,xmarker:,xline:,xcolor:,ses-y2range:,ses-yrange:,ash-yrange:,res-yrange:,res-y2range:"
+usage="$commandname [-x|-X|--xmarker|--xline 'time text'] [--xcolor=rgbname] [-l|--latest|[-r] runnumber] [-k|--key key] [{gnuplot range settings}]"
 
 getopt -Q $options -- "$@" || exit 1
 options=$(getopt -n $commandname $options -- "$@")
@@ -42,6 +42,8 @@ sesy2range=''
 resyrange=''
 ashyrange=''
 resy2range=''
+mykey="$RWLOLTP_NAME"
+wantlatest=no
 
 while test $1 != '--'
 do
@@ -58,7 +60,9 @@ do
 	;;
     -r) runnumber=$2; shift; shift;
 	;;
-    -l|--latest) runnumber=`rwloadsim latest.rwl`; shift;
+    -k|--key) mykey=$2; shift; shift;
+	;;
+    -l|--latest) wantlatest=yes; shift;
 	;;
     --xfile) cat $2 | while read x; do echo m $x; done >> $markerfile; shift; shift;
         ;;
@@ -79,6 +83,11 @@ do
 done
 shift
 
+if test $wantlatest = yes
+then
+    runnumber=`rwloadsim --mykey=$mykey latest.rwl`
+fi
+
 if test $help = yes
 then
   cat <<HELP

man/man2rwl/oltpdirectory.2rwl

@@ -29,6 +29,12 @@ Output the name of the directory where gnuplot input, csv files, etc. for the
 latest run from the current host is found.
 .RE
 .P
+.B -k|--key key
+.RS 4
+Provide a key in the repository rather than the default taken from the RWLOLTP_NAME environment variable.
+This option is only relevant if you also use the -l or --latest option.
+.RE
+.P
 .B -h|-H|--help
 .RS 4 
 Only output a short help.

man/man2rwl/oltpplot.2rwl

@@ -2,17 +2,40 @@
 .SH NAME
 oltpplot \- Create html and graphics for a single run
 .SH SYNOPSIS
-\fBoltpplot [--xfile|--Xfile filename] [-x|-X|--xmarker|--xline 'time text'] [-c|--xcolor rgbname] [--ses-y{2}range '[ .. ]' [--res-y{2}range '[ .. ]' --ash-yrange '[ .. ]' [-l|--latest|[-r] runnumber]\fR
+\fBoltpplot [--xfile|--Xfile filename] [-x|-X|--xmarker|--xline 'time text'] [-c|--xcolor rgbname] [--ses-y{2}range '[ .. ]' [--res-y{2}range '[ .. ]' --ash-yrange '[ .. ]' [-k|--key key] [-l|--latest|[-r] runnumber]\fR
 .P
 Recreate the report that was created using
 .B oltprun
+with possible changes to y-axes and/or
 potentially adding named markers or vertical lines.
 .SH OPTIONS
 .B -h|-H|--help
 .RS 4
 Print short help.
 .RE
 .P
+.B --res-yrange '[ .. ]'
+.br
+.B --res-y2range '[ .. ]'
+.br
+.B --ses-yrange '[ .. ]'
+.br
+.B --ses-y2range '[ .. ]'
+.br
+.B --ash-yrange '[ .. ]'
+.br
+.RS 4
+By default the ranges of the left and right y-axes in the various plots are set to be "reasonable".
+The first two options will explicitly set different ranges in the first plot of
+resources (dbcpu and dbtime) on the left y-axis or throughput on the right y-axis.
+The second two options explicitly set different ranges in the second plot of sessions on
+the left y-axis (database open/active sessions)
+or right y-axis (instance distribution).
+The last option will set the left y-axis range (session count) for the ash plot.
+The argument to these options must be a valid gnuplot argument for a range such as [0:*], [0:20] or similar
+and it should typically be enclosed in quotes to prevent shell expansion.
+.RE
+.P
 .B -x|--xmarker 'time text'
 .RS 4
 Put a named marker on the x-axis of all relevant plots at some time.
@@ -55,34 +78,18 @@ By default, these markers and lines are printed by gnuplot using the rgb name of
 you can use this option to choose any other valid rgb name.
 .RE
 .P
-.B --res-yrange '[ .. ]'
-.br
-.B --res-y2range '[ .. ]'
-.br
-.B --ses-yrange '[ .. ]'
-.br
-.B --ses-y2range '[ .. ]'
-.br
-.B --ash-yrange '[ .. ]'
-.br
-.RS 4
-By default the ranges of the left and right y-axes in the various plots are set to be "reasonable".
-The first two options will explicitly set different ranges in the first plot of
-resources (dbcpu and dbtime) on the left y-axis or throughput on the right y-axis.
-The second two options explicitly set different ranges in the second plot of sessions on
-the left y-axis (database open/active sessions)
-or right y-axis (instance distribution).
-The last option will set the left y-axis range (session count) for the ash plot.
-The argument to these options must be a valid gnuplot argument for a range such as [0:*], [0:20] or similar
-and it should typically be enclosed in quotes to prevent shell expansion.
-.RE
-.P
 .B -l|--latest
 .RS 4
 You can provide this option as an alternative to an actual runnumber, which causes the latest
 run from the current host to be used.
 .RE
 .P
+.B -k|--key key
+.RS 4
+Provide a key in the repository rather than the default taken from the RWLOLTP_NAME environment variable.
+This option is only relevant if you also use the -l or --latest option.
+.RE
+.P
 .SH USAGE
 You normally don't need to call this directly; it is automatically
 called after each execution of \fBoltprun\fR
@@ -99,6 +106,16 @@ To create a useful string for a date representation for either option, you can c
 date -u +%Y.%m.%dT%H:%M:%S
 .fi
 .SH EXAMPLES
+If you find that your latest run was using a y-axis for the database cpu and time that was
+inappropriate, you can recreate the graphs using a command like
+.P
+.nf
+oltpplot --res-yrange='[0:20]' -l
+.fi
+.P
+which will cause the y-axis on the throughput and resources graph to have the range 0-20 seconds.
+Note that the actual range typically needs to be quoted to prevent shell expansion.
+.P
 If you had a run with number 12345 starting on 2021.12.31 just before midnight
 and you want to add a vertical line to the plots at exactly midnight, you
 can recreate the graphs using