wM Integration Server Service Profiler

This version adds to the previous version some enhancements and corrections:

• Minor corrections to the page's HTML;

  Most are just adjustements for compliance with standards.

• Make sure it will work with Solaris 64-bit;

  The setting was already used and applied in existing installations for that target, but was not part of the installales.

• The Help link, if forced to open in a new tab or window would show a page only with the top frame;

  This is corrected, but right-click targeting is no longer available.

• Added the reset input field to service wia.pub.issprofiler.snapshot:take;
• Make IE use EDGE as its default view mode;

  Before this version this browser would automatically decide to view the pages with IE7 compatibility mode.

• Added a bar-chart to the service details pane of the Browse Snapshot dashboard.

  This chart outlines the timing percentages of the service's direct child nodes.

  It is intended to quickly identify which of direct child nodes have the greatest weight in the total elapsed time of the selected service, and also hinting where to drilldown further.

This version adds the previous version a feature that enhances the application of Patch #6 and makes v1.5.7 more suitable to be applied when upgrading Service Profiler from previous versions:

• Automatic recognition of ACL inconformity present and automatically corrects it.

  Patch #6 corrects the issue that generates the inconformity and does not allow it to manifest itself in new installations.

  However, when upgrading an already existing installation the inconformity is already set and only this new version activelly recognizes it and corrects it.

Versions 1.5.1 to 1.5.5 were not officially published.

These versions were associated with patches, #1 to #6, which added features and/or corrected issues found in v1.5. Patches #1 to #3 were suppressed and are included in patch#4, but #5 and #6 are isolated.

This version (1.5.6) includes all patches published previously published for Service Profiler v1.5.

New Features:

• Added a filter by elapsed time to the Browse Running Services dashboard;

  By setting a value in the minimum elapsed time option, and refreshing the dashboard, only threads that have top-level services running for at least that amount of time are shown.

  This is a way of quickly show which threads are running for a very long time. For instance, if 'a long time' is 10 minutes, setting the value of the option to "10:00.0" will only show the threads that have an elapsed time of at least that time... all the others are not shown.

• Improved the controlled replacement of static JARs when installing a new version of the tool;
• Prepare for Next Upgrade;

  The shutdown sequence of the package verifies if there are changes to be installed in the startup of the server and make preparation actions for it.

  These actions, specially in MS Windows environments, try to avoid errors during the next startup. This is also why the new script editing instructions for webMethods v9.x focus on making sure the Service Profiler setup scripts only run on startup.

