Geneos Upgrade Notes

Netprobe and Collection Agent

• 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.

  Important

  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

  • Combo

  • Component Versions

  • DQM Compare, DQM Updates

  • Effix Status

  • Fix Cameron Status

  • Gissing

  • RTIC Latency

  • SWX

  • Triarch Latency

  • UL Bridge

• 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

  • MISS-X

  • PATS Status, PATS Trading Breaches, PATS Users

  • SETS SLC

  • SU

  • Tradeview

• 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 Windows platform is now more consistent with other Unix 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 Windows 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.

Gateway

• 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 and Obcerv connectivity

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.

Updated Refinitiv RTDS Integration

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.

Apache Log4j library

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.

Apache Log4j library

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.

Dynamic Entity mapping

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

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.

Netprobe package files per platform

Beginning Geneos 5.9.1, the libssl.so.1.1 and libcrypto.so.1.1 libraries are renamed to libsslgeneos.so.1.1 and libcryptogeneos.so.1.1 respectively for generic Linux and Linux on IBM POWER8 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 Linux, the runtime loader of Linux (ld.so) ignores the RPATH and 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>/lib64 has 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 Linux.

• When /usr/lib64 or 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/lib64 directory. Therefore, they might not be compatible.

Geneos components

The additional HTTP security headers are now applied to all web responses sent on the Geneos communication ports (EMF2 ports):

• X-Frame-Options: sameorigin

• X-XSS-Protection: 1; mode=block

• X-Content-Type-Options: nosniff

• Strict-Transport-Security: max-age=31536000; includeSubDomains

This applies to all Geneos components including debug and ORB pages generated by Netprobes and Gateways.

Licence Daemon

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.

Gateway and Licence Daemon

Both Gateway and Licence Daemon are not compatible with RHEL 6.x (kernel 2.6.32). Both components now require at least RHEL 7.x or higher.

Web Dashboard

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.

Express Report

Beginning Geneos 5.8.x, the Express Reports feature of Gateway is no longer available.

This feature will continue to be available and supported for Geneos 5.7.x and older until its end of life (EOL) date on 31 December 2021.

Publisher plugin

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.

Hardware plugin

The following metrics in the Hardware plugin have been changed:

• ntpAvailability is now timeSyncSource.

• ntpLocalClockOffset is now timeSyncOffset.

For more information, see Hardware documentation.

IBM i plugin

Beginning Geneos 5.7.x, the severityCodeFilter metric and filters > queueNameFilter configuration in the IBM i Queue plugin have been deprecated.

The new filters for Queue library and Queue name replaces the filters > queueNameFilter.

Web Dashboard

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.

Dynamic Entities

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 2 minutes to 1 hour.

• 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 2 minutes.

Gateway publishing to Gateway Hub

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.

New binary file name for Geneos third-party plugins

The binary file naming convention in ITRS Downloads has been changed from <plugin><version>.tar.gz to <plugin>-<version>.tar.gz. This change applies to all Geneos versions.

New ITRS Maven repository

The ITRS Maven repository has changed its location from <url>https://itrsgroup.bintray.com/collection</url> to <url>https://maven.itrsgroup.com/repository/public</url>. Please update all the existing links as they will stop working by end of February 2021.

New workspace directory in Active Console

Beginning Geneos 5.6.x, Active Console now sets the new workspace default directory to the following paths:

• On Windows: ~\ITRS\ActiveConsole

• On macOS and Linux: ~/ITRS/ActiveConsole/

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.

New binary file name for Geneos components

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 to geneos-<component>-<version>-<os>.tar.gz. This change applies beginning Geneos 5.5.x.

Self-monitoring in Geneos

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.

E4JMS plugin

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.

File Keyword Monitor plugin

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:

• Regular expressions
• Notable differences between POSIX and PCRE

State Tracker plugin

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.

Dynamic Entities

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.

Gateway and Licence Daemon

If you are upgrading to Gateway 5.2.x or higher, you must also upgrade Licence Daemon to version 5.2.x or higher.

StatsD Plugin

The StatsD configuration in the packaged Collection Agent (collection-agent.yml) now uses the default protocol UDP and port 8125. Previously, this was set to protocol TCP and port 7780.