ashplot: top 8, nicer userhelp, script in bin

Author: bengsig

GENERATED.txt

@@ -11,6 +11,10 @@
  * of the directories in PATH. An appropriate Oracle
  * client environment with properly set LD_LIBRARY_PATH
  * is needed.
+ *
+ * To get help for either exeuctable, execute it with a
+ * -h option. To show the rwl source, exeucte with a
+ * --list-generated option.
  * 
  * The full source code is available from
  * https://opensource.oracle.com/

bin/ashplot

@@ -0,0 +1,13 @@
+#!/bin/sh
+
+# RWP*Load Simulator
+#
+# Copyright (c) 2021 Oracle Corporation
+# Licensed under the Universal Permissive License v 1.0
+# as shown at https://oss.oracle.com/licenses/upl/
+#
+# call rwloadsim -u ashplot.rwl
+
+# bengsig  27-nov-2023 - Creation
+
+rwloadsim --pretend-gen-banner='RWP*ASH Plot' -u ashplot.rwl "$@"

man/man2rwl/ashplot.2rwl

@@ -1,12 +1,12 @@
 .TH ashplot "2rwl" "May 2022" "RWP*Load Simulator" "Utility Syntax"
 .SH NAME
-ashplot.rwl \- Create a plot of ash data
+ashplot \- Create a plot of ash data
 .SH SYNOPSIS
-\fBrwloadsim [options] -u -l u/p@c ashplot.rwl\fR
+\fBashplot [options] -l u/p@c ashplot.rwl\fR
 .P
-\fBrwloadsim [options] -u -l u/p@c ashplot.rwl header text\fR
+\fBashplot [options] -l u/p@c ashplot.rwl title text\fR
 .P
-The ashplot.rwl script is used to create a plot of ash data
+The ashplot command is used to create a plot of ash data
 in any of three possible formats:
 .TP 4
 1.
@@ -18,7 +18,7 @@ Create an image file in png format.
 3.
 Create an image file in svg format potentially with the svgmouse option.
 .P
-All output is generated using the gnuplot command which therefore must be installed.
+All output is generated using the gnuplot which therefore must be installed.
 .P
 The data used to generate the graphs is retrieved from either live data
 in gv$active_session_history or from the awr repository in dba_hist_active_sess_history.
@@ -29,25 +29,20 @@ option.
 If you do not provide one of the output options, no graph is created, but you 
 will be shown a date interval (with minute resolution) for which data is available.
 If your goal is to graph data from the awr repository, you are suggested to first
-use awrreport.rwl to identify the databases, instances and snapshot 
+use awrreport to identify the databases, instances and snapshot 
 ranges available.
 This is particularly useful if you are working with an awr repository that
 contains awr imports from other databases.
 .P
 .SH OPTIONS
-\fB-u\fR
-.RS 4
-Compulsory option to find the ashplot.rwl script in the public directory.
-.RE
-.P
 .B -l u/p
 .br
 .B -l u/p@c
 .RS 4
 Compulsory option to provide the username, password, and potentially
 connect string for a database connection that provides access to
 the necessary gv$ and dba_hist views.
-If you omit /p, rwloadsim will prompt for the password.
+If you omit /p, ashplot will prompt for the password.
 .RE
 .P
 .B --dbid=<dbid>
@@ -133,7 +128,7 @@ This example shows how you can progressively narrow down a certain database and
 for which you create the ash plots.
 Start by listing all available databases and instances in some repository:
 .nf
-rwloadsim -ul system/{password}@tnsalias awrreport.rwl
+awrreport -l system/{password}@tnsalias
 .fi
 .P
 which may generate an output like:
@@ -152,7 +147,7 @@ Assume the last one is the interesting one,
 so first create a plot using X-Windows covering the whole available range:
 .P
 .nf
-rwloadsim --output-X --dbid=4001460110 -ul system/{password}@tnsalias ashplot.rwl
+ashplot --output-X --dbid=4001460110 -l system/{password}@tnsalias
 .fi
 .P
 which first will show the actual available range and then (potentially after some time)
@@ -164,12 +159,12 @@ Data available between 2022.03.21T00:47 and 2022.04.02T23:59
 .P
 You may then want to narrow down the actual time for which the plot it produced:
 .nf
-rwloadsim --output-X --fromtime=2022.04.01T12 --totime=2022.04.02T12 --dbid=4001460110 -ul system/{password}@tnsalias ashplot.rwl
+ashplot --output-X --fromtime=2022.04.01T12 --totime=2022.04.02T12 --dbid=4001460110 -l system/{password}@tnsalias
 .fi
 .P
 And finally, you may want to reduce it further, also create image files, and also include SYS sessions:
 .nf
