APIIDA API Gateway Manager

Release Notes Winter 19

This page contains information about the APIIDA API Gateway Manager Winter 19. 

New Features and Enhancements

Dashboard 

DescriptionNotes
Brand new DashboardStrongly improved Dashboard to give you an even more modern and useful way to monitor your Gateway instances and Services.
Handling of Alarms

Active Alarms are now shown also after confirming them.
Batch confirming is now possible. 
Dashboard shows only active and the last 20 non-active alarms for a faster load. 

Widget: "CHART: CPU, Memory and Disk Space of a Node"

With this new widget you can analyze interactively Node metrics on the Dashboard. You can show the following metrics to a Node:

  • CPU (%): CPU utilization on Gateway server
  • Memory (%): RAM utilization on Gateway server, including cache and buffer
  • Disk Space (%): used disc space on Gateway server

You can show data from the last 5, 10 and 30 min.

Widget: "CHART: Display values of a chosen variable for all instances of a service as line chart"

With this new widget you can analyze interactively Service metrics on the Dashboard. You can show the following metrics to a Node:

  • Backend response time (ms) 
  • Frontend response time (ms)
  • Number of Requests
  • Number of Successful Requests
  • Policy Violations
  • Routing Failures 

You can show data from the last 5, 10 and 30 min.

You can add Alarming thresholds for the stages Dev, Test and Prod. 

Widget: "CHART: Display values of a chosen variable for all nodes of a cluster as line chart"

With this new widget you can analyze interactively metrics for a specific Cluster on the Dashboard. You can show the following metrics for all nodes of the Cluster:

  • CPU (%): CPU utilization on Gateway server
  • Memory (%): RAM utilization on Gateway server, including cache and buffer
  • Disk Space (%): used disc space on Gateway server

You can show data from the last 5, 10 and 30 min.

Widget: "Quick Health Check"Added the option to filter to show only Nodes from a specific Cluster. If you want to show all Nodes, just don't select a cluster. 
Widget: "Node State"

Completely new Widget to show the status of a Node or a Cluster. Real-time metrics data for the Node for

  • CPU (%): CPU utilization on Gateway server
  • Memory (%): RAM utilization on Gateway server, including cache and buffer
  • Disk Space (%): used disc space on Gateway server

Shows you on every metrics with the color (running=grey, warning=yellow, error=red) an indication of the Node Health. 

Widget: "Service State"

Completely new Widget to show the status of a Services. Real-time metrics data for the Service for

  • State: Health of the Service for all Nodes, the Service is running
  • Request: Requests combined for all Nodes, the Service is running
Widget: "Instance State"

Completely new Widget to show the status of a Services for a specific Node (Instance). Real-time metrics data for the Instance for

  • Frontend Response Time (ms)
  • Requests
Widget: "Node load per Stage"Added the metric Disc space of a Node to this widget. 
Rename/Delete  DashboardAdded the possibility to delete and rename existing Dashboards. 

Health Check

DescriptionNotes
Health variable CPU loadAdded the metric CPU utilization of the Gateway server. This metrics will now be gathered directly from the APIIDA Metrics Assertion. SNMP is not needed anymore. 
Health variable memory load

Added the metric RAM utilization of the Gateway server. This metrics will now be gathered directly from the APIIDA Metrics Assertion. SNMP is not needed anymore. 

Utilization will be calculated as following: (available memory) = (total memory) - (used memory) - (memory for cache) - (memory for buffer)

Health variable disk consumptionAdded the metric disc consumption of the Gateway server. This metrics will be gathered directly from the APIIDA Metrics Assertion. 

Alarming

DescriptionNotes
Support of channel MattermostSupporting now the instant messenger Mattermost. For documentation to create an incoming webhook, see: https://docs.mattermost.com/developer/webhooks-incoming.html 
Support of channel webhookAdded the possibility to send out generic webhooks as an alarming channel. With that APIIDA API Gateway Manager supports all systems, that are able to handle incoming webhooks. 
Central notification settingsAdded a page to centralize the notification settings. Administer your notification channel on one single page. 
Custom notification for every state changeAdded the possibility to set alarming channels for every state change individual, e.g. notification from state running to state warning or from state error to state running. 

One-Click Migration

DescriptionNotes
Migrate folder structures

