Gateway Hub 1.x Release Notes

Gateway Hub 1.6.0

Released: 12 December 2019

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

Highlights

The main features of this release are listed below. For all the latest highlights, see What's New in Geneos.

• Web Console monitoring UI.
• Event query API.
• Grafana data source (Technology Preview).
• Centralised configuration validation.

Web Console monitoring UI

The Web Console monitoring UI brings a brand new look for real-time monitoring, to supplement Active Console. The following is available in the Web Console:

• Entities, their statuses and related metrics.
• The ability to see the historical data for additional context and incident investigation when metric and event history is enabled in Gateway Hub.

The Web Console is available free of charge for all Geneos users. For more information, see Monitoring.

Event query API

Events such as severity, snooze and user assignment data can now be queried using an open API, providing access to the raw data for further analysis of trends and problem entities.

Centralised configuration validation

Updates to centralised configuration files can now be validated against all Gateways dependent on that configuration, in order to avoid updates causing issues remotely. By default, changes that would cause errors in any dependent Gateways are refused.

The API for centralised configuration has been finalised since the early access version, and as a result all Gateways using GA centralised configuration must be version 5.0. For more information, see Centralised gateways user guide.

Breaking changes

These are the breaking changes in the current release:

New features and enhancements

These are the new features and enhancements in this release:

Issues fixed

These are the issues we have fixed in this release:

Gateway Hub 1.5.4

Released: 13 November, 2019

Note: Gateway Hub 1.5.4 is a patch release containing a number of fixes for security and deployment issues. Versions 1.5.1 — 1.5.3 were only released internally.

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 in this release:

Issues fixed

These are the issues we have fixed in this release:

Known issues

These are the known issues affecting this release:

"ansible" : { 
  	"variables" : { 
		"hub_user":
 			"gwh", 
  		"hub_group":
 			"gwh", 
		} 
}

Gateway Hub 1.5.0

Released: 8 October, 2019

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

Highlights

The main features of this release are listed below. For all the latest highlights, see What's New in Geneos.

• Anomaly detection rules.
• Kafka publishing filter.
• Role based security.

Anomaly detection rules

One of the major sources of monitoring noise is due to simple thresholds set on metrics that are inherently variable over time. Many business processes follow a fairly predictable pattern, peaking around market open and close, and dormant over the weekends.

Anomaly detection rules provide a better way of monitoring these kinds of metrics. By analysing the history of a metric stored in Gateway Hub, an anomaly detection rule can determine what is normal, alerting only when this normality is deviated from.

For example, an anomaly detection rule can be set to trigger an alert if orders fall outside a certain tolerance for a given time and day of the week, for that specific server, or for all similar servers.

Switching to anomaly detection rules can result in significantly more accurate alerting and substantially reduced events over time for metrics that follow a pattern or cycle. Some metrics are more suited to anomaly detection rules than others.

For more information, see Anomaly Detection.

Kafka publishing filter

In addition to the improved data format, normalisation and schemas published to Kafka from Gateway Hub, filtering options are now available to restrict the data that is published to an external Kafka cluster.

The publishing of metrics and events can now be individually controlled. In addition, publishing can be restricted to certain entities such as where Division = Securities and certain metrics, such as Bloomberg only.

For more information, see Publish to Kafka.

Role based security

This release brings easy-to-configure single sign on (SSO) and role based security to Gateway Hub. With this version, predefined Administrator and Operator roles are available to provide write and read access to Gateway Hub. Gateway Access control is still configured at the Gateway, although this will be centralised in a future version.

Role based security requires integration with Active Directory or LDAP.

For more information, see Configure Single Sign-On (SSO).

Breaking changes

These are the breaking changes in the current release:

New features and enhancements

These are the new features and enhancements in this release:

Issues fixed

These are the issues we have fixed in this release:

Known issues

These are the known issues affecting this release:

"ansible" : { 
  	"variables" : { 
		"hub_user":
 			"gwh", 
  		"hub_group":
 			"gwh", 
		} 
}

Gateway Hub 1.4.1

Released: 14 August, 2019

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 in this release:

Known issues

These are the known issues affecting this release:

fatal: [ec2-34-247-183-246.eu-west-1.compute.amazonaws.com]: FAILED! => changed=true 
attempts: 30 
cmd: /opt/mapr/server/mrconfig info containers resync local 

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

"ansible" : { 
  	"variables" : { 
		"hub_user":
 			"gwh", 
  		"hub_group":
 			"gwh", 
		} 
}

Gateway Hub 1.4.0

Released: 31 July, 2019

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

Highlights

The main features of this release are listed below. For all the latest highlights, see What's New in Geneos.

