Icon

Comments have been closed on this page. Please use AppMon & UEM Open Q & A forum for questions about this plugin.

 

What to Expect

This plugin is useful for customers who have both Gomez and dynaTrace, and want to leverage their customized Gomez page and group ID's in dynaTrace.

Customers of the popular Compuware Gomez product can manually label their pages with page and group ID strings, and refer to those strings in their Gomez-produced reports.  This dynaTrace Gomez Page ID plugin integrates these same strings into the dynaTrace UEM data, thus enabling a dynaTrace customer to refer to the strings in dynaTrace reports.

Supported dynaTrace Versions

dynaTrace 5.6.x, 6.0.x and later

Tested Browser Versions

The Gomez Page ID plugin is supported on all web browsers that are supported by the dynaTrace UEM JavaScript Agent.

To Enable The Plugin

The plugin is NOT installed with dynaTrace.  It must be downloaded from the APM Community, HERE, then imported into dynaTrace.

By default, the plugin is not enabled.  To enable the plugin, run the dynaTrace Client, and enable the "Gomez Page ID" checkbox in the "Manage Captured Content" section of the UEM Configuration of a System Profile.

Operational Details

The Gomez customer already has placed a "gomez" JavaScript global object variable into each page that is monitored by Gomez.  The page ID's and group ID's are manually added to this global object, according to the Gomez standard ...

 

The "gs" and "acctId" properties are already present in any Gomez-enabled page.  The plugin does not use these properties.

In addition to the "pgId" and "grpId" properties, the customer may add "grpId1", "grpId2", "grpId3" and "grpId4".  The plugin does not require any particular one of the properties --  If any or all are present, those properties are reported.

There is no Gomez-documented limit to the values of these six properties, but the plugin requires them to be simple JavaScript strings, no longer than 256 characters.  Long strings are truncated.

The strings are integrated into dynaTrace via the dT_['rs'] (a.k.a. "reportString") method.  This method attaches a given key and string to the current action.  Via this plugin, they appear on the load action.  To avoid potential collisions with other keys, the key names are prefixed with "dtz" ...

 

gomez propertydynaTrace key
pgIddtzpgId
grpIddtzgrpId
grpId1dtzgrpId1
grpId2dtzgrpId2
grpId3dtzgrpId3
grpId4dtzgrpId4
 
The keys and their strings can then be leveraged by dynaTrace Business Transactions (BT), to include them in reports.  The development and use of BT's is documented elsewhere, and is beyond the scope of this humble Wiki page.

Verification

To verify that the plugin is working correctly, run the dynaTrace Client and view the User Action PurePaths for the web page.  You should see the keys and strings in the load action for the page ...

 

Troubleshooting

  • Verify that the page ID's appear in the dynaTrace User Action PurePaths.  If they do appear, then this plugin is working correctly, and the page ID's are being stored in the dynaTrace data.
  • In the "Manage Captured Content" section of the UEM Configuration of a System Profile, verify that the Gomez Page ID plugin is listed, along with the other plugins (e.g. Basic XHR, jQuery).  If it is not listed, then the plugin needs to be imported into dynaTrace.
  • Verify that the Gomez Page ID plugin is enabled in the "Manage Captured Content" section of the UEM Configuration of a System Profile.  If it is not enabled, then enable it, and test again.
  • View the HTML source code of the web page, and verify that the JavaScript Agent is injected into the page, and that hash code "z" appears in the file's name.  If the agent is not injected, or it has the wrong hash codes, then fix this injection problem.
  • View the HTML source code of the web page, and verify that the "gomez" JavaScript global variable is defined, and that it appears to have the correct format.  Ensure that the last property entry in the "gomez" object is not followed by a comma, which would be invalid JavaScript syntax.
  • Verify that the page ID's are present in Gomez reports.  If they are not present, then follow the Gomez procedure(s) for fixing or establishing them.  (Admittedly, this is using Gomez as a tool, to verify that the global variable is defined correctly.  If Gomez doesn't see it, then it is not yet correct!)
  • In the dynaTrace Client, turn on Debug Mode, and turn on the JavaScript console log messages from the plugins.  This plugin has many, helpful messages.  Each message begins with "[GomezPageId]".