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.

Sign up for GitHub

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

[SLO] Add/edit form mark optional fields #175807

Merged
merged 4 commits into from
Jan 31, 2024
Merged

[SLO] Add/edit form mark optional fields #175807

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
a799dea
mark optional fields
shahzad31 Jan 29, 2024
d36ef85
remove unused code
shahzad31 Jan 29, 2024
8194909
Merge branch 'main' of https://github.com/elastic/kibana into slo-for…
shahzad31 Jan 31, 2024
2b06a4d
PR feedback
shahzad31 Jan 31, 2024
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
42 changes: 0 additions & 42 deletions x-pack/plugins/observability/public/hooks/slo/use_fetch_index_pattern_fields.ts
View file
Open in desktop

This file was deleted.

56 changes: 7 additions & 49 deletions ...ublic/pages/slo_edit/components/apm_availability/apm_availability_indicator_type_form.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,18 +5,16 @@
* 2.0.
*/

import { EuiCallOut, EuiFlexGroup, EuiFlexItem, EuiIconTip } from '@elastic/eui';
import { EuiFlexGroup, EuiFlexItem, EuiIconTip } from '@elastic/eui';
import { i18n } from '@kbn/i18n';
import { ALL_VALUE } from '@kbn/slo-schema/src/schema/common';
import React, { useEffect } from 'react';
import { useFormContext } from 'react-hook-form';
import { useFetchGroupByCardinality } from '../../../../hooks/slo/use_fetch_group_by_cardinality';
import { useCreateDataView } from '../../../../hooks/use_create_data_view';
import { GroupByField } from '../common/group_by_field';
import { useFetchApmIndex } from '../../../../hooks/slo/use_fetch_apm_indices';
import { useFetchIndexPatternFields } from '../../../../hooks/slo/use_fetch_index_pattern_fields';
import { CreateSLOForm } from '../../types';
import { FieldSelector } from '../apm_common/field_selector';
import { DataPreviewChart } from '../common/data_preview_chart';
import { IndexFieldSelector } from '../common/index_field_selector';
import { QueryBuilder } from '../common/query_builder';

export function ApmAvailabilityIndicatorTypeForm() {
Expand All @@ -28,15 +26,10 @@ export function ApmAvailabilityIndicatorTypeForm() {
setValue('indicator.params.index', apmIndex);
}
}, [setValue, apmIndex]);
const timestampField = watch('indicator.params.timestampField');
const groupByField = watch('groupBy');

const { isLoading: isIndexFieldsLoading, data: indexFields = [] } =
useFetchIndexPatternFields(apmIndex);

const { isLoading: isGroupByCardinalityLoading, data: groupByCardinality } =
useFetchGroupByCardinality(apmIndex, timestampField, groupByField);
const groupByFields = indexFields.filter((field) => field.aggregatable);
const { dataView, loading: isIndexFieldsLoading } = useCreateDataView({
indexPatternString: apmIndex,
});