-rwloadsim --svgmouse --output-image=/var/www/html/myash/myplot --include-sys --fromtime=2022.04.01T17:30 --totime=2022.04.01T20:30 --output-X --dbid=4001460110 -ul system/{password}@tnsalias ashplot.rwl
+ashplot --svgmouse --output-image=/var/www/html/myash/myplot --include-sys --fromtime=2022.04.01T17:30 --totime=2022.04.01T20:30 --output-X --dbid=4001460110 -l system/{password}@tnsalias 
 .fi
 .P
 The image files will be put in the directory /var/www/html/myash,
@@ -179,7 +174,7 @@ You can see an actual sample image at https://github.com/oracle/rwloadsim/blob/m
 .P
 This final example shows how you can plot all available live data (i.e. from gv$active_session_history):
 .nf
-rwloadsim --include-sys --output-X -ul system/{password}@tnsalias ashplot.rwl
+ashplot --include-sys --output-X -l system/{password}@tnsalias 
 .fi
 .SH BUGS
 If there are many ash samples, generating the data and subsequently using gnuplot takes a long time.

public/ashplot.rwl

@@ -9,6 +9,7 @@
 # History:
 #
 # Modified Date         Comments
+# bengsig  27-sep-2023  include top 8 (rather than 6)
 # bengsig  13-sep-2023  use ampersand replacement
 # bengsig  13-apr-2022  Created as rwl from shell script
 # bengsig  23-mar-2022  Add -n for node (instance) number
@@ -20,9 +21,11 @@
 $longoption:file-count=1
 
 # If we didn't connect, don't do anything
-if oraerror is not null and oraerror then
+$if not defined(default database) $then
+  writeline stderr, "Missing or incorrect -l option; use -h to get help";
   exit 1;
-end if;
+$endif
+
 
 # Check of gnuplot is available
 string gnuplotok;
@@ -32,52 +35,44 @@ if system("type gnuplot 2>/dev/null", gnuplotok) then
 end if;
 
 integer maxsessions := 0;
-$useroption:maxsessions:"--maxsessions=<N> - Highest number of sessions to show in y-axis"
-
 integer dbid;
-$useroption:dbid:"--dbid=<N> - query dba_hist_active_sess_history in stead of gv$"
-
 integer instance;
-$useroption:instance:"--instance=<N> - only include sessions in this instance"
-
 string mintime, fromtime;
-$useroption:fromtime:"--fromtime=YYYY.MM.DDTHH24:MI - first timestamp to include in graph"
-
 string maxtime, totime;
-$useroption:totime:"--totime=YYYY.MM.DDTHH24:MI - last timestamp to include in graph"
-
 string(1000) ashplot_tempdir;
-$useroption:ashplot-tempdir # not documented
-
 integer ashplot_debug := 0;
-$userswitch:ashplot-debug # Not documented
-
 integer output_X := 0;
-$userswitch:output-X:"--output-X - generate output as X11 image"
-
 string(1000) output_png;
-$useroption:output-png:"--output-png=<file.svg> - create image file as PNG"
-
 string(1000) output_svg;
-$useroption:output-svg:"--output-svg=<file.svg> - create image files as SVG"
-
 integer svgmouse := 0;
-$userswitch:svgmouse:"--svgmouse - embed mouse javascript code in svg file"
-
 integer boxwidth := 0;
-$useroption:boxwidth:"--boxwidth=N - set boxwidth" 
-
 string(1000) output_image;
-$useroption:output-image:"--output-image=<file> - create image files named file.svg and file.png"
-
 integer include_sys := 0;
-$userswitch:include-sys:"--include-sys - Include sessions from SYS, default is to exclude SYS"
-
 integer w_pixels := 640;
-$useroption:w-pixels:"--w-pixels - set the width in pixels"
-
 integer h_pixels := 480;
-$useroption:h-pixels:"--h-pixels - set the height in pixels"
+                  $userhelp:"Create a plot of ash data as image file or using X-Windows"
+		  $userhelp:"-l usr/pwd@con                - required option providing database credentials"
+           $useroption:dbid:"--dbid=<N>                    - query dba_hist_active_sess_history in"
+                  $userhelp:"                                stead of gv$active_session_history"
+       $useroption:instance:"--instance=<N>                - only include sessions in this instance"
+    $userswitch:include-sys:"--include-sys                 - Include sessions from SYS, default is"
+                  $userhelp:"                                to exclude SYS"
+       $useroption:fromtime:"--fromtime=YYYY.MM.DDTHH24:MI - first timestamp to include in graph"
+         $useroption:totime:"--totime=YYYY.MM.DDTHH24:MI   - last timestamp to include in graph"
+       $userswitch:output-X:"--output-X                    - generate output as X-Windows image"
+     $useroption:output-png:"--output-png=<file.svg>       - create image file as png"
+     $useroption:output-svg:"--output-svg=<file.svg>       - create image files as svg"
+       $userswitch:svgmouse:"--svgmouse                    - embed svgmouse code in svg file"
+   $useroption:output-image:"--output-image=<file>         - create image files named file.svg"
+                  $userhelp:"                                and file.png"
+    $useroption:maxsessions:"--maxsessions=<N>             - Highest number of sessions to show"
+                  $userhelp:"                                on y-axis"
+       $useroption:w-pixels:"--w-pixels=<N>                - set the width in pixels"
+       $useroption:h-pixels:"--h-pixels=<N>                - set the height in pixels"
+                  $userhelp:"The following options are normally not used:"
+       $useroption:boxwidth:"--boxwidth=N                  - set boxwidth" 
+$useroption:ashplot-tempdir:"--ashplot-tempdir=<directory> - use directory for intermediate files"
+  $userswitch:ashplot-debug:"--ashplot-debug               - output some debug, save tempdir"
 
 string(1000) title;
 
