These release notes are for the xMatters 5.1 release:
Release version: PATCH-510-009
Release date: March 24, 2015
To download the latest version, see the xMatters 5.x Product Suite page.
NOTE: This document is subject to change after the initial release. If you would like to be alerted when the document is modified, click Follow above this article.
This release of xMatters offers the following deployment options:
- You can install this release as a new xMatters version 5.1 deployment (i.e., you do not need to install a previous version of xMatters);
- You can use this release to patch an existing xMatters 5.x deployment up to xMatters version 5.1 patch 009 (in this case, this release should be applied to all xMatters application nodes, notification nodes, web servers, and to the Data Sync server, if applicable); or,
- You can use the included database migration tool to upgrade from xMatters 4.1 patch 023 directly to xMatters version 5.1 patch 009 (for more information and complete migration tool instructions, refer to the xMatters 5.x Documentation).
This release addresses a vulnerability discovered within Apache Commons, and requires an update to the epic-server directory. For more information, see the Warning below.
The following table lists the issues addressed since the most recent patch release and included in this version of xMatters. To see details about an issue, click the related link in the Details column:
|XFO-6898||SMPP logging is inaccurate||Details|
|VOR-1205||Updated Apache Commons||Details|
|SCO-7626||Holiday coverage does not cover holiday||Details|
|SCO-7460||Replay Event feature enabled for scenario-based events||Details|
|ARCH-3950||Multiple connections on an invalid provider causing out-of-memory errors||Details|
The following instructions describe how to use the installer to patch an existing xMatters 5.x deployment and upgrade it to version 5.1 patch 009. For information about installing a new xMatters 5.x deployment, see the xMatters 5.x Documentation.
Apply this patch to all xMatters application nodes, notification nodes and web servers (and any Data Sync installations, if applicable).
Installer files included with this release:
For use on:
Note that this installer file also requires a 32-bit JRE.
For use only on supported Microsoft Windows systems that are using a 64-bit JRE, and which will not require PSTN/Dialogic support.
Warning: Existing integrations
When applying an xMatters patch to an existing installation, the patch may overwrite some files that were already modified for an integration. This may cause the integration to stop working. If this occurs, using the integration documentation, re-apply the configuration changes and validate the integration. (See also Integration stops working after applying patch.)
Warning: Configuration file changes
When applying an xMatters patch, any changes you have made to the parameters in any of the configuration files may not be retained. The patch may overwrite modifications to some or all of the following files:
Any changes you may have made according to the information in the xMatters installation and administration guide will need to be reapplied.
Warning: Database changes
If you are upgrading from an older version, be aware that this patch includes database changes that may impact your replication mechanism (consult with your database administrator for further details).
These patches may also include updates to the database audit tables that can take an extreme amount of time to adjust when applying the patch. It is highly recommended that you clear the audit data (i.e., archive all your runtime data by running the Clear Runtime/History job in the web user interface) before installing any xMatters patch to reduce the amount of time required for the patch to process the data.
Note that introducing new indexes to a database may cause an increase in the required storage space. This is a normal consequence of using indexes, and assists performance of the overall system.
Warning: Apache Commons vulnerability
A vulnerability in Apache Commons has been addressed by an update to the commons-collections.jar file. For both patching and new install cases, all occurrences of the commons-collections in the install folder should be version 3.2.2 (commons-collections-3.2.2.jar), not 3.2 or 3.2.1.
This patch does not modify the epic-server directory. If you have previously installed the EPIC server, extract the latest epic-server.zip file into the /epic-server directory, and then manually remove the commons-collections-3.2.1.jar file from /epic-server/lib .
Before installing this patch:
- Shut down or stop all node processes.
- Shut down or stop all web server processes.
- Back up the xMatters Database.
- If you have made changes to the Template Company scripts, back up your script packages (see note about database changes, above.)
Note: If you are installing on Windows, you must run the installer as an administrator.
To install this patch:
1. Back up the xMatters installation directory (referred to as <xMHOME>).
- On Linux, the default install directory is:
- On Windows, the default install directory is:
C:\Program Files (x86)\xMatters\
2. Save the xMatters installer file to your local machine.
3. Open a command prompt and navigate to the directory containing the installer file.
4. Do one of the following:
- To run the installer in GUI mode, run the following command (replace <version> with i586 or x64, depending on your version of the installer):
java -jar xmatters-installer-<version>-5.1.9.jar
- To run the installer in console mode, run the following command (replace <version> with i586 or x64, depending on your version of the installer):
java -jar xmatters-installer-<version>-5.1.9.jar -console
5. The installer displays a welcome message; press Enter (console installation) or click Next (GUI installation) to continue.
6. Specify the location on the machine where the xMatters components are installed, and then press Enter or click Next to continue.
- The installer will inspect the current installation and determine whether the patch needs to be applied.
7. Next, the installer offers the following options:
- Back up the installation folder: Selecting this option will create a backup copy of the existing xMatters installation directory (by default, saved to /opt/xmatters.bak.1/)
- Remove old application log files and temporary folder: Selecting this option will remove the temporary folders and log files from the existing installation's web server cache.
8. Select the options you want, and then press Enter or click Next to continue.
9. The installer then checks the disk to determine whether there is enough space to continue with the installation; press Enter or click Next to continue.
10. Next, the installer displays a summary of your selected options and the components included in the patch process; press Enter or click Next to continue.
- The installer will then patch your installation. When it is complete, it displays a summary page, and gives you an option to generate an automatic installation script so you can patch other components using the same options. (For more information about the automatic installation script, see the xMatters installation and administration guide.)
After installing this patch:
- Start the Node processes.
- Start the web server processes.
- Database upgrades may take place after this patch is applied (i.e., during startup of xMatters components). The first component to be started will cause the database upgrades to be applied. This means that the subsequent startup of web servers and nodes may be delayed while they wait for the database updates to be completed. To monitor the progress of the updates, see "Determining the status of database updates", below.
Determining the status of database updates
To determine the current status of database updates, open the log file(s) associated with the first xMatters component being restarted. The default locations are shown; only one log will include the MUTEX entries. Note also the log level indicated in the messages below; if your logging level is not detailed enough, you will not see the log messages.
During component restart, you will see log entries similar to the following:
2009-01-21 22:07:02,251 [AlarmPoint Node-main] WARN - - Acquiring patch update MUTEX.
2009-01-21 22:07:21,685 [AlarmPoint Node-main] WARN - - Acquired patch update MUTEX.
2009-01-21 22:07:22,356 [AlarmPoint Node-main] WARN - - Package 1 of 8 (apod/oracle/01.xml)
2009-01-21 22:07:22,356 [AlarmPoint Node-main] WARN - - Statement 1 of 2: Executing SQL Statement.
2009-01-21 22:07:22,506 [AlarmPoint Node-main] WARN - - Statement 2 of 2: Executing SQL Statement.
2009-01-21 22:07:22,516 [AlarmPoint Node-main] WARN - - Package 2 of 8 (apod/oracle/02.xml)
2009-01-21 22:07:22,847 [AlarmPoint Node-main] WARN - - Package 8 of 8 (apod/oracle/finalize.sql)
2009-01-21 22:07:22,936 [AlarmPoint Node-main] WARN - - The database update scripts have been successfully processed and deleted.
2009-01-21 22:07:22,936 [AlarmPoint Node-main] WARN - - Patch update MUTEX released.1
After the message "Patch update MUTEX released" appears in the log, the database update has completed.
Note: If the log shows that the process has not proceeded from "Acquiring patch update MUTEX" to "Acquired patch update MUTEX" in a timely manner, ensure that there are no locks on the ORGS database table.
SMPP logging is inaccurate
An issue was reported with the SMPP functionality where no error was being logged if the connection was null or invalid. This was traced to a problem within the code responsible for logging the SMPP requests that was logging the message too early. The code was updated so that the outbound message was logged after the connection had been validated and the sending was about to occur, and new log messages were added to indicate whether the connection was null or invalid.
Updated Apache Commons
A potential vulnerability within Apache Commons was addressed by updating the included commons-collections.jar file to version 3.2.2. See Warning in the installation section, above.
Holiday coverage does not cover holiday
An issue was reported where notifications would occasionally not be sent to the appropriate holiday coverage. This was traced to an issue within the portion of the code responsible for checking holiday coverage status; this issue has been addressed.
Replay Event feature enabled for scenario-based events
An issue was reported with the Replay Event feature incorrectly being displayed on the Event Properties report for events that were generated by a scenario. This issue has been addressed.
Multiple connections on an invalid provider causing out-of-memory errors
An issue was reported where using multiple SMPP connections with a provider that does not support multiple connection on the same account could cause an out-of-memory error. This issue has been addressed, and this situation should now return an appropriate rejection message.
Appendix 2: Known Issues
xMatters 5.0 patch 007 included an upgrade to the included Java version from Java 6 to Java 7. The Automated-Speech-Recognition (ASR) functionality is currently not compatible with Java 7. If an xMatters deployment includes scripts that use ASR, the node will crash. The following are examples of script calls that use ASR:
(xMatters Reference: XFO-3472)
Some flavors of Linux with SELinux enabled will not run Java 7. After installing xMatters and trying to start the node, users may encounter an issue where Java fails to start, and an error similar to the following appears in log files:
Error: dl failure on line 864
Error: failed /opt/xmatters/staging/jre/lib/i386/server/libjvm.so, because /opt/xmatters/staging/jre/lib/i386/server/libjvm.so:
cannot restore segment prot after reloc: Permission denied
This is due to an issue with SELinux identifying the Java 7 libraries as a possible security threat. To resolve this issue, you must edit the /etc/selinux/config file and disable SELlinux.
(xMatters Reference: DTN-3158)
On Linux, serial modem Device Engines (TAP, GSM, etc.) that have experienced a connection failure due to a modem power failure (or deliberate power down) do not recover after the modem is powered on. Instead, to resolve the problem the node must be restarted. NOTE: this issue occurs only when Flow Control is set to "hardware".
(xMatters Reference: PRE-4832)
The xMatters Installer does not remove the Windows Services (i.e., the xMatters Webserver and the xMatters Node) when uninstalling. Instructions on how to manually remove the services have been added to the xMatters installation and administration guide, or are available on the Microsoft Windows Support site.
(xMatters Reference: XFO-2013, DTN-2960)
None in this release.