return (
<EuiFlexGroup direction="column" gutterSize="l">
Expand Down Expand Up @@ -140,42 +133,7 @@ export function ApmAvailabilityIndicatorTypeForm() {
</EuiFlexItem>
</EuiFlexGroup>

<IndexFieldSelector
indexFields={groupByFields}
name="groupBy"
defaultValue={ALL_VALUE}
label={
<span>
{i18n.translate('xpack.observability.slo.sloEdit.groupBy.label', {
defaultMessage: 'Group by',
})}{' '}
<EuiIconTip
content={i18n.translate('xpack.observability.slo.sloEdit.groupBy.tooltip', {
defaultMessage: 'Create individual SLOs for each value of the selected field.',
})}
position="top"
/>
</span>
}
placeholder={i18n.translate('xpack.observability.slo.sloEdit.groupBy.placeholder', {
defaultMessage: 'Select an optional field to group by',
})}
isLoading={!!apmIndex && isIndexFieldsLoading}
isDisabled={!apmIndex}
/>

{!isGroupByCardinalityLoading && !!groupByCardinality && (
<EuiCallOut
size="s"
iconType={groupByCardinality.isHighCardinality ? 'warning' : ''}
color={groupByCardinality.isHighCardinality ? 'warning' : 'primary'}
title={i18n.translate('xpack.observability.slo.sloEdit.groupBy.cardinalityInfo', {
defaultMessage:
"Selected group by field '{groupBy}' will generate at least {card} SLO instances based on the last 24h sample data.",
values: { card: groupByCardinality.cardinality, groupBy: groupByField },
})}
/>
)}
<GroupByField dataView={dataView} isLoading={isIndexFieldsLoading} />

<DataPreviewChart />
</EuiFlexGroup>
Expand Down
64 changes: 7 additions & 57 deletions ...vability/public/pages/slo_edit/components/apm_latency/apm_latency_indicator_type_form.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,25 +5,16 @@
* 2.0.
*/

import {
EuiCallOut,
EuiFieldNumber,
EuiFlexGroup,
EuiFlexItem,
EuiFormRow,
EuiIconTip,
} from '@elastic/eui';
import { EuiFieldNumber, EuiFlexGroup, EuiFlexItem, EuiFormRow, EuiIconTip } from '@elastic/eui';
import { i18n } from '@kbn/i18n';
import { ALL_VALUE } from '@kbn/slo-schema/src/schema/common';
import React, { useEffect } from 'react';
import { Controller, useFormContext } from 'react-hook-form';
import { useFetchGroupByCardinality } from '../../../../hooks/slo/use_fetch_group_by_cardinality';
import { GroupByField } from '../common/group_by_field';
import { useCreateDataView } from '../../../../hooks/use_create_data_view';
import { useFetchApmIndex } from '../../../../hooks/slo/use_fetch_apm_indices';
import { useFetchIndexPatternFields } from '../../../../hooks/slo/use_fetch_index_pattern_fields';
import { CreateSLOForm } from '../../types';
import { FieldSelector } from '../apm_common/field_selector';
import { DataPreviewChart } from '../common/data_preview_chart';
import { IndexFieldSelector } from '../common/index_field_selector';
import { QueryBuilder } from '../common/query_builder';

export function ApmLatencyIndicatorTypeForm() {
Expand All @@ -36,15 +27,9 @@ export function ApmLatencyIndicatorTypeForm() {
}
}, [setValue, apmIndex]);

const timestampField = watch('indicator.params.timestampField');
const groupByField = watch('groupBy');

const { isLoading: isIndexFieldsLoading, data: indexFields = [] } =
useFetchIndexPatternFields(apmIndex);

const { isLoading: isGroupByCardinalityLoading, data: groupByCardinality } =
useFetchGroupByCardinality(apmIndex, timestampField, groupByField);
const groupByFields = indexFields.filter((field) => field.aggregatable);
const { dataView, loading: isIndexFieldsLoading } = useCreateDataView({
indexPatternString: apmIndex,
});

return (
<EuiFlexGroup direction="column" gutterSize="l">
Expand Down Expand Up @@ -191,42 +176,7 @@ export function ApmLatencyIndicatorTypeForm() {
</EuiFlexItem>
</EuiFlexGroup>

<IndexFieldSelector
indexFields={groupByFields}
name="groupBy"
defaultValue={ALL_VALUE}
label={
<span>
{i18n.translate('xpack.observability.slo.sloEdit.groupBy.label', {
defaultMessage: 'Group by',
})}{' '}
<EuiIconTip
content={i18n.translate('xpack.observability.slo.sloEdit.groupBy.tooltip', {
defaultMessage: 'Create individual SLOs for each value of the selected field.',
})}
position="top"
/>
</span>
}
placeholder={i18n.translate('xpack.observability.slo.sloEdit.groupBy.placeholder', {
defaultMessage: 'Select an optional field to group by',
})}
isLoading={!!apmIndex && isIndexFieldsLoading}
isDisabled={!apmIndex}
/>

{!isGroupByCardinalityLoading && !!groupByCardinality && (
<EuiCallOut
size="s"
iconType={groupByCardinality.isHighCardinality ? 'warning' : ''}
color={groupByCardinality.isHighCardinality ? 'warning' : 'primary'}
title={i18n.translate('xpack.observability.slo.sloEdit.groupBy.cardinalityInfo', {
defaultMessage:
"Selected group by field '{groupBy}' will generate at least {card} SLO instances based on the last 24h sample data.",
values: { card: groupByCardinality.cardinality, groupBy: groupByField },
})}
/>
)}
<GroupByField dataView={dataView} isLoading={isIndexFieldsLoading} />

<DataPreviewChart />
</EuiFlexGroup>
Expand Down
70 changes: 70 additions & 0 deletions x-pack/plugins/observability/public/pages/slo_edit/components/common/group_by_field.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
/*
* Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
* or more contributor license agreements. Licensed under the Elastic License
* 2.0; you may not use this file except in compliance with the Elastic License
* 2.0.
*/

import { ALL_VALUE } from '@kbn/slo-schema';
import { i18n } from '@kbn/i18n';
import { EuiCallOut, EuiIconTip } from '@elastic/eui';
import React from 'react';
import { DataView } from '@kbn/data-views-plugin/common';
import { useFormContext } from 'react-hook-form';
import { OptionalText } from './optional_text';
import { useFetchGroupByCardinality } from '../../../../hooks/slo/use_fetch_group_by_cardinality';
import { CreateSLOForm } from '../../types';
import { IndexFieldSelector } from './index_field_selector';

export function GroupByField({ dataView, isLoading }: { dataView?: DataView; isLoading: boolean }) {
const { watch } = useFormContext<CreateSLOForm>();

const groupByFields = dataView?.fields?.filter((field) => field.aggregatable) ?? [];
const index = watch('indicator.params.index');
const timestampField = watch('indicator.params.timestampField');
const groupByField = watch('groupBy');

const { isLoading: isGroupByCardinalityLoading, data: groupByCardinality } =
useFetchGroupByCardinality(index, timestampField, groupByField);

return (
<>
<IndexFieldSelector
indexFields={groupByFields}
name="groupBy"
defaultValue={ALL_VALUE}
label={
<span>
{i18n.translate('xpack.observability.slo.sloEdit.groupBy.label', {
defaultMessage: 'Group by',
})}{' '}
<EuiIconTip
content={i18n.translate('xpack.observability.slo.sloEdit.groupBy.tooltip', {
defaultMessage: 'Create individual SLOs for each value of the selected field.',
})}
position="top"
/>
</span>
}
labelAppend={<OptionalText />}
placeholder={i18n.translate('xpack.observability.slo.sloEdit.groupBy.placeholder', {
defaultMessage: 'Select an optional field to group by',
})}
isLoading={!!index && isLoading}
isDisabled={!index}
/>
{!isGroupByCardinalityLoading && !!groupByCardinality && (
<EuiCallOut
size="s"
iconType={groupByCardinality.isHighCardinality ? 'warning' : ''}
color={groupByCardinality.isHighCardinality ? 'warning' : 'primary'}
title={i18n.translate('xpack.observability.slo.sloEdit.groupBy.cardinalityInfo', {
defaultMessage:
"Selected group by field '{groupBy}' will generate at least {card} SLO instances based on the last 24h sample data.",
values: { card: groupByCardinality.cardinality, groupBy: groupByField },
})}
/>
)}
</>
);
}
4 changes: 3 additions & 1 deletion ...ck/plugins/observability/public/pages/slo_edit/components/common/index_field_selector.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,11 +21,13 @@ interface Props {
isLoading: boolean;
isRequired?: boolean;
defaultValue?: string;
labelAppend?: ReactNode;
}
export function IndexFieldSelector({
indexFields,
name,
label,
labelAppend,
placeholder,
isDisabled,
isLoading,
Expand All @@ -41,7 +43,7 @@ export function IndexFieldSelector({

return (
<EuiFlexItem>
<EuiFormRow label={label} isInvalid={getFieldState(name).invalid}>
<EuiFormRow label={label} isInvalid={getFieldState(name).invalid} labelAppend={labelAppend}>
<Controller
defaultValue={defaultValue}
name={name}
Expand Down
20 changes: 20 additions & 0 deletions x-pack/plugins/observability/public/pages/slo_edit/components/common/optional_text.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
/*
* Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
* or more contributor license agreements. Licensed under the Elastic License
* 2.0; you may not use this file except in compliance with the Elastic License
* 2.0.
*/

import { EuiText } from '@elastic/eui';
import { i18n } from '@kbn/i18n';
import React from 'react';

export function OptionalText() {
return (
<EuiText size="xs" color="subdued">
{i18n.translate('xpack.observability.slo.sloEdit.optionalLabel', {
defaultMessage: 'Optional',
})}
</EuiText>
);
}
6 changes: 3 additions & 3 deletions x-pack/plugins/observability/public/pages/slo_edit/components/common/query_builder.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ import { Controller, FieldPath, useFormContext } from 'react-hook-form';
import { useCreateDataView } from '../../../../hooks/use_create_data_view';
import { useKibana } from '../../../../utils/kibana_react';
import { CreateSLOForm } from '../../types';
import { OptionalText } from './optional_text';

export interface Props {
dataTestSubj: string;
Expand Down Expand Up @@ -54,6 +55,7 @@ export function QueryBuilder({
label
)
}
labelAppend={!required ? <OptionalText /> : undefined}
isInvalid={getFieldState(name).invalid}
fullWidth
>
Expand All @@ -62,14 +64,12 @@ export function QueryBuilder({
name={name}
control={control}
rules={{
required: Boolean(required),
required: Boolean(required) && Boolean(dataView),
}}
render={({ field, fieldState }) => (
<QueryStringInput
appName="Observability"
bubbleSubmitEvent={false}
dataTestSubj={dataTestSubj}
disableAutoFocus
disableLanguageSwitcher
indexPatterns={dataView ? [dataView] : []}
isDisabled={!dataView}
Expand Down
Loading