Upgrade Notes For RTView Enterprise Monitor, Version 5.2

RTView DataServer and DataCollector

Upgrade Steps

  • Download the new deliverable and extract it on the same system as your old installation.

  • If you have a permanent license, copy the following file from the old installation to the new installation:

rtvapm/rtview/lib/KEYS

  • If you modified any of the top level scripts in the old installation, make a backup copy of those scripts in your new installation, then copy the modified scripts from the old installation to the new installation.

  • In the new deliverable, make a backup copy of the projects directory.

  • Copy the projects directory from the old installation to the new installation.

  • Copy the sl.log4j.properties file from your old installation to projects/sl.log4j.properties. Any changes to the logging configuration should be made in projects/sl.log4j.properties.

  • For RTViewDataCollector only, in the new installation, open projects/rtvservers.dat in a text editor, add -propfilter:receiver to the dataserver line and save the file.

  • For RTViewDataServer only

– Add new CacheMetric column to your alert database as described in the release note for TN24246.

– The projects\rtview-server\update_wars scripts changed between 5.1 and 5.2. Copy the scripts from the backup directory you created to the projects\rtview-server directory. If you modified those files in the previous installation, reapply your changes to the new scripts. If you enabled authentication of the rtvquery servlet in your previous installation (for LDAP or http authentication), modify the update_wars script to set SECURE to -secure so that the script will generate a secure rtvquery war file. Execute the update_wars script in an initialized command prompt. If you are using an application server, copy the generated war files to your application server.

– The projects\custom\make_classes scripts changed between 5.1 and 5.2. Copy the scripts from the backup directory you created to the projects\custom\src directory. If you modified those files in the previous installation, reapply your changes to the new scripts.
If you have a custom java notification, execute the projects\custom\make_classes script in an initialized command prompt.

  • Apply solution package specific upgrade notes listed below

  • Start up the new installation using the top level start script

RTView Configuration Application

RTView DataServers - EM Integration Tab

The EM Integration tab in the Configuration Application has been enhanced to make it easier to use.The following changes were made:

  • The help text was expanded and improved.

  • The RTView Data Server Host field was removed. This field was not directly used by the configuration, but instead was used to generate the RTView Data Server Connection and RTView Data Server Query URL values.

  • The order of the fields was rearranged to make the critical fields more visible.

  • The default value of the Announce this RTView Data Server to the Central Server has been changed to true and the field has been moved to the bottom of the page.

If you are upgrading from a previous version and set the RTView Data Server Host option, then you will not lose your changes. That field value will be used to generate the RTView Data Server Connection and RTView Data Server Query URL values, which will be saved the next time changes are saved from the Configuration Application. You do not need to do anything to make this work.

If you are upgrading from a previous version and enabled EM Integration but left Announce this RTView Data Server to the Central Server as false, then you will need to go into the Configuration Application and set it to false again as the default has changed from false to true.

Upgrading RTView Enterprise from Version 5.1 to Version 5.2

RTViewCentral

Upgrade Steps

  • Download the new deliverable and extract it in a new directory on the same system as your old deliverable.

  • In the new deliverable, make a backup copy of the projects directory.

  • In the new deliverable, make a backup copy of the bin directory.

  • If you have a permanent license, copy the following file from the old installation to the new installation:

rtvapm/rtview/lib/KEYS

  • If you modified the scripts under RTViewCentral\bin in the old installation, copy RTViewCentral\bin from the old installation to the new installation.

  • If you modified any files under projects/custom in the old installation

– The following files under projects/custom were changed between 5.1 and 5.2. If you modified them in your old installation, reapply the changes to the new versions of the files:

projects/custom/src/make_classes.bat

projects/custom/src/make_classes.sh

– Copy any other java files you modified from projects/custom/src/com/sl/rtvapm/custom in the old installation to the new.

– Execute make_classes.bat or make_classes.sh in an initialized command prompt to rebuild your custom classes against the new release.

  • The following files under projects/rtview-server were changed between 5.1 and 5.2.

custom_setup.bat

custom_setup.sh

update_wars.bat

update_wars.sh

central.properties (this file has been removed)

If you modified them in your old installation, reapply the changes to the new versions of these files. Note that the custom_setup scripts now point to the central.properties under RTVAPM_HOME/appmon/conf instead of the local directory. Do not change this path and do not modify RTVAPM_HOME/appmon/conf/central.properties. If you made changes to the local central.properties file in your previous installation, they will be addressed in a later step.

  • Copy all files not mentioned in the previous step under projects/rtview-server from old to new.

  • If you enabled authentication of the rtvquery servlet in your previous installation (for LDAP or http authentication), modify the update_wars script to set SECURE to -secure so that the script will generate a secure rtvquery war file.

  • Execute projects/rtview-server/update_wars in an initialized command prompt and copy the generated jars to RTViewCentral/apache-tomcat-*-sl/webapps or your application server.

  • The following files under projects/rtview-manager were changed between 5.1 and 5.2. If you modified them in your old installation, reapply the changes to the new versions of these files:

