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

Consolidating rule status: frontend changes #11

Open
wants to merge 4 commits into
base: 136039-rules-status
Choose a base branch
from
Open
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 @@ -40,7 +40,7 @@ const getMockRule = () => {
error: null,
},
monitoring: {
execution: {
run: {
history: [
{
success: true,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -88,6 +88,7 @@ export const StorybookContextDecorator: React.FC<StorybookContextDecoratorProps>
ruleTagFilter: true,
ruleStatusFilter: true,
rulesDetailLogs: true,
ruleLastRunOutcome: true,
},
});
return (
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ export const allowedExperimentalValues = Object.freeze({
ruleTagFilter: true,
ruleStatusFilter: true,
rulesDetailLogs: true,
ruleLastRunOutcome: true,
});

type ExperimentalConfigKeys = Array<keyof ExperimentalFeatures>;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,7 @@ interface UseBulkEditSelectProps {
actionTypesFilter?: string[];
tagsFilter?: string[];
ruleExecutionStatusesFilter?: string[];
ruleLastRunOutcomesFilter?: string[];
ruleStatusesFilter?: RuleStatus[];
searchText?: string;
}
Expand All @@ -89,6 +90,7 @@ export function useBulkEditSelect(props: UseBulkEditSelectProps) {
actionTypesFilter,
tagsFilter,
ruleExecutionStatusesFilter,
ruleLastRunOutcomesFilter,
ruleStatusesFilter,
searchText,
} = props;
Expand Down Expand Up @@ -187,6 +189,7 @@ export function useBulkEditSelect(props: UseBulkEditSelectProps) {
actionTypesFilter,
tagsFilter,
ruleExecutionStatusesFilter,
ruleLastRunOutcomesFilter,
ruleStatusesFilter,
searchText,
});
Expand All @@ -208,6 +211,7 @@ export function useBulkEditSelect(props: UseBulkEditSelectProps) {
actionTypesFilter,
tagsFilter,
ruleExecutionStatusesFilter,
ruleLastRunOutcomesFilter,
ruleStatusesFilter,
searchText,
]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,21 @@

import { i18n } from '@kbn/i18n';
import { useState, useCallback, useMemo } from 'react';
import { RuleExecutionStatusValues } from '@kbn/alerting-plugin/common';
import { RuleExecutionStatusValues, RuleLastRunOutcomeValues } from '@kbn/alerting-plugin/common';
import type { LoadRuleAggregationsProps } from '../lib/rule_api';
import { loadRuleAggregationsWithKueryFilter } from '../lib/rule_api/aggregate_kuery_filter';
import { useKibana } from '../../common/lib/kibana';

const initializeAggregationResult = (values: readonly string[]) => {
return values.reduce<Record<string, number>>(
(prev: Record<string, number>, status: string) => ({
...prev,
[status]: 0,
}),
{}
);
};

type UseLoadRuleAggregationsProps = Omit<LoadRuleAggregationsProps, 'http'> & {
onError: (message: string) => void;
};
Expand All @@ -21,22 +31,21 @@ export function useLoadRuleAggregations({
typesFilter,
actionTypesFilter,
ruleExecutionStatusesFilter,
ruleLastRunOutcomesFilter,
ruleStatusesFilter,
tagsFilter,
onError,
}: UseLoadRuleAggregationsProps) {
const { http } = useKibana().services;

const [rulesStatusesTotal, setRulesStatusesTotal] = useState<Record<string, number>>(
RuleExecutionStatusValues.reduce<Record<string, number>>(
(prev: Record<string, number>, status: string) => ({
...prev,
[status]: 0,
}),
{}
)
initializeAggregationResult(RuleExecutionStatusValues)
);

const [rulesLastRunOutcomesTotal, setRulesLastRunOutcomesTotal] = useState<
Record<string, number>
>(initializeAggregationResult(RuleLastRunOutcomeValues));

const internalLoadRuleAggregations = useCallback(async () => {
try {
const rulesAggs = await loadRuleAggregationsWithKueryFilter({
Expand All @@ -45,12 +54,16 @@ export function useLoadRuleAggregations({
typesFilter,
actionTypesFilter,
ruleExecutionStatusesFilter,
ruleLastRunOutcomesFilter,
ruleStatusesFilter,
tagsFilter,
});
if (rulesAggs?.ruleExecutionStatus) {
setRulesStatusesTotal(rulesAggs.ruleExecutionStatus);
}
if (rulesAggs?.ruleLastRunOutcome) {
setRulesLastRunOutcomesTotal(rulesAggs.ruleLastRunOutcome);
}
} catch (e) {
onError(
i18n.translate(
Expand All @@ -67,18 +80,28 @@ export function useLoadRuleAggregations({
typesFilter,
actionTypesFilter,
ruleExecutionStatusesFilter,
ruleLastRunOutcomesFilter,
ruleStatusesFilter,
tagsFilter,
onError,
setRulesStatusesTotal,
setRulesLastRunOutcomesTotal,
]);

return useMemo(
() => ({
loadRuleAggregations: internalLoadRuleAggregations,
rulesStatusesTotal,
rulesLastRunOutcomesTotal,
setRulesStatusesTotal,
setRulesLastRunOutcomesTotal,
}),
[internalLoadRuleAggregations, rulesStatusesTotal, setRulesStatusesTotal]
[
internalLoadRuleAggregations,
rulesStatusesTotal,
rulesLastRunOutcomesTotal,
setRulesStatusesTotal,
setRulesLastRunOutcomesTotal,
]
);
}
Original file line number Diff line number Diff line change
Expand Up @@ -89,6 +89,7 @@ export function useLoadRules({
typesFilter,
actionTypesFilter,
ruleExecutionStatusesFilter,
ruleLastRunOutcomesFilter,
ruleStatusesFilter,
tagsFilter,
sort,
Expand Down Expand Up @@ -120,6 +121,7 @@ export function useLoadRules({
typesFilter,
actionTypesFilter,
ruleExecutionStatusesFilter,
ruleLastRunOutcomesFilter,
ruleStatusesFilter,
tagsFilter,
sort,
Expand All @@ -144,6 +146,7 @@ export function useLoadRules({
hasEmptyTypesFilter &&
isEmpty(actionTypesFilter) &&
isEmpty(ruleExecutionStatusesFilter) &&
isEmpty(ruleLastRunOutcomesFilter) &&
isEmpty(ruleStatusesFilter) &&
isEmpty(tagsFilter)
);
Expand All @@ -168,6 +171,7 @@ export function useLoadRules({
typesFilter,
actionTypesFilter,
ruleExecutionStatusesFilter,
ruleLastRunOutcomesFilter,
ruleStatusesFilter,
tagsFilter,
sort,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ export interface RuleTagsAggregations {

export const rewriteBodyRes: RewriteRequestCase<RuleAggregations> = ({
rule_execution_status: ruleExecutionStatus,
rule_last_run_outcome: ruleLastRunOutcome,
rule_enabled_status: ruleEnabledStatus,
rule_muted_status: ruleMutedStatus,
rule_snoozed_status: ruleSnoozedStatus,
Expand All @@ -26,6 +27,7 @@ export const rewriteBodyRes: RewriteRequestCase<RuleAggregations> = ({
ruleEnabledStatus,
ruleMutedStatus,
ruleSnoozedStatus,
ruleLastRunOutcome,
ruleTags,
});

Expand All @@ -41,6 +43,7 @@ export interface LoadRuleAggregationsProps {
typesFilter?: string[];
actionTypesFilter?: string[];
ruleExecutionStatusesFilter?: string[];
ruleLastRunOutcomesFilter?: string[];
ruleStatusesFilter?: RuleStatus[];
tagsFilter?: string[];
}
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
*/
import { RuleExecutionStatus } from '@kbn/alerting-plugin/common';
import { AsApiContract, RewriteRequestCase } from '@kbn/actions-plugin/common';
import { Rule, RuleAction, ResolvedRule } from '../../../types';
import { Rule, RuleAction, ResolvedRule, RuleLastRun } from '../../../types';

const transformAction: RewriteRequestCase<RuleAction> = ({
group,
Expand All @@ -30,6 +30,16 @@ const transformExecutionStatus: RewriteRequestCase<RuleExecutionStatus> = ({
...rest,
});

const transformLastRun: RewriteRequestCase<RuleLastRun> = ({
outcome_msg: outcomeMsg,
alerts_count: alertsCount,
...rest
}) => ({
outcomeMsg,
alertsCount,
...rest,
});

export const transformRule: RewriteRequestCase<Rule> = ({
rule_type_id: ruleTypeId,
created_by: createdBy,
Expand All @@ -46,6 +56,8 @@ export const transformRule: RewriteRequestCase<Rule> = ({
snooze_schedule: snoozeSchedule,
is_snoozed_until: isSnoozedUntil,
active_snoozes: activeSnoozes,
last_run: lastRun,
next_run: nextRun,
...rest
}: any) => ({
ruleTypeId,
Expand All @@ -65,6 +77,8 @@ export const transformRule: RewriteRequestCase<Rule> = ({
scheduledTaskId,
isSnoozedUntil,
activeSnoozes,
...(lastRun ? { lastRun: transformLastRun(lastRun) } : {}),
...(nextRun ? { nextRun } : {}),
...rest,
});

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,13 @@ import { transformRule } from './common_transformations';

type RuleCreateBody = Omit<
RuleUpdates,
'createdBy' | 'updatedBy' | 'muteAll' | 'mutedInstanceIds' | 'executionStatus'
| 'createdBy'
| 'updatedBy'
| 'muteAll'
| 'mutedInstanceIds'
| 'executionStatus'
| 'lastRun'
| 'nextRun'
>;
const rewriteBodyRequest: RewriteResponseCase<RuleCreateBody> = ({
ruleTypeId,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ export const mapFiltersToKueryNode = ({
typesFilter,
actionTypesFilter,
ruleExecutionStatusesFilter,
ruleLastRunOutcomesFilter,
ruleStatusesFilter,
tagsFilter,
searchText,
Expand All @@ -20,6 +21,7 @@ export const mapFiltersToKueryNode = ({
actionTypesFilter?: string[];
tagsFilter?: string[];
ruleExecutionStatusesFilter?: string[];
ruleLastRunOutcomesFilter?: string[];
ruleStatusesFilter?: RuleStatus[];
searchText?: string;
}): KueryNode | null => {
Expand Down Expand Up @@ -51,6 +53,16 @@ export const mapFiltersToKueryNode = ({
);
}

if (ruleLastRunOutcomesFilter && ruleLastRunOutcomesFilter.length) {
filterKueryNode.push(
nodeBuilder.or(
ruleLastRunOutcomesFilter.map((resf) =>
nodeBuilder.is('alert.attributes.lastRun.outcome', resf)
)
)
);
}

if (ruleStatusesFilter && ruleStatusesFilter.length) {
const snoozedFilter = nodeBuilder.or([
fromKueryExpression('alert.attributes.muteAll: true'),
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ export interface LoadRulesProps {
actionTypesFilter?: string[];
tagsFilter?: string[];
ruleExecutionStatusesFilter?: string[];
ruleLastRunOutcomesFilter?: string[];
ruleStatusesFilter?: RuleStatus[];
sort?: Sorting;
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ export async function loadRulesWithKueryFilter({
typesFilter,
actionTypesFilter,
ruleExecutionStatusesFilter,
ruleLastRunOutcomesFilter,
ruleStatusesFilter,
tagsFilter,
sort = { field: 'name', direction: 'asc' },
Expand All @@ -32,6 +33,7 @@ export async function loadRulesWithKueryFilter({
actionTypesFilter,
tagsFilter,
ruleExecutionStatusesFilter,
ruleLastRunOutcomesFilter,
ruleStatusesFilter,
searchText,
});
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,27 +8,22 @@
import React, { lazy } from 'react';
import { i18n } from '@kbn/i18n';
import { EuiSpacer, EuiFlexGroup, EuiFlexItem, EuiTabbedContent } from '@elastic/eui';
import {
ActionGroup,
RuleExecutionStatusErrorReasons,
AlertStatusValues,
} from '@kbn/alerting-plugin/common';
import { ActionGroup, AlertStatusValues } from '@kbn/alerting-plugin/common';
import { useKibana } from '../../../../common/lib/kibana';
import { Rule, RuleSummary, AlertStatus, RuleType } from '../../../../types';
import {
ComponentOpts as RuleApis,
withBulkRuleOperations,
} from '../../common/components/with_bulk_rule_api_operations';
import './rule.scss';
import { getHealthColor } from '../../rules_list/components/rule_execution_status_filter';
import {
rulesStatusesTranslationsMapping,
ALERT_STATUS_LICENSE_ERROR,
} from '../../rules_list/translations';
import type { RuleEventLogListProps } from './rule_event_log_list';
import { AlertListItem } from './types';
import { getIsExperimentalFeatureEnabled } from '../../../../common/get_experimental_features';
import { suspendedComponentWithProps } from '../../../lib/suspended_component_with_props';
import {
getRuleHealthColor,
getRuleStatusMessage,
} from '../../../../common/lib/rule_status_helpers';
import RuleStatusPanelWithApi from './rule_status_panel';

const RuleEventLogList = lazy(() => import('./rule_event_log_list'));
Expand Down Expand Up @@ -78,12 +73,8 @@ export function RuleComponent({
requestRefresh();
};

const healthColor = getHealthColor(rule.executionStatus.status);
const isLicenseError =
rule.executionStatus.error?.reason === RuleExecutionStatusErrorReasons.License;
const statusMessage = isLicenseError
? ALERT_STATUS_LICENSE_ERROR
: rulesStatusesTranslationsMapping[rule.executionStatus.status];
const healthColor = getRuleHealthColor(rule);
const statusMessage: string = getRuleStatusMessage(rule);

const renderRuleAlertList = () => {
return suspendedComponentWithProps(
Expand Down
Loading