[Swift-commit] r6329 - trunk/docs/userguide

[ketan at ci.uchicago.edu]

Author: ketan
Date: 2013-03-04 21:25:51 -0600 (Mon, 04 Mar 2013)
New Revision: 6329

Added:
   trunk/docs/userguide/swift_monitor.png
Modified:
   trunk/docs/userguide/configuration_properties
Log:
formatting, tui and monitor

Modified: trunk/docs/userguide/configuration_properties
===================================================================
--- trunk/docs/userguide/configuration_properties	2013-03-04 05:53:21 UTC (rev 6328)
+++ trunk/docs/userguide/configuration_properties	2013-03-05 03:25:51 UTC (rev 6329)
@@ -1,17 +1,16 @@
 Swift configuration properties
 ------------------------------
-Various aspects of the behavior of the Swift Engine can be configured
-through properties. The Swift Engine recognizes a global, per
-installation properties file which can found in etc/swift.properties
-in the Swift installation directory and a user properties file which can
-be created by each user in ~/.swift/swift.properties. The Swift Engine
-will first load the global properties file. It will then try to load the
-user properties file. If a user properties file is found, individual
-properties explicitly set in that file will override the respective
-properties in the global properties file. Furthermore, some of the
-properties can be overridden directly using command line arguments to
-the *swift* command.
+Various aspects of the behavior of Swift can be configured through properties.
+Swift recognizes a global, per installation properties file which can found in
+etc/swift.properties in the Swift installation directory and a user properties
+file which can be created by each user in ~/.swift/swift.properties.
 
+Swift will first load the global properties file. It will then try to load the
+user properties file. If a user properties file is found, individual properties
+explicitly set in that file will override the respective properties in the
+global properties file. Furthermore, some of the properties can be overridden
+directly using command line arguments to the *swift* command.
+
 Swift properties are specified in the following format:
 
 <name>=<value>
@@ -452,3 +451,43 @@
 ip.address=192.168.0.1
 ----
 
+Monitoring Swift
+~~~~~~~~~~~~~~~~
+
+A Swift run can be monitored for progress and resource usage. To monitor the resource usage, use the +-monitor+ option with the Swift commandline. For example:
+
+----
+swift -tc.file tc -sites.file sites.xml -config cf modis04.swift -monitor
+----
+
+This will produce a gui/X window consisting of the following quantities:
+
+* Allocated memory
+* Heap Size
+* Total Threads
+* Total Workers
+
+.Figure 4. Resource Monitor
+image:swift_monitor.png[]
+
+Figure 4 shows a snapshot of a Swift resource monitor.
+
+
+The progress of a Swift run can be monitored using the +-tui+ option. For example:
+
+----
+swift -tc.file tc -sites.file sites.xml -config cf modis04.swift -tui
+----
+
+This will produce a textual user interface with multiple tabs, each showing the following features of the current Swift run:
+
+* A summary view showing task status
+* An apps tab
+* A jobs tab
+* A transfer tab
+* A scheduler tab
+* A Tast statistics tab
+* A customized tab called 'Ben's View'
+
+Navigation between these tabs can be done using the function keys f2 through f8.
+

Added: trunk/docs/userguide/swift_monitor.png
===================================================================
(Binary files differ)


Property changes on: trunk/docs/userguide/swift_monitor.png
___________________________________________________________________
Added: svn:mime-type
   + application/octet-stream