|Table of Contents|
The UI allows the user to view and control jobs that have been submitted to the Tractor queue. It also provides information about the tractor-blades that have connected to the engine.
To start a Dashboard session, direct your web browser to http://tractor-engine/tractor/dashboard or, if you have chosen other hostnames or ports to http: //your_engine_host:your_engine_port/tractor/dashboard.
Although the Tractor Dashboard is accessed like a simple web page, it is a full-blown application and, as such, it will consume a non-trivial amount of memory, especially in sophisticated pipelines where data might be large.
If this is the first time you've connected to the Dashboard, you may be required to log in. Currently any username that is valid on the engine's host is acceptable. Once logged in, the Job List pane will display jobs for that user. A cookie will be stored in your browser that will allow you to connect without the login in future sessions.
The Main Display
When the Dashboard first runs, it comes up in Jobs mode. This can also be activated by clicking the button that looks like a small 4-task job graph in the top toolbar. In this mode there are four primary panes:
Job List PaneThe upper left pane is the Joblist pane. All jobs which satisfy the user type-in field are displayed int his pane. Clicking on any job will cause information to be displayed in two other panes.
Job Info PaneThe lower left panel is the Job Info pane, and contains information from the engine which describes the selected job.
Task Graph PaneThe upper right panel is the Task Graph pane. It can display the selected job as a graph or as a list. The display mode can be changed by clicking the associated icon at the top of the pane.
Task Info PaneWhen a node in the Task Graph pane is selected, information pertaining to that specific task and its current command will be displayed in the task info pane. This pane is in the same location as the Job Info Pane, and display reverts to showing job-related information when a new job has been selected.
Clicking on the Blades button, represented by a stack of three servers, puts the Dashboard in Blades mode. In this mode there are four panes:
Blade List PaneThe upper left pane is the Blade List pane. A list of all blade servers and summary information will be displayed here.
Blade Activity PaneThe upper right pane is the Blade Activity pane. Each blade is represented as a square and is colored according to its status.
Server Info PaneWhen a specific server is selected in the Blade List pane, information about that server is displayed in the lower left pane.
Assignment Tracer PaneWhen an Assignment Tracer has been actived from the context menu, the tracer output for the selected blade is displayed in the lower right pane.
Clicking on the Query button (the magnifying glass over the list) in the upper left will put the Dashboard in Query mode. This is a simple, yet powerful page for interactively searching for tractor entities. See the Query Pane page for details.
Clicking on the Graph button will display graphs of system metrics, which are helpful to know the size of the work queue, farm resource utilization, and engine performance. It also displays the donut charts which visualize the utilization of resources managed by adaptive farm allocations.
Clicking on the Gears button displays an administrative section where engine logs can be inspected, system reconfiguration can be triggered, dispatching can be paused, and limit counts and user connectivity can be observed.
Clicking on the Book button will cause the documentation to appear in a new browser tab or window.
Lastly, clicking on the Tractor button will display various details regarding the system, such as the engine build, dispatching mode, and license count.