custom_setup.bat (new)

custom_setup.sh (new)

rtvservers.dat

update_wars.bat

update_wars.sh

  • The following files under projects/rtview-manager were changed between 5.1 and 5.2. These are modified via the Configuration Application. Any changes you made to the rtview-manager via the Configuration Application in the previous release will be addressed in a later step.

project.properties

project.properties.json

  • Copy all files not mentioned in the previous 2 steps under projects/rtview-manager from old to new.

  • If you enabled authentication of the rtvquery servlet in your previous installation (for LDAP or http authentication), modify the update_wars script to set SECURE to -secure so that the script will generate a secure rtvquery war file.

  • Execute projects/rtview-manager/update_wars in an initialized command prompt and copy the generated jars to RTViewCentral/apache-tomcat-*-sl/webapps or your application server.

  • If using HSQLDB, copy projects/DATA and projects/rtview-manager/DATA from the old installation to the new installation.

  • Add new CacheMetric column to your alert database as described in the release note for TN24246.

  • If your previous installation included LDAP integration

– Copy RTViewCentral/apache-tomcat-*-sl/lib/ldapUser.jar from the old installation to the new installation.

– Copy RTViewCentral/apache-tomcat-*-sl/conf/server.xml from the old installation to the new installation.

– Copy RTViewCentral/apache-tomcat-*-sl/conf/Catalina.properties from the old installation to the new installation.

  • If you modified rtvapm/common/conf/sl.log4j.properties in your old installation, copy the sl.log4j.properties file from your old installation to projects/sl.log4j.properties. All future changes to the logging configuration should be made in projects/sl.log4j.properties.

  • Start up the new installation using the start_servers script under bin.

  • If you made changes to central.properties file in your previous installation:

– Open the Configuration Application at http://localhost:10070/rtvadmin.

– Use rtvadmin/rtvadmin for the login.

– Click on the Central Server, then click on the CUSTOM PROPERTIES tab.

– Add all properties that you changed in the central.properties in the previous version.

– Click SAVE at the top, the Restart Servers to save and apply your changes.

  • If you made changes to the rtview-manager using the configuration application in your previous installation:

– Open the configuration application at http://localhost:3070/rtvadmin.

– Use rtvadmin/rtvadmin for the login.

– Click SAVE at the top, the Restart Servers to save and apply your changes.

– Click on the RTView Manager server and reapply all changes you made in the previous version.

Upgrading Solution Packages from Version 5.1 to 5.2

Solace

The Solace Event Module configuration has been added to the Solace DATA COLLECTION tab in the Configuration Application. Upgrading users should copy the rtvapm\solmon\soleventmodule\conf\soleventmodule.properties from their old installation to their new installation to keep their old settings. The next time you run the Configuration Application and save your properties files, the properties will be automatically transferred to rtview-server/project.properties*. After that, the soleventmodule.properties file will no longer be used and all further configuration changes to the Solace Event Module must be done through the Configuration Application.

The Solace Event Module logging configuration used to be done in rtvapm\solmon\soleventmodule\config\log4j2.properties. In 5.2, the logging configuration is done in projects\rtview-server\soleventmod.log4j2.properties. Upgrading users should copy the rtvapm\solmon\soleventmodule\config\log4j2.properties file in their old installation to projects\rtview-server\soleventmod.log4j2.properties in the new installation. All further changes to the Solace Event Module logging configuration should be done in projects\rtview-server\soleventmod.log4j2.properties.

Alter the Solace history database tables as described in the release note for TN24464.

Database Tables for Solace

The database table schemas in the rtvapm\solmon\dbconfig directory have been updated to include all updated table schemas. To upgrade, drop the following database tables from the RTVHISTORY database:

SOL_BRIDGE_STATS
SOL_CSPF_NEIGHBOR
SOL_VPNS
SOL_CLIENT_STATS
SOL_CSPF_NEIGHBOR

Recreate the database tables using the appropriate table creation SQL sentence for your supported platform, which are in the rtvapm\solmon\dbconfig directory.

Integer Client Metrics

DB2/HSQLDB

