IT33936: Provide mechanism to trace the New Web Console Javascript that runs inside a browser

APAR status

• Closed as program error.

Error description

• The IBM MQ 9.2 New Web Console provides a new way for customers
  to perform basic administration tasks. The New Web Console
  consists of some Javascript that runs within a browser, and
  some back end code written in Java that runs within the  MQ web
  server.
  
  It is possible to trace the Java back end code that runs within
  the mqweb server. However, it is not possible to trace the
  Javascript code that runs inside the browser.
  

Local fix

Problem summary

• ****************************************************************
  USERS AFFECTED:
  This issue affects users of the New Web Console shipped with MQ
  9.2.
  
  
  Platforms affected:
  MultiPlatform
  
  ****************************************************************
  PROBLEM DESCRIPTION:
  The IBM MQ 9.2 New Web Console consists of:
  
  - Javascript which runs inside of a browser.
  - Back end code, written in Java, which runs inside the MQ web
  server.
  
  Although it was possible to trace the back end code for the New
  Web Console, there was no mechanism to trace the Javascript.
  This meant that it was difficult for IBM Support to diagnose
  issues with the Javascript.
  

Problem conclusion

• The New Web Console has been updated to provide a mechanism to
  trace the Javascript running inside a browser.
  
  In order to trace the Javascript, the following steps need to be
  carried out:
  
  - Run the following command:
  
  setmqweb properties -k traceSpec -v "*=info:js.mq*=all"
  
  to enable the tracing mechanism in the MQ web server.
  - Start the MQ web server.
  - Bring up a browser, and log into the New Web Console.
  - Modify the URI that is being used to access the New Web
  Console, so that it includes the string
  
  ?trace=true
  
  as shown in the example below:
  
  Original URI : https://localhost:9443/ibmmq/console/#/
  New URI: https://localhost:9443/ibmmq/console/?trace=true#/
  
  Trace of the Javascript running inside the browser will now be
  written to a file called trace.log, which can be found in the
  <MQ_DATA_PATH>/web/installations/<installationName>/servers/mqwe
  b/logs/ directory.
  
  To turn trace off, modify the URI and remove the string:
  
  ?trace=true
  
  An example of the trace information generated by the New Web
  Console Javascript code running inside a browser is shown below:
  
  [18/08/20 14:34:13:880 BST] 00000050 trace-patcher 1
  js.mq.mq.lib.service.trace-patcher patchFn DATA [18/08/20
  14:34:10:472 BST] User:[mqadmin] (@static) "Patching ->
  i.componentDidMount"
  [18/08/20 14:34:13:880 BST] 00000050 trace-patcher 1
  js.mq.mq.lib.service.trace-patcher patchFn DATA [18/08/20
  14:34:10:472 BST] User:[mqadmin] (@static) "Patching ->
  i.componentWillUnmount"
  [18/08/20 14:34:13:880 BST] 00000050 trace-patcher 1
  js.mq.mq.lib.service.trace-patcher patchFn DATA [18/08/20
  14:34:10:472 BST] User:[mqadmin] (@static) "Patching ->
  i._getTopicsData"
  [18/08/20 14:34:13:880 BST] 00000050 trace-patcher 1
  js.mq.mq.lib.service.trace-patcher patchFn DATA [18/08/20
  14:34:10:472 BST] User:[mqadmin] (@static) "Patching ->
  i._showCreateTopic"
  [18/08/20 14:34:13:880 BST] 00000050 trace-patcher 1
  js.mq.mq.lib.service.trace-patcher patchFn DATA [18/08/20
  14:34:10:472 BST] User:[mqadmin] (@static) "Patching ->
  i._showDeleteTopic"
  [18/08/20 14:34:13:881 BST] 00000050 trace-patcher 1
  js.mq.mq.lib.service.trace-patcher patchFn DATA [18/08/20
  14:34:10:472 BST] User:[mqadmin] (@static) "Patching ->
  i._showTopicDetails"
  [18/08/20 14:34:13:881 BST] 00000050 trace-patcher 1
  js.mq.mq.lib.service.trace-patcher patchFn DATA [18/08/20
  14:34:10:472 BST] User:[mqadmin] (@static) "Patching ->
  i._showCreateSubscription"
  [18/08/20 14:34:13:881 BST] 00000050 trace-patcher 1
  js.mq.mq.lib.service.trace-patcher patchFn DATA [18/08/20
  14:34:10:472 BST] User:[mqadmin] (@static) "Patching ->
  i.render"
  
  ---------------------------------------------------------------
  The fix is targeted for delivery in the following PTFs:
  
  Version    Maintenance Level
  v9.2 LTS   9.2.0.1
  
  The latest available maintenance can be obtained from
  'WebSphere MQ Recommended Fixes'
  http://www-1.ibm.com/support/docview.wss?rs=171&uid=swg27006037
  
  If the maintenance level is not yet available information on
  its planned availability can be found in 'WebSphere MQ
  Planned Maintenance Release Dates'
  http://www-1.ibm.com/support/docview.wss?rs=171&uid=swg27006309
  ---------------------------------------------------------------
  

Temporary fix

Comments

APAR Information

• APAR is sysrouted FROM one or more of the following:

• APAR is sysrouted TO one or more of the following:

Fix information

• Fixed component name

  MQ BASE V9.2

• Fixed component ID

  5724H7281

Applicable component levels