Jump to: navigation, search

Difference between revisions of "WTP/HTTP Connection Tracer Diagnostic Utility"

< WTP
(initial transfered draft)
(initial transfered draft)
Line 5: Line 5:
 
There are times that code is seen to go to the internet to fetch something, and its not often clear why or what code is responsible. Sometimes it is necessary for code to fetch something remotely, but often it is best to keep a local cached copy, use and XML Catalog, etc., to avoid excessive internet traffic.
 
There are times that code is seen to go to the internet to fetch something, and its not often clear why or what code is responsible. Sometimes it is necessary for code to fetch something remotely, but often it is best to keep a local cached copy, use and XML Catalog, etc., to avoid excessive internet traffic.
  
== The solution (to help diagnosis excessive access) ==
+
== The solution (to help diagnosis excessive access) ==
  
 
There is an "HTTP Connection Tracer" tool to help detect and track when code requests an HTTP connection, so that excessive requests can be detected early, and more easily fixed.  
 
There is an "HTTP Connection Tracer" tool to help detect and track when code requests an HTTP connection, so that excessive requests can be detected early, and more easily fixed.  
Line 11: Line 11:
 
In addition to logging request, the tool does allow a "remapping" of an HTTP request to a local file. This can help work around immediate problems but, of course, is not a long term solution.  
 
In addition to logging request, the tool does allow a "remapping" of an HTTP request to a local file. This can help work around immediate problems but, of course, is not a long term solution.  
  
