Browse Source

Document the enhancements to ILM Health Indicator (#96980)

Pablo Alcantar Morales 2 years ago
parent
commit
1c8c4d80f7

+ 37 - 0
docs/reference/health/health.asciidoc

@@ -365,6 +365,43 @@ watermark threshold>>.
 `policies`::
     (int) The number of index lifecycle policies that the system is managing.
 
+`stagnating_indices`::
+    (int) the number of indices managed by {ilm} that has been stagnant longer than expected.
+
+`stagnating_indices_per_action`::
+    (optional, map) Summary of the number of indices, grouped by action, that have been stagnant longer than
+    expected.
++
+.Properties of `stagnating_indices_per_action`
+[%collapsible%open]
+=======
+`downsample`::
+(int) The number of stagnant indices in the `downsample` action.
+
+`allocate`::
+(int) The number of stagnant indices in the `allocate` action.
+
+`shrink`::
+(int) The number of stagnant indices in the `shrink` action.
+
+`searchable_snapshot`::
+(int) The number of stagnant indices in the `searchable_snapshot` action.
+
+`rollover`::
+(int) The number of stagnant indices in the `rollver` action.
+
+`forcemerge`::
+(int) The number of stagnant indices in the `forcemerge` action.
+
+`delete`::
+(int) The number of stagnant indices in the `delete` action.
+
+`migrate`::
+(int) The number of stagnant indices in the `migrate` action.
+
+
+=======
+
 [[health-api-response-details-slm]]
 ===== slm
 

+ 10 - 0
docs/reference/settings/health-diagnostic-settings.asciidoc

@@ -35,3 +35,13 @@ cluster wide health aspects such as disk space.
 `health.reporting.local.monitor.interval`::
 (<<cluster-update-settings,Dynamic>>) Determines the interval in which each node of the cluster monitors aspects that
 comprise its local health such as its disk usage.
+
+`health.ilm.max_time_on_action`::
+(<<cluster-update-settings,Dynamic>>) The minimum amount of time an index has to be in an {ilm} ({ilm-init}) action before it is considered stagnant. Defaults to `1d` (1 day).
+
+`health.ilm.max_time_on_step`::
+(<<cluster-update-settings,Dynamic>>) The minimum amount of time an index has to be in an {ilm-init} step before it is considered stagnant. Defaults to `1d` (1 day).
+
+`health.ilm.max_retries_per_step`::
+(<<cluster-update-settings,Dynamic>>) The minimum amount of times an index has retried by an {ilm-init} step before it is considered stagnant. Defaults to `100`
+