For installation instruction, see INSTALL.

Known Problems

When running from the CLI on linux workstations, the 'Type RETURN message
from gnuPlot is displayed in the terminal window and the plot window may be
occluded by other windows.

Some mailers don't handle uuencoded mail properly, which is what colplot
currently uses.  Support for MIME attachments will probably be added in the
future.

Restrictions

Colplot can deal with multiple files contains the same data in different columns BUT
since it uses the columns headers to identify the data, if you mix different data
for the same day by appending to the same file colplot has no way of knowing.  In 
these situations you MUST create unique files when there is different data by 
using -ou with collectl.

Modification History

4.6.3  Jun 22, 2012
- relaxed x11 check to ONLY cases where cli used w/o --filedir option
- make margins tighter when legend or x-axis turned off
- updated INSTALL/UNINSTALL to be deal with apache2 on debian
- when legend/xaxis suppressed, reduce corresponding margin sizes
- new experimental API to allow last minute modification of standard plotting params
  by specifying a file as an email subject, but only for a single plot type.  added
  tiny and oneperpage to kit as examples to experiment with
- allow -suffix after a plot filenames date/time
- removed divisor from memory field defs in colplotlib.defsand added to plots themselves, 
  making it possible to use GB for mem plot and MB for some of the individual ones like 
  membuf and memmap
- added mask of 32 to allow limiting  y-axis to %f.1 to make less cluttered even though some
  labels repeat
- made the spacing between labels in the legend a little tighter 1.0 -> .7 so they're more likely
  to fit in single column.
- changed disk/network plot setting so that disk read/writes are never divided by 1000 and
  network packets always are

4.6.2
- added mask of 18 to definitions for plots 'swap' and 'nfsmeta'
- added mask to output for debug=2
- sort detail plots by instance names [kevin - thanks for the push]
- can now add addition plot header/extension mappings to defs files
  using <extmaps> stanza
- added debug 2048 to colplotlib and enhanced debug 32 a little more too
- in colplotlib when writing to a pdf, you need to set the teminal type to
  postscript BEFORE setting the output filename
- added id/for to checkboxes so you can click on text as well [thanks justin]

4.6.1   Nov  2, 2010
- see changes to colplotlib.defs
- see changes to colplotlib.phanksh
- changed behavior for 'contains'
  - default set to ANY
  - if 'contains' contains a '[', ignore any/all and treat as a pdsh expression
- added nvidia plot definitions

4.5.1   July 24, 2010
- is 'anyall' or 'contains' used as argument take them as field defaults
- changed default directory to /var/log/collectl as a number of users prefer this
  to the example plot directory.  the 'getting started' topic in the FAQ was
  updated accordingly
- don't require ghostscript for png files, fixed error check
- deal with $email format of /dir/prefix and validate against dir

4.4.2   April 26, 2010
- need to divide the read/write KBs for disk data by 1024 in colplotlib.defs

4.4.1   December 15, 2009
- clarified copyright notice
- set $LibDir to binary directory if colplotlib.ph is there, otherwise look in
  /usr/share/collectl

4.4.0	August 21, 2009
- open source release

4.3.2	July 21, 2009
- if plotting by points, set plot type to thickness-1 since we can't change the size of default
  style 0 and DO want that when thick=1
- changed message "No files matching your selections were found" to more clearly state the
  situation
- if multiple detail files for same day were generated by using -ou and the configuration changed
  (currently this is only an issues with polyserve), colplot WILL correctly select the correct
  column numbers for each individual file, something it couldn't do before.

4.3.1   April 28, 2009
- support for remote plotting
  - 2 new switches: -addr and -href
  - new plot type of 'tty' which prints png file to tty
- removed all print statements from -help routine
- upgrade to support gnuplot 4.2, which sets canvas size in 'set terminal' and
  hardcodes 'set size 1,1'
- rookie bug - wasn't NOT masking the mask variabe with 1 so it wouldn't pick up
  any other setting.
- added new switch/webfield, thick to change thickness of plot line (so I can see it!)

4.2.1   March 15, 2009
- change to colplotlib.ph

4.2.0   January 29, 2009
- when running gnuplot on a pc, can't echo a 'set terminal' command and so we have
  to just assume png and x11 are builtin, which they seem to be with 4.2
- 2 newplots - faults and paging
- added swap in/out to swap
- added all 3 to allsum

4.1.5   December 17, 2008
- updated colplot main help file

4.1.4   December 4, 2008
- added new environmentatl plot, Power
- added date range to debug code in findFiles()
- new switch for cli, --lastmins which specifies the last minutes of data to plot
  either just prior to the last file access time OR overridden with --time.  Only
  caveat for --time is you can't specify a begin time so you need something like
  "-hh:mm" in quote so the leading - doesn't look like a switch

4.1.3   October 9, 2008
- added options for Fans and Temps
- see RELEASE-collectl-utils

