Gateway Hub Release Notes 1.3


Released: 14 June, 2019

ITRS is pleased to announce the release of Gateway Hub 1.3.x.

This release delivers the updated binaries for Gateway Hub in the ITRS Downloads page.


Gateway Hub is a brand new component in the Geneos ecosystem, providing the foundations for smarter monitoring, improved scalability, and a refreshed modern UI. The main features in this release are:

  • An open query API for retrieving metric data.
  • A new directory for storing Entity information.
  • Centralised Gateway configuration.

Metric Query API

Metric data can now be retrieved using an open REST API call:

POST /metrics/query

This endpoint can be used to retrieve metric data, grouped by time bucket with a number of built in aggregations such as median, mean, and percentiles, supporting simpler display of large amounts of monitored data. As of version 1.3 this endpoint is tuned for reporting and results can take several minutes, which is a substantial improvement over querying a relational database. Performance will be improved further in a future release.

A list of the aggregation functions is available using the following REST API call:

GET /metrics/aggregations

An OpenAPI definition is now available for these endpoints. Further documentation on using the metric query endpoints can be found here.

Entity Directory

This release marks the first version of the Entity directory, providing the basis for the next generation of the state tree. The entity directory brings a number of significant advantages over the existing Geneos state tree, including:

  • Support for significantly larger monitored estates
  • Better analysis and retrieval of data across groups of similar servers

The entity store is an important part of our long term goal to simplify the data model, in particular removing Gateways and Netprobes from the XPath hierarchy and moving towards dealing with Entities and Metrics only. This will have a number of benefits, including easier configuration of Self-announcing Netprobes that rebalance across different Gateways frequently, as well as ultimately simplifying the way monitoring is configured in Geneos. Although the existing state tree will remain available for existing setups, over time we anticipate you will choose to switch to the simpler model.

In 1.4 the Entity Directory will also serve as the backbone for the new web-based monitoring UI.

For more information about the improved data model, see Introduction to Entities and Metrics.

Centralised Gateway Configuration

Gateway Hub can now store and serve Gateway configuration centrally. This version allows include files to be uploaded to Gateway Hub and used by connected Gateways. This is the first step in the journey to significantly simplify administration of Gateways at scale. More features will be added in the coming release, including centralised validation and locking, as well as administration UI screens in the Web Console.

For more information about this feature, see Centralised Gateways User Guide.

New features and enhancements

These are the features and enhancements in the current release:

Issue key Release description


JMX instrumentation by various components has now been secured.


Processing of schema messages from the Gateway has been substantially improved.


The style for snackbar error and information messages in the Web Console has been updated.


Web Console has improved handling of concurrency when changing configuration.


Added a confirmation modal when leaving a Web Console page with errors.


Improved design for system and ingestion error pages on mobile devices for the Web Console.


In the Web Console, save buttons are now disabled in the presence of validation errors.


Improved memory management for various Gateway Hub components.


The Archiving jobs have been combined into a single Spark job for increased performance.


A ITRS-Doc-Version HTTP header is required on all PUT endpoints, preventing concurrency issues. GET endpoints now return the current document version.


Password field types in the Web Console have been improved to allow better password input.


The documentation link in the About page is now correctly linked to the current Web Console version.


The Web Console will now preserve the collapsed/expanded status of the sidebar between sessions.


The status of Kafka publishing is now displayed in the publishing screen in the Web Console.


The Web Console now handles an unlicensed system better.


Ports are now configurable for Kafka, REST API, Web Console, SSO API, and MCS monitoring UI.


DD MMM YYYY has been added to the list of supported date formats in the Web Console.


MapR Enterprise Components (MEP) have been upgraded to 6.1.


The MapR instance underpinning Gateway Hub has been upgraded to 6.1.


System errors are no longer displayed alongside ingestion errors and have their own endpoint and Web Console screen instead.


The Kafka offsets have been removed from ingestion errors and replaced with the raw message, so that older errors did not become outdated by Kafka rebalances and retention settings.


The ingestion errors pages in the Web Console have been reworked for significantly better performance and robustness. Outdated links to old errors that have been resolved are now handled correctly.

Issues fixed

These are the issues we have fixed in the current release:

Issue key Release description
STARK-8991 Dataview columns and headline cells with a full stop/period in the name no longer cause an error when queried for metrics.
STARK-8931 Dataview columns with backticks (`) in the name no longer cause the archiver to crash.
STARK-8668 Updating a metric's type no longer causes the metric to be marked as deleted.


Various improvements to the way Zookeeper is configured to improve stability.


The /dataview endpoint has been updated to include a path parameter, allowing filtering by partial dataview path.


The Web Console sidebar will no longer get stuck when collapsed under certain circumstances.


Special characters (for example, ñ) are now handled correctly in Licence page of the Web Console.


When publishing is disabled, schema and snapshot requests are no longer attempted.


Column name escaping has been improved, preventing crashes when querying data from certain plugins.

Known issues

These are the known issues affecting this release:

Issue key Known issue description

Occasionally a container synchronisation issue occurs during an upgrade, resulting in the following error message:

fatal: []: FAILED! => changed=true 
attempts: 30 
cmd: /opt/mapr/server/mrconfig info containers resync local 

If this occurs, resync the containers manually using the following command:

/opt/mapr/server/mrconfig info containers resync local


Due to a bug with Spark SQL, metric history cannot be retrieved from dataview columns with a semicolon in the name e.g. "test;". To resolve this issue update the dataview column name removing the semicolon.


The SSL certificate install incorrectly uses the default 'hub' user when applying an SSL certificate. To specify a different install user please add the following to the hubctl installation file:

"ansible" : { 
  	"variables" : { 


Gateway Hub will not correctly handle a dataview defined in a gateway with columns named "sampleTime", "netprobeTime" or "dataViewId".


Dataview data from additional rows computed in the Gateway is not stored for regular/non-computed columns.


Data that is somehow received without a timestamp has a default timestamp incorrectly applied with the timezone of the local machine.

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

Other releases

Gateway Hub Release Notes 1.5 Released: 8 October 2019
Gateway Hub Release Notes 1.4 Released: 31 July 2019
Gateway Hub Release Notes 1.3 Released: 14 June 2019
Gateway Hub Release Notes 1.2 Released: 11 March, 2019
Gateway Hub Release Notes 1.1 Released: 21 January, 2019