Please address any questions, comments or suggestions in [https://bugs.eclipse.org/bugs/enter_bug.cgi?product=Web%20Tools bugs] or via the [https://dev.eclipse.org/mailman/listinfo/wtp-dev wtp-dev@eclipse.org] mailing list.
+
Please address any questions, comments or suggestions in [https://bugs.eclipse.org/bugs/enter_bug.cgi?product=Web%20Tools bugs] or via the [https://dev.eclipse.org/mailman/listinfo/wtp-dev wtp-dev@eclipse.org] mailing list.  
  
=== Installation ===
+
Note: this utility only detects HTTP requests that are made through the Java VM APIs. There are other frameworks, such as org.apache.commons.httpclient and ECF that provide other APIs (this is why, for example, p2 related http requests would not normally show up in this utility). <br>
  
Download the [http://www.eclipse.org/webtools/development/httptracerutility/httphandler.jar HTTP connection tracer diagnostic utility] jar file.
+
Note: this utility was written by Craig Salter and provided to Ecliple open source via {{bug|109788}}, in 2006. Thanks go to him. It was (much) later renamed to conform "eclipse.org" namespace, and put into Web Tools CVS (/cvsroot/webtools), in webtools.releng/tests/org.eclipse.wtp.releng.httphandler. This jar is not built during any of our regular builds, but was built from a developers workspace, and placed on downloads server, and /shared/webtools/apps, so whenever a new VM is used, it should be easy to find the built version to put in the jre/lib/ext directory. <br>
  
The jar file must be added to the JRE's lib/ext directory. This must be done for each JRE that you're using in your environment. So if you're developing your code with eclipse and deploying to a server (and you want to get trace information for both) you'll need to make the JAR available for both the eclipse JRE and the server's JRE.
+
=== Installation  ===
  
=== Configuration ===
+
Download the [http://www.eclipse.org/webtools/development/httptracerutility/httphandler.jar HTTP connection tracer diagnostic utility] jar file.
  
When you launch eclipse or run your sever, you'll need to specify some vmargs to activate the "HTTP Connection Tracer" tool. Here's an example of how you'd do this on the command line for Eclipse.
+
The jar file must be added to the JRE's lib/ext directory. This must be done for each JRE that you're using in your environment. So if you're developing your code with eclipse and deploying to a server (and you want to get trace information for both) you'll need to make the JAR available for both the eclipse JRE and the server's JRE.
 +
 
 +
=== Configuration  ===
 +
 
 +
When you launch eclipse or run your sever, you'll need to specify some vmargs to activate the "HTTP Connection Tracer" tool. Here's an example of how you'd do this on the command line for Eclipse.  
 
<pre> eclipse.exe -vmargs -Djava.protocol.handler.pkgs=org.eclipse.wtp.releng.www.protocol -DurlMapLocation=C:\map.txt -DurlLogLocation=C:\log.txt
 
<pre> eclipse.exe -vmargs -Djava.protocol.handler.pkgs=org.eclipse.wtp.releng.www.protocol -DurlMapLocation=C:\map.txt -DurlLogLocation=C:\log.txt
 
</pre>  
 
</pre>  
Here's a description of what each argument does ....
+
Here's a description of what each argument does ....  
  
 
{| border="1"
 
{| border="1"
 
|-
 
|-
! name
+
! name  
! example value
+
! example value  
 
! description
 
! description
 
|-
 
|-
| java.protocol.handler.pkgs
+
| java.protocol.handler.pkgs  
| org.eclipse.wtp.releng.www.protocol
+
| org.eclipse.wtp.releng.www.protocol  
 
| Tells the JVM to utilize the "HTTP Connection Tracer" tool.
 
| Tells the JVM to utilize the "HTTP Connection Tracer" tool.
 
|-
 
|-
| urlMapLocation
+
| urlMapLocation  
| C:\map.txt
+
| C:\map.txt  
 
| Specifies the location of a 'properties' file where URL mapping information can be provided. Note that if no map location is specified then URL redirection never occurs.
 
| Specifies the location of a 'properties' file where URL mapping information can be provided. Note that if no map location is specified then URL redirection never occurs.
 
|-
 
|-
| urlLogLocation
+
| urlLogLocation  
| C:\log.txt
+
| C:\log.txt  
 
| Specifies the location of a log file where logging information will be written. Note that if no log location is specified the logging information will be written to System.out. [ISSUE: is the following sentence still true? The log might always be created now?] Note also that if no HTTP requests are made, then no log or output is produced. If there is no output, you may want to confirm your setup by running a small test program that explicitly does a URL connection. See {{bug|216524}} for an example.
 
| Specifies the location of a log file where logging information will be written. Note that if no log location is specified the logging information will be written to System.out. [ISSUE: is the following sentence still true? The log might always be created now?] Note also that if no HTTP requests are made, then no log or output is produced. If there is no output, you may want to confirm your setup by running a small test program that explicitly does a URL connection. See {{bug|216524}} for an example.
 
|}
 
|}
  
==== The Map File ====
+
==== The Map File ====
  
Here's an example of what the map file looks like....
+
Here's an example of what the map file looks like....  
 
<blockquote>http://www.hello.com/bar.xsd =file:///D:/my-schema-cache/bar.xsd<br> http://www.ibm.com/foo.xsd=file:///D:/my-schema-cache/foo.xsd</blockquote>  
 
<blockquote>http://www.hello.com/bar.xsd =file:///D:/my-schema-cache/bar.xsd<br> http://www.ibm.com/foo.xsd=file:///D:/my-schema-cache/foo.xsd</blockquote>  
Notice its just a list of mapping pairs (separated by an '=' sign) that specifies how a web address should be redirected to a local file system address. By editing this file, a customer can workaround nagging 'going off to the internet problems' until a proper fix is delivered.
+
Notice its just a list of mapping pairs (separated by an '=' sign) that specifies how a web address should be redirected to a local file system address. By editing this file, a customer can workaround nagging 'going off to the internet problems' until a proper fix is delivered.  
  
==== The Log File ====
+
==== The Log File ====
  
Each time the JVM attempts to create an HTTP connection, an entry is added to the log file. Below is an example log file entry. It consists of three interesting pieces of information...
+
Each time the JVM attempts to create an HTTP connection, an entry is added to the log file. Below is an example log file entry. It consists of three interesting pieces of information...  
 
<blockquote>URL request - provides the URL address for the connection requested<br> URL mapped - provides the 'mapped' address (as specified in the 'map.txt' file) to help the customer see that the URL has been successfully redirected<br> STACK TRACE - dumps of stack to help the support and development teams understand the code paths involved in creating the connection request</blockquote>  
 
<blockquote>URL request - provides the URL address for the connection requested<br> URL mapped - provides the 'mapped' address (as specified in the 'map.txt' file) to help the customer see that the URL has been successfully redirected<br> STACK TRACE - dumps of stack to help the support and development teams understand the code paths involved in creating the connection request</blockquote>  
Note that the presence of an entry in the log does not necessarily imply an defect in code. Some attempts to create an HTTP connections are expected. So I'd encourage you to scrutinize the entries in the log file. At the very least the logs will provide you some useful stack trace information that will help developers understand the nature of the HTTP connections.
+
Note that the presence of an entry in the log does not necessarily imply an defect in code. Some attempts to create an HTTP connections are expected. So I'd encourage you to scrutinize the entries in the log file. At the very least the logs will provide you some useful stack trace information that will help developers understand the nature of the HTTP connections.  
  
=== Example Output ===
+
=== Example Output ===
 
<pre>&lt;code&gt;
 
<pre>&lt;code&gt;
 
URL requested&nbsp;: http://www.ibm.com/foo.xsd
 
URL requested&nbsp;: http://www.ibm.com/foo.xsd
Line 114: Line 118:
 
&nbsp;&nbsp;&nbsp;at org.eclipse.core.launcher.Main.main(Main.java:688)  
 
&nbsp;&nbsp;&nbsp;at org.eclipse.core.launcher.Main.main(Main.java:688)  
 
&lt;/code&gt;
 
&lt;/code&gt;
</pre>  
+
</pre>
 +
 
 
== The solution (for fixing code that makes excessive http requests) ==
 
== The solution (for fixing code that makes excessive http requests) ==
  

Revision as of 21:45, 25 September 2011

HTTP Connection Tracer Diagnostic Utility

The Problem

There are times that code is seen to go to the internet to fetch something, and its not often clear why or what code is responsible. Sometimes it is necessary for code to fetch something remotely, but often it is best to keep a local cached copy, use and XML Catalog, etc., to avoid excessive internet traffic.

The solution (to help diagnosis excessive access)

There is an "HTTP Connection Tracer" tool to help detect and track when code requests an HTTP connection, so that excessive requests can be detected early, and more easily fixed.

In addition to logging request, the tool does allow a "remapping" of an HTTP request to a local file. This can help work around immediate problems but, of course, is not a long term solution.

Please address any questions, comments or suggestions in bugs or via the wtp-dev@eclipse.org mailing list.

Note: this utility only detects HTTP requests that are made through the Java VM APIs. There are other frameworks, such as org.apache.commons.httpclient and ECF that provide other APIs (this is why, for example, p2 related http requests would not normally show up in this utility).

Note: this utility was written by Craig Salter and provided to Ecliple open source via bug 109788, in 2006. Thanks go to him. It was (much) later renamed to conform "eclipse.org" namespace, and put into Web Tools CVS (/cvsroot/webtools), in webtools.releng/tests/org.eclipse.wtp.releng.httphandler. This jar is not built during any of our regular builds, but was built from a developers workspace, and placed on downloads server, and /shared/webtools/apps, so whenever a new VM is used, it should be easy to find the built version to put in the jre/lib/ext directory.

Installation

Download the HTTP connection tracer diagnostic utility jar file.

The jar file must be added to the JRE's lib/ext directory. This must be done for each JRE that you're using in your environment. So if you're developing your code with eclipse and deploying to a server (and you want to get trace information for both) you'll need to make the JAR available for both the eclipse JRE and the server's JRE.

Configuration

When you launch eclipse or run your sever, you'll need to specify some vmargs to activate the "HTTP Connection Tracer" tool. Here's an example of how you'd do this on the command line for Eclipse.

 eclipse.exe -vmargs -Djava.protocol.handler.pkgs=org.eclipse.wtp.releng.www.protocol -DurlMapLocation=C:\map.txt -DurlLogLocation=C:\log.txt

Here's a description of what each argument does ....

name example value description
java.protocol.handler.pkgs org.eclipse.wtp.releng.www.protocol Tells the JVM to utilize the "HTTP Connection Tracer" tool.
urlMapLocation C:\map.txt Specifies the location of a 'properties' file where URL mapping information can be provided. Note that if no map location is specified then URL redirection never occurs.
urlLogLocation C:\log.txt Specifies the location of a log file where logging information will be written. Note that if no log location is specified the logging information will be written to System.out. [ISSUE: is the following sentence still true? The log might always be created now?] Note also that if no HTTP requests are made, then no log or output is produced. If there is no output, you may want to confirm your setup by running a small test program that explicitly does a URL connection. See bug 216524 for an example.

The Map File

Here's an example of what the map file looks like....

http://www.hello.com/bar.xsd =file:///D:/my-schema-cache/bar.xsd
http://www.ibm.com/foo.xsd=file:///D:/my-schema-cache/foo.xsd

Notice its just a list of mapping pairs (separated by an '=' sign) that specifies how a web address should be redirected to a local file system address. By editing this file, a customer can workaround nagging 'going off to the internet problems' until a proper fix is delivered.

The Log File

Each time the JVM attempts to create an HTTP connection, an entry is added to the log file. Below is an example log file entry. It consists of three interesting pieces of information...

URL request - provides the URL address for the connection requested
URL mapped - provides the 'mapped' address (as specified in the 'map.txt' file) to help the customer see that the URL has been successfully redirected
STACK TRACE - dumps of stack to help the support and development teams understand the code paths involved in creating the connection request

Note that the presence of an entry in the log does not necessarily imply an defect in code. Some attempts to create an HTTP connections are expected. So I'd encourage you to scrutinize the entries in the log file. At the very least the logs will provide you some useful stack trace information that will help developers understand the nature of the HTTP connections.

Example Output

<code>
URL requested : http://www.ibm.com/foo.xsd
URL mapped : file:///D:/workspaces/corona-test/XMLExamples/substitutionGroup/Catalogue4.xsd
STACK TRACE :
java.lang.Exception: dumpTheStack
   at com.ibm.etools.www.protocol.http.Handler.openConnection(Handler.java:156) 
   at java.net.URL.openConnection(URL.java:924) 
   at org.apache.xerces.impl.XMLEntityManager.setupCurrentEntity(Unknown Source) 
   at org.apache.xerces.impl.XMLVersionDetector.determineDocVersion(Unknown Source) 
   at org.apache.xerces.parsers.XML11Configuration.parse(Unknown Source) 
   at org.apache.xerces.parsers.XML11Configuration.parse(Unknown Source) 
   at org.apache.xerces.parsers.XMLParser.parse(Unknown Source) 
   at org.apache.xerces.parsers.AbstractSAXParser.parse(Unknown Source) 
   at javax.xml.parsers.SAXParser.parse(Unknown Source) 
   at org.eclipse.xsd.util.XSDParser.parse(XSDParser.java:175) 
   at com.ibm.xsdeditor.internal.wizards.XSDSelectIncludeFileWizard.doLoadExternalModel(XSDSelectIncludeFileWizard.java:183) 
   at com.ibm.xsdeditor.internal.wizards.XSDSelectIncludeFileWizard$XSDURLPage.openExternalSchema(XSDSelectIncludeFileWizard.java:293)
   at com.ibm.xsdeditor.internal.wizards.XSDSelectIncludeFileWizard$XSDURLPage.access$0(XSDSelectIncludeFileWizard.java:271) 
   at com.ibm.xsdeditor.internal.wizards.XSDSelectIncludeFileWizard$1.run(XSDSelectIncludeFileWizard.java:318) 
   at org.eclipse.jface.operation.ModalContext.runInCurrentThread(ModalContext.java:303) 
   at org.eclipse.jface.operation.ModalContext.run(ModalContext.java:253) 
   at org.eclipse.jface.wizard.WizardDialog.run(WizardDialog.java:752) 
   at com.ibm.xsdeditor.internal.wizards.XSDSelectIncludeFileWizard.performFinish(XSDSelectIncludeFileWizard.java:130) 
   at org.eclipse.jface.wizard.WizardDialog.finishPressed(WizardDialog.java:609) 
   at org.eclipse.jface.wizard.WizardDialog.buttonPressed(WizardDialog.java:305) 
   at org.eclipse.jface.dialogs.Dialog$2.widgetSelected(Dialog.java:506) 
   at org.eclipse.swt.widgets.TypedListener.handleEvent(TypedListener.java:89) 
   at org.eclipse.swt.widgets.EventTable.sendEvent(EventTable.java(Compiled Code)) 
   at org.eclipse.swt.widgets.Widget.sendEvent(Widget.java:796) 
   at org.eclipse.swt.widgets.Display.runDeferredEvents(Display.java:2772) 
   at org.eclipse.swt.widgets.Display.readAndDispatch(Display.java(Compiled Code)) 
   at org.eclipse.jface.window.Window.runEventLoop(Window.java:668) 
   at org.eclipse.jface.window.Window.open(Window.java:648) 
   at com.ibm.xsdeditor.internal.properties.section.NamespaceAndSchemaLocationSection.widgetSelected(NamespaceAndSchemaLocationSection.java:159)
   at org.eclipse.swt.widgets.TypedListener.handleEvent(TypedListener.java:89) 
   at org.eclipse.swt.widgets.EventTable.sendEvent(EventTable.java(Compiled Code)) 
   at org.eclipse.swt.widgets.Widget.sendEvent(Widget.java:796) 
   at org.eclipse.swt.widgets.Display.runDeferredEvents(Display.java:2772) 
   at org.eclipse.swt.widgets.Display.readAndDispatch(Display.java:2431) 
   at org.eclipse.ui.internal.Workbench.runEventLoop(Workbench.java:1377) 
   at org.eclipse.ui.internal.Workbench.runUI(Workbench.java:1348) 
   at org.eclipse.ui.internal.Workbench.createAndRunWorkbench(Workbench.java:254) 
   at org.eclipse.ui.PlatformUI.createAndRunWorkbench(PlatformUI.java:141) 
   at org.eclipse.ui.internal.ide.IDEApplication.run(IDEApplication.java:96) 
   at org.eclipse.core.internal.runtime.PlatformActivator$1.run(PlatformActivator.java:335) 
   at org.eclipse.core.runtime.adaptor.EclipseStarter.run(EclipseStarter.java:273) 
   at org.eclipse.core.runtime.adaptor.EclipseStarter.run(EclipseStarter.java:129) 
   at sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method) 
   at sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:85) 
   at sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:58) 
   at sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:60) 
   at java.lang.reflect.Method.invoke(Method.java:391) 
   at org.eclipse.core.launcher.Main.basicRun(Main.java:185) 
   at org.eclipse.core.launcher.Main.run(Main.java:704) 
   at org.eclipse.core.launcher.Main.main(Main.java:688) 
</code>

The solution (for fixing code that makes excessive http requests)

While there is no one solution for all situations where you want to avoid or minimize network access, here we will mention a few things to consider.

  • Use an XML Catalog, with copies of resources on your local disk.
  • Set validation off, and set a null resolver.
  • Use a cache, so resources are at least only retrieved once, such as the cache in WTP!