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

[davidk at ci.uchicago.edu]

Author: davidk
Date: 2014-04-25 16:11:25 -0500 (Fri, 25 Apr 2014)
New Revision: 7803

Added:
   trunk/docs/userguide/HTTP-monitor.jpg
   trunk/docs/userguide/Swing-monitor.jpg
   trunk/docs/userguide/TUI-monitor.jpg
Removed:
   trunk/docs/userguide/swift_monitor.png
Modified:
   trunk/docs/userguide/configuration
   trunk/docs/userguide/debugging
Log:
Userguide updates for the various monitors


Added: trunk/docs/userguide/HTTP-monitor.jpg
===================================================================
(Binary files differ)


Property changes on: trunk/docs/userguide/HTTP-monitor.jpg
___________________________________________________________________
Added: svn:mime-type
   + application/octet-stream

Added: trunk/docs/userguide/Swing-monitor.jpg
===================================================================
(Binary files differ)


Property changes on: trunk/docs/userguide/Swing-monitor.jpg
___________________________________________________________________
Added: svn:mime-type
   + application/octet-stream

Added: trunk/docs/userguide/TUI-monitor.jpg
===================================================================
(Binary files differ)


Property changes on: trunk/docs/userguide/TUI-monitor.jpg
___________________________________________________________________
Added: svn:mime-type
   + application/octet-stream

Modified: trunk/docs/userguide/configuration
===================================================================
--- trunk/docs/userguide/configuration	2014-04-25 03:05:59 UTC (rev 7802)
+++ trunk/docs/userguide/configuration	2014-04-25 21:11:25 UTC (rev 7803)
@@ -397,6 +397,13 @@
  information enabling this will increase the size of log files,
  sometimes significantly.
 
+|provider.staging.pin.swiftfiles
+|true, false
+|false
+|When provider staging is enabled and provider.staging.pin.swiftfiles
+|is set, cache some small files needed by Swift to avoid the cost
+|of staging more than once.
+
 |sitedir.keep
 |true, false
 |false
@@ -497,6 +504,15 @@
 |Progress:
 |String to prepend to ticker output
 
+|tracing.enabled
+|true, false
+|true
+|Enables tracing of procedure invocations, assignments,
+ iteration constructs, as well as certain dataflow events
+ such as data intialization and waiting. This is done at 
+ a slight decrease in performance. Traces will be available
+ in the log file.
+
 |use.wrapper.staging
 |true, false
 |false

Modified: trunk/docs/userguide/debugging
===================================================================
--- trunk/docs/userguide/debugging	2014-04-25 03:05:59 UTC (rev 7802)
+++ trunk/docs/userguide/debugging	2014-04-25 21:11:25 UTC (rev 7803)
@@ -71,29 +71,52 @@
 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 runs can be monitored for progress and resource usage. There are three basic monitors available: Swing, TUI, and http.
 
-----
-swift -tc.file tc -sites.file sites.xml -config cf modis04.swift -monitor
-----
+HTTP Monitor
+^^^^^^^^^^^^
+The HTTP monitor will allow for the monitoring of Swift via a web browser. To start the HTTP monitor, run Swift with the +-ui http:<port>+
+command line option. For example:
 
-This will produce a gui/X window consisting of the following quantities:
+-----
+swift -ui http:8000 modis.swift
+-----
+image:HTTP-monitor.jpg[]
 
-* Allocated memory
-* Heap Size
-* Total Threads
-* Total Workers
+This will create a server running on port 8000 on the machine where Swift is running. Point your web browser to http://<ip_address>:8000 to view
+progress.
 
-.Figure 4. Resource Monitor
-image:swift_monitor.png[]
 
-Figure 4 shows a snapshot of a Swift resource monitor.
+Swing Monitor
+^^^^^^^^^^^^^
 
-The progress of a Swift run can be monitored using the +-tui+ option. For example:
+The Swing monitor displays information via a Java gui/X window. To start the Swing monitor, run Swift with the
++-ui Swing+ command line option. For example:
 
+-----
+swift -ui Swing modis.swift
+-----
+image:Swing-monitor.jpg[]
+
+This will produce a gui/X window consisting of the following tabs:
+
+* Summary
+* Graphs
+* Applications
+* Tasks
+* Gantt Chart
+
+TUI Monitor
+^^^^^^^^^^^
+The TUI (textual user interface) monitor is one option for monitoring Swift on the console using a curses-like
+library.
+
+The progress of a Swift run can be monitored using the +-ui TUI+ option. For example:
+
 ----
-swift -tc.file tc -sites.file sites.xml -config cf modis04.swift -tui
+swift -ui TUI modis.swift
 ----
+image:TUI-monitor.jpg[]
 
 This will produce a textual user interface with multiple tabs, each showing the following features of the current Swift run:
 
@@ -102,7 +125,7 @@
 * A jobs tab 
 * A transfer tab 
 * A scheduler tab 
-* A Tast statistics tab 
+* A Task statistics tab 
 * A customized tab called 'Ben's View'
 
 Navigation between these tabs can be done using the function keys f2 through f8. 

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