Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Overview

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:

http: //your_engine_host:your_engine_port/tractor/dashboard
Image RemovedImage Added
  • Important

    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.

    It's also worth noting that browsers perform differently when executing javascript. Safari and Google Chrome have been the strongest performers in our testing. Firefox works very well, but is a bit slower. We suggest that you test different browsers when running the Tractor UI.

...

Login Panel

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.

...

Toolbar

Image RemovedImage Added

The Tractor Dashboard toolbar spans the top of the browser window and contains the following regions.

  • Page Icons

    There are seven icons which are used to switch to different pages in the dashboard. From left to right they are "About Tractor", "Job List", "Blade List", "Metrics", "Administration", and "Documentation".

  • Reloading Job or Blade List

    The job and blade lists are automatically refreshed at an interval defined in the user's preferences; by default this interval is 60 seconds. Additionally, the job list data is updated in real-time through messages that are sent to the Dashboard from the Engine. If a user wishes to get the most up-to-date information, the job list and blade list icons can be reselected to force a new refresh of their respective lists. Given the real-tlme nature of job updates from the engine, a manual refresh is more likely to be useful for updating the blade list; however, a congested network or an Engine under heavy load may result in some updates not reaching the Dashboard, and as such a manual refresh can be useful.

  • Message Area

    Messages of general importance like "Dispatching Paused" will be displayed in the area in the middle of the toolbar.

  • The Filter Pulldown

    You can define filters that limit or filter the amount of information that is shown in the job or blade lists. More information on filters can be found in the Filter Editor reference

  • Pattern Matcher

    The pattern matcher is a type-in field that is used as a selector to filter which items are visible in the job or blade lists. The pattern match field will be compared against the owner and title attributes in the job list, and the host and profile attributesin the blade list. Note, unlike filters this operation is performed in the browser and simply limits the number of items displayed. Filters are applied by the Engine, and limit the number of jobs or blades sent to the Dashboard from the Engine.

  • User Name

    The name of the currently logged in user is shown on the far right. Clicking on the user name will present a drop down menu to navigate to user preferences or to log out.

...