• Validate new License Key before applying.

  Up until this patch (#3, i.e., v1.5.3), the new License Key would be directly applied and validated as part of that process. However, should the new license be invalid the instance would be set with that invalid license.

  With this patch, the key is validated prior to applying, and if invalid it does not invalidate/overwrite the one that is currently active.

Bug Corrections:

• In the Browse Running Services dashboard, all services in their current stack now present a value for the Running Instance field;

  Only the frame with the currently executing service would present a value other than 0 (zero).

• Depending on the webMethods version, the error messages in the DSPs would appear with a font size too small, too large or OK;

  Definitions of the error message CSS were created to show it in the same way in all versions of webMethods.

• Stopping the Service Profiler from the Admin page would not automatically freeze the current snapshot;
• When the license key expired, the message on the top frame would be 'Installation Incomplete', which is misguiding.
• Correct a bug introduced by Patch #3;

  (Only) on a new installation, the license management page would issue a NullPointerException, and even if the tool was correctly installed it would still indicate 'Installation Incomplete'.

• Correction of the error java.lang.ClassCastException: java.lang.String cannot be cast to java.lang.Boolean;

  This error was thrown when using the public services to download as CSV or JSON, via HTTP request and using the parameter resetCounters.

• The assignment of the ACL WiaServiceProfilers to the folder wia.pub.issprofiler would be lost with a server restart.

  This would only be noticed if defining a user group restricted to only use the Service Profiler by adding that group to the mentioned ACL. The users would be able to use the services with no issues, until a server restart. From that moment onwards, they would always get an Access Denied.

This version updates the installation procedure and instructions for support webMethods v9.9 and v9.10.

For webMethods v9.10, the new retyling of the platform pages is not followed and a reworked version based on the previous one is used. This breaks the usual alignment with the platform's style and opens the possibility of having the presentation layer completelly reworked in the next version of the tool.

Requirements:

• For some of the corrections and features to work correctly, some packages need to be updated to newer versions:

  • The WiaRoot package needs to be, at least, v1.2;
  • The WiaUtilities package needs to be, at least, v1.12;
  • The WiaRuntimeEcosystem package needs to be, at least, v1.1.
• It is not mandatory, but advisable, to review the startup script editions to match the most recent installation instructions.

  The detailed installation instructions are available as a dynamic webpage accessible from the download page at the website.

New Features:

• Added user information to the snapshot;

  This is oinformation is integrated into the existing dashboards and exported files.

• Added a new View Per User dashboard;
• Added the option to disable Package Exclusion Patterns without actually having to remove them to all the available dashboards;
• Added new red and amber visual alerts to the View Per service dashboard based on configurable thresholds;
• Snapshot is exportable as JSON;
• Top frame auto-refresh is configurable via a property;
• If conditions are met, the dashboards automatically render links to the Service Comments Viewer;
• Counters can be reset without having to stop the profiler.

Bug Corrections:

• Correction to thread-info XML tag in the snapshot: [ISC.0042.9325] Element <thread-info> is missing end tag
  • The tag was not being terminated;
  • The value of the lock-owner-name was not being encoded and sometimes generated an error when rendering.
• The Maximum Thread Count would not reset when counters were reset;
• On Integration Servers v9.6 and above, the setting for preventing the tool from loading was not working.
• The Service Profiler could either not load properly of conflict with recently installed FIXes.

  The Service Profiler used to calculate the profile configuration properties only at installation time, while the FIXes arbitrarily set their own properties. If the settings index coincided (which already happens in some base installations) the last one replaces the others, suppressing them.

  With this new version, the startup scripts and configuration automation tools have been changed to:

  • Always reevaluate the environment, recalculate and generate configurations each time the server starts up, instead of only once on the first time installation;
  • Always consider all profile configuration files to erradicate any conflict;
  • Further avoid conflicts by including the Service Profiler profile configuration in the custom_wrapper.conf file instead of the wrapper.conf.

Other Corrections:

• Corrections to HTML for better compliance with standards;
• Corrections to CSS.

This version updates the installation instructions for webMethods v8.2 and webMethods v9.x, including v9.7¹ and Java 8².

¹ Introduced with build 9211.

² Introduced with build 9348.

Requirements:

• For some of the corrections and features to work correctly, some packages need to be updated to newer versions and a new package has been introduced:

  • The WiaRoot package needs to be, at least, v1.0.3;
  • The WiaUtilities package needs to be, at least, v1.9.2;
  • The new package WiaRuntimeEcosystem package needs to be, at least, v1.0.

    This package is used to manage any files created by the runtime of any package, i.e., property files, log files, temporary files, etc. It streamlines the management of the locations of these files seamlessly.

    The homepage of the package provides further information.

    The Service Profiler uses the services from this package to manage the location of its property files and the exported snapshots created by file generation.

• It is not mandatory, but advisable, to review the startup script editions to match the most recent installation instructions.

  The detailed installation instructions are available as a dynamic webpage accessible from the download page at the website.

Bug Corrections:

• Added icons for Blaze service type;
• Corrected cause of error "Timer already canceled." when setting a new license key after old already expired.
• Corrected compatibility issues with Internet Explorer from IE8 onwards:
  • Overlay images (with exceptions, paused, running, etc.) of the service icons in the snapshot tree would show in the wrong place;
  • On Export to File, it would only execute the default options.

    Changing to CSV or Generate file & link would not yield the desired result.

New Features:

• Package Coverage can now be analyzed against the Integration Server's service usage statistics.

This version is created by installation of Patch #4.

This patch updates the installation instructions for webMethods v8.2, and especially when running the Integration Server as a Windows NT Service.

Requirements:

• For some of the corrections and features to work correctly, it is required to have installed v1.0.2 of the WiaRoot package.

  Failing to comply with this requirement will cause the Service Profiler package to fail (re)loading due to dependencies validation by the Integration Server.

Bug Corrections:

• The BrowseSnapshot tree could not show.

  Some Software AG FIXes targeting cross-scripting change the encoding of DSP values generating JavaScript errors.

  The encoding problem also shows when displaying error messages on any of the dashboards.

New Features:

• Added the identification currently logged user at the top of the page;
• Added option to disable Package Exclusion Patterns without actually having to remove them;
• In the dashboards that show a service call tree, a new option has been added to show the tree considering all packages by momentarily ignoring any Package Exclusion Pattern settings.

This version is created by installation of Patch #3.

This patch updates the installation instructions for webMethods v8.2, and especially when running the Integration Server as a Windows NT Service.

Bug Corrections:

• In the Admin page, when there was only one Package Exclusion Pattern in the list, it could be removed.

This version is created by installation of Patch #2.

This patch updates the online help to include features introduced with v1.3 of the tool.

Additionally, adds a new feature that targets the situation where the Integration Server is known in the network by multiple names, or even when it is connected to multiple sub-networks. In this environment, it is very possible that the server name reported by the IS (and that is placed at the header of the Service Profiler exported snasphots) is not the same as the one it is publicly known. This patch allows you to override the server name to whatever you like... it can even be a logical name with nothing to do with network names.

New Features:

• The Server Name in the snapshot may be overiden by a new configuration property.

  The setting will only affect the next snapshot activation, i.e., current profiling snapshot is unaware of the change to the property. You will have stop current activation (if any) and start the profiler again.

  Because the number of properties has grown a bit, they are now presented in separate tabs, but still on the same page/form.

This version is created by installation of Patch #1.

Bug Corrections:

• Corrected further situations where the Server Name in the snapshot may appear with the port number set as -1;
• The field ExceptionCount was missing on the snapshot public document.

Correct setup incompatibilities with the Integration Server v8.2. These incompatibilities affect mainly the tool's installation steps.

Bug Corrections:

• Stack Trace info being shown as HTML text;
  This might happen with any Integration Server version since v8.0, due to cross-scripting protection added to the %value% tag.
  This problem has been corrected.
• The Service Profiler can now be used with an Integration Server v8.2 running as a Windows NT Service.

New Features:

• Added a setting that indicates that the Service Profiler should automatically be started upon its package (re)load;
• Added a setting that indicates that a (last) snapshot documents is published upon the Service Profiler's package unload.
  A trigger and a service that processes that published document can be developed to, for instance, save it into a database.
• Added export services to directly download the snapshot as a CSV or XML file, with option to reset counters.
  These services fill the gap of providing the UI functionality without using UI-specific services.
  They are usefull to, for instance, scripted remote retrieval of the snapshot with wget:
  • wia.pub.issprofiler.export:as_csv_download
  • wia.pub.issprofiler.export:as_xml_download

This version includes all patches to v1.2.1 and updates the company logo.

Upgrading to this version may be accomplished by applying patch #2 on v1.2.

Bug Corrections:

• AIX native dynamic shared librares may not work;
  The previously provided libraries had a problem handling the class loaders of the IBM specific JVM.
  As a result, the snapshots were always empty.

New Features:

The are no new features, other than replacing all previous patches of v1.2.

patch 1

Upgrading to this version may be accomplished by applying patch #4 on v1.1.

Bug Corrections:

• Native dynamic shared librares may not load in RedHat Linux 4 ES;
  The provided libraries had a dependency on glibc v2.5 while the OS usually only has v2.3.
  This dependency has been removed.

New Features:

• Added the possibility of viewing the reported times as averages in the Browse Snapshot dashboard.
• Tested with webMethods v8.0.
  Adaptive page styling adjusts itself to the server's version color scheme, whether it is v8.0 or a previous one.

patch 1

patch 2

Upgrading to this version requires the complete uninstall of any previous version.

New Features:

• The Service Profiler tool directory is automatically created on 1^st time installation;
• Profiling sessions can be named, each time the Service Profiler is started;
• Completely disabling the Service Profiler can be done from the tool's admin page;
• Clear generated export files directly from the tool's admin page;
• The snapshot XML contains the version of its structure as an attribute;
• The exported XML file is enriched with service metadata;
• A previouly exported XML file can be uploaded for viewing;
• Export snapshot as content stream;
• Added the Maximum Thread Count (MTC) to the View Per Service and Code Coverage dashboards;
• Browse Running Services with Java Stack Trace and Thread Info;
• Search a service by name in the snapshot tree of the Browse Snapshot and Browse Running Services dashboards using a Regular Expression.

Bug Corrections:

• Correct paging control of a large tree with small page setting;
• Correctly show services that are False Roots;
• Correctly show the Running Instance elapsed time;
• No node in the snapshot tree is selected if the details panel is blank.

patch 2

patch 3

patch 4

Integrate all patches of v1.0.2.

patch 1

Integrate all patches of v1.0.1.

Added support for HP-UX Itanium, 32-bit and 64-bit.

patch 3

patch 4

Auto-pagination of the Browse Snapshot and Browse Running Services dashboards.

This feature was added in response to a timeout or long-running script warning message from the browsers when the navigation tree contained a large number of nodes. A large number would vary from browser-to-browser and from environment-to-environment, but would normally be a number above 1000 nodes. In some enviroments, it would only manifest itself above 3000 nodes.
The implemented improvement simplifies the script generation (speeding generation and page load) and automatically creates pagination control on a threshold of 1000 nodes-per-page. This value is the default, and can be overriden through a configuration setting.
Check the Troubleshooting section of the User Guide manual for detailed information.

First delivered version.