TPTP feature: 156527

Author: Eugene Chan
Alex Nan
email: ewchan@ca.ibm.com
apnan@ca.ibm.com
Last updated:

Rough workload estimate in person weeks: 4.26PW
Process Sizing Names of people doing the work
Design 3PD Eugene Chan, Alex Nan
Code 14PD
Test 2PD
Documentation 2PD
Build and infrastructure 0.3PD Build team
Code review & other committer work
(e.g. check-in, contribution tracking)
if this is to be contributed by someone who
is not a committer in the component
- N/A - will be done by committer
Total Estimate 21.3PD (4.26PW)

Requirement summary

  1. Provide a way to contribute import and export actions to the Log Navigator context menu. Group actions in cascading menus.
    Third parties should be able to register their own import and export log wizards corresponding to specific import log methods.[1.5 PD]
  2. Reorganize the Eclipse import and export wizard Profiling and Logging category. Provide two subcategories for import and export logs. [0.5 PD]
  3. Enhance the current communication mechanism between the import log wizard and a custom control to provide host information and enable/disable the import log wizard host selection tab based on the custom control input. [5 PD]
  4. Enhance the log import wizard to support multi host log file elements in custom control. [3 PD]
  5. Enhance the log import wizard framework to support agent-less log import from remote machine, i.e. a remote import that doesn’t use the Agent Controller communication framework. The actual import job is done locally but log file is displayed as remote log file under a ‘virtual’ remote host in Log Navigator. For example the current ftp and http import scenarios fall into this category. [3 PD]
  6. Change both Symptom 0.1 and Symptom 2.0 Import Catalog wizards and capture the source location from where the catalog was imported. Local imports should capture a local file URL and remote imports should capture a URL to the remote host. Also change both Symptom 0.1 and Symptom 2.0 New Catalog wizards to capture the location of the created symptom catalog. [1 PD]

User interactions

Use case 1: (Requirement 1)

  1. In Log Navigator view, user right-clicks and selects ‘Import’ > ‘Log File’, then he selects which import method he wants to use, the corresponding Import Log File wizard is shown.
  2. User clicks finishes the wizard and the import log job starts.

Use case 2: (Requirement 3, 4, 5)

  1. In Add Log File dialog, user selects a third party log type which resolves log files information of multiple hosts for user automatically. Host tab of Add Log File dialog will be disabled from user selection.
  2. User selects OK to close Add Log File dialog, new log file entries of different hosts are added in log file table, user clicks Finish and import log jobs starts.
  3. Third-party extension will transfer resolved files from remote machines to localhost, and import jobs will import the logs locally and displays them under the hostnames they are transferred from.

Design summary

  1. Reorganize the Log Navigator context menu with cascaded group for Import and Export actions. Register the Log Navigator view for external action contribution.
  2. Create new org.eclipse.ui.importWizards categories for Import and Export wizard for log type actions under existing category org.eclipse.tptp.platform.category.trace.import.
  3. Consumers would need to provide host information to each life line in a string having the format “lifeline1:host1;lifeline2:host2” and the import log will process the returned custom control input so that each life line maps to it’s own host.
  4. Add a virtualHost property to the log file element that will be used to create the host model resource in the workspace. The old host property will still be used to distinguish between local log imports and remote imports executed using the Agent Controller. In the import from ftp, http URLs case, the host will be set to “local” and the virtualHost will be set to the corresponding host found in the URL.
  5. Change the Import Symptom Catalog wizards to set the URL property of the symptom catalog to be the URL of the source file. Change the New Symptom Catalog wizards to set the URL property of the new catalog to a file URL representing the absolute path of the catalog on the local file system.