ST-Perf Installation and getting started:

Unfortunately the installation cannot be limited to the ST-Perf module, since ST-Perf is based on Python and the TK Toolkit. As a result the first step is always to ensure that the necessary environment exists.

1. Installation of the Python interpreter on:
   1. Linux
   2. Solaris
2. Installation of additional Python modules
3. NetWorker special features
4. Installation of ST-Perf
5. Getting started
6. FAQ

1. Installation of the Python interpreter

   1. Installation on Linux

      1. Requirements on operating system

         We require a Linux distribution equivalent to SuSE V. 7.3 or higher. The crucial element here, however, is not the actual distribution itself but which version of the Python interpreter it uses. All SuSE versions from 7.3 upwards are supported and tested by us, with the Python packages listed below. But we presume that the package will also run on other Linux versions with a Python interpreter equivalent to version 2.2.1 or higher.

      2. Python 2.2.1 or higher

         For a SuSE-Linux installation, any version from V.8.1 upwards is appropriate. Then you only have to check that the Python package and the additional Tix and Tkinter packages are installed. If they are not, you are advised to install both Python and Tkinter packages with Yast.
         For the installation of the Python packages you will need the Gnu MP Library (gmp), which is contained in the distributions.
         
         Should you be using a different Linux distribution which does not contain the Python packages, you can download them from the Python.org website. The packages Tix and Tkinterm, which are also required, can be found in your Linux distribution or:
         1. Tix: from tix.sourceforge.net.
         2. Tkinter: from Python.org.

   2. Installation on Solaris

      ST-Perf is supported by the Solaris 8 version of the operating system and upwards.
      
      The installation of the Python interpreter on Solaris along with the other required packages is unfortunately somewhat more extensive, since the Python interpreter and other required packages are not installed by default on Solaris systems. The packages, however, are all available from the website http://www.sunfreeware.com/.
      
      Specifically, the following packages must be installed:
      • python-2.6.2-sol26-sparc-local.gz Python interpreter (Sunfreeware)
      • libgcc-3.3.pkg.gz libgcc Bibliothek required by Python (Sunfreeware)
      • tcl-853.pkg.gz TCL package (Sunfreeware)
      • tk853.pkg.gz TK package (Sunfreeware)
      • tix-8.1.4.tar.gz Source Code (sourceforge.net)
      
      
      All packages are installed with the command "pkgadd -d `pwd`/<filename> in the directory /usr/local. It is not possible to influence this.

2. Installation of additional Python modules:

   Various functions of ST-Perf require two other Python modules that are not installed with the Python interpreter. Thus the next step is to install these modules. This follows the same procedure for both Linux and Solaris.

   1. Pmw

      Pmw1.2 can be found at pmw.sourceforge.net. For the installation of Pmw (Python Mega Widgets) please proceed as follows:
      1. Download file Pmw.1.2.tar.gz
      2. Unzip the file using the command
         tar zxvf Pmw.1.2.tar.gz
      3. This creates a directory with the name PMW. You now simply have to move this directory into the directory /usr/lib/python2.?/site-packages (linux) bzw /usr/local/lib/python2.3.3/site-packages (solaris), using:
         mv Pmw /usr/lib/python2.2/site-packages
         or
         mv Pmw /usr/lib/python2.3/site-packages
         depending on which Python version is installed on your computer.

   2. pexpect

      pexpect can be obtained from pexpect.sourceforge.net
      The installation of pexpect is as easy as it goes:
      1. Download file pexpect-current.tgz
      2. Unzip the file using the command tar zxvf pexpect-current.tgz
      3. Copy the file pexpect.py to /usr/lib/python2.?/site-packages or /usr/local/lib/python2.?/site-packages.
         cd pexpect-0.99
         mv pexpect.py /usr/lib/python2.?/site-packages

3. NetWorker special features

   1. NetWorker Server

      In principle there are no restrictions on the NetWorker server.

      1. Platform

         The NetWorker server can run on all platforms.

      2. Versionof the NetWorker server

         ST-Perf supports all NetWorker versions from 6.0 upwards, whether the server is an original EMC NetWorker server, the Fujitsu-Siemens OEM product, or a SUN.

      3. Dynamic device distribution (im SAN SRS/DDS)

         At the moment only the SAN solution of the Fujitsu NetWorker (SRS) is supported. A support of the EMC DDS solution is in preparation.

   2. Networker client

      In order to record the data, ST-Perf requires a NetWorker client to be residing on the same machine. To record the data of non-shared SAN drives you will require a NetWorker client (Fujitsu or EMC) from version 6.0 upwards.
      
      For SRS support an Fujitsu NetWorker client must be installed. Here, however, in addition to the client software, the Fujitsu-specific command nsrsrscmd is needed. The nsrsrscmd is part of the Fujitsu NetWorker server package.

   3. Particular features

      In order to obtain an accurate output of the sessions active at any given time, the system times of the NetWorker server and that of the recording machine must be synchronized. More detailed information on time synchronization can be found, for example, on page ntp.1 of the user manual.

