Some Eclipse Foundation services are deprecated, or will be soon. Please ensure you've read this important communication.

Bug 172120

Summary: Improve error reporting when the JVMTI Profiler cannot be launched
Product: z_Archived Reporter: Asaf Yaffe <asaf.yaffe>
Component: TPTPAssignee: jkubasta
Status: CLOSED WONTFIX QA Contact:
Severity: normal    
Priority: P2 CC: analexee, guru.nagarajan, jkubasta, leo_welsch, te
Version: unspecifiedKeywords: plan
Target Milestone: ---   
Hardware: All   
OS: All   
Whiteboard: closed471

Description Asaf Yaffe CLA 2007-01-30 03:50:42 EST
When the JVMTI Profiler cannot be launched, the following generic message appears:
"The JVMTI agent org.eclipse.tptp.jvmti is not available. Make sure that the
agent's libraries are available and that it is configuered properly.". This message also have a "Details" button which opens an empty message pane.

The problem is that this error is meaningless for the end user. Error reporting should be improved to:
1. Provide more information on what went wrong (timeout issues with AC, unable to locate the JVMTI runtime libraries, a VM initialization error, etc).
2. Suggest a remediation if possible.  For example, if the JVMTI libraries are missing, show a message asking the user to verify that the JVMTI runtime libraries are properly installed in the <AC HOME>\plugins directory.
Comment 1 Guru Nagarajan CLA 2007-03-02 12:38:18 EST
This defect is needed to be addressed for IPF and X64 where no GA driver is available.
Comment 2 Guru Nagarajan CLA 2007-04-23 16:15:09 EDT
Ruslan - please take over this defect to add additional messages.
Comment 3 Ruslan Scherbakov CLA 2007-04-26 07:44:47 EDT
There are following texts reprorted on errors:

unable to locate the JVMTI runtime libraries (Agent is simply removed from AC plugin dir to reproduce on win32):
ERROR_TI_AGENT_UNAVAILABLE=
>>The JVMTI agent {0} is not available. Make sure that the libraries for the agent are available and that it is configured properly.<<

timeout issues with AC (when AC is not running):
ERROR_TI_AC_UNAVAILABLE=
>>Agent Controller is unavailable under port {0}.  Make sure that the service is started and the port number is correct under preferences.<<

for other errors, e.g. VM initialization error is related with ERROR_TI_AGENT_UNAVAILABLE -> agent is not available the VM initialization error occurs.

So we already have these two main errors for 'unavailable' AC and Agent causing the JVMTI Profiler fail to be launched.

What detailed text should be assigned for ERROR_TI_AGENT_UNAVAILABLE and ERROR_TI_AC_UNAVAILABLE messages?

Suggestion:

ERROR_TI_AGENT_UNAVAILABLE=
>>The JVMTI agent {0} is not available. Unable
to locate the JVMTI runtime libraries. Make sure that the libraries for the agent are properly installed in the <AC HOME>\plugins directory and that it is configured properly.<<

timeout issues with AC (when AC is not running):
// note: timout is equivalent to unavailability in this case
ERROR_TI_AC_UNAVAILABLE=<as is>
Comment 4 Leopold Welsch CLA 2007-04-26 09:09:11 EDT
My suggestion about the text would be:

Make sure that the libraries for the agent are available and that it is configured properly.

===>>

>>Make sure that the libraries for the
agent are properly installed in the <AC HOME>\plugins directory and that it is
configured properly.
<AC HOME> = [... path to the AC HOME-variable]<<

If the AC HOME is not set, then I would bring an extra message.

1) MYYY problem was that I misunderstood the <AC HOME> with the <ECLIPSE HOME> and should be little bit more clear in the Error-messages.
2) Using all the time the same string for the Error-message is OK as long as it is the content is clear for all types or messages. I personally do not understand the meaning of

'Make sure that the libraries for the agent are available' 

because from it, would NOT know WHAT to check resp. WHAT to 'make sure'. And if it is only a variable which should be set, then make this clear. IF something else is a prerequisit, then this should be in the Error-message as well.
Comment 5 Guru Nagarajan CLA 2007-05-10 08:57:15 EDT
Lets address this in i4
Comment 6 Guru Nagarajan CLA 2007-05-30 10:46:46 EDT
Alexander,
  This is assigned to you at this time. This is a candidate for deferral for 4.4+ given where we are in the cycle
Comment 7 Guru Nagarajan CLA 2007-09-07 01:00:41 EDT
Deferred to 4.5
Comment 8 Alexander N. Alexeev CLA 2008-04-01 07:30:07 EDT
Igor, please also take a look on messages related to user notification. They should not contain any internal IDs.
Comment 9 Alexander N. Alexeev CLA 2008-05-24 06:54:48 EDT
moved to future with PMC approval
Comment 10 Kathy Chan CLA 2009-02-23 13:40:21 EST
Mass update of P1 enhancements and defects targetted to future to P2.
Comment 11 Paul Slauenwhite CLA 2009-06-30 06:53:10 EDT
As of TPTP 4.6.0, TPTP is in maintenance mode and focusing on improving quality by resolving relevant defects and increasing test coverage through test creation, automation, Build Verification Tests (BVTs), and expanded run-time execution. Since this defect is more than 2 years old, it may be no longer relevant. As part of the TPTP Bugzilla housecleaning process (see http://wiki.eclipse.org/Bugzilla_Housecleaning_Processes), this defect is resolved as WONTFIX. If this defect is still relevant and reproducible in the latest TPTP release (http://www.eclipse.org/tptp/home/downloads/), please re-open.
Comment 12 Kathy Chan CLA 2010-11-18 18:48:30 EST
As of TPTP 4.6.0, TPTP is in maintenance mode and focusing on improving quality by resolving relevant enhancements/defects and increasing test coverage through test creation, automation, Build Verification Tests (BVTs), and expanded run-time execution. As part of the TPTP Bugzilla housecleaning process (see http://wiki.eclipse.org/Bugzilla_Housecleaning_Processes), this enhancement/defect is verified/closed by the Project Lead since this enhancement/defect has been resolved and unverified for more than 1 year and considered to be fixed. If this enhancement/defect is still unresolved and reproducible in the latest TPTP release (http://www.eclipse.org/tptp/home/downloads/), please re-open.