Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

make custom result index lifecycle management in AD optional #777

Merged
merged 3 commits into from
Jun 11, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -23,27 +23,48 @@ import {
EuiIcon,
EuiFieldNumber,
} from '@elastic/eui';
import { Field, FieldProps } from 'formik';
import React, { useState } from 'react';
import { Field, FieldProps, FormikProps, useFormikContext } from 'formik';
import React, { useEffect, useState } from 'react';
import ContentPanel from '../../../../components/ContentPanel/ContentPanel';
import { CUSTOM_AD_RESULT_INDEX_PREFIX } from '../../../../../server/utils/constants';
import { BASE_DOCS_LINK } from '../../../../utils/constants';
import {
isInvalid,
getError,
validateCustomResultIndex,
validatePositiveInteger,
validateEmptyOrPositiveInteger,
} from '../../../../utils/utils';
import { FormattedFormRow } from '../../../../components/FormattedFormRow/FormattedFormRow';
import { DetectorDefinitionFormikValues } from '../../models/interfaces';
import { get } from 'lodash';

interface CustomResultIndexProps {
isEdit: boolean;
useDefaultResultIndex?: boolean;
resultIndex?: string;
formikProps: FormikProps<DetectorDefinitionFormikValues>;
}

function CustomResultIndex(props: CustomResultIndexProps) {
const [enabled, setEnabled] = useState<boolean>(!!props.resultIndex);
const [customResultIndexConditionsEnabled, setCustomResultIndexConditionsEnabled] = useState<boolean>(true);
const customResultIndexMinAge = get(props.formikProps, 'values.resultIndexMinAge');
const customResultIndexMinSize = get(props.formikProps, 'values.resultIndexMinSize');
const customResultIndexTTL = get(props.formikProps, 'values.resultIndexTtl');
const { setFieldValue } = useFormikContext();

useEffect(() => {
if (props.isEdit) {
if (customResultIndexMinAge === undefined && customResultIndexMinSize === undefined && customResultIndexTTL === undefined) {
setCustomResultIndexConditionsEnabled(false);
}
}
if (!customResultIndexConditionsEnabled) {
setFieldValue('resultIndexMinAge', '');
setFieldValue('resultIndexMinSize', '');
setFieldValue('resultIndexTtl', '');
}
},[customResultIndexConditionsEnabled])

return (
<ContentPanel
Expand Down Expand Up @@ -89,7 +110,7 @@ function CustomResultIndex(props: CustomResultIndexProps) {
<EuiFlexItem>
<EuiCallOut
data-test-subj="cannotEditResultIndexCallout"
title="You can't change the custom result index after creating the detector. You can manage the result index using the following three settings."
title="You can't change the custom result index after creating the detector. You can manage the result index using the following three settings inside Anomaly Detection plugin or with the Index Management plugin."
color="warning"
iconType="alert"
size="s"
Expand All @@ -115,20 +136,37 @@ function CustomResultIndex(props: CustomResultIndexProps) {
</EuiFormRow>
</EuiFlexItem>
) : null}

{enabled ? (
<EuiFlexItem>
<EuiCheckbox
id={'resultIndexConditionCheckbox'}
label="Enable custom result index lifecycle management"
checked={customResultIndexConditionsEnabled}
onChange={() => {
setCustomResultIndexConditionsEnabled(!customResultIndexConditionsEnabled);
}}
/>
</EuiFlexItem>
) : null}
</EuiFlexGroup>
)}
</Field>

{enabled ? (<Field
{ (enabled && customResultIndexConditionsEnabled) ? (<Field
name="resultIndexMinAge"
validate={enabled ? validatePositiveInteger : null}
validate={(enabled && customResultIndexConditionsEnabled) ? validateEmptyOrPositiveInteger : null}
>
{({ field, form }: FieldProps) => (
<EuiFlexGroup>
<EuiFlexItem style={{ maxWidth: '70%' }}>
<FormattedFormRow
fullWidth
title="Max Index Age"
formattedTitle={
<p>
Min Index Age <span className="optional">- optional</span>
</p>
}
hint={[
`This setting would define a specific threshold for the age of an index. When this threshold is surpassed, a rollover will be triggered automatically.`,
]}
Expand All @@ -141,6 +179,7 @@ function CustomResultIndex(props: CustomResultIndexProps) {
name="resultIndexMinAge"
id="resultIndexMinAge"
data-test-subj="resultIndexMinAge"
placeholder="Min index age"
min={1}
{...field}
/>
Expand All @@ -157,16 +196,20 @@ function CustomResultIndex(props: CustomResultIndexProps) {
)}
</Field>) : null}

{enabled ? (<Field
{(enabled && customResultIndexConditionsEnabled) ? (<Field
name="resultIndexMinSize"
validate={enabled ? validatePositiveInteger : null}
validate={(enabled && customResultIndexConditionsEnabled) ? validateEmptyOrPositiveInteger : null}
>
{({ field, form }: FieldProps) => (
<EuiFlexGroup>
<EuiFlexItem style={{ maxWidth: '70%' }}>
<FormattedFormRow
fullWidth
title="Max Index Size"
formattedTitle={
<p>
Min Index Size <span className="optional">- optional</span>
</p>
}
hint={[
`This setting would define a specific threshold for the size of an index. When this threshold is surpassed, a rollover will be triggered automatically.`,
]}
Expand All @@ -178,7 +221,7 @@ function CustomResultIndex(props: CustomResultIndexProps) {
<EuiFieldNumber
name="resultIndexMinSize"
id="resultIndexMinSize"
placeholder="Max index size"
placeholder="Min index size"
data-test-subj="resultIndexMinSize"
min={1000}
{...field}
Expand All @@ -196,16 +239,20 @@ function CustomResultIndex(props: CustomResultIndexProps) {
)}
</Field>) : null}

{enabled ? (<Field
{(enabled && customResultIndexConditionsEnabled) ? (<Field
name="resultIndexTtl"
validate={enabled ? validatePositiveInteger : null}
validate={(enabled && customResultIndexConditionsEnabled) ? validateEmptyOrPositiveInteger : null}
>
{({ field, form }: FieldProps) => (
<EuiFlexGroup>
<EuiFlexItem style={{ maxWidth: '70%' }}>
<FormattedFormRow
fullWidth
title="Index TTL"
formattedTitle={
<p>
Index TTL <span className="optional">- optional</span>
</p>
}
hint={[
`This setting would define the duration after which an index is considered expired and eligible for deletion.`,
]}
Expand All @@ -218,6 +265,7 @@ function CustomResultIndex(props: CustomResultIndexProps) {
name="resultIndexTtl"
id="resultIndexTtl"
data-test-subj="resultIndexTtl"
placeholder="Index TTL"
min={1}
{...field}
/>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -392,6 +392,7 @@ export const DefineDetector = (props: DefineDetectorProps) => {
<CustomResultIndex
isEdit={props.isEdit}
resultIndex={get(formikProps, 'values.resultIndex')}
formikProps={formikProps}
/>
</Fragment>
</EuiPageBody>
Expand Down
6 changes: 3 additions & 3 deletions public/pages/DefineDetector/models/interfaces.ts
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ export interface DetectorDefinitionFormikValues {
timeField: string;
interval: number;
windowDelay: number;
resultIndexMinAge?: number;
resultIndexMinSize?: number;
resultIndexTtl?:number;
resultIndexMinAge?: number | string;
resultIndexMinSize?: number | string;
resultIndexTtl?:number | string;
}
6 changes: 3 additions & 3 deletions public/pages/DefineDetector/utils/helpers.ts
Original file line number Diff line number Diff line change
Expand Up @@ -45,9 +45,9 @@ export function detectorDefinitionToFormik(
timeField: ad.timeField,
interval: get(ad, 'detectionInterval.period.interval', 10),
windowDelay: get(ad, 'windowDelay.period.interval', 0),
resultIndexMinAge: get(ad, 'resultIndexMinAge', 7),
resultIndexMinSize:get(ad, 'resultIndexMinSize', 51200),
resultIndexTtl: get(ad, 'resultIndexTtl', 60),
resultIndexMinAge: get(ad, 'resultIndexMinAge', undefined),
resultIndexMinSize:get(ad, 'resultIndexMinSize', undefined),
resultIndexTtl: get(ad, 'resultIndexTtl', undefined),
};
}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -131,9 +131,13 @@ export const DetectorDefinitionFields = (
}
};

const minAge = get(props, 'detector.resultIndexMinAge', '-');
const minSize = get(props, 'detector.resultIndexMinSize', '-');
const ttl = get(props, 'detector.resultIndexTtl', '-');
const minAgeValue = get(props, 'detector.resultIndexMinAge', undefined);
const minAge = (minAgeValue === undefined) ? '-' : minAgeValue + " Days";
const minSizeValue = get(props, 'detector.resultIndexMinSize', undefined);
const minSize = (minSizeValue === undefined) ? '-' : minSizeValue + " MB";
const ttlValue = get(props, 'detector.resultIndexTtl', undefined);
const ttl = (ttlValue === undefined) ? '-' : ttlValue + " Days";


return (
<ContentPanel
Expand Down Expand Up @@ -224,19 +228,19 @@ export const DetectorDefinitionFields = (
<EuiFlexItem>
<ConfigCell
title="Custom result index min age"
description={minAge === '-' ? minAge : `${minAge} Days`}
description={minAge}
/>
</EuiFlexItem>
<EuiFlexItem>
<ConfigCell
title="Custom result index min size"
description={minSize == '-' ? minSize : `${minSize} MB`}
description={minSize}
/>
</EuiFlexItem>
<EuiFlexItem>
<ConfigCell
title="Custom result index TTL"
description={ttl == '-' ? ttl : `${ttl} Days`}
description={ttl}
/>
</EuiFlexItem>
</EuiFlexGrid>
Expand Down
5 changes: 5 additions & 0 deletions public/utils/utils.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -110,6 +110,11 @@ export const validatePositiveInteger = (value: any) => {
return 'Must be a positive integer';
};

export const validateEmptyOrPositiveInteger = (value: any) => {
if (Number.isInteger(value) && value < 1)
return 'Must be a positive integer';
};

export const validateNonNegativeInteger = (value: any) => {
if (!Number.isInteger(value) || value < 0)
return 'Must be a non-negative integer';
Expand Down
Loading