maxmustermann/kibana
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

[alerts] adds support for index threshold index param string type (#88540)

Browse source 
resolves https://github.com/elastic/kibana/issues/68575

The index threshold alert defines an `index` parameter which is
typed as `string | string[]`.  However the UI for this alert has
been typing it as only `string[]`.

This PR changes the UI to work with an incoming string value for
this parameter.  If the parameter is edited in the UI, it will always
be set as an array, even if there is only one element.
This commit is contained in:
Patrick Mueller 2021-01-25 16:43:46 -05:00 committed by GitHub
parent 5d68b10106
commit 14fa82dc54
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
4 changed files with 17 additions and 10 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

21
x-pack/plugins/stack_alerts/public/alert_types/threshold/expression.tsx
View file

@ -75,6 +75,12 @@ function isString(value: unknown): value is string {
return typeof value === 'string';
}
// normalize the `index` parameter to be a string array
function indexParamToArray(index: string | string[]): string[] {
if (!index) return [];
return isString(index) ? [index] : index;
}
export const IndexThresholdAlertTypeExpression: React.FunctionComponent<
AlertTypeParamsExpressionProps<IndexThresholdAlertParams>
> = ({ alertParams, alertInterval, setAlertParams, setAlertProperty, errors, charts, data }) => {
@ -92,6 +98,7 @@ export const IndexThresholdAlertTypeExpression: React.FunctionComponent<
timeWindowUnit,
} = alertParams;
const indexArray = indexParamToArray(index);
const { http } = useKibana<KibanaDeps>().services;
const [indexPopoverOpen, setIndexPopoverOpen] = useState(false);
@ -131,8 +138,8 @@ export const IndexThresholdAlertTypeExpression: React.FunctionComponent<
threshold: threshold ?? DEFAULT_VALUES.THRESHOLD,
});
if (index && index.length > 0) {
const currentEsFields = await getFields(http, index);
if (indexArray.length > 0) {
const currentEsFields = await getFields(http, indexArray);
const timeFields = getTimeFieldOptions(currentEsFields);
setEsFields(currentEsFields);
@ -170,7 +177,7 @@ export const IndexThresholdAlertTypeExpression: React.FunctionComponent<
defaultMessage="Indices to query"
/>
}
isInvalid={errors.index.length > 0 && index !== undefined}
isInvalid={errors.index.length > 0 && indexArray.length > 0}
error={errors.index}
helpText={
<FormattedMessage
@ -183,11 +190,11 @@ export const IndexThresholdAlertTypeExpression: React.FunctionComponent<
fullWidth
async
isLoading={isIndiciesLoading}
isInvalid={errors.index.length > 0 && index !== undefined}
isInvalid={errors.index.length > 0 && indexArray.length > 0}
noSuggestions={!indexOptions.length}
options={indexOptions}
data-test-subj="thresholdIndexesComboBox"
selectedOptions={(index || []).map((anIndex: string) => {
selectedOptions={indexArray.map((anIndex: string) => {
return {
label: anIndex,
value: anIndex,
@ -306,12 +313,12 @@ export const IndexThresholdAlertTypeExpression: React.FunctionComponent<
description={i18n.translate('xpack.stackAlerts.threshold.ui.alertParams.indexLabel', {
defaultMessage: 'index',
})}
value={index && index.length > 0 ? renderIndices(index) : firstFieldOption.text}
value={indexArray.length > 0 ? renderIndices(indexArray) : firstFieldOption.text}
isActive={indexPopoverOpen}
onClick={() => {
setIndexPopoverOpen(true);
}}
isInvalid={!(index && index.length > 0 && timeField !== '')}
isInvalid={!(indexArray.length > 0 && timeField !== '')}
/>
}
isOpen={indexPopoverOpen}

2
x-pack/plugins/stack_alerts/public/alert_types/threshold/types.ts
View file

@ -27,7 +27,7 @@ export interface GroupByType {
}
export interface IndexThresholdAlertParams extends AlertTypeParams {
index: string[];
index: string | string[];
timeField?: string;
aggType: string;
aggField?: string;

2
x-pack/plugins/stack_alerts/public/alert_types/threshold/validation.test.ts
View file

@ -32,7 +32,7 @@ describe('expression params validation', () => {
});
test('if aggField property is invalid should return proper error message', () => {
const initialParams: IndexThresholdAlertParams = {
index: ['test'],
index: 'test',
aggType: 'avg',
threshold: [],
timeWindowSize: 1,

2
x-pack/test/functional_with_es_ssl/apps/triggers_actions_ui/details.ts
View file

@ -228,7 +228,7 @@ export default ({ getPageObjects, getService }: FtrProviderContext) => {
timeWindowUnit: 'm',
groupBy: 'all',
threshold: [1000, 5000],
index: ['.kibana_1'],
index: '.kibana_1',
timeField: 'alert',
},
actions: [