ALTER TABLE "SOL_MESSAGE_SPOOL" ALTER COLUMN "ingress-flow-count" SET DATA TYPE BIGINT;
ALTER TABLE "SOL_MESSAGE_SPOOL" ALTER COLUMN "queue-topic-subscriptions-used" SET DATA TYPE BIGINT;
ALTER TABLE "SOL_MESSAGE_SPOOL" ALTER COLUMN "spool-files-total-used" SET DATA TYPE BIGINT;
ALTER TABLE "SOL_MESSAGE_SPOOL" ALTER COLUMN "transacted-sessions-used" SET DATA TYPE BIGINT;
ALTER TABLE "SOL_APPLIANCE" ALTER COLUMN "num-messages-spooled" SET DATA TYPE BIGINT;
ALTER TABLE "SOL_APPLIANCE" ALTER COLUMN"total-clients-connected" SET DATA TYPE BIGINT;
ALTER TABLE "SOL_ENDPOINT" ALTER COLUMN "num-messages-spooled" SET DATA TYPE BIGINT;
ALTER TABLE "SOL_VPN" ALTER COLUMN "connections" SET DATA TYPE BIGINT;
ALTER TABLE "SOL_VPN" ALTER COLUMN "total-unique-subscriptions" SET DATA TYPE BIGINT;
ALTER TABLE "SOL_VPN" ALTER COLUMN"num-messages-spooled" SET DATA TYPE BIGINT;

MySQL

ALTER TABLE "SOL_MESSAGE_SPOOL" MODIFY "ingress-flow-count" BIGINT;
ALTER TABLE "SOL_MESSAGE_SPOOL" MODIFY "queue-topic-subscriptions-used" BIGINT;
ALTER TABLE "SOL_MESSAGE_SPOOL" MODIFY "spool-files-total-used" BIGINT;
ALTER TABLE "SOL_MESSAGE_SPOOL" MODIFY "transacted-sessions-used" BIGINT;
ALTER TABLE "SOL_APPLIANCE" MODIFY "num-messages-spooled" BIGINT;
ALTER TABLE "SOL_APPLIANCE" MODIFY "total-clients-connected" BIGINT;
ALTER TABLE "SOL_ENDPOINT" MODIFY "num-messages-spooled" BIGINT;
ALTER TABLE "SOL_VPN" MODIFY "connections" BIGINT;
ALTER TABLE "SOL_VPN" MODIFY "total-unique-subscriptions" BIGINT;
ALTER TABLE "SOL_VPN" MODIFY "num-messages-spooled" BIGINT;

SQL Server

ALTER TABLE [SOL_MESSAGE_SPOOL] ALTER COLUMN [ingress-flow-count] BIGINT;
ALTER TABLE [SOL_MESSAGE_SPOOL] ALTER COLUMN [queue-topic-subscriptions-used] BIGINT;
ALTER TABLE [SOL_MESSAGE_SPOOL] ALTER COLUMN [spool-files-total-used] BIGINT;
ALTER TABLE [SOL_MESSAGE_SPOOL] ALTER COLUMN [transacted-sessions-used] BIGINT;
ALTER TABLE [SOL_APPLIANCE] ALTER COLUMN [num-messages-spooled] BIGINT;
ALTER TABLE [SOL_APPLIANCE] ALTER COLUMN [total-clients-connected] BIGINT;
ALTER TABLE [SOL_ENDPOINT] ALTER COLUMN [num-messages-spooled] BIGINT;
ALTER TABLE [SOL_VPN] ALTER COLUMN [connections] BIGINT;
ALTER TABLE [SOL_VPN] ALTER COLUMN [total-unique-subscriptions] BIGINT;
ALTER TABLE [SOL_VPN] ALTER COLUMN [num-messages-spooled] BIGINT;


Solace Event Module Logging

or upward compatibility, if the projects/rtview-server/soleventmod.log4j2.properties file is not found, the rtvapm/soleventmodule/config/log4j2.properties file will be used instead. However, users upgrading from previous versions who have modified the logging settings should apply their logging changes to the soleventmod.log4j2.properties file in projects/rtview-server in order to make it easier to upgrade to future releases.

Apache Kafka

Alter the Kafka history database tables as described in TN24206.

SolacePubSubMonitor

The Solace PubSub+ Monitor file structure has been refactored. Review the release note for TN23877 for a list of all changes.

  • Download the new deliverable and extract it in a new directory on the same system as your old deliverable

  • In the new deliverable, make a backup copy of the projects directory.

  • In the new deliverable, make a backup copy of the bin directory.

  • If you have a permanent license, copy the following file from the old installation to the new installation:

rtvapm/rtview/lib/KEYS

  • If you modified the scripts under RTViewSolaceMonitor\bin in the old installation, reapply those changes to the scripts under SolacePubSubMonitor. Do not copy the scripts from the old installation to the new installation as they have all changed to work with the new directory structure.

  • If you modified any files under projects\custom in your old installation

– The following files under projects\custom were changed between 5.1 and 5.2. If you modified them in your old installation, reapply the changes to the new versions of the files:

