Rollover add max_primary_shard_docs condition

client/rest-high-level/src/main/java/org/elasticsearch/client/ilm/RolloverAction.java

@@ -26,11 +26,12 @@ public class RolloverAction implements LifecycleAction, ToXContentObject {
     private static final ParseField MAX_PRIMARY_SHARD_SIZE_FIELD = new ParseField("max_primary_shard_size");
     private static final ParseField MAX_AGE_FIELD = new ParseField("max_age");
     private static final ParseField MAX_DOCS_FIELD = new ParseField("max_docs");
+    private static final ParseField MAX_SHARD_DOCS_FIELD = new ParseField("max_shard_docs");
 
     private static final ConstructingObjectParser<RolloverAction, Void> PARSER = new ConstructingObjectParser<>(
         NAME,
         true,
-        a -> new RolloverAction((ByteSizeValue) a[0], (ByteSizeValue) a[1], (TimeValue) a[2], (Long) a[3])
+        a -> new RolloverAction((ByteSizeValue) a[0], (ByteSizeValue) a[1], (TimeValue) a[2], (Long) a[3], (Long) a[4])
     );
 
     static {
@@ -53,25 +54,28 @@ public class RolloverAction implements LifecycleAction, ToXContentObject {
             ValueType.VALUE
         );
         PARSER.declareLong(ConstructingObjectParser.optionalConstructorArg(), MAX_DOCS_FIELD);
+        PARSER.declareLong(ConstructingObjectParser.optionalConstructorArg(), MAX_SHARD_DOCS_FIELD);
     }
 
     private final ByteSizeValue maxSize;
     private final ByteSizeValue maxPrimaryShardSize;
     private final TimeValue maxAge;
     private final Long maxDocs;
+    private final Long maxShardDocs;
 
     public static RolloverAction parse(XContentParser parser) {
         return PARSER.apply(parser, null);
     }
 
-    public RolloverAction(ByteSizeValue maxSize, ByteSizeValue maxPrimaryShardSize, TimeValue maxAge, Long maxDocs) {
-        if (maxSize == null && maxPrimaryShardSize == null && maxAge == null && maxDocs == null) {
+    public RolloverAction(ByteSizeValue maxSize, ByteSizeValue maxPrimaryShardSize, TimeValue maxAge, Long maxDocs, Long maxShardDocs) {
+        if (maxSize == null && maxPrimaryShardSize == null && maxAge == null && maxDocs == null && maxShardDocs == null) {
             throw new IllegalArgumentException("At least one rollover condition must be set.");
         }
         this.maxSize = maxSize;
         this.maxPrimaryShardSize = maxPrimaryShardSize;
         this.maxAge = maxAge;
         this.maxDocs = maxDocs;
+        this.maxShardDocs = maxShardDocs;
     }
 
     public ByteSizeValue getMaxSize() {
@@ -90,6 +94,10 @@ public Long getMaxDocs() {
         return maxDocs;
     }
 
+    public Long getMaxShardDocs() {
+        return maxShardDocs;
+    }
+
     @Override
     public String getName() {
         return NAME;
@@ -110,13 +118,16 @@ public XContentBuilder toXContent(XContentBuilder builder, Params params) throws
         if (maxDocs != null) {
             builder.field(MAX_DOCS_FIELD.getPreferredName(), maxDocs);
         }
+        if (maxShardDocs != null) {
+            builder.field(MAX_SHARD_DOCS_FIELD.getPreferredName(), maxShardDocs);
+        }
         builder.endObject();
         return builder;
     }
 
     @Override
     public int hashCode() {
-        return Objects.hash(maxSize, maxPrimaryShardSize, maxAge, maxDocs);
+        return Objects.hash(maxSize, maxPrimaryShardSize, maxAge, maxDocs, maxShardDocs);
     }
 
     @Override
@@ -131,7 +142,8 @@ public boolean equals(Object obj) {
         return Objects.equals(maxSize, other.maxSize)
             && Objects.equals(maxPrimaryShardSize, other.maxPrimaryShardSize)
             && Objects.equals(maxAge, other.maxAge)
-            && Objects.equals(maxDocs, other.maxDocs);
+            && Objects.equals(maxDocs, other.maxDocs)
+            && Objects.equals(maxShardDocs, other.maxShardDocs);
     }
 
     @Override

client/rest-high-level/src/main/java/org/elasticsearch/client/indices/rollover/RolloverRequest.java

@@ -11,6 +11,7 @@
 import org.elasticsearch.action.admin.indices.rollover.MaxAgeCondition;
 import org.elasticsearch.action.admin.indices.rollover.MaxDocsCondition;
 import org.elasticsearch.action.admin.indices.rollover.MaxPrimaryShardSizeCondition;
+import org.elasticsearch.action.admin.indices.rollover.MaxShardDocsCondition;
 import org.elasticsearch.action.admin.indices.rollover.MaxSizeCondition;
 import org.elasticsearch.client.TimedRequest;
 import org.elasticsearch.client.indices.CreateIndexRequest;
@@ -120,6 +121,17 @@ public RolloverRequest addMaxPrimaryShardSizeCondition(ByteSizeValue size) {
         return this;
     }
 
+    /**
+     * Adds a size-based condition to check if the docs of the largest shard has at least <code>numDocs</code>
+     */
+    public void addMaxShardDocsCondition(long numDocs) {
+        MaxShardDocsCondition maxShardDocsCondition = new MaxShardDocsCondition(numDocs);
+        if (this.conditions.containsKey(maxShardDocsCondition.name())) {
+            throw new IllegalArgumentException(maxShardDocsCondition + " condition is already set");
+        }
+        this.conditions.put(maxShardDocsCondition.name(), maxShardDocsCondition);
+    }
+
     /**
      * Returns all set conditions
      */

client/rest-high-level/src/test/java/org/elasticsearch/client/IndexLifecycleIT.java

@@ -169,7 +169,7 @@ public void testStartStopILM() throws Exception {
     public void testExplainLifecycle() throws Exception {
         Map<String, Phase> lifecyclePhases = new HashMap<>();
         Map<String, LifecycleAction> hotActions = new HashMap<>();
-        hotActions.put(RolloverAction.NAME, new RolloverAction(null, null, TimeValue.timeValueHours(50 * 24), null));
+        hotActions.put(RolloverAction.NAME, new RolloverAction(null, null, TimeValue.timeValueHours(50 * 24), null, null));
         Phase hotPhase = new Phase("hot", randomFrom(TimeValue.ZERO, null), hotActions);
         lifecyclePhases.put("hot", hotPhase);
 

client/rest-high-level/src/test/java/org/elasticsearch/client/IndicesClientIT.java

@@ -1066,6 +1066,24 @@ public void testRollover() throws IOException {
             assertEquals("test", rolloverResponse.getOldIndex());
             assertEquals("test_new", rolloverResponse.getNewIndex());
         }
+        {
+            rolloverRequest.addMaxShardDocsCondition(1L);
+            rolloverRequest.dryRun(true);
+            RolloverResponse rolloverResponse = execute(
+                rolloverRequest,
+                highLevelClient().indices()::rollover,
+                highLevelClient().indices()::rolloverAsync
+            );
+            assertFalse(rolloverResponse.isRolledOver());
+            assertTrue(rolloverResponse.isDryRun());
+            Map<String, Boolean> conditionStatus = rolloverResponse.getConditionStatus();
+            assertEquals(3, conditionStatus.size());
+            assertTrue(conditionStatus.get("[max_docs: 1]"));
+            assertTrue(conditionStatus.get("[max_age: 1ms]"));
+            assertTrue(conditionStatus.get("[max_shard_docs: 1]"));
+            assertEquals("test", rolloverResponse.getOldIndex());
+            assertEquals("test_new", rolloverResponse.getNewIndex());
+        }
         {
             String mappings = "{\"properties\":{\"field2\":{\"type\":\"keyword\"}}}";
             rolloverRequest.getCreateIndexRequest().mapping(mappings, XContentType.JSON);
@@ -1080,9 +1098,10 @@ public void testRollover() throws IOException {
             assertTrue(rolloverResponse.isRolledOver());
             assertFalse(rolloverResponse.isDryRun());
             Map<String, Boolean> conditionStatus = rolloverResponse.getConditionStatus();
-            assertEquals(4, conditionStatus.size());
+            assertEquals(5, conditionStatus.size());
             assertTrue(conditionStatus.get("[max_docs: 1]"));
             assertTrue(conditionStatus.get("[max_age: 1ms]"));
+            assertTrue(conditionStatus.get("[max_shard_docs: 1]"));
             assertFalse(conditionStatus.get("[max_size: 1mb]"));
             assertFalse(conditionStatus.get("[max_primary_shard_size: 1mb]"));
             assertEquals("test", rolloverResponse.getOldIndex());

client/rest-high-level/src/test/java/org/elasticsearch/client/documentation/ILMDocumentationIT.java

@@ -95,7 +95,7 @@ public void testPutLifecyclePolicy() throws Exception {
         Map<String, Phase> phases = new HashMap<>();
         Map<String, LifecycleAction> hotActions = new HashMap<>();
         hotActions.put(RolloverAction.NAME, new RolloverAction(
-                new ByteSizeValue(50, ByteSizeUnit.GB), null, null, null));
+                new ByteSizeValue(50, ByteSizeUnit.GB), null, null, null, null));
         phases.put("hot", new Phase("hot", TimeValue.ZERO, hotActions)); // <1>
 
         Map<String, LifecycleAction> deleteActions =
@@ -163,7 +163,7 @@ public void testDeletePolicy() throws IOException, InterruptedException {
         {
             Map<String, Phase> phases = new HashMap<>();
             Map<String, LifecycleAction> hotActions = new HashMap<>();
-            hotActions.put(RolloverAction.NAME, new RolloverAction(new ByteSizeValue(50, ByteSizeUnit.GB), null, null, null));
+            hotActions.put(RolloverAction.NAME, new RolloverAction(new ByteSizeValue(50, ByteSizeUnit.GB), null, null, null, null));
             phases.put("hot", new Phase("hot", TimeValue.ZERO, hotActions));
             Map<String, LifecycleAction> deleteActions = Collections.singletonMap(DeleteAction.NAME, new DeleteAction());
             phases.put("delete", new Phase("delete", new TimeValue(90, TimeUnit.DAYS), deleteActions));
@@ -231,7 +231,7 @@ public void testGetLifecyclePolicy() throws IOException, InterruptedException {
         {
             Map<String, Phase> phases = new HashMap<>();
             Map<String, LifecycleAction> hotActions = new HashMap<>();
-            hotActions.put(RolloverAction.NAME, new RolloverAction(new ByteSizeValue(50, ByteSizeUnit.GB), null, null, null));
+            hotActions.put(RolloverAction.NAME, new RolloverAction(new ByteSizeValue(50, ByteSizeUnit.GB), null, null, null, null));
             phases.put("hot", new Phase("hot", TimeValue.ZERO, hotActions));
 
             Map<String, LifecycleAction> deleteActions = Collections.singletonMap(DeleteAction.NAME, new DeleteAction());
@@ -324,7 +324,7 @@ public void testExplainLifecycle() throws Exception {
         {
             Map<String, Phase> phases = new HashMap<>();
             Map<String, LifecycleAction> hotActions = new HashMap<>();
-            hotActions.put(RolloverAction.NAME, new RolloverAction(new ByteSizeValue(50, ByteSizeUnit.GB), null, null, null));
+            hotActions.put(RolloverAction.NAME, new RolloverAction(new ByteSizeValue(50, ByteSizeUnit.GB), null, null, null, null));
             phases.put("hot", new Phase("hot", TimeValue.ZERO, hotActions));
 
             LifecyclePolicy policy = new LifecyclePolicy("my_policy", phases);

client/rest-high-level/src/test/java/org/elasticsearch/client/ilm/RolloverActionTests.java

@@ -41,11 +41,17 @@ static RolloverAction randomInstance() {
         Long maxDocs = (maxSize == null && maxPrimaryShardSize == null && maxAge == null || randomBoolean())
             ? randomNonNegativeLong()
             : null;
-        return new RolloverAction(maxSize, maxPrimaryShardSize, maxAge, maxDocs);
+        Long maxShardDocs = (maxSize == null && maxPrimaryShardSize == null && maxAge == null && maxDocs == null || randomBoolean())
+            ? randomNonNegativeLong()
+            : null;
+        return new RolloverAction(maxSize, maxPrimaryShardSize, maxAge, maxDocs, maxShardDocs);
     }
 
     public void testNoConditions() {
-        IllegalArgumentException exception = expectThrows(IllegalArgumentException.class, () -> new RolloverAction(null, null, null, null));
+        IllegalArgumentException exception = expectThrows(
+            IllegalArgumentException.class,
+            () -> new RolloverAction(null, null, null, null, null)
+        );
         assertEquals("At least one rollover condition must be set.", exception.getMessage());
     }
 }

client/rest-high-level/src/test/java/org/elasticsearch/client/indices/rollover/RolloverRequestTests.java

@@ -12,6 +12,7 @@
 import org.elasticsearch.action.admin.indices.rollover.MaxAgeCondition;
 import org.elasticsearch.action.admin.indices.rollover.MaxDocsCondition;
 import org.elasticsearch.action.admin.indices.rollover.MaxPrimaryShardSizeCondition;
+import org.elasticsearch.action.admin.indices.rollover.MaxShardDocsCondition;
 import org.elasticsearch.action.admin.indices.rollover.MaxSizeCondition;
 import org.elasticsearch.common.unit.ByteSizeValue;
 import org.elasticsearch.core.TimeValue;
@@ -39,15 +40,18 @@ public void testConstructorAndFieldAssignments() {
         MaxDocsCondition maxDocsCondition = new MaxDocsCondition(10000L);
         MaxSizeCondition maxSizeCondition = new MaxSizeCondition(new ByteSizeValue(2000));
         MaxPrimaryShardSizeCondition maxPrimaryShardSizeCondition = new MaxPrimaryShardSizeCondition(new ByteSizeValue(3000));
+        MaxShardDocsCondition maxShardDocsCondition = new MaxShardDocsCondition(5000L);
         Condition<?>[] expectedConditions = new Condition<?>[] {
             maxAgeCondition,
             maxDocsCondition,
             maxSizeCondition,
-            maxPrimaryShardSizeCondition };
+            maxPrimaryShardSizeCondition,
+            maxShardDocsCondition };
         rolloverRequest.addMaxIndexAgeCondition(maxAgeCondition.value());
         rolloverRequest.addMaxIndexDocsCondition(maxDocsCondition.value());
         rolloverRequest.addMaxIndexSizeCondition(maxSizeCondition.value());
         rolloverRequest.addMaxPrimaryShardSizeCondition(maxPrimaryShardSizeCondition.value());
+        rolloverRequest.addMaxShardDocsCondition(maxShardDocsCondition.value());
         List<Condition<?>> requestConditions = new ArrayList<>(rolloverRequest.getConditions().values());
         assertThat(requestConditions, containsInAnyOrder(expectedConditions));
     }

client/rest-high-level/src/test/java/org/elasticsearch/client/indices/rollover/RolloverResponseTests.java

@@ -12,6 +12,7 @@
 import org.elasticsearch.action.admin.indices.rollover.MaxAgeCondition;
 import org.elasticsearch.action.admin.indices.rollover.MaxDocsCondition;
 import org.elasticsearch.action.admin.indices.rollover.MaxPrimaryShardSizeCondition;
+import org.elasticsearch.action.admin.indices.rollover.MaxShardDocsCondition;
 import org.elasticsearch.action.admin.indices.rollover.MaxSizeCondition;
 import org.elasticsearch.common.unit.ByteSizeValue;
 import org.elasticsearch.core.TimeValue;
@@ -36,6 +37,7 @@ public class RolloverResponseTests extends ESTestCase {
         conditionSuppliers.add(() -> new MaxDocsCondition(randomNonNegativeLong()));
         conditionSuppliers.add(() -> new MaxSizeCondition(new ByteSizeValue(randomNonNegativeLong())));
         conditionSuppliers.add(() -> new MaxPrimaryShardSizeCondition(new ByteSizeValue(randomNonNegativeLong())));
+        conditionSuppliers.add(() -> new MaxShardDocsCondition(randomNonNegativeLong()));
     }
 
     public void testFromXContent() throws IOException {

docs/reference/ilm/actions/ilm-rollover.asciidoc

@@ -81,6 +81,14 @@ replicas are ignored.
 TIP: To see the current shard size, use the <<cat-shards, _cat shards>> API.
 The `store` value shows the size each shard, and `prirep` indicates whether a
 shard is a primary (`p`) or a replica (`r`).
+
+`max_shard_docs`::
+(Optional, integer)
+Triggers rollover when the largest shard in the index reaches a certain number of documents.
+This is the maximum docs of the shards in the index. As with `max_docs`
++
+TIP: To see the current shard docs, use the <<cat-shards, _cat shards>> API.
+The `docs` value shows the number of documents each shard.
 // end::rollover-conditions[]
 
 [[ilm-rollover-ex]]
@@ -155,6 +163,29 @@ PUT _ilm/policy/my_policy
 }
 --------------------------------------------------
 
+[ilm-rollover-documents-ex]]
+===== Roll over based on document count of the largest shard
+
+This example rolls the index over when it contains at least ten million documents of the largest shard.
+
+[source,console]
+--------------------------------------------------
+PUT _ilm/policy/my_policy
+{
+  "policy": {
+    "phases": {
+      "hot": {
+        "actions": {
+          "rollover" : {
+            "max_shard_docs": 10000000
+          }
+        }
+      }
+    }
+  }
+}
+--------------------------------------------------
+
 [ilm-rollover-age-ex]]
 ===== Roll over based on index age
 

docs/reference/indices/rollover-index.asciidoc

@@ -79,7 +79,7 @@ If you use an index alias for time series data, you can use
 date. For example, you can create an alias that points to an index named
 `<my-index-{now/d}-000001>`. If you create the index on May 6, 2099, the index's
 name is `my-index-2099.05.06-000001`. If you roll over the alias on May 7, 2099,
-the new index's name is `my-index-2099.05.07-000002`. For an example, see 
+the new index's name is `my-index-2099.05.07-000002`. For an example, see
 <<roll-over-index-alias-with-write-index>>.
 ****
 
@@ -233,7 +233,8 @@ POST my-data-stream/_rollover
   "conditions": {
     "max_age": "7d",
     "max_docs": 1000,
-    "max_primary_shard_size": "50gb"
+    "max_primary_shard_size": "50gb",
+    "max_shard_docs": "2000"
   }
 }
 ----
@@ -255,7 +256,8 @@ The API returns:
   "conditions": {
     "[max_age: 7d]": false,
     "[max_docs: 1000]": true,
-    "[max_primary_shard_size: 50gb]": false
+    "[max_primary_shard_size: 50gb]": false,
+    "[max_shard_docs: 2000]": false
   }
 }
 ----
@@ -302,7 +304,8 @@ POST my-alias/_rollover
   "conditions": {
     "max_age": "7d",
     "max_docs": 1000,
-    "max_primary_shard_size": "50gb"
+    "max_primary_shard_size": "50gb",
+    "max_shard_docs": "2000"
   }
 }
 ----
@@ -324,7 +327,8 @@ The API returns:
   "conditions": {
     "[max_age: 7d]": false,
     "[max_docs: 1000]": true,
-    "[max_primary_shard_size: 50gb]": false
+    "[max_primary_shard_size: 50gb]": false,
+    "[max_shard_docs: 2000]": false
   }
 }
 ----
@@ -371,7 +375,8 @@ POST my-write-alias/_rollover
   "conditions": {
     "max_age": "7d",
     "max_docs": 1000,
-    "max_primary_shard_size": "50gb"
+    "max_primary_shard_size": "50gb",
+    "max_shard_docs": "2000"
   }
 }
 ----
@@ -393,7 +398,8 @@ The API returns:
   "conditions": {
     "[max_age: 7d]": false,
     "[max_docs: 1000]": true,
-    "[max_primary_shard_size: 50gb]": false
+    "[max_primary_shard_size: 50gb]": false,
+    "[max_shard_docs: 2000]": false
   }
 }
 ----