Fixing an issue in Index-Rollover - Indices are rolled over too often

Author: Chris Wiechmann

api-builder-plugin-fn-elasticsearch/CHANGELOG.md

@@ -4,6 +4,10 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/)
 and this project adheres to [Semantic Versioning](http://semver.org/).
 
+## [1.0.19] 2021-02-03
+### Fixed
+- Index-Rollup method was rolling over indices too often depending on the number of existing indices
+
 ## [1.0.18] 2021-01-11
 ### Fixed
 - The API-Builder process will no longer die, if Elasticsearch is not available for search request

api-builder-plugin-fn-elasticsearch/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@axway-api-builder-ext/api-builder-plugin-fn-elasticsearch",
-	"version": "1.0.18",
+	"version": "1.0.19",
 	"description": "Integrate Elasticsearch into your API-Builder flow to combine search data for instance with other data available in your flow.",
 	"author": "Chris Wiechmann <cwiechmann@axway.com> (http://www.axway.com)",
 	"license": "Apache-2.0",

api-builder-plugin-fn-elasticsearch/src/actions/indices.js

@@ -33,22 +33,40 @@ async function indicesRollover(params, options) {
 	} else {
 		aliasesToRollover.push(alias);
 	}
-	// Is the given alias is a wildcard, search for other indicies starting with this alias
+	/* Is the given alias is a wildcard (e.g. apigw-traffic-summary-*), search for other aliases starting with this alias
+	 * This the result we may get
+	 * alias                   index                          filter routing.index routing.search is_write_index
+	 * apigw-trace-messages-us apigw-trace-messages-us-000002 -      -             -              true
+	 * apigw-trace-messages-us apigw-trace-messages-us-000001 -      -             -              false
+	 * apigw-trace-messages-eu apigw-trace-messages-us-000001 -      -             -              false
+	 * apigw-trace-messages-eu apigw-trace-messages-us-000002 -      -             -              false
+	 * apigw-trace-messages-eu apigw-trace-messages-us-000003 -      -             -              true
+	 * 
+	 * For each found alias it must be rolled once, hence it must be the write index
+	 */
 	if(wildcardAlias) {
 		aliasesToRollover = [];
 		logger.debug(`Rolling over all indicies starting with alias: ${alias}`);
-		var indicesFound = await client.indices.getAlias({name: `${alias}*`}, { ignore: [404], maxRetries: 3 });
-		for (const index of Object.values(indicesFound.body)) {
-			var indexAlias = Object.keys(index.aliases)[0];
-			aliasesToRollover.push(indexAlias);
-		}	
+		var foundAliases = await client.indices.getAlias({name: `${alias}*`}, { ignore: [404], maxRetries: 3 });
+		// Based on the alias name we get all indicies
+		for (const [key, value] of Object.entries(foundAliases.body)) {
+			for (const [aliasName, aliasSettings] of Object.entries(value.aliases)) {
+				// Each can have only one write index, which we use to perform the rollover
+				if(aliasSettings.is_write_index) {
+					logger.debug(`Adding is write alias: ${aliasName} to the list of aliases to rollover`);
+					aliasesToRollover.push(aliasName);
+					break;
+				}
+			}
+		}
 	}
 	if(aliasesToRollover.length == 0) {
 		throw new Error(`No index found to rollover for alias: ${JSON.stringify(alias)}`);
 	}
 	try {
 		var result = [];
 		for(alias of aliasesToRollover) {
+			logger.debug(`Rolling over index: ${alias}`);
 			var rolloverResult = await client.indices.rollover( { alias: alias }, { ignore: [404], maxRetries: 3 });
 			result.push(rolloverResult);
 		}

api-builder-plugin-fn-elasticsearch/test/mock/indices/twoIndicesForAliasFoundResponse.json

@@ -3,14 +3,28 @@
       "apigw-traffic-summary-000002": {
         "aliases": {
           "apigw-traffic-summary": {
-            
+            "is_write_index": true
+          }
+        }
+      },
+      "apigw-traffic-summary-000001": {
+        "aliases": {
+          "apigw-traffic-summary": {
+            "is_write_index": false
           }
         }
       },
       "apigw-traffic-summary-us-dc1-000001": {
         "aliases": {
           "apigw-traffic-summary-us-dc1": {
-            
+            "is_write_index": false
+          }
+        }
+      },
+      "apigw-traffic-summary-us-dc1-000002": {
+        "aliases": {
+          "apigw-traffic-summary-us-dc1": {
+            "is_write_index": true
           }
         }
       }