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

[8.x] feat(slo): SLO grouping values selector (#202364) #203168

Merged
merged 1 commit into from
Dec 5, 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

This file was deleted.

Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
/*
* 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 * as t from 'io-ts';
import { toBooleanRt } from '@kbn/io-ts-utils';

const getSLOGroupingsParamsSchema = t.type({
path: t.type({ id: t.string }),
query: t.intersection([
t.type({
instanceId: t.string,
groupingKey: t.string,
}),
t.partial({
search: t.string,
afterKey: t.string,
size: t.string,
excludeStale: toBooleanRt,
remoteName: t.string,
}),
]),
});

const getSLOGroupingsResponseSchema = t.type({
groupingKey: t.string,
values: t.array(t.string),
afterKey: t.union([t.string, t.undefined]),
});

type GetSLOGroupingsParams = t.TypeOf<typeof getSLOGroupingsParamsSchema.props.query>;
type GetSLOGroupingsResponse = t.OutputOf<typeof getSLOGroupingsResponseSchema>;

export { getSLOGroupingsParamsSchema, getSLOGroupingsResponseSchema };
export type { GetSLOGroupingsResponse, GetSLOGroupingsParams };
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ export * from './find_group';
export * from './find_definition';
export * from './get';
export * from './get_burn_rates';
export * from './get_instances';
export * from './get_slo_groupings';
export * from './get_preview_data';
export * from './reset';
export * from './manage';
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
/*
* 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 { EuiFlexGroup, EuiFlexItem, EuiLoadingSpinner } from '@elastic/eui';
import React from 'react';

export function LoadingState({ dataTestSubj }: { dataTestSubj?: string }) {
return (
<EuiFlexGroup alignItems="center" justifyContent="center" style={{ height: '100%' }}>
<EuiFlexItem grow={false}>
<EuiLoadingSpinner size="xxl" data-test-subj={dataTestSubj} />
</EuiFlexItem>
</EuiFlexGroup>
);
}
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ export function AutoRefreshButton({ disabled, isAutoRefreshing, onClick }: Props
data-test-subj="autoRefreshButton"
disabled={disabled}
iconSide="left"
iconType="play"
iconType="refresh"
onClick={onClick}
>
{i18n.translate('xpack.slo.slosPage.autoRefreshButtonLabel', {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,15 @@ export const sloKeys = {
groupings?: Record<string, unknown>
) => [...sloKeys.all, 'preview', indicator, range, groupings] as const,
burnRateRules: (search: string) => [...sloKeys.all, 'burnRateRules', search],
groupings: (params: {
sloId: string;
instanceId: string;
groupingKey: string;
search?: string;
afterKey?: string;
excludeStale?: boolean;
remoteName?: string;
}) => [...sloKeys.all, 'fetch_slo_groupings', params] as const,
};

export type SloKeys = typeof sloKeys;
Original file line number Diff line number Diff line change
@@ -0,0 +1,149 @@
/*
* 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 {
EuiButtonIcon,
EuiComboBox,
EuiComboBoxOptionOption,
EuiCopy,
EuiFlexItem,
} from '@elastic/eui';
import { css } from '@emotion/react';
import { i18n } from '@kbn/i18n';
import { ALL_VALUE, SLOWithSummaryResponse } from '@kbn/slo-schema';
import React, { useEffect, useState } from 'react';
import { useHistory, useLocation } from 'react-router-dom';
import useDebounce from 'react-use/lib/useDebounce';
import { SLOS_BASE_PATH } from '../../../../../common/locators/paths';
import { useFetchSloGroupings } from '../../hooks/use_fetch_slo_instances';
import { useGetQueryParams } from '../../hooks/use_get_query_params';

interface Props {
slo: SLOWithSummaryResponse;
groupingKey: string;
value?: string;
}

interface Field {
label: string;
value: string;
}

export function SLOGroupingValueSelector({ slo, groupingKey, value }: Props) {
const isAvailable = window.location.pathname.includes(SLOS_BASE_PATH);
const { search: searchParams } = useLocation();
const history = useHistory();
const { remoteName } = useGetQueryParams();

const [currentValue, setCurrentValue] = useState<string | undefined>(value);
const [options, setOptions] = useState<Field[]>([]);
const [search, setSearch] = useState<string | undefined>(undefined);
const [debouncedSearch, setDebouncedSearch] = useState<string | undefined>(undefined);
useDebounce(() => setDebouncedSearch(search), 500, [search]);

const { isLoading, isError, data } = useFetchSloGroupings({
sloId: slo.id,
groupingKey,
instanceId: slo.instanceId ?? ALL_VALUE,
search: debouncedSearch,
remoteName,
});

useEffect(() => {
if (data) {
setSearch(undefined);
setDebouncedSearch(undefined);
setOptions(data.values.map(toField));
}
}, [data]);

const onChange = (selected: Array<EuiComboBoxOptionOption<string>>) => {
const newValue = selected[0].value;
if (!newValue) return;
setCurrentValue(newValue);

const urlSearchParams = new URLSearchParams(searchParams);
const newGroupings = { ...slo.groupings, [groupingKey]: newValue };
urlSearchParams.set('instanceId', toInstanceId(newGroupings, slo.groupBy));
history.replace({
search: urlSearchParams.toString(),
});
};

return (
<EuiFlexItem grow={false}>
<EuiComboBox<string>
css={css`
max-width: 500px;
`}
isClearable={false}
compressed
prepend={groupingKey}
append={
currentValue ? (
<EuiCopy textToCopy={currentValue}>
{(copy) => (
<EuiButtonIcon
data-test-subj="sloSLOGroupingValueSelectorButton"
color="text"
iconType="copyClipboard"
onClick={copy}
aria-label={i18n.translate(
'xpack.slo.sLOGroupingValueSelector.copyButton.label',
{
defaultMessage: 'Copy value to clipboard',
}
)}
/>
)}
</EuiCopy>
) : (
<EuiButtonIcon
data-test-subj="sloSLOGroupingValueSelectorButton"
color="text"
disabled={true}
iconType="copyClipboard"
aria-label={i18n.translate(
'xpack.slo.sLOGroupingValueSelector.copyButton.noValueLabel',
{ defaultMessage: 'Select a value before' }
)}
/>
)
}
singleSelection={{ asPlainText: true }}
options={options}
isLoading={isLoading}
isDisabled={isError || !isAvailable}
placeholder={i18n.translate('xpack.slo.sLOGroupingValueSelector.placeholder', {
defaultMessage: 'Select a group value',
})}
selectedOptions={currentValue ? [toField(currentValue)] : []}
onChange={onChange}
truncationProps={{
truncation: 'end',
}}
onSearchChange={(searchValue: string) => {
if (searchValue !== '') {
setSearch(searchValue);
}
}}
/>
</EuiFlexItem>
);
}

function toField(value: string): Field {
return { label: value, value };
}

function toInstanceId(
groupings: Record<string, string | number>,
groupBy: string | string[]
): string {
const groups = [groupBy].flat();
return groups.map((group) => groupings[group]).join(',');
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
/*
* 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 { EuiFlexGroup, EuiFlexItem, EuiText } from '@elastic/eui';
import { i18n } from '@kbn/i18n';
import { SLOWithSummaryResponse } from '@kbn/slo-schema';
import React from 'react';
import { SLOGroupingValueSelector } from './slo_grouping_value_selector';

export function SLOGroupings({ slo }: { slo: SLOWithSummaryResponse }) {
const groupings = Object.entries(slo.groupings ?? {});

if (!groupings.length) {
return null;
}

return (
<EuiFlexGroup direction="row" gutterSize="s" alignItems="center">
<EuiFlexItem grow={false}>
<EuiText size="xs">
<h4>
{i18n.translate('xpack.slo.sloDetails.groupings.title', {
defaultMessage: 'Instance',
})}
</h4>
</EuiText>
</EuiFlexItem>
{groupings.map(([groupingKey, groupingValue]) => {
return (
<SLOGroupingValueSelector
key={groupingKey}
slo={slo}
groupingKey={groupingKey}
value={String(groupingValue)}
/>
);
})}
</EuiFlexGroup>
);
}
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,10 @@
* 2.0.
*/

import React from 'react';
import { ComponentStory } from '@storybook/react';

import { KibanaReactStorybookDecorator } from '../../../utils/kibana_react.storybook_decorator';
import React from 'react';
import { buildSlo } from '../../../data/slo/slo';
import { KibanaReactStorybookDecorator } from '../../../utils/kibana_react.storybook_decorator';
import { HeaderControl as Component, Props } from './header_control';

export default {
Expand All @@ -22,11 +21,10 @@ const Template: ComponentStory<typeof Component> = (props: Props) => <Component

const defaultProps: Props = {
slo: buildSlo(),
isLoading: false,
};

export const Default = Template.bind({});
Default.args = defaultProps;

export const WithLoading = Template.bind({});
WithLoading.args = { slo: undefined, isLoading: true };
WithLoading.args = { slo: undefined };
Loading
Loading