Overview
Gateway Hub release notes contain the list of enhancements of features, and a set of issues fixed in the current release.
This page contains release notes for all Gateway Hub 2.x releases.
For the latest highlights, see What's New in Geneos.
Gateway Hub 2.2.1
Released: September 2020
This release delivers the updated binaries for Gateway Hub in the ITRS Downloads page.
New features and enhancements
These are the new features and enhancements of this release:
| Issue key | Release description |
|---|---|
| STARK-13070 | Kafka retention settings are now configurable during installation. |
| STARK-14393 | The Kafka log format now aligns with other components. |
| STARK-14396 | Log formats are now consistent across all Gateway Hub components. |
| STARK-14599 | Application log retention settings are now configurable during installation. |
Issues fixed
These are the issues we have fixed in this release:
| Issue key | Release description |
|---|---|
| STARK-11874 | Log entries are now displayed in UTC instead of local time. |
| STARK-14582 | Memory now correctly allocated for machines with 16 GB memory. |
| STARK-14648 | If installation.connection.user is not specified, the Hub checker now uses hub.user when connecting to the remote node. |
| STARK-14679 | Chart axes and tooltips in the Entity metrics view no longer report duplicate rounded values. |
| STARK-14680 | Web Console no longer displays 401 errors when multiple cookies are available for the same domain. |
Gateway Hub 2.2.0
Released: August 2020
This release delivers the updated binaries for Gateway Hub in the ITRS Downloads page.
Highlights
These are the highlights of this release:
- Simplified Gateway Hub installation
- SAML security
- Capacity Planner integration
Gateway Hub 2.2.x is a significant upgrade, further simplifying the installation process, and reducing the software and hardware requirements. Although the look and feel of the Web Console remains largely the same, it is now far simpler to deploy. The hardware requirements for Gateway Hub have been decreased further, though as always, additional hardware will provide better performance.
Simplified installation
Gateway Hub is now deployed as a single tar file, with a simple Ansible script for installing the relevant components. Typical installations will take a few minutes, and root access is not required.
For more information, see Install in Gateway Hub documentation.
SAML security
A new security scheme, SAML has been introduced, providing simpler integration with compatible security infrastructures. SAML authentication also allows access to the Web Console outside the firewall for environments that permit this. In order to use SAML authentication, you must map the LDAP (or equivalent) groups to a field in the SAML token typically memberOf.
For more information, see SAML configuration in Gateway Hub documentation.
Capacity Planner integration
Integration with ITRS Capacity Planner is now provided via a new app, allowing capacity data to be sent to Capacity Planner with minimal configuration required. The Capacity Planner app supersedes the Capacity Planner Helper plugin.
For more information, see Capacity Planner app configuration in Gateway Hub documentation.
New features and enhancements
These are the new features and enhancements of this release:
| Issue key | Release description |
|---|---|
| STARK-12078 | Business hours are now configurable instead of having a fixed value of 9-5. |
| STARK-12815 | The granularity of all charts has been increased. |
| STARK-12973 | Stacked area chart visualisation is now available on the Web Console. |
| STARK-13084 | Web Console now has better handling of concurrent updates to dashboards. |
| STARK-13475 | You can now deselect metrics in the entity monitoring screen to clear the history chart and show all events relevant for that entity. |
| STARK-13494 | The Events overlay in the monitoring screen now shows aggregated error information. |
| STARK-13602 | You can now import and export dashboards in the Web Console. |
| STARK-13619 | The System Errors screen is no longer available in the Web Console. |
| STARK-13840 | Gateway Hub now supports RHEL 7.8. |
| STARK-14546 | Gateway Hub no longer requires to be disabled. |
Issues fixed
These are the issues we have fixed in this release:
| Issue key | Release description |
|---|---|
| STARK-11343 | Autocomplete now correctly handles the keywords EXISTS and NOT EXISTS. |
| STARK-12371 | Webhooks are correctly displayed as read-only for Operators. |
| STARK-13190 | Error message no longer displays after a Webhook is deleted. |
| STARK-13275 | The entity filter autocomplete is now displayed correctly when the NOT IN keyword is used. |
| STARK-13466 | Show in dashboard control improved for dashboards with long names. |
| STARK-13477 | Dashboard panels referring to missing metrics no longer show a loading indicator. |
| STARK-13609 | Gateway IDs are no longer assigned sequentially. |
| STARK-13696 | The certificate chain is now correctly generated when using self-signed certificates. |
| STARK-13941 | Gateway Hub now supports Oracle JRE. |
| STARK-13945 | Editing a dashboard name no longer deletes unsaved widgets. |
| STARK-14532 | Web Console now uses 8443 as its default HTTPS port. |
Gateway Hub 2.1.2
Released: June 2020
This release delivers the updated binaries for Gateway Hub in the ITRS Downloads page.
New features and enhancements
These are the new features and enhancements of this release:
| Issue key | Release description |
|---|---|
| STARK-13762 | Manually triggered data retention jobs now finish considerably quicker than before. |
| STARK-13761 | Snapshot and API daemon logging has been reduced, resulting in smaller disk usage. |
Gateway Hub 2.1.1
Released: June 2020
This release delivers the updated binaries for Gateway Hub in the ITRS Downloads page.
Gateway Hub 2.1.0
Released: May 2020
This release delivers the updated binaries for Gateway Hub in the ITRS Downloads page.
New features and enhancements
These are the new features and enhancements of this release:
| Issue key | Release description |
|---|---|
| STARK-13386 | The Events browser chart now provides more granular data. |
| STARK-13340 | The entity filter parameter in the Grafana datasource plugin no longer requires quotes. |
| STARK-13302 | Percentiles are now displayed more compactly, for example p95. |
| STARK-13245 | The Grafana datasource plugin now supports Entity queries. |
| STARK-13244 | The Grafana datasource plugin now supports Event queries. |
| STARK-13237 | GPG keys are now correctly removed when uninstalling. |
| STARK-13205 | Gateway Hub diagnostic files now include syslog. |
| STARK-13199 | Metric queries now have improved performance. |
| STARK-13184 | Entity metrics can now be filtered by typing in the column headers in the Web Console. |
| STARK-13078 | The Dashboard home list now shows Dashboard descriptions. |
| STARK-13053 | Dashboard panels can now display metrics filtered by row name. |
| STARK-13047 | Users with Operator privileges can no longer modify other users' dashboards when SSO is enabled. |
| STARK-13046 | Dashboard panels now support the following aggregations: first, last, p1, and p99. |
| STARK-13042 |
You can now set the output of an entity query as a Global parameter in a Dashboard. Panels can be configured to use the Global parameter. This allows you to quickly switch the targets of panels from one entity to another. |
| STARK-12974 | Area charts are now available in Dashboard panels. |
| STARK-12907 | Dashboard metric selector has been made more compact. |
| STARK-12838 | Gateway Hub can now handle entities with large numbers of metrics, for example 10,000+. |
| STARK-12732 | Infinity and negative infinity values are now handled correctly. |
| STARK-12712 | Hub checker no longer checks Spark configuration. |
| STARK-12642 | The Gateway config UI now displays the Gateway validation messages when include files are assigned. |
| STARK-12058 | Gateway Hub no longer supports using a KeyStore and TrustStore to configure TLS/SSL. You must provide PEM files instead. |
| STARK-12045 | All hosts must now be specified using fully qualified domain names (FQDNs). IP addresses are no longer accepted as these cause SSL issues. |
| STARK-9804 | The Dashboard list is now searchable. |
| STARK-9182 | The entity overview metric table now displays a floating header. |
| STARK-5997 |
You can now display the expected normal bounds when viewing metric history charts. This allows you to compare current values with the expected values based on historical data. |
Issues fixed
These are the issues we have fixed in this release:
| Issue key | Release description |
|---|---|
| STARK-13496 | Gateway Hub's data retention processes no longer causes NoClassDefFoundError errors. |
| STARK-13373 | Restarting Gateway Hub is now less likely to result in apid errors. |
| STARK-13351 | TimescaleDB packages included in the Gateway Hub installer are now signed correctly. |
| STARK-13347 | The Web Console no longer incorrectly shows an Enable storage to show historical data prompt when viewing an entity without historical data. |
| STARK-13322 | Hub checker now correctly fails if a non-existing child device is supplied as a MapR disk. |
| STARK-13312 | Dashboard text panels now correctly show their text contents. |
| STARK-13304 | Hub checker now correctly accepts 7.7.1908 as a supported version. |
| STARK-13301 | Dashboard metric charts no longer interpolate empty buckets. |
| STARK-13289 | Hub checker now correctly fails when mapr_disks is not set. |
| STARK-13278 | Hub checker no longer reports a false positive for a missing Java runtime when installing as root. |
| STARK-13277 | Hub checker now correctly handles blank lines in the hosts file. |
| STARK-13268 | Hub checker no longer requires disks to be located in the /dev directory. |
| STARK-13249 | Hub checker now tests for syslinux as a prerequisite. |
| STARK-13222 | Removing a Managed Entity no longer causes a crash in the normaliser. |
| STARK-13220 | Hub checker now correctly handles non-existing disks. |
| STARK-13219 | Hub checker will no longer allow partitioned disks for MapR. |
| STARK-13193 | Adding an include file through the Gateway config UI no longer adds an empty include group. |
| STARK-13119 | Open API definitions now correctly refer to Roles rather than Groups. |
| STARK-13100 | Dashboard errors now clear after some time has elapsed. |
| STARK-13099 | The Dashboard panel KPI preview now correctly reflects the user's timezone. |
| STARK-13089 | The Open API documentation now correctly shows the ITRS-Doc-Version. |
| STARK-13085 | Displaying a tooltip is now easier for metric charts with a single point. |
| STARK-13068 | The Dashboard header now follows the page when scrolling. |
| STARK-13035 | KPI icons are now optional. |
| STARK-12609 | The Gateway config UI now identifies locked Gateways and resources. |
| STARK-12597 | Dashboard panels now account for the user timezone correctly. |
| STARK-12521 | Changing a Dashboard panel's visualisation type will no longer reset the title and description. |
Gateway Hub 2.0.0
Released: 8 April 2020
This release delivers the updated binaries for Gateway Hub in the ITRS Downloads page.
Note: Upgrading from Gateway Hub 1.x.x to 2.0.0 is not currently supported.
Highlights
These are the highlights of this release:
- Dashboards
- Metric query improvements
- Reduced hardware requirements
- Centralised configuration UI
Dashboards
The Web Console now includes Dashboard functionality for easy visualisation of metrics and their related events. This release includes line charts, bar charts, KPIs, and table visualisations.
Metric query improvements
Metric storage and query performance has been improved. Queries that previously took up to a minute now take a few seconds or less. This is due to a change in the way that metric data is being stored, as well as various improvements to how metric data is being retrieved.
Reduced hardware requirements
Another benefit of improved query performance is reduced hardware required to run the Gateway Hub. The minimum memory requirements have decreased from 32 GB to 16 GB, and the disk space required for storage has also decreased.
The Gateway Hub sizing tool has been updated to account for these new minimums, although it is important to note that just like with all software, better hardware will result in better performance.
Centralised configuration UI
A new administration UI is provided for centralised configuration. Although the Gateway Setup Editor is still the best place to work with include files directly, the new Web Console pages provide some additional tools such as the ability to see which Gateways are using which includes and vice versa. It also provides the ability to see the history of include files, including the diffs between versions, as well as a UI tool to upload Gateway binaries to Gateway Hub, which is required for centralised setup validation.
New features and enhancements
These are the new features and enhancements of this release:
| Issue key | Release description |
|---|---|
| STARK-13034 | Added a View in Dashboard control to the Events viewer, allowing the current entity date filters to be passed to a dashboard. |
| STARK-12685 | Gateway Hub no longer requires JDK for installation. JRE is now sufficient to install. |
| STARK-12454 | A tooltip has been added to the Events overlay in metric history charts. |
| STARK-12419 |
Additional pre-install checks were added:
|
| STARK-12295 | Entities that have been grouped by severity are now displayed in decreasing order of severity instead of by count. |
| STARK-12117 | A legend has been added to the Events chart in the Web Console. |
| STARK-11134 | Creation time was added to the Events result table in the Web Console. |
| STARK-11098 | First and Last aggregations have been added. |
| STARK-10296 | Web Console no longer displays generic 401 error messages when a more specific error is available from the backend. |
Issues fixed
These are the issues we have fixed in this release:
| Issue key | Release description |
|---|---|
| STARK-13142 | Significantly decreased storage requirements for events. |
| STARK-13117 | The documentation link in the About page of the snapshot versions of the Web Console (used in the snapshot versions of MiniGeneos) now correctly points to the latest published version of the documentation. |
| STARK-13088 | Fixed a null pointer exception when Webhooks is publishing events from dataview headlines. |
| STARK-13023 | Added ITRS-Doc-Version that was missing from the API definition for GET /documents/{id}. |
| STARK-12936 | The Events chart tooltip now works correctly. |
| STARK-12782 | Gateway Hub install checker now handles multiple Kafka directories correctly. |
| STARK-12750 | Empty entity filters can no longer be set in the Web Console Monitoring home page. |
| STARK-12652 | Events screen chart X-axis no longer overflows the panel. |
Known issues
These are the known issues affecting this release:
| Issue key | Known issue description |
|---|---|
|
STARK-13180 |
For large scale deployments, the Gateway Hub 2.0.0 installer can set PostgreSQL These values are found in the When these values are too small the Hub will perform poorly for both ingesting and querying metric data. You will also see entries like the following in the PostgreSQL logs at 2020-04-07 09:08:35.566 UTC [26000] LOG: checkpoints are occurring too frequently (1 second apart). 2020-04-07 09:08:35.566 UTC [26000] HINT: consider increasing the configuration parameter To resolve the situation, do the following on each Hub node after installation:
|
|
STARK-6505 |
Gateway Hub will not correctly handle a dataview defined in a Gateway with columns
named sampleTime, netprobeTime, or
dataViewId. |
|
STARK-4463 |
Dataview data from additional rows computed in the Gateway is not stored for regular or non-computed columns. |
|
STARK-4350 |
Data that is received without a timestamp has a default timestamp incorrectly applied with the timezone of the local machine. |
Other Gateway Hub releases
| Gateway Hub 2.x Release Notes | Released: 8 April 2020 |
| Gateway Hub 1.x Release Notes | Released: 21 January 2019 |
Disclaimer: The information contained in this document is for general information and guidance on our products, services, and other matters. It is only for information purposes and is not intended as advice which should be relied upon. We try to ensure that the content of this document is accurate and up-to-date, but this cannot be guaranteed. Changes may be made to our products, services, and other matters which are not noted or recorded herein. All liability for loss and damage arising from reliance on this document is excluded (except where death or personal injury arises from our negligence or loss or damage arises from any fraud on our part).