• Improved Gateway integration.
• Centralised configuration locking.
• Improved API documentation.
• Custom install directory for Gateway Hub.

This release is also focused on improving stability and robustness of metric queries. A number of stability issues have been resolved.

Improved Gateway integration

Integration between Gateway and Gateway Hub has been optimised, resulting in almost 25% less disk required for a standard Gateway Hub with metric storage compared to the previous version. Data will also be available in the Gateway Hub significantly faster than before due to the improved processing. These improvements require Gateway version 4.12.x.

Centralised Gateway configuration locking

Centralised configuration files can now be centrally locked, preventing concurrent updates from causing issues. This feature requires Gateway 4.12.x.

For more information, see Centralised Gateways User Guide.

Improved API documentation

API documentation is now published using redoc allowing better navigation and examples.

For more information, see Gateway Hub API documentation.

Custom install directory

You can now perform new installations of Gateway Hub in custom locations, allowing Gateway Hub, the Web Console SSO, and Kafka to be installed in any location.

Note that the install location for MapR cannot be changed from /opt/mapr.

Note: Changing install directories as part of an upgrade is not supported.

New features and enhancements

These are the new features and enhancements in this release:

Issues fixed

These are the issues we have fixed in this release:

java.lang.RuntimeException: org.apache.spark.SparkException:
Job aborted due to stage failure:
Exception while getting task result: scala.MatchError: None (of class scala.None$)

Known issues

These are the known issues affecting this release:

fatal: [ec2-34-247-183-246.eu-west-1.compute.amazonaws.com]: FAILED! => changed=true 
attempts: 30 
cmd: /opt/mapr/server/mrconfig info containers resync local 

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

"ansible" : { 
  	"variables" : { 
		"hub_user":
 			"gwh", 
  		"hub_group":
 			"gwh", 
		} 
}

Gateway Hub 1.3.0

Released: 14 June, 2019

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

Highlights

The main features of this release are listed below. For all the latest highlights, see What's New in Geneos.

• 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

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 new features and enhancements in this release:

Issues fixed

These are the issues we have fixed in this release:

Known issues

These are the known issues affecting this release:

fatal: [ec2-34-247-183-246.eu-west-1.compute.amazonaws.com]: FAILED! => changed=true 
attempts: 30 
cmd: /opt/mapr/server/mrconfig info containers resync local 

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

"ansible" : { 
  	"variables" : { 
		"hub_user":
 			"gwh", 
  		"hub_group":
 			"gwh", 
		} 
}

Gateway Hub 1.2.0

Released: 11 March, 2019

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

Highlights

The main features of this release are listed below. For all the latest highlights, see What's New in Geneos.

• Publishing of normalised data with schema to an external Kafka interface.
• Additional administration screens for the Web Console.

Kafka publishing

The Kafka Publishing available with Gateway Hub builds upon the feature previously available in the Gateway. With Gateway Hub, schemas can now be published along with the metric and event data, in order to provide easier integration with other applications, and the published data is now normalised, enabling simpler usage downstream.

For more information, see Kafka Publishing Message Formats.

Web Console

This release brings the new administration screens for the Web Console, allowing licence management and configuration of Publishing.

For more information, see Web Console Administration Pages.

Breaking changes

These are the breaking changes in the current release:

New features and enhancements

These are the new features and enhancements in this release:

Issues fixed

These are the issues we have fixed in this release:

Known issues

These are the known issues affecting this release:

Gateway Hub 1.1.0

Released: 21 January, 2019

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

Highlights

The main features of this release are listed below. For all the latest highlights, see What's New in Geneos.

• Ability to store historical data for all Geneos metrics and events.
• A brand new web-based UI for Gateway Hub Administration.

Historical metric and event storage

Historical metric and event data can now be stored in Gateway Hub and retrieved using Active Console. This is significantly more reliable than database logging and is designed to handle all metrics being logged, rather than a subset.

Metric and event storage in Gateway Hub also provides the foundation for improved monitoring over the next few releases, including adaptive rules (anomaly detection), automatic baselining, predictive and causal analysis through machine learning.

For more information, see How to view metrics in Active Console.

Web Console

his release brings the first release of the new web-based UI for Geneos, the Web Console, focusing on administration of Gateway Hub. The Web Console will be expanded upon in future releases to initially complement, and eventually replace, Active Console.

For more information, see GeneosWeb Console.

Breaking changes

Note: These changes are applicable to Early Access customers only.

These are the breaking changes in the current release:

New features and enhancements

These are the new features and enhancements in this release:

Issues fixed

These are the issues we have fixed in this release:

Known issues

These are the known issues affecting this release: