[ILM] Add index_codec to forcemerge action in hot and warm phases (#7…

…8175) * [ILM] Add index_codec to forcemerge action in hot and warm phases * [ILM] Fix i18n check errors * [ILM] Add code review suggestions * [ILM] Add code review suggestions Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com> Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
elastic · Oct 6, 2020 · dcb646d · dcb646d
1 parent 3a7d709
commit dcb646d
Show file tree

Hide file tree

Showing 10 changed files with 283 additions and 36 deletions.
diff --git a/x-pack/plugins/index_lifecycle_management/common/types/policies.ts b/x-pack/plugins/index_lifecycle_management/common/types/policies.ts
@@ -42,9 +42,7 @@ export interface SerializedHotPhase extends SerializedPhase {
       max_age?: string;
       max_docs?: number;
     };
-    forcemerge?: {
-      max_num_segments: number;
-    };
+    forcemerge?: ForcemergeAction;
     set_priority?: {
       priority: number | null;
     };
@@ -57,9 +55,7 @@ export interface SerializedWarmPhase extends SerializedPhase {
     shrink?: {
       number_of_shards: number;
     };
-    forcemerge?: {
-      max_num_segments: number;
-    };
+    forcemerge?: ForcemergeAction;
     set_priority?: {
       priority: number | null;
     };
@@ -105,6 +101,12 @@ export interface AllocateAction {
   };
 }
 
