{section: Module Description} -This is a resource viewer. +HTCondor View is used to automatically generate +World Wide Web (WWW) pages displaying usage statistics of your HTCondor +Pool. Included in the module is a shell script that invokes the +condor_stats command to retrieve pool usage statistics from the +HTCondor View server and generate HTML pages from the results. {section: Download} {link:ftp://ftp.cs.wisc.edu/condor/contrib/view_client-2.1-Any-Java.tar.Z view_client-2.1} @@ -10,49 +14,44 @@ {section: Information and Installation} -The Condor View Client Contrib Module is used to automatically generate -World Wide Web (WWW) pages displaying usage statistics of your Condor +The HTCondor View Client Contrib Module is used to automatically generate +World Wide Web (WWW) pages displaying usage statistics of your HTCondor Pool. Included in the module is a shell script that invokes the condor_stats command to retrieve pool usage statistics from the -Condor View server and generate HTML pages from the results. Also -included is a Java applet that graphically visualizes Condor usage +HTCondor View server and generate HTML pages from the results. Also +included is a Java applet that graphically visualizes HTCondor usage information. Users can interact with the applet to customize the visualization, or to zoom-in to a specific time frame. -After unpacking and installing the Condor View Client, a script named -"make_stats" can be invoked to create HTML pages displaying Condor usage +After unpacking and installing the HTCondor View Client, a script named +"make_stats" can be invoked to create HTML pages displaying HTCondor usage for the past hour, day, week, or month. By using the Unix cron facility -to periodically execute make_stats, Condor pool usage statistics can be -kept up to date automatically. This simple model allows the Condor View +to periodically execute make_stats, HTCondor pool usage statistics can be +kept up to date automatically. This simple model allows the HTCondor View Client to be installed easily; no Web server CGI interface is needed. -*** To install the Condor View Client: +*** To install the HTCondor View Client: 1. First, make certain that you have configured your pool's condor_collector (typically running on the central manager) to log information to disk in order to provide a persistent, historical -database of pool statistics. The Condor View client makes queries over -the network against this database. The condor_collector included with -version 6.0.x of Condor does not have this database support; you will -need to download and install the Condor View Server contrib module. If -you are running Condor version 6.1 or above, there is no need to install -the CondorView Server contrib module because the condor_collector -included in Condor v6.1+ already has the necessary database support. To +database of pool statistics. The HTCondor View client makes queries over +the network against this database. To activate the persistent database logging, add the following entries into the condor_config files on your central manager: POOL_HISTORY_DIR = /full/path/to/directory/to/store/historical/data KEEP_POOL_HISTORY = True -For full details, see the Condor Version Administrator's Manual, in +For full details, see the HTCondor Manual, in the section "condor_collector Config File Entries". -2. Create a directory where you would like Condor View to create the HTML +2. Create a directory where you would like HTCondor View to create the HTML files. This directory should be one published by a web server, so that HTML files which exist in this directory can be accessed via a web browser. We will refer to this directory as the VIEWDIR directory. -3. Unpack/untar the Condor View Client contrib module file "view_client.tgz" +3. Unpack/untar the HTCondor View Client contrib module file "view_client.tgz" into the VIEWDIR. This will create several files and subdirectories in the VIEWDIR. @@ -69,12 +68,12 @@ at the bottom of the web pages. *: VIEWDIR : Set VIEWDIR to the full pathname (_not_ a relative path) - to the VIEWDIR directory you selected in installation step #2 + to the VIEWDIR directory you selected in installation step 2 above. It is the same directory where the make_stats file lives. *: STATSDIR : Set STATSDIR to be the full pathname to the _directory_ which contains the condor_stats binary. The condor_stats program - is included in the bin directory with Condor version 6.1 and + is included in the bin directory with HTCondor version 6.1 and above. The value for STATSDIR is added to the PATH parameter by default; see below. @@ -98,13 +97,13 @@ day" once an hour, "make_stats week" twice per day, and "make_stats month" once per day. These are reasonable defaults. You can add these commands to cron on any system that can access to the VIEWDIR and -STATSDIR, even on a system that does not have Condor installed. The +STATSDIR, even on a system that does not have HTCondor installed. The commands do not have to run as user root either; in fact, they should probably not run as root. These commands can run as any user that has read/write access to the VIEWDIR. To add these commands to cron, enter: crontab cronentries -7. If you have one or more checkpoint servers, you can use Condor View +7. If you have one or more checkpoint servers, you can use HTCondor View to display statistics about them. For instructions, see the INSTALL file in the "ckptserver" subdirectory.