4.1.2   ???
- updated a few definitions in colplotlib.defs
- name of nfs detail plot wrong.  changed it from nfsd to detnfs
- made error message about missing column name in plot file more explicit
- fixed bug in live move which caused error when crossing an hour boundary
- add from date to plot display header and if different add 'thru' as well

4.1.1   Feb 29, 2008
- added new plot types for cpu to include irs, soft, steal and intrpt
  (only changes to colplotlib.defs)

4.1.0	Feb 08, 2008
- make sure gnuplot suppots png/x11 graphics for type in invocation and
  include with -v status

4.0.2 	Nov 19, 2007
- changed ambiguous 'type -h for help' message to 'type -help...'
- was not correctly setting 'unique' on initial call to findFiles which in some 
  cases [still not entirely understood] caused an infinite loop in that routine
- had wrong name for default Lustre plots.  Should have been 'sumlus' not 'lustre'
- changed units on lustre client and OST plot data to MB instead of KB

4.0.1 	Jul 13, 2007
- enhanced some error messages
- changed nfs summary plot name, which doesn't exist, to 'sumnfs'
- fixed colplotlib.ph to handle nested macros as long as defined in right order
- nested some macros in colplotlib.defs
- when both divisors the same (ctx/int) and mulitple of 1000, append multiplier
  to title
- by default, select plot file with unique or date-stamped name formats based 
  on the type of the first one that matches selection criteria.  this behavior
  can be overridden in the CLI with -unique or -nounique
- changed search order to look for 'conf' file in current dictory, then that
  where the binary is located and finally /etc
- if you run collectl on lustre server nodes with -L to force node type(s) you 
  could end up with columns that contain only 0s if that type of service not
  running and colplot then generates empty plots.  colplotlib has been modified to
  ignore such plots
- installation now supports standard redhat/suse apache configurations
- for hosts in a cluster that end in a variable width numeric, ensure they
  collate in the correct order
- wan't picking up -ylog in command line mode

4.0.0	December 15, 2006
- major rewrite/simplification of plotting routines via new library 
  'colplotlib.ph'
- added new summary/detail plots 'All Plots'
- added some new plot definitions as well as macros
- combined 3 lustre plots into 1 as colplot does the right thing
- changed user-defined plotting mechanism
- replaced sample files with different ones

3.4.0
- wasn't handling mulitple axis correctly
- added new switch -unique, which if specified will cause files generated
  with -ou (unique) by collectl to be plotted; otherwise they will be skipped
- saving output as mulitple png files was producing 0 length png files for all
  but first plot!  added '$pngFlag' to simplify processing

3.3.9
- created new directory structure for colplot putting colplot in
  /opt/hp/collectl/utils/colplot and initParams.ph in 
  /opt/hp/collectl/utils/lib
- changed default memory plot to mem26 format and renames mem to mem24.

3.3.8
- changed labels for memory plot to MB from KB in initParams.cfg

3.3.7
- added support for interconnect detail plots
- cleaned up the processing for mixing custom/non-custom plots which was buggy
- was not printing plots-by-name in the right order for web-based help

3.3.6
- had renamed interconnect plot to 'intmb' in initParams.cfg and forgot to change
  it in colplot.pl

3.3.5
- allow for plot files generated with -ou switch (they contain TIME as well
  as DATE)

3.3.4
- updated initParams.cfg to add NICE to cpu plots

3.3.3
- support for new lustre suboptions
- removed extra <p> after header that was generating unnecessary whitespace
- exit when no plots selected
- removed unused subroutine selectionClean()
- changed defaults for disk, network, lustre and interconnect to only show 
  data raates

3.3.2
- updates/bugfixes in support of changes to initParams for lustre -O flags

3.3
- LOTS of changes to initParams to support 'subopts' in lustre plots
- fixed a bug in initParams for checking LusType field for custom lustre plots
- added ability to use ranges in column specifications
- added debug value of 64 to initParams, added debug 32 to colplot
3.2.3
- support for dealing with variable width lustre client data (-OM, -OR)
  This involved changes to initParams.cfg and initParams.ph too
  however this is NOT current support for generating plots associted with that data
3.2.2
- support for normal/live menus
- change number lustre client variables from 16 to 12 (this was a bug)
- infiniband support
- make sure 'wait' is included in all the cpu plots
3.2.1
- initParams.cfg changes
  - cpu plot had Wait and Sys reversed
  - disk data in diskMB not being divided by 1024
  - wrong length for 'clt' data
- if gs not defined or is but doesn't exist, do not include 'pdf' as an output type
- logic for validating file types should only include lustre type when lustre
  subsystem has indeed been selected, before calling getext()
- commented out some diagnostic print statements
3.2.0
- support for table format for html pages
- updated path listed in genplotfiles man page
- change way path determined by using readlink [thanks fred]
3.1.0
- allow gnuplot to return version name with both upper/lower v's in 'version'
- removed some -config debugging code that got left in
- only require GS when producing pdf files
- '-dir .' was NOT using the right directory.  had to remove 'chdir' and pass working
  directory to paramsInit in selection hash.

3.0.0 - Oct 10, 2005
- major release, too many changes to list