projects/custom/src/make_classes.bat

projects/custom/src/make_classes.sh

– Copy any other java files you modified from projects/custom/src/com/sl/rtvapm/custom in the old installation to the new.

– Execute make_classes.bat or make_classes.sh in an initialized command prompt to rebuild your custom classes against the new release.

  • The following files under projects/rtview-server were changed between 5.1 and 5.2. If you modified them in your old installation, reapply the changes to the new versions of these files.

update_wars.bat

update_wars.sh

  • Copy all files not mentioned in the previous step under projects/rtview-server from the old installation to the new installation.

  • Execute projects/rtview-server/update_wars in an initialized command prompt and copy the generated jars to SolacePubSubMonitor/apache-tomcat-*-sl/webapps or your application server.

  • The following files under projects/rtview-manager were changed between 5.1 and 5.2. If you modified them in your old installation, reapply the changes to the new versions of these files:

update_wars.bat

update_wars.sh

  • The following files under projects/rtview-manager were changed between 5.1 and 5.2. These are modified via the Configuration Application. Any changes you made to the rtview-manager via the Configuration Application in the previous release will be addressed in a later step.

project.properties

project.properties.json

  • Copy all files not mentioned in the previous 2 steps under projects/rtview-manager from old to new.

  • Execute projects/rtview-manager/update_wars in an initialized command prompt and copy the generated jars to SolacePubSubMonitor/apache-tomcat-*-sl/webapps or your application server.

  • In the previous installation, projects/rtvservers.dat was used for both projects/rtview-server and projects/rtview-manager. In the new installation, this has been split into projects/rtview-server/rtvservers.dat and projects/rtview-manager/rtvservers.dat. If you modified the projects/rtvservers.dat in your previous installation, apply the Solace monitor changes to projects/rtview-server/rtvservers.dat and the RTView Manager changes to projects/rtview-manager/rtvservers.dat.

  • If you are using the Solace Event Module

– Copy rtvapm\solmon\soleventmodule\conf\soleventmodule.properties from your old installation to your new installation to keep your old configuration. This configuration has been moved the Solace DATA COLLECTION tab of the Configuration Application. The next time you run the Configuration Application and save your properties files, the properties will be automatically transferred to rtview-server/project.properties*. After that, the soleventmodule.properties file will no longer be used and all further configuration changes to the Solace Event Module must be done through the Configuration Application.

– Copy the rtvapm\solmon\soleventmodule\config\log4j2.properties file in your old installation to projects\rtview-server\soleventmod.log4j2.properties in the new installation. All further changes to the Solace Event Module logging configuration should be done in projects\rtview-server\soleventmod.log4j2.properties.

  • If using HSQLDB, copy projects/DATA in your old installation to projects/DATA and projects/rtview-manager/DATA in your new installation.

  • Add new CacheMetric column to your alert database as described in the release note for TN24246

  • Alter the Solace history database tables as described in the release note for TN24464.

  • If your previous installation included LDAP integration

– Copy apache-tomcat-*-sl/lib/ldapUser.jar from the old installation to the new installation.

– Copy apache-tomcat-*-sl/conf/server.xml from the old installation to the new installation.

– Copy apache-tomcat-*-sl/conf/Catalina.properties from the old installation to the new installation.

  • If you modified rtvapm/common/conf/sl.log4j.properties in your old installation, copy the sl.log4j.properties file from your old installation to projects/sl.log4j.properties. All changes to the logging configuration should be made in projects/sl.log4j.properties.

  • Start up the new installation using the start_servers script under bin.

  • If you entered secure connection properties in the CUSTOM PROPERTIES tab in the RTView Configuration Application, they will continue to work with no changes. However, it is recommended that you remove those properties from the CUSTOM PROPERTIES and enter them in the Solace CONNECTIONS tab for easier editing in the future. The truststore information can be entered on the SECURITY tab.

  • If you made changes to the rtview-manager using the configuration application in your previous installation:

– Open the configuration application at http://localhost:3070/rtvadmin.

– Use rtvadmin/rtvadmin for the login.

– Click SAVE at the top, the Restart Servers to save and apply your changes.

– Click on the RTView Manager server and reapply all changes you made in the previous version.

Alert Notification

In previous releases, any notification other than executing the my_alert_actions scripts had to be configured on the CUSTOM PROPERTIES tab of the RTView Configuration Application. If you are running a project configured with a previous release that has alert notifications defined in the CUSTOM PROPERTIES tab, they will continue to work as they did before with no changes. However, if you want to use the new Alert Notification configuration page, you will need to first delete the CUSTOM PROPERTIES for alert notifications, then recreate them in the Alert Notification page. Otherwise, the CUSTOM PROPERTIES will override the settings in the Alert Notification page.