+export interface ForcemergeAction {
+  max_num_segments: number;
+  // only accepted value for index_codec
+  index_codec?: 'best_compression';
+}
+
 export interface Policy {
   name: string;
   phases: {
@@ -150,6 +152,7 @@ export interface PhaseWithIndexPriority {
 export interface PhaseWithForcemergeAction {
   forceMergeEnabled: boolean;
   selectedForceMergeSegments: string;
+  bestCompressionEnabled: boolean;
 }
 
 export interface HotPhase

diff --git a/x-pack/plugins/index_lifecycle_management/public/application/constants/policy.ts b/x-pack/plugins/index_lifecycle_management/public/application/constants/policy.ts
@@ -21,6 +21,7 @@ export const defaultNewHotPhase: HotPhase = {
   selectedMaxSizeStoredUnits: 'gb',
   forceMergeEnabled: false,
   selectedForceMergeSegments: '',
+  bestCompressionEnabled: false,
   phaseIndexPriority: '100',
   selectedMaxDocuments: '',
 };
@@ -29,6 +30,7 @@ export const defaultNewWarmPhase: WarmPhase = {
   phaseEnabled: false,
   forceMergeEnabled: false,
   selectedForceMergeSegments: '',
+  bestCompressionEnabled: false,
   selectedMinimumAge: '0',
   selectedMinimumAgeUnits: 'd',
   selectedNodeAttrs: '',

diff --git a/...ex_lifecycle_management/public/application/sections/edit_policy/components/forcemerge.tsx b/...ex_lifecycle_management/public/application/sections/edit_policy/components/forcemerge.tsx
@@ -8,6 +8,7 @@ import { FormattedMessage } from '@kbn/i18n/react';
 import {
   EuiDescribedFormGroup,
   EuiFieldNumber,
+  EuiFormRow,
   EuiSpacer,
   EuiSwitch,
   EuiTextColor,
@@ -19,17 +20,25 @@ import { ErrableFormRow } from './form_errors';
 import { Phases, PhaseWithForcemergeAction } from '../../../../../common/types';
 import { PhaseValidationErrors } from '../../../services/policies/policy_validation';
 
-const forcemergeLabel = i18n.translate('xpack.indexLifecycleMgmt.warmPhase.forceMergeDataLabel', {
+const forcemergeLabel = i18n.translate('xpack.indexLifecycleMgmt.forcemerge.enableLabel', {
   defaultMessage: 'Force merge data',
 });
 
+const bestCompressionLabel = i18n.translate(
+  'xpack.indexLifecycleMgmt.forcemerge.bestCompressionLabel',
+  {
+    defaultMessage: 'Compress stored fields',
+  }
+);
+
 interface Props {
   errors?: PhaseValidationErrors<PhaseWithForcemergeAction>;
   phase: keyof Phases & string;
   phaseData: PhaseWithForcemergeAction;
   setPhaseData: (dataKey: keyof PhaseWithForcemergeAction, value: boolean | string) => void;
   isShowingErrors: boolean;
 }
+
 export const Forcemerge: React.FunctionComponent<Props> = ({
   errors,
   phaseData,
@@ -42,15 +51,15 @@ export const Forcemerge: React.FunctionComponent<Props> = ({
       title={
         <h3>
           <FormattedMessage
-            id="xpack.indexLifecycleMgmt.editPolicy.warmPhase.forceMergeDataText"
+            id="xpack.indexLifecycleMgmt.editPolicy.forceMerge.enableText"
             defaultMessage="Force merge"
           />
         </h3>
       }
       description={
         <EuiTextColor color="subdued">
           <FormattedMessage
-            id="xpack.indexLifecycleMgmt.editPolicy.warmPhase.forceMergeDataExplanationText"
+            id="xpack.indexLifecycleMgmt.editPolicy.forceMerge.enableExplanationText"
             defaultMessage="Reduce the number of segments in your shard by merging smaller files and clearing deleted ones."
           />{' '}
           <LearnMoreLink docPath="indices-forcemerge.html" />
@@ -73,23 +82,43 @@ export const Forcemerge: React.FunctionComponent<Props> = ({
       <EuiSpacer />
       <div id="forcemergeContent" aria-live="polite" role="region">
         {phaseData.forceMergeEnabled ? (
-          <ErrableFormRow
-            id={`${phase}-selectedForceMergeSegments`}
-            label={i18n.translate('xpack.indexLifecycleMgmt.warmPhase.numberOfSegmentsLabel', {
-              defaultMessage: 'Number of segments',
-            })}
-            isShowingErrors={isShowingErrors}
-            errors={errors?.selectedForceMergeSegments}
-          >
-            <EuiFieldNumber
-              data-test-subj={`${phase}-selectedForceMergeSegments`}
-              value={phaseData.selectedForceMergeSegments}
-              onChange={(e) => {
-                setPhaseData('selectedForceMergeSegments', e.target.value);
-              }}
-              min={1}
-            />
-          </ErrableFormRow>
+          <>
+            <ErrableFormRow
+              id={`${phase}-selectedForceMergeSegments`}
+              label={i18n.translate('xpack.indexLifecycleMgmt.forceMerge.numberOfSegmentsLabel', {
+                defaultMessage: 'Number of segments',
+              })}
+              isShowingErrors={isShowingErrors}
+              errors={errors?.selectedForceMergeSegments}
+            >
+              <EuiFieldNumber
+                data-test-subj={`${phase}-selectedForceMergeSegments`}
+                value={phaseData.selectedForceMergeSegments}
+                onChange={(e) => {
+                  setPhaseData('selectedForceMergeSegments', e.target.value);
+                }}
+                min={1}
+              />
+            </ErrableFormRow>
+            <EuiFormRow
+              hasEmptyLabelSpace
+              helpText={
+                <FormattedMessage
+                  id="xpack.indexLifecycleMgmt.editPolicy.forceMerge.bestCompressionText"
+                  defaultMessage="Use higher compression for stored fields at the cost of slower performance."
+                />
+              }
+            >
+              <EuiSwitch
+                data-test-subj={`${phase}-bestCompression`}
+                label={bestCompressionLabel}
+                checked={phaseData.bestCompressionEnabled}
+                onChange={(e) => {
+                  setPhaseData('bestCompressionEnabled', e.target.checked);
+                }}
+              />
+            </EuiFormRow>
+          </>
         ) : null}
       </div>
     </EuiDescribedFormGroup>

diff --git a/x-pack/plugins/index_lifecycle_management/public/application/services/policies/cold_phase.ts b/x-pack/plugins/index_lifecycle_management/public/application/services/policies/cold_phase.ts
@@ -16,7 +16,7 @@ import {
 import { determineDataTierAllocationType } from '../../lib';
 import { serializePhaseWithAllocation } from './shared';
 
-const coldPhaseInitialization: ColdPhase = {
+export const coldPhaseInitialization: ColdPhase = {
   phaseEnabled: false,
   selectedMinimumAge: '0',
   selectedMinimumAgeUnits: 'd',

diff --git a/x-pack/plugins/index_lifecycle_management/public/application/services/policies/hot_phase.ts b/x-pack/plugins/index_lifecycle_management/public/application/services/policies/hot_phase.ts
@@ -26,6 +26,7 @@ const hotPhaseInitialization: HotPhase = {
   selectedMaxSizeStoredUnits: 'gb',
   forceMergeEnabled: false,
   selectedForceMergeSegments: '',
+  bestCompressionEnabled: false,
   phaseIndexPriority: '',
   selectedMaxDocuments: '',
 };
@@ -64,6 +65,8 @@ export const hotPhaseFromES = (phaseSerialized?: SerializedHotPhase): HotPhase =
       const forcemerge = actions.forcemerge;
       phase.forceMergeEnabled = true;
       phase.selectedForceMergeSegments = forcemerge.max_num_segments.toString();
+      // only accepted value for index_codec
+      phase.bestCompressionEnabled = forcemerge.index_codec === 'best_compression';
     }
 
     if (actions.set_priority) {
@@ -105,6 +108,10 @@ export const hotPhaseToES = (
       esPhase.actions.forcemerge = {
         max_num_segments: parseInt(phase.selectedForceMergeSegments, 10),
       };
+      if (phase.bestCompressionEnabled) {
+        // only accepted value for index_codec
+        esPhase.actions.forcemerge.index_codec = 'best_compression';
+      }
     } else {
       delete esPhase.actions.forcemerge;
     }