@@ -160,7 +155,7 @@ sql execute
 end;
 
 if mintime = "" or maxtime = "" then
-  writeline stderr, "No data available between " fromtime " and " totime;
+  writeline stderr, "No data available in " tablename;
 else
   writeline stderr, "Data available between " mintime " and " maxtime;
 end if;
@@ -223,12 +218,12 @@ string(4000) csvheader := "#YYYYMM.DD.HH24:MI:SS 'CPU' ";
 string event;
 integer ecount, d, lc := 0;
 
-plotline := "plot '" tempdir "/ashdata.csv' using 1:($2+$3+$4+$5+$6+$7+$8+$9) "
+plotline := "plot '" tempdir "/ashdata.csv' using 1:($2+$3+$4+$5+$6+$7+$8+$9+$10+$11) "
   "with boxes lc rgb 'gray' title 'Other' \\\n";
 
-# We want to show the top 6 events plus CPU and Other, but do
+# We want to show the top 8 events plus CPU and Other, but do
 # not know which events that are. Hence we rename them in 
-# a decode to E1 until E6
+# a decode to E1 until E8
 
 integer totalevs, maxevents := 0;
 double sinceprevious, maxprevious := 0;
@@ -245,6 +240,8 @@ csvquery :=
   "|| ' ' || nvl(e4,0)\n"
   "|| ' ' || nvl(e5,0)\n"
   "|| ' ' || nvl(e6,0)\n"
+  "|| ' ' || nvl(e7,0)\n"
+  "|| ' ' || nvl(e8,0)\n"
   "|| ' ' || nvl(other,0) csvline\n"
   ", nvl(cpu,0)\n"
   "  + nvl(e1,0)\n"
@@ -253,10 +250,12 @@ csvquery :=
   "  + nvl(e4,0)\n"
   "  + nvl(e5,0)\n"
   "  + nvl(e6,0)\n"
+  "  + nvl(e7,0)\n"
+  "  + nvl(e8,0)\n"
   "  + nvl(other,0) totalevs\n"
   ", 86400 * (sample_time - first_value( sample_time) over (order by sample_time rows between 1 preceding and current row)) sinceprevious\n"
   "from ( \n"
-  "select sample_time,CPU,E1,E2,E3,E4,E5,E6,OTHER\n"
+  "select sample_time,CPU,E1,E2,E3,E4,E5,E6,E7,E8,OTHER\n"
   "from ( \n"
   "select sample_time\n"
   ", event \n"
@@ -267,7 +266,7 @@ csvquery :=
   ", decode(event ";
 
 # The core of that query comes from picking the top
-# 6 events, that we get here with the order by
+# 8 events, that we get here with the order by
 # and rownum predicate
 for
   select event, ecount from ( 
@@ -277,7 +276,7 @@ for
     &constraints.
     group by event
     order by count(*) desc )
-  where rownum <= 6
+  where rownum <= 8
   /
 loop
   lc += 1;
@@ -287,7 +286,7 @@ loop
   sprintf || csvquery, "\n, '%s', 'E%d' ", event, lc;
   sprintf || plotline, ",'%s/ashdata.csv' using 1:($2", tempdir;
   # this sum deals with the bars put on top of each other
-  for d := lc..6 loop
+  for d := lc..8 loop
     sprintf || plotline, "+$%d", d+2; # :plt := :plt || '+\$'||to_char(d+2,'FM99');
   end loop;
   plotline ||= ") with boxes lc rgb ";
@@ -304,6 +303,8 @@ loop
     if lc=4 then plotline ||= "'blue'"; end if;
     if lc=5 then plotline ||= "'light-blue'"; end if;
     if lc=6 then plotline ||= "'salmon'"; end if;
+    if lc=7 then plotline ||= "'gold'"; end if;
+    if lc=8 then plotline ||= "'cyan'"; end if;
   end if;
   plotline ||= " title '" event "' \\\n";
 end loop;
@@ -327,6 +328,8 @@ csvquery ||= "\n, NULL, 'CPU', 'OTHER') event from\n" tablename "\n"
   ", 'E4' as E4\n"
   ", 'E5' as E5\n"
   ", 'E6' as E6\n"
+  ", 'E7' as E7\n"
+  ", 'E8' as E8\n"
   ", 'CPU' as CPU\n"
   ", 'OTHER'as OTHER\n"
   ")))\n"