This document provides information about the product changes that can affect upgrading from one version of Geneos to another.
To learn more about the supported Geneos versions and new features in the Geneos 6.x release, see the following documents:
Upgrading to Netprobe 6.x requires you to also upgrade the Collection Agent and its plugins to version 3.x. The compatible versions of Collection Agent 3.x and its plugins are packaged with the Netprobe 6.x. The latest versions of Netprobe and Collection Agent are also compatible with updated Helm charts and Docker images.
The configurations, metric names, and dimensions of Collection Agent and its plugins have all changed. These changes are not backward compatible. See Upgrading to Collection Agent 3.x for more information.
The following Netprobe plugins, which are already deprecated and not supported, are now removed from Netprobe. These plugins no longer work in Geneos 6.0 and newer. However, the plugins may still continue to work in Geneos 5.x, but they remain unsupported. Please contact ITRS Support if you have any concerns.
Citrix Apps, Citrix Processes, Citrix Sessions, Citrix Summary
DQM Compare, DQM Updates
Fix Cameron Status
The following Netprobe plugins are now deprecated in configuration and are no longer supported. However, the plugins may still continue to work in Geneos 5.x and 6.x, but they remain unsupported. Please contact ITRS Support if you have any concerns.
GL Greffon, GL Lost Orders, GL Order Book, GL Permissions, GL SLC, GL SLC Relay, GL SLE, GL SLE TCP
PATS Status, PATS Trading Breaches, PATS Users
Market Data Monitoring (MDM) plugin in Netprobe 6.0.x and newer does not require an application key file (
mdm_appkey.txt) in the Netprobe directory to function. This additional requirement has been removed, but the plugin still requires a valid Licence Daemon token to function.
The dataview generated by the Netprobe CPU plugin on the platform is now more consistent with other platforms. This means the value in the first column of the dataview listing the name of the logical CPU has changed to
cpu_<num>_logical#<num>. This may break existing x-paths that reference the row name. Please check the Gateway configuration with reference to the CPU plugin dataview on the platform.
The Kubernetes specific Netprobe package (
geneos-netprobe-<version>-kubernetes.tar.gz) is no longer available to download from the ITRS Downloads website. Both the Kubernetes plugin and the template Gateway configuration for Kubernetes are now available in the standard Netprobe and the Gateway packages, respectively. We recommend that you set up Kubernetes monitoring using the Helm Charts available through ITRS Helm repository. See Installation using Helm for more information.
Geneos 6.0 introduced capabilities to centrally manage the Collection Agent configuration (
collection-agent.yml) in the Gateway through the Gateway Setup Editor. As part of this change, the Gateway Dynamic Entity configuration section has new settings to manage the Collection Agent. All changes in the Gateway configuration are backward compatible, meaning your current Gateway configuration remains valid when upgrading to Geneos 6.x. For more information, see Collection Agent Setup and Dynamic Entities.
Note: This feature requires Gateway and Netprobe version 6.x. It is also recommended you upgrade Active Console and Gateway Setup Editor to version 6.x.
If you upgrade Gateway to 6.0 or newer, you must use Active Console 5.4.x or newer due to changes in the way Gateway provides database connection details to Active Console. Older Active Console might still function, but they won't have the Gateway database connection information needed to query historical data from databases.
Gateway now adds a new self-monitoring entity named <probe-name> Netprobe Info for every Netprobe that is configured with Dynamic Entities. This is the default behaviour, but it can be disabled in the Operating Environment section of the Gateway configuration. This self-monitoring entity contains the Dynamic Entity Health views that are useful for understanding the data received from the Collection Agent and how that data is represented in Geneos.
Geneos 5.14.0 is the first fully supported release that is compatible with ITRS Obcerv 1.0. You might have deployed Geneos Gateway and Netprobe versions older than 5.14.0 to integrate with beta versions of Obcerv. There are several changes to both Netprobe and Gateway such as Publisher plugin settings and Obcerv connection settings, respectively. We recommend you upgrade to version 5.14.0 or newer to minimise any compatibility issues.
Geneos 5.14.0 includes an updated Refinitiv RTDS integration. This integration replaces the previous one from Geneos 4.9.0. It is recommended that Managed Entities using the old types are re-configured as there have been some structural changes and renaming as part of the rebranding exercise. For more information, see Refinitiv RTDS.
The Apache Log4j library in the Active Console, Web Dashboard, Terracotta Messaging integration, and VMware Monitor integration, has been upgraded to 2.17.1 to fix the security vulnerability in Apache Log4j (CVE-2021-44832). We recommend upgrading to the latest version Geneos 5.12.0 or newer.
Upgraded the Apache Log4j library to fix the following vulnerabilities:
The Apache Log4j library in the Active Console, Web Dashboard, Terracotta Messaging integration, and VMware Monitor integration, has been upgraded to 2.17.0 to fix the security vulnerability in Apache Log4j (CVE-2021-45105). We recommend upgrading to the latest version Geneos 5.11.3 or newer.
The Apache Log4j library in the Active Console, Web Dashboard, Terracotta Messaging integration, and VMware Monitor integration, has been upgraded to 2.16.0 to fix the security vulnerability in Apache Log4j (CVE-2021-45046). We recommend upgrading to the latest version Geneos 5.11.2 or newer.
The Apache Log4j library in the Active Console, Web Dashboard, Terracotta Messaging integration, and VMware Monitor integration, has been upgraded to 2.15.0 to fix the security vulnerability in Apache Log4j (CVE-2021-44228). We recommend upgrading to the latest version Geneos 5.11.1 or newer.
Netprobe 5.11.0 introduced changes to the Dynamic Entities wherein additional checks are now made to ensure new metric data points being added to an existing entity have a consistent set of dimensions and attributes. As a result of this change, your current Dynamic Entity mapping configuration may reject metric data points that were previously accepted.
You will see the rejected metric in the Dynamic Entity plugin dataview with the reason
Entity Dimension clash. Make sure that all metric data points mapped to a single entity have the same set of dimensions and attributes.
Further, Netprobe 5.11.0 removed the old Dynamic entities > Mappings configuration that was first introduced in Geneos 5.1.0. This configuration has already been deprecated and was replaced by more simplified Dynamic entities > Mapping configuration in Geneos 5.7.0.
Publisher plugin has been updated so that Success, Failed, and Lost columns no longer just accumulate the number of events. Instead, the columns now show the number of occurrence of each event for each sample interval. We recommend that you review the existing rules that you have set in the Publisher plugin configuration.
Beginning Geneos 5.9.1, the
libcrypto.so.1.1 libraries are renamed to
libcryptogeneos.so.1.1 respectively for generic and on platforms to eliminate the dependency of libcurl to these libraries, and to reduce compatibility issues such as the following scenarios:
When the Netprobe is run under elevated privileges in , the runtime loader of (
ld.so) ignores the
LD_LIBRARY_PATH, so the Netprobe is unable to load the libraries from
<netprobe directory>/lib64. For the libraries to be loaded, the path to
<netprobe directory>/lib64has to be added to the trusted paths of
ld.so. This can cause compatibility issues for other applications that run on the same machine. For more information, see Run Netprobe under elevated privileges in .
/usr/lib64or any library folder that has OpenSSL libraries is loaded before the
netprobe conf, files are loaded alphabetically in
/etc/ld.so.conf.d/*. These libraries are not packaged with Netprobe but are in the
/usr/lib64directory. Therefore, they might not be compatible.
The additional HTTP security headers are now applied to all web responses sent on the Geneos communication ports (EMF2 ports):
X-XSS-Protection: 1; mode=block
Strict-Transport-Security: max-age=31536000; includeSubDomains
This applies to all Geneos components including debug and ORB pages generated by Netprobes and Gateways.
Beginning Geneos 5.9.x, the Licence Daemon detailed report is not available by default. A new command line option
-report detail is required to enable a detailed report.
Geneos 5.8.2 introduced changes to the
security.xml file in the Web Server
config folder as a result of the upgraded Spring Security libraries.
When upgrading to Geneos 5.8.2 or newer, we recommend that you use this latest version of
security.xml and ensure that any previous
security.xml files are removed from your local machine. Otherwise, the Web Server will not run properly.
The Publisher plugin Elasticsearch configuration schema has been refactored to support additional publishing destinations.
The plugin configuration prior to version 5.7.1 is not compatible with versions 5.7.1 and higher. We recommend that you update the configuration after upgrading to Geneos 5.7.1 and higher.
The following metrics in the Hardware plugin have been changed:
For more information, see Hardware documentation.
Beginning Geneos 5.7.x, the
severityCodeFilter metric and filters > queueNameFilter configuration in the Queue plugin have been deprecated.
Web Dashboard requires the
fontconfig package to be installed in the system to start up. Beginning Geneos 5.7.x, Web Dashboard now uses Open Sans as its default font when a required font is not available in the system.
For more information, see Fontconfig dependency in Web Dashboard documentation.
The new and simplified mapping configuration replaces the Dynamic Mapping Configuration. Any existing configurations using the previous setup will continue to work. However, we recommend you migrate to the new Dynamic Entities > Mapping:
Dynamic entities > Mapping type > Entity timeout — the new default entity time out value is increased from
Dynamic entities > Mapping type > Stale data timeout — this is a new setting in this release to mark individual dataviews as containing stale data if the data has not been updated within the set timeout. The default is
Beginning Geneos 5.7, Gateway supports publishing data to Gateway Hub without schema. This schema-less publishing of data from Gateways is supported beginning Gateway Hub 2.4.x.
If you upgrade your Gateway to version 5.7.x or higher and you have many dataviews in the Gateway without a valid schema, then it is recommended that you also upgrade Gateway Hub to version 2.4.x or higher to take advantage of the automatic inference of schema in the Gateway Hub. Gateway Hub 2.3.x and older will continue to report ingestion errors if a dataview is published without a schema.
The binary file naming convention in ITRS Downloads has been changed from
<plugin>-<version>.tar.gz. This change applies to all Geneos versions.
The ITRS Maven repository has changed its location from
<url>https://maven.itrsgroup.com/repository/public</url>. Please update all the existing links as they will stop working by end of February 2021.
Beginning Geneos 5.6.x, Active Console now sets the new workspace default directory to the following paths:
The new default workspace directory is used when creating a new workspace, but all existing workspaces are not affected. For more information, see Workspace directory in Active Console.
As part of the improvements to automate our deployment process, the binary file naming convention in ITRS Downloads has been changed from
geneos-<component>-<version>-<os>.tar.gz. This change applies beginning Geneos 5.5.x.
Beginning Geneos 5.4.x, self-monitoring in Geneos is now enabled by default with no configuration required.
This results in an Entity being dynamically created called
<gateway_name> Info which contains samplers and dataviews that are automatically enabled with no configuration required. These samplers and dataviews are created using the existing Gateway plugins which you may already have manually configured in your Gateways.
If you do not wish the Gateway to automatically create a self-monitoring Entity, you can disable this feature in the Gateway > Operating environment section.
For more information, see operatingEnvironment > selfMonitoring in Gateway Operating Environment documentation.
Beginning Geneos 5.4.x, the E4JMS plugin supports SSL client authentication. This feature introduces breaking changes to the E4JMS plugin SSL implementation for older Geneos versions.
If you are using SSL connections on your E4JMS plugins, you must update your configuration when using the new schema.
For more information, see E4JMS Plugin Technical Reference.
Beginning Geneos 5.4.x, the FKM plugin uses Perl Compatible Regular Expressions (PCRE) by default. Be aware that this may introduce breaking changes in your implementation.
For more information, see the following documentation in the File Keyword Monitor:
The State Tracker > Rewind option in Gateway Setup Editor is now disabled by default.
For more information, see trackerGroup > trackers > tracker > rewind in State Tracker Technical Reference.
If you enable this option, this may cause a sudden increase in your CPU usage with no known changes in the monitored file. Since the State Tracker will track the monitored file from the beginning, and not when the file grows for new events.
Gateway, Netprobe, and Licence Daemon have each been updated to support licensing of Collection Agent plugins. All three of these components must be updated to Geneos 5.2.x or higher for the Dynamic Entities feature to be supported in Gateway.
Collection Agent plugins require an additional licence to use. Please contact your ITRS Account Manager or ITRS Sales.
If you are upgrading to Gateway 5.2.x or higher, you must also upgrade Licence Daemon to version 5.2.x or higher.
- The ITRS Maven repository has changed its location from
<url>https://maven.itrsgroup.com/repository/public</url>. Please update all the existing links as they will stop working by end of February 2021.
- Netprobe 5.1.x is not generally available to download except for Netprobe 5.1.0 -64 package certified for deployment on Solace devices. Please download version 5.2.x or newer for all other deployments.
- Support for Geneos 3.x ended on 30 April 2020. We strongly advise you to upgrade to version 4.x or newer as soon as possible.
- From the release of Geneos 5.0.x, there will be no interoperability with other Geneos components older than version 3.6.x. In order to successfully deploy or upgrade to Geneos 5.0.x in a staged manner, you must first ensure that no other connecting Geneos components are older than version 3.6.x. This change is a result of the removal of LZO compression support in the inter-component EMF2 communication protocol.
- Collection Agent plugins require an additional licence to use. Please contact your ITRS Account Manager or ITRS Sales.
If you have any question or concerns, please contact ITRS Support.
The Hardware plug-in now uses a new method of obtaining
memoryAvailablePct for platforms. The metrics are now based on the same calculation uses to calculate the
memAvailable field in
/proc/meminfo. For more information, see the Hardware Plug-in documentation.
Ensure that any affected Gateway rules and thresholds are reviewed.
Gateway 5.0 cannot publish data to Gateway Hub 1.4 or older versions. This is due to the changes in the publishing format in order to improve performance.
Gateway Setup Editor now enables the Simplified Comments by default. With
simplifiedComments enabled, GSE removes all icons that indicate comments. You can only add, edit, or remove comments on named components in the Navigation panel.
The API for centralised configuration has changed since Early Access. Upgrade to Gateway 5.0 to use the centralised configuration with Gateway Hub 1.6 and above. For more information, see Centralised Gateways User Guide.
Active Console 5.0 now supports a new light theme user interface. The Look and Feel in the Advanced settings has been removed.
Beginning with version 5.0, these Gateway settings are deprecated:
- Managed Entity > Banner (Advanced tab)
- Sampler > Publish (Visibility tab)
Changes to default Gateway configuration in version 5.0:
- DatabaseLogging > logNetprobeSampleTimeForDataItems default is now True.
- Actions > action > sharedLibrary > runThreaded default is now True.
- Effects > effect > sharedLibrary > runThreaded default is now True.
In the Gateway, the behaviour of the
_COMMENT environment variable has changed for actions fired by the unassignment of a data item. Previously, the comment provided when the item was assigned was placed in the
_COMMENT environment variable for both assignment and unassignment events. It is now possible to configure Gateways to require comments for both assignment and unassignment events. This means for actions fired by unassignment events, the comment provided when the item is unassigned is placed in the
_COMMENT environment variable. The comment that was provided when the item was originally assigned is now moved to a new environment variable called
Improved the Context Sensitive Help (CSH) for Gateway Setup Editor (Gateway Setup Editor) that is based on the specific content available online. Context sensitive help will launch your default browser to access the content online. To know more about this, see Host the documentation locally to use GSE context-sensitive help in Gateway Setup Editor.
Geneos 4.7.x release introduces changes to the way arguments are parsed to Commands, Actions, and Effects.
These changes were required to provide consistent behaviour and understanding across both Netprobe and Gateway to simplify user experience.
We strongly recommend you check the configuration and behaviour of any Commands, Actions, and Effects before deploying to production.
For more information, see Commands, Actions and Effects.
The following changes are introduced to Geneos 4.0.x packages:
- Name of the package file is
- For example,
- For example,
- Packages contains a root directory <component>.
- Libraries are located within a sub-directory named