APIIDA API Gateway now uses the Restman interface to migrate the folder structure. This will be needed, because the GMU didn't migrate the folder structure in every case. 

In the migration process APIIDA API Gateway autodetects necessary folders and creates them, before the GMU command will be called. 

Migrate whole solutionsAdded the possibility to migrate a solution. A solution is a set of Services inside the same parent folder on the Gateway. Therefore it is possible to migrate more then one Service in the same migration process. 
Better overview screenRedesigned the overview page before the migration. Easier to have an overview to see the changes for the migration. 
Upgrade to GMU 1.6Upgraded the included Gateway Migration Utility to the version 1.6. 

Node/Service overview

DescriptionNotes
New modern view

Compleatly new design for the Node or Services overview. See primary metrics in one view with the new Node/Services/Instance widgets (also available on the dashboard). 

The Node overview shows you the metrics for CPU, Memory and Disk consumption.

The Services overview shows you the metrics for state and requests. 

The Instance overview (Service of a Node) shows you the metrics Requests and Frontend Response Time. 

Support of clustersAdded the support for clusters. Just create a Cluster and add the corresponding Nodes. 
Support of servicesAdded the support for Services. A service is a combination of belonging together Services. The Services on the Gateway have to be in the same parent folder. 
Node analyticsNew tab inside the Node administration page. Inside this tab APIIDA API Gateway Manager provides a widget to analyze the Node for the metrics CPU, Memory and Disk consumption. You can show data from the last 5, 10 and 30 min. This widget is also available in the Dashboard. 
Service analyticsNew tab inside the Service administration page. Inside this tab APIIDA API Gateway Manager provides a widget to analyze the Service for the metrics: 
  • Backend response time (ms) 
  • Frontend response time (ms)
  • Number of Requests
  • Number of Successful Requests
  • Policy Violations
  • Routing Failures 
. You can show data from the last 5, 10 and 30 min. This widget is also available in the Dashboard. 
Tree view in service discoveryEasier import of Services and Solutions in the service discovery. New tree view of all Services from the gateway allows you to have a better overview before importing a Service or Solution to APIIDA API Gateway Manager. 
Delete or change Nodes/Services

Added the possibility to delete Nodes and Services. 

Added the possibility to change settings from Nodes and Services. 

Overall Improvements

DescriptionNotes
Notification info on every pageAdded a notification icon on every page in the header of the page. Instant view, if there is any active alarm that need to be handled. 
Support of CA API Gateway 9.2, 9.3 and 9.4Added support for the CA API Gateway versions 9.2, 9.3 and 9.4 with the brand new APIIDA Metrics Assertion. Please upgrade your existing Assertion to the version greater then v1.2. 
More stable metrics readerConnectivity issues are now handled properly between APIIDA API Gateway Manager and the API Gateways. 
Less memory consumption on gatewayDecreased the memory consumption with the APIIDA Metrics Assertion on the gateway. 
Faster interaction on all pagesIncreased the overall performance in the UI of APIIDA API Gateway Manager. 
Variable memory consumption's of database Docker container (aagmdb)The database container now consumes 50% of the available server memory. This can be changed to a fixed value with an environment variable inside the the Docker Compose file. 

Known Issues

Description

Notes

Missing data with different dates on server

Please ensure, that all of your server (all gateway server and server for APIIDA API Gateway Manager) have the same time. You can use NTP for this. 

ServiceID in Migration overview of solutions

If you migrate a solution to a gateway, the current overview show you only one ServiceID. 

Dashboard: Click on 'add' deletes all changed widget data

If you click on 'add' in a Dashboard edit page, all your changed widgets preferences are lost. Please save all your preferences before you add a widget or block. 

Edit mode from Dashboard: all sites are in edit mode

If you are in the edit mode from a Dashboard, all other sites (e.g. Nodes or Services) are in edit mode too. Please go back to your Dashboard and save your changes. 

Migration fails with folders with same name

Migration fails when there are multiple folders with the same name on the target gateway

Memory consumption show cache from OS

The memory consumption is currently calculated by following rule:

(available memory) = (total memory) - (used memory) - (memory for cache) - (memory for buffer)

This will be changed in the next release to following rule:

(available memory) = (total memory) - (used memory)