QSPI V1.1 for OpenVMS Release Notes December 12, 2006 © Copyright 2005-2006 Quadratrix gcv, Zwijndrecht, Belgium All rights reserved. Introduction ------------ QSPI is a set of tools to capture and display system performance information. The QSPI facility consists of 3 major parts: - the data collector - the presentation tool - the control program Directory Structure ------------------- The following depicts the directory structure needed by QSPI, after a default installation. Directory SYS$SYSDEVICE:[QSPI] CGI.DIR;1 DATA.DIR;1 EXE.DIR;1 LOG.DIR;1 WEB.DIR;1 Total of 5 files. Directory SYS$SYSDEVICE:[QSPI.CGI] QSPICGI.COM;1 QSPI_OSU.CONF;1 QSPI_OSU.CONF_TEMPLATE;1 QSPI_SWS.CONF;1 QSPI_SWS.CONF_TEMPLATE;1 QSPI_WASD.CONF;1 QSPI_WASD.CONF_TEMPLATE;1 Total of 7 files. Directory SYS$SYSDEVICE:[QSPI.EXE] QSPI.CLD;1 QSPI.HLB;1 QSPIDC_SSTARTUP.COM;1 QSPIDC_STARTUP.COM;1 QSPI_C.EXE;1 QSPI_DC.EXE;1 QSPI_LOGICALS.COM;1 QSPI_PT.EXE;1 QSPI_SYLOGICALS.COM;1 QSPI_SYLOGICALS.COM_TEMPLATE;1 Total of 10 files. Grand total of 3 directories, 22 files. Logical Names ------------- QSPI expects to have the following logical names defined: LNM$QSPI system-wide logical name indicating the logical name table used by QSPI QSPI$ROOT rooted directory, something like DISK1:[QSPI.] QSPI$CGI directory where the CGI scripts reside (e.g.: DISK1:[QSPI.CGI]) QSPI$DATA directory where the data collector puts its data files (collections); and where the presentation tool searches for data (e.g.: DISK1:[QSPI.DATA]) QSPI$EXE directory where the programs, command procedures, etc. reside (e.g.: DISK1:[QSPI.EXE]) QSPI$GRAPH directory where the presentation tool puts the generated images (.PNG files) (e.g.: DISK1:[QSPI.WEB]) QSPI$LOG log directory (e.g.: DISK1:[QSPI.LOG]) QSPI$WEB path for webserver to QSPI$GRAPH (e.g.: "/qspiweb/") The Data Collector ------------------ The data collector is normally started using QSPIDC_STARTUP.COM. Note that this command procedure expects to find the SYS$BATCH queue, since it wants to submit the procedure QSPIDC_SSTARTUP.COM. The data collector normally runs in a detached process with username QSPI$DC and UIC [400,400]. In the procedure QSPIDC_SSTARTUP.COM, a default invocation of the data is coded ( QSPI/COLLECT/MODES/STATES ). This invocation can be modified to better suit the needs. Please consult the help library for additional qualifiers to the QSPI/COLLECT command. ( HELP/LIBRARY=the$disk:[the.path]QSPI.HLB ) By default the data collector gathers performance data into files in the QSPI$DATA directory. At midnight a new collection file is created. See also the QSPI/RENEW command. The Presentation Tool --------------------- The presentation tool can be started from the DCL command line, using the QSPI command. See the help library for more information. ( HELP/LIBRARY=the$disk:[the.path]QSPI.HLB ) The Control Program ------------------- The control program is used to signal an active data collector: - to start a new data collection file ( QSPI/RENEW ) - to start tracing ( QSPI/TRACE ) - to stop ( QSPI/STOP ) Web Interface ------------- The QSPICGI.COM provides a web interface to the presentation tool. During installation, three (3) configuration files are put in place, one for the SWS webserver, one for the OSU webserver, and one for the WASD webserver. The appropriate configuration file can be incorporated in the various configuration files of the webserver, if so desired. Provided a webserver is in use, and (the contents of) the appropriate configuration file (QSPI_OSU.CONF, QSPI_SWS.CONF, or QSPI_WASD.CONF) is integrated with the webserver's configuration file(s), the web interface to QSPI is activated by specifying the following URL in the webbrowser: http://server.domain/qspi/qspicgi If the script (QSPICGI.COM) finds data collection files, it presents a list of nodes for which data is collected. Once a node is selected, the user is presented with a screen from which various performance data for the node can be selected, together with a time interval. Once the choices are made, the script will invoke the presentation tool and will present in the browser either a list with numeric data, or a graphic presentation of the data. Known Problems and Restrictions in Version 1.0 ---------------------------------------------- The presentation tool does not present data regarding processes (/PROCESSES qualifier) nor cluster member related information (/SCS qualifier) in graphic format (/GRAPH qualifier). Performance data regarding storage devices (disks) can neither be collected nor presented. Known Problems and Restrictions in Version 1.1 ---------------------------------------------- See Version 1.0 (except for disks). If QSPI runs on a node in a cluster, it is mandatory to restart the data collector once a node has joined the cluster. New Features in Version 1.1 --------------------------- Performance data regarding storage devices (disks) (/DISKS qualifier) can be collected but not presented in graphic format. New qualifiers: /HELP displays the contents of QSPI's help library /VERSION shows QSPI's version