4. ST-Perf installation

   1. The installation must be carried out as 'root'.
   2. The conditions listed under points 1-3 must have been fulfilled prior to the installation.
   3. ST-Perf installs an executable program module and a directory structure for the configuration, the data collection and logging. Both directories are permanently preset in the RPM package. If you prefer different paths from the ones named below, it is a good idea to create the given directories as symbolic links to your desired directories before starting the installation process.
      1. The default installation path for the executable programs is '/opt/nsr/st-perf'. In this directory the subdirectories bin, lib2.2, lib2.3 and lib are created. lib is a symbolic link either to lib2.2 or lib2.3., depending on which Python version is found during the installation. If you change the version of Python subsequent to the st-perf installation, this link must also be changed.
      2. The runtime data, the configuration, and the logging are all saved to the directory '/nsr/st-perf/. The sub-directories data, logs and config are created in this directory.
         • The data directory is used for the recorded performance data of the individual devices. A sub-directory is created here at the start of every recording, with the name and start time of the recording in its title. st-perf checks the number of existing recordings.
         • The logs directory is used to store the logfiles of the st-perf programs. These are needed for debugging purposes and in case of errors should be forwarded to the Schäfer & Tobies Software and Consulting.
         • The config directory is used to save the configuration. The file created in the process (conf_perf) may only be altered with one of the supplied programs config or xconfig, since otherwise a flawless functioning of the programs cannot be guaranteed.
   4. The actual installation of ST-Perf is launched with the command
      LINUX: rpm -i[vh] st-perf.<build>.rpm
      SOLARIS: pkgadd -d st-perf_<build>.pkg
      These commands cause the directories described above to be created if they do not yet exist.

5. Getting started

   In the directory /opt/nsr/st-perf/bin you will find the following 4 commands:
   1. xconfig
      This program is used in the graphical configuration of the performance tool. Here you can first of all select the NetWorker servers that are to be monitored. For each NetWorker server you can mark the devices you wish to monitor and, if required, assign colors to them. You can start a one-time recording (st-perf generates an at job), or have it start daily at a specified time (in this case st-perf generates an entry in the crontab).
      
      Should you require, you can also define an SRS server and the associated devices whose data that you wish to record.
   2. config
      The CLI command to configure the recording. With this command you can interactively carry out all settings for the recording described above, excluding the assignment of colors and the automatic start of the recording.
   3. record
      The program for recording performance data. First of all, record reads the configuration. If a single NetWorker server is configured, the program begins immediately with the recording. Next a new subdirectory is generated in the directory /nsr/st-perf/data/ with the current date of the recording in its title. In each subdirectory a file is generated for each configured device, containing the performance figures of the device for the duration of the recording..
      
      If you have configured more than one NetWorker server, record asks you interactively which server's data you wish to record. If you want to start the recording without any interaction, you can specify the server by stating the name of the server as an argument.
      
      record <NetWorker Servername>
      
      If multiple NetWorker servers have been configured, the recording directories are not created directly under /nsr/st-perf/data. In this case for each server record creates a subdirectory, in which the subdirectories of the current recordings are then generated..
   4. st-perf
      The program st-perf displays the recorded performance data of your devices in graphical form. You can specify which devices are displayed either in the graphical interface via the menu item Load, or by stating the file names as arguments in the program. The required files can be found in the directory /nsr/st-perf/data/<DATE>. Within these directories there is one file for each device, in which the performance data of the device is logged.
      
      For more detailed information please refer to the user manual.

6. FAQ (tips and tricks)

   1. Error message: 'LookupError: unknown encoding: CHARSET'
      This error message indicated an unknown CHARSET. The problem is a familiar one with older SuSE versions and is caused when the chosen language environment is not present as a CHARSET.
      One can avoid the problem by setting the LANG variable before giving the command to launch st-perf.
      Example: LANG=C /opt/nsr/st-perf/bin/xconfig
   2. In order to obtain an accurate output of the sessions active at any given time, the system times of the NetWorker server and that of the recording machine must be synchronized. More detailed information on time synchronization can be found, for example, on page ntp.1 of the user manual.