{ruleCriteria.map((criteria, criticalIndex) => {
- const threshold = criteria.threshold;
- const comparator = criteria.comparator;
+ const { threshold, comparator } = criteria;
+ let formattedComparator = comparator.toUpperCase();
+ if (
+ comparator === COMPARATORS.NOT_BETWEEN ||
+ comparator === LEGACY_COMPARATORS.OUTSIDE_RANGE
+ ) {
+ // No need for i18n as we are using the enum value, we only need a space.
+ formattedComparator = 'NOT BETWEEN';
+ }
return (
-
{`${comparator.toUpperCase()} ${threshold}`}
+
{`${formattedComparator} ${threshold}`}
);
})}
diff --git a/x-pack/plugins/observability_solution/observability/public/components/custom_threshold/components/alert_details_app_section/helpers/log_rate_analysis_query.test.ts b/x-pack/plugins/observability_solution/observability/public/components/custom_threshold/components/alert_details_app_section/helpers/log_rate_analysis_query.test.ts
index 0e5da33f67d6c5..05a8c3eb67a35f 100644
--- a/x-pack/plugins/observability_solution/observability/public/components/custom_threshold/components/alert_details_app_section/helpers/log_rate_analysis_query.test.ts
+++ b/x-pack/plugins/observability_solution/observability/public/components/custom_threshold/components/alert_details_app_section/helpers/log_rate_analysis_query.test.ts
@@ -5,7 +5,8 @@
* 2.0.
*/
-import { Aggregators, Comparator } from '../../../../../../common/custom_threshold_rule/types';
+import { COMPARATORS } from '@kbn/alerting-comparators';
+import { Aggregators } from '../../../../../../common/custom_threshold_rule/types';
import { CustomThresholdRuleTypeParams } from '../../../types';
import { getLogRateAnalysisEQQuery } from './log_rate_analysis_query';
@@ -29,7 +30,7 @@ describe('buildEsQuery', () => {
timeSize: 1,
timeUnit: 'm',
threshold: [90],
- comparator: Comparator.GT,
+ comparator: COMPARATORS.GREATER_THAN,
},
],
};
@@ -85,7 +86,7 @@ describe('buildEsQuery', () => {
timeSize: 1,
timeUnit: 'm',
threshold: [90],
- comparator: Comparator.GT,
+ comparator: COMPARATORS.GREATER_THAN,
},
],
},
@@ -108,7 +109,7 @@ describe('buildEsQuery', () => {
timeSize: 1,
timeUnit: 'm',
threshold: [90],
- comparator: Comparator.GT,
+ comparator: COMPARATORS.GREATER_THAN,
},
],
},
diff --git a/x-pack/plugins/observability_solution/observability/public/components/custom_threshold/components/criterion_preview_chart/threshold_annotations.test.tsx b/x-pack/plugins/observability_solution/observability/public/components/custom_threshold/components/criterion_preview_chart/threshold_annotations.test.tsx
index a8e64ac343a0f4..6be6f983c7e3c3 100644
--- a/x-pack/plugins/observability_solution/observability/public/components/custom_threshold/components/criterion_preview_chart/threshold_annotations.test.tsx
+++ b/x-pack/plugins/observability_solution/observability/public/components/custom_threshold/components/criterion_preview_chart/threshold_annotations.test.tsx
@@ -5,7 +5,7 @@
* 2.0.
*/
import { Color } from '../../../../../common/custom_threshold_rule/color_palette';
-import { Comparator } from '../../../../../common/custom_threshold_rule/types';
+import { COMPARATORS } from '@kbn/alerting-comparators';
import { shallow } from 'enzyme';
import React from 'react';
@@ -30,7 +30,7 @@ describe('ThresholdAnnotations', () => {
const defaultProps = {
threshold: [20, 30],
sortedThresholds: [20, 30],
- comparator: Comparator.GT,
+ comparator: COMPARATORS.GREATER_THAN,
color: Color.color0,
id: 'testId',
firstTimestamp: 123456789,
@@ -54,7 +54,7 @@ describe('ThresholdAnnotations', () => {
});
it('should render a rectangular annotation for in between thresholds', async () => {
- const wrapper = await setup({ comparator: Comparator.BETWEEN });
+ const wrapper = await setup({ comparator: COMPARATORS.BETWEEN });
const annotation = wrapper.find('[data-test-subj="between-rect"]');
const expectedValues = [
@@ -73,7 +73,7 @@ describe('ThresholdAnnotations', () => {
});
it('should render an upper rectangular annotation for outside range thresholds', async () => {
- const wrapper = await setup({ comparator: Comparator.OUTSIDE_RANGE });
+ const wrapper = await setup({ comparator: COMPARATORS.NOT_BETWEEN });
const annotation = wrapper.find('[data-test-subj="outside-range-lower-rect"]');
const expectedValues = [
@@ -92,7 +92,7 @@ describe('ThresholdAnnotations', () => {
});
it('should render a lower rectangular annotation for outside range thresholds', async () => {
- const wrapper = await setup({ comparator: Comparator.OUTSIDE_RANGE });
+ const wrapper = await setup({ comparator: COMPARATORS.NOT_BETWEEN });
const annotation = wrapper.find('[data-test-subj="outside-range-upper-rect"]');
const expectedValues = [
@@ -111,7 +111,7 @@ describe('ThresholdAnnotations', () => {
});
it('should render a rectangular annotation for below thresholds', async () => {
- const wrapper = await setup({ comparator: Comparator.LT });
+ const wrapper = await setup({ comparator: COMPARATORS.LESS_THAN });
const annotation = wrapper.find('[data-test-subj="below-rect"]');
const expectedValues = [
@@ -130,7 +130,7 @@ describe('ThresholdAnnotations', () => {
});
it('should render a rectangular annotation for above thresholds', async () => {
- const wrapper = await setup({ comparator: Comparator.GT });
+ const wrapper = await setup({ comparator: COMPARATORS.GREATER_THAN });
const annotation = wrapper.find('[data-test-subj="above-rect"]');
const expectedValues = [
diff --git a/x-pack/plugins/observability_solution/observability/public/components/custom_threshold/components/criterion_preview_chart/threshold_annotations.tsx b/x-pack/plugins/observability_solution/observability/public/components/custom_threshold/components/criterion_preview_chart/threshold_annotations.tsx
index e911eba6ad6c84..763d43ae5eab39 100644
--- a/x-pack/plugins/observability_solution/observability/public/components/custom_threshold/components/criterion_preview_chart/threshold_annotations.tsx
+++ b/x-pack/plugins/observability_solution/observability/public/components/custom_threshold/components/criterion_preview_chart/threshold_annotations.tsx
@@ -7,13 +7,13 @@
import { AnnotationDomainType, LineAnnotation, RectAnnotation } from '@elastic/charts';
import { first, last } from 'lodash';
import React from 'react';
+import { COMPARATORS } from '@kbn/alerting-comparators';
import { Color, colorTransformer } from '../../../../../common/custom_threshold_rule/color_palette';
-import { Comparator } from '../../../../../common/custom_threshold_rule/types';
interface ThresholdAnnotationsProps {
threshold: number[];
sortedThresholds: number[];
- comparator: Comparator;
+ comparator: COMPARATORS;
color: Color;
id: string;
firstTimestamp: number;
@@ -34,8 +34,10 @@ export function ThresholdAnnotations({
domain,
}: ThresholdAnnotationsProps) {
if (!comparator || !threshold) return null;
- const isAbove = [Comparator.GT, Comparator.GT_OR_EQ].includes(comparator);
- const isBelow = [Comparator.LT, Comparator.LT_OR_EQ].includes(comparator);
+ const isAbove = [COMPARATORS.GREATER_THAN, COMPARATORS.GREATER_THAN_OR_EQUALS].includes(
+ comparator
+ );
+ const isBelow = [COMPARATORS.LESS_THAN, COMPARATORS.LESS_THAN_OR_EQUALS].includes(comparator);
return (
<>
- {sortedThresholds.length === 2 && comparator === Comparator.BETWEEN ? (
+ {sortedThresholds.length === 2 && comparator === COMPARATORS.BETWEEN ? (
<>
) : null}
- {sortedThresholds.length === 2 && comparator === Comparator.OUTSIDE_RANGE ? (
+ {sortedThresholds.length === 2 && comparator === COMPARATORS.NOT_BETWEEN ? (
<>
= {
timeSize: 1,
timeUnit: 'm' as TimeUnitChar,
threshold: [1],
- comparator: Comparator.GT,
+ comparator: COMPARATORS.GREATER_THAN,
},
fields: [
{ name: 'system.cpu.user.pct', normalizedType: 'number' },
@@ -128,7 +128,7 @@ CustomEquationEditorWithEquationErrors.args = {
timeSize: 1,
timeUnit: 'm' as TimeUnitChar,
threshold: [1],
- comparator: Comparator.GT,
+ comparator: COMPARATORS.GREATER_THAN,
},
errors: {
equation:
diff --git a/x-pack/plugins/observability_solution/observability/public/components/custom_threshold/components/custom_threshold.stories.tsx b/x-pack/plugins/observability_solution/observability/public/components/custom_threshold/components/custom_threshold.stories.tsx
index 674ce1c5797561..f471333f536613 100644
--- a/x-pack/plugins/observability_solution/observability/public/components/custom_threshold/components/custom_threshold.stories.tsx
+++ b/x-pack/plugins/observability_solution/observability/public/components/custom_threshold/components/custom_threshold.stories.tsx
@@ -8,8 +8,7 @@
import React from 'react';
import { ComponentMeta } from '@storybook/react';
import { LIGHT_THEME } from '@elastic/charts';
-
-import { Comparator } from '../../../../common/custom_threshold_rule/types';
+import { COMPARATORS } from '@kbn/alerting-comparators';
import { Props, Threshold as Component } from './custom_threshold';
export default {
@@ -31,7 +30,7 @@ export default {
const defaultProps: Props = {
chartProps: { baseTheme: LIGHT_THEME },
- comparator: Comparator.GT,
+ comparator: COMPARATORS.GREATER_THAN,
id: 'componentId',
threshold: [90],
title: 'Threshold breached',
diff --git a/x-pack/plugins/observability_solution/observability/public/components/custom_threshold/components/custom_threshold.test.tsx b/x-pack/plugins/observability_solution/observability/public/components/custom_threshold/components/custom_threshold.test.tsx
index fbb728b4b81aa3..e0c83d31ddb4cd 100644
--- a/x-pack/plugins/observability_solution/observability/public/components/custom_threshold/components/custom_threshold.test.tsx
+++ b/x-pack/plugins/observability_solution/observability/public/components/custom_threshold/components/custom_threshold.test.tsx
@@ -10,13 +10,13 @@ import { LIGHT_THEME } from '@elastic/charts';
import { render } from '@testing-library/react';
import { Props, Threshold } from './custom_threshold';
import React from 'react';
-import { Comparator } from '../../../../common/custom_threshold_rule/types';
+import { COMPARATORS } from '@kbn/alerting-comparators';
describe('Threshold', () => {
const renderComponent = (props: Partial = {}) => {
const defaultProps: Props = {
chartProps: { baseTheme: LIGHT_THEME },
- comparator: Comparator.GT,
+ comparator: COMPARATORS.GREATER_THAN,
id: 'componentId',
threshold: [90],
title: 'Threshold breached',
@@ -43,7 +43,7 @@ describe('Threshold', () => {
it('shows component for between', () => {
const component = renderComponent({
- comparator: Comparator.BETWEEN,
+ comparator: COMPARATORS.BETWEEN,
threshold: [90, 95],
});
expect(component.queryByTestId('thresholdRule-90-95-93')).toBeTruthy();
diff --git a/x-pack/plugins/observability_solution/observability/public/components/custom_threshold/components/custom_threshold.tsx b/x-pack/plugins/observability_solution/observability/public/components/custom_threshold/components/custom_threshold.tsx
index 7e9fbfce9d682d..a82c369c577372 100644
--- a/x-pack/plugins/observability_solution/observability/public/components/custom_threshold/components/custom_threshold.tsx
+++ b/x-pack/plugins/observability_solution/observability/public/components/custom_threshold/components/custom_threshold.tsx
@@ -10,7 +10,7 @@ import { Chart, Metric, Settings } from '@elastic/charts';
import { EuiIcon, EuiPanel, useEuiBackgroundColor } from '@elastic/eui';
import type { PartialTheme, Theme } from '@elastic/charts';
import { i18n } from '@kbn/i18n';
-import { Comparator } from '../../../../common/custom_threshold_rule/types';
+import { COMPARATORS } from '@kbn/alerting-comparators';
export interface ChartProps {
theme?: PartialTheme;
@@ -19,7 +19,7 @@ export interface ChartProps {
export interface Props {
chartProps: ChartProps;
- comparator: Comparator | string;
+ comparator: COMPARATORS | string;
id: string;
threshold: number[];
title: string;
diff --git a/x-pack/plugins/observability_solution/observability/public/components/custom_threshold/components/expression_row.test.tsx b/x-pack/plugins/observability_solution/observability/public/components/custom_threshold/components/expression_row.test.tsx
index 2bdd1f2def0815..b5ea26f2fb9073 100644
--- a/x-pack/plugins/observability_solution/observability/public/components/custom_threshold/components/expression_row.test.tsx
+++ b/x-pack/plugins/observability_solution/observability/public/components/custom_threshold/components/expression_row.test.tsx
@@ -9,9 +9,10 @@ import { mountWithIntl, nextTick } from '@kbn/test-jest-helpers';
import React from 'react';
import { act } from 'react-dom/test-utils';
-import { Aggregators, Comparator } from '../../../../common/custom_threshold_rule/types';
+import { Aggregators } from '../../../../common/custom_threshold_rule/types';
import { MetricExpression } from '../types';
import { ExpressionRow } from './expression_row';
+import { COMPARATORS } from '@kbn/alerting-comparators';
describe('ExpressionRow', () => {
async function setup(expression: MetricExpression) {
@@ -57,7 +58,7 @@ describe('ExpressionRow', () => {
it('should display thresholds as a percentage for pct metrics', async () => {
const expression: MetricExpression = {
- comparator: Comparator.GT,
+ comparator: COMPARATORS.GREATER_THAN,
metrics: [
{
name: 'A',
@@ -82,7 +83,7 @@ describe('ExpressionRow', () => {
it('should display thresholds as a decimal for all other metrics', async () => {
const expression = {
- comparator: Comparator.GT,
+ comparator: COMPARATORS.GREATER_THAN,
metrics: [
{
name: 'A',
diff --git a/x-pack/plugins/observability_solution/observability/public/components/custom_threshold/components/expression_row.tsx b/x-pack/plugins/observability_solution/observability/public/components/custom_threshold/components/expression_row.tsx
index ffff1212ce05b9..0d4fe7ecafbb80 100644
--- a/x-pack/plugins/observability_solution/observability/public/components/custom_threshold/components/expression_row.tsx
+++ b/x-pack/plugins/observability_solution/observability/public/components/custom_threshold/components/expression_row.tsx
@@ -18,35 +18,20 @@ import { i18n } from '@kbn/i18n';
import React, { useCallback, useMemo, useState, ReactElement } from 'react';
import {
AggregationType,
- builtInComparators,
- COMPARATORS,
IErrorObject,
ThresholdExpression,
} from '@kbn/triggers-actions-ui-plugin/public';
import { DataViewBase, DataViewFieldBase } from '@kbn/es-query';
import { debounce } from 'lodash';
-import { Aggregators, Comparator } from '../../../../common/custom_threshold_rule/types';
+import { COMPARATORS } from '@kbn/alerting-comparators';
+import { convertToBuiltInComparators } from '../../../../common/utils/convert_legacy_outside_comparator';
+import { Aggregators } from '../../../../common/custom_threshold_rule/types';
import { MetricExpression } from '../types';
import { CustomEquationEditor } from './custom_equation';
import { CUSTOM_EQUATION, LABEL_HELP_MESSAGE, LABEL_LABEL } from '../i18n_strings';
import { decimalToPct, pctToDecimal } from '../helpers/corrected_percent_convert';
import { isPercent } from '../helpers/threshold_unit';
-// Create a new object with COMPARATORS.NOT_BETWEEN removed as we use OUTSIDE_RANGE
-const updatedBuiltInComparators = { ...builtInComparators };
-delete updatedBuiltInComparators[COMPARATORS.NOT_BETWEEN];
-
-const customComparators = {
- ...updatedBuiltInComparators,
- [Comparator.OUTSIDE_RANGE]: {
- text: i18n.translate('xpack.observability.customThreshold.rule.alertFlyout.outsideRangeLabel', {
- defaultMessage: 'Is not between',
- }),
- value: Comparator.OUTSIDE_RANGE,
- requiredValues: 2,
- },
-};
-
interface ExpressionRowProps {
title: ReactElement;
fields: DataViewFieldBase[];
@@ -76,14 +61,13 @@ export const ExpressionRow: React.FC = (props) => {
title,
} = props;
- const { metrics, comparator = Comparator.GT, threshold = [] } = expression;
-
+ const { metrics, comparator = COMPARATORS.GREATER_THAN, threshold = [] } = expression;
const isMetricPct = useMemo(() => isPercent(metrics), [metrics]);
const [label, setLabel] = useState(expression?.label || undefined);
const updateComparator = useCallback(
(c?: string) => {
- setRuleParams(expressionId, { ...expression, comparator: c as Comparator });
+ setRuleParams(expressionId, { ...expression, comparator: c as COMPARATORS });
},
[expressionId, expression, setRuleParams]
);
@@ -214,12 +198,17 @@ const ThresholdElement: React.FC<{
return threshold;
}, [threshold, isMetricPct]);
+ const thresholdComparator = useCallback(() => {
+ if (!comparator) return COMPARATORS.GREATER_THAN;
+ // Check if the rule had a legacy OUTSIDE_RANGE inside its params.
+ // Then, change it on-the-fly to NOT_BETWEEN
+ return convertToBuiltInComparators(comparator);
+ }, [comparator]);
return (
<>
{
timeUnit: 'm',
sourceId: 'default',
threshold: [1],
- comparator: Comparator.GT_OR_EQ,
+ comparator: COMPARATORS.GREATER_THAN_OR_EQUALS,
};
const { wrapper } = await setup(expression);
expect(wrapper.find('[data-test-subj="thresholdRuleNoChartData"]').exists()).toBeTruthy();
diff --git a/x-pack/plugins/observability_solution/observability/public/components/custom_threshold/components/rule_condition_chart/rule_condition_chart.tsx b/x-pack/plugins/observability_solution/observability/public/components/custom_threshold/components/rule_condition_chart/rule_condition_chart.tsx
index 08de905213f874..1e326e3fa5f6de 100644
--- a/x-pack/plugins/observability_solution/observability/public/components/custom_threshold/components/rule_condition_chart/rule_condition_chart.tsx
+++ b/x-pack/plugins/observability_solution/observability/public/components/custom_threshold/components/rule_condition_chart/rule_condition_chart.tsx
@@ -25,11 +25,9 @@ import { IErrorObject } from '@kbn/triggers-actions-ui-plugin/public';
import { i18n } from '@kbn/i18n';
import { TimeRange } from '@kbn/es-query';
import { EventAnnotationConfig } from '@kbn/event-annotation-common';
+import { COMPARATORS } from '@kbn/alerting-comparators';
import { EventsAsUnit } from '../../../../../common/constants';
-import {
- Comparator,
- CustomThresholdSearchSourceFields,
-} from '../../../../../common/custom_threshold_rule/types';
+import { CustomThresholdSearchSourceFields } from '../../../../../common/custom_threshold_rule/types';
import { useKibana } from '../../../../utils/kibana_react';
import { MetricExpression } from '../../types';
import { AggMap, PainlessTinyMathParser } from './painless_tinymath_parser';
@@ -121,15 +119,15 @@ export function RuleConditionChart({
const refLayers = [];
if (
- comparator === Comparator.OUTSIDE_RANGE ||
- (comparator === Comparator.BETWEEN && threshold.length === 2)
+ comparator === COMPARATORS.NOT_BETWEEN ||
+ (comparator === COMPARATORS.BETWEEN && threshold.length === 2)
) {
const refLineStart = new XYReferenceLinesLayer({
data: [
{
value: (threshold[0] || 0).toString(),
color: euiTheme.colors.danger,
- fill: comparator === Comparator.OUTSIDE_RANGE ? 'below' : 'none',
+ fill: comparator === COMPARATORS.NOT_BETWEEN ? 'below' : 'none',
},
],
});
@@ -138,7 +136,7 @@ export function RuleConditionChart({
{
value: (threshold[1] || 0).toString(),
color: euiTheme.colors.danger,
- fill: comparator === Comparator.OUTSIDE_RANGE ? 'above' : 'none',
+ fill: comparator === COMPARATORS.NOT_BETWEEN ? 'above' : 'none',
},
],
});
@@ -146,7 +144,7 @@ export function RuleConditionChart({
refLayers.push(refLineStart, refLineEnd);
} else {
let fill: FillStyle = 'above';
- if (comparator === Comparator.LT || comparator === Comparator.LT_OR_EQ) {
+ if (comparator === COMPARATORS.LESS_THAN || comparator === COMPARATORS.LESS_THAN_OR_EQUALS) {
fill = 'below';
}
const thresholdRefLine = new XYReferenceLinesLayer({
diff --git a/x-pack/plugins/observability_solution/observability/public/components/custom_threshold/components/validation.tsx b/x-pack/plugins/observability_solution/observability/public/components/custom_threshold/components/validation.tsx
index 87cefa2742bbbf..184187c7052388 100644
--- a/x-pack/plugins/observability_solution/observability/public/components/custom_threshold/components/validation.tsx
+++ b/x-pack/plugins/observability_solution/observability/public/components/custom_threshold/components/validation.tsx
@@ -11,8 +11,8 @@ import { buildEsQuery, fromKueryExpression } from '@kbn/es-query';
import { i18n } from '@kbn/i18n';
import { ValidationResult } from '@kbn/triggers-actions-ui-plugin/public';
import { isEmpty } from 'lodash';
+import { COMPARATORS } from '@kbn/alerting-comparators';
import {
- Comparator,
CustomMetricExpressionParams,
CustomThresholdSearchSourceFields,
} from '../../../../common/custom_threshold_rule/types';
@@ -111,7 +111,7 @@ export function validateCustomThreshold({
// The Threshold component returns an empty array with a length ([empty]) because it's using delete newThreshold[i].
// We need to use [...c.threshold] to convert it to an array with an undefined value ([undefined]) so we can test each element.
const { comparator, threshold } = { comparator: c.comparator, threshold: c.threshold } as {
- comparator?: Comparator;
+ comparator?: COMPARATORS;
threshold?: number[];
};
if (threshold && threshold.length && ![...threshold].every(isNumber)) {
@@ -130,7 +130,7 @@ export function validateCustomThreshold({
});
}
- if (comparator === Comparator.BETWEEN && (!threshold || threshold.length < 2)) {
+ if (comparator === COMPARATORS.BETWEEN && (!threshold || threshold.length < 2)) {
errors[id].critical.threshold1.push(
i18n.translate(
'xpack.observability.customThreshold.rule.alertFlyout.error.thresholdRequired',
diff --git a/x-pack/plugins/observability_solution/observability/public/components/custom_threshold/custom_threshold_rule_expression.test.tsx b/x-pack/plugins/observability_solution/observability/public/components/custom_threshold/custom_threshold_rule_expression.test.tsx
index 8f569e1d80b178..02c428ccf36984 100644
--- a/x-pack/plugins/observability_solution/observability/public/components/custom_threshold/custom_threshold_rule_expression.test.tsx
+++ b/x-pack/plugins/observability_solution/observability/public/components/custom_threshold/custom_threshold_rule_expression.test.tsx
@@ -13,7 +13,8 @@ import { queryClient } from '@kbn/osquery-plugin/public/query_client';
import { mountWithIntl, nextTick } from '@kbn/test-jest-helpers';
import { QueryClientProvider } from '@tanstack/react-query';
import { act } from 'react-dom/test-utils';
-import { Aggregators, Comparator } from '../../../common/custom_threshold_rule/types';
+import { COMPARATORS } from '@kbn/alerting-comparators';
+import { Aggregators } from '../../../common/custom_threshold_rule/types';
import { useKibana } from '../../utils/kibana_react';
import { kibanaStartMock } from '../../utils/kibana_react.mock';
import Expressions from './custom_threshold_rule_expression';
@@ -152,7 +153,7 @@ describe('Expression', () => {
aggType: Aggregators.COUNT,
},
],
- comparator: Comparator.GT,
+ comparator: COMPARATORS.GREATER_THAN,
threshold: [100],
timeSize: 1,
timeUnit: 'm',
@@ -178,7 +179,7 @@ describe('Expression', () => {
{ name: 'A', aggType: Aggregators.AVERAGE, field: 'system.load.1' },
{ name: 'B', aggType: Aggregators.CARDINALITY, field: 'system.cpu.user.pct' },
],
- comparator: Comparator.LT_OR_EQ,
+ comparator: COMPARATORS.LESS_THAN_OR_EQUALS,
equation: 'A * B',
label: 'prefill label',
threshold: [500],
@@ -200,7 +201,7 @@ describe('Expression', () => {
{ name: 'A', aggType: Aggregators.AVERAGE, field: 'system.load.1' },
{ name: 'B', aggType: Aggregators.CARDINALITY, field: 'system.cpu.user.pct' },
],
- comparator: Comparator.LT_OR_EQ,
+ comparator: COMPARATORS.LESS_THAN_OR_EQUALS,
equation: 'A * B',
label: 'prefill label',
threshold: [500],
diff --git a/x-pack/plugins/observability_solution/observability/public/components/custom_threshold/custom_threshold_rule_expression.tsx b/x-pack/plugins/observability_solution/observability/public/components/custom_threshold/custom_threshold_rule_expression.tsx
index 41127b2880233d..f3aff841233cfe 100644
--- a/x-pack/plugins/observability_solution/observability/public/components/custom_threshold/custom_threshold_rule_expression.tsx
+++ b/x-pack/plugins/observability_solution/observability/public/components/custom_threshold/custom_threshold_rule_expression.tsx
@@ -36,8 +36,9 @@ import {
RuleTypeParamsExpressionProps,
} from '@kbn/triggers-actions-ui-plugin/public';
+import { COMPARATORS } from '@kbn/alerting-comparators';
import { useKibana } from '../../utils/kibana_react';
-import { Aggregators, Comparator } from '../../../common/custom_threshold_rule/types';
+import { Aggregators } from '../../../common/custom_threshold_rule/types';
import { TimeUnitChar } from '../../../common/utils/formatters/duration';
import { AlertContextMeta, AlertParams, MetricExpression } from './types';
import { ExpressionRow } from './components/expression_row';
@@ -53,7 +54,7 @@ type Props = Omit<
>;
export const defaultExpression: MetricExpression = {
- comparator: Comparator.GT,
+ comparator: COMPARATORS.GREATER_THAN,
metrics: [
{
name: 'A',
diff --git a/x-pack/plugins/observability_solution/observability/public/components/custom_threshold/mocks/custom_threshold_rule.ts b/x-pack/plugins/observability_solution/observability/public/components/custom_threshold/mocks/custom_threshold_rule.ts
index 045c04219801e4..efa32473e0b445 100644
--- a/x-pack/plugins/observability_solution/observability/public/components/custom_threshold/mocks/custom_threshold_rule.ts
+++ b/x-pack/plugins/observability_solution/observability/public/components/custom_threshold/mocks/custom_threshold_rule.ts
@@ -7,8 +7,9 @@
import { v4 as uuidv4 } from 'uuid';
import { ParsedTechnicalFields } from '@kbn/rule-registry-plugin/common';
+import { COMPARATORS } from '@kbn/alerting-comparators';
import { CustomThresholdAlertFields } from '../types';
-import { Aggregators, Comparator } from '../../../../common/custom_threshold_rule/types';
+import { Aggregators } from '../../../../common/custom_threshold_rule/types';
import { CustomThresholdAlert, CustomThresholdRule } from '../components/types';
@@ -60,7 +61,7 @@ export const buildCustomThresholdRule = (
params: {
criteria: [
{
- comparator: Comparator.GT,
+ comparator: COMPARATORS.GREATER_THAN,
metrics: [
{
name: 'A',
@@ -72,7 +73,7 @@ export const buildCustomThresholdRule = (
timeUnit: 'm',
},
{
- comparator: Comparator.GT,
+ comparator: COMPARATORS.GREATER_THAN,
metrics: [
{
name: 'B',
@@ -83,11 +84,9 @@ export const buildCustomThresholdRule = (
threshold: [4],
timeSize: 15,
timeUnit: 'm',
- warningComparator: Comparator.GT,
- warningThreshold: [2.2],
},
{
- comparator: Comparator.GT,
+ comparator: COMPARATORS.GREATER_THAN,
metrics: [
{
name: 'C',
@@ -100,7 +99,7 @@ export const buildCustomThresholdRule = (
timeUnit: 'm',
},
{
- comparator: Comparator.GT,
+ comparator: COMPARATORS.GREATER_THAN,
metrics: [
{
name: 'A',
@@ -115,7 +114,7 @@ export const buildCustomThresholdRule = (
'A + A + A + A + A + A + A + A + A + A + A + A + A + A + A + A + A + A + A + A + A',
},
{
- comparator: Comparator.GT,
+ comparator: COMPARATORS.GREATER_THAN,
metrics: [
{
name: 'C',
@@ -133,7 +132,7 @@ export const buildCustomThresholdRule = (
timeUnit: 'm',
},
{
- comparator: Comparator.GT,
+ comparator: COMPARATORS.GREATER_THAN,
metrics: [
{
name: 'CAD',
@@ -209,7 +208,7 @@ export const buildCustomThresholdAlert = (
'kibana.alert.rule.parameters': {
criteria: [
{
- comparator: Comparator.GT,
+ comparator: COMPARATORS.GREATER_THAN,
metrics: [
{
name: 'A',
@@ -222,7 +221,7 @@ export const buildCustomThresholdAlert = (
timeUnit: 'm',
},
{
- comparator: Comparator.GT,
+ comparator: COMPARATORS.GREATER_THAN,
metrics: [
{
name: 'B',
@@ -233,7 +232,7 @@ export const buildCustomThresholdAlert = (
threshold: [4],
timeSize: 15,
timeUnit: 'm',
- warningComparator: Comparator.GT,
+ warningComparator: COMPARATORS.GREATER_THAN,
warningThreshold: [2.2],
},
],
diff --git a/x-pack/plugins/observability_solution/observability/public/pages/rule_details/rule_details.tsx b/x-pack/plugins/observability_solution/observability/public/pages/rule_details/rule_details.tsx
index bdaf10b04ca694..31ae9e41d05291 100644
--- a/x-pack/plugins/observability_solution/observability/public/pages/rule_details/rule_details.tsx
+++ b/x-pack/plugins/observability_solution/observability/public/pages/rule_details/rule_details.tsx
@@ -194,7 +194,6 @@ export function RuleDetailsPage() {
: '';
if (isLoading || isRuleDeleting) return ;
-
if (!rule || isError) return ;
return (
diff --git a/x-pack/plugins/observability_solution/observability/server/lib/rules/custom_threshold/custom_threshold_executor.test.ts b/x-pack/plugins/observability_solution/observability/server/lib/rules/custom_threshold/custom_threshold_executor.test.ts
index 8f65682c68fb10..cb99f17a9db5c1 100644
--- a/x-pack/plugins/observability_solution/observability/server/lib/rules/custom_threshold/custom_threshold_executor.test.ts
+++ b/x-pack/plugins/observability_solution/observability/server/lib/rules/custom_threshold/custom_threshold_executor.test.ts
@@ -13,9 +13,9 @@ import { FIRED_ACTION, NO_DATA_ACTION } from './constants';
import { Evaluation } from './lib/evaluate_rule';
import type { LogMeta, Logger } from '@kbn/logging';
import { DEFAULT_FLAPPING_SETTINGS } from '@kbn/alerting-plugin/common';
+import { COMPARATORS } from '@kbn/alerting-comparators';
import {
Aggregators,
- Comparator,
CustomMetricExpressionParams,
CustomThresholdExpressionMetric,
} from '../../../../common/custom_threshold_rule/types';
@@ -234,7 +234,7 @@ describe('The custom threshold alert type', () => {
beforeEach(() => jest.clearAllMocks());
afterAll(() => clearInstances());
const instanceID = '*';
- const execute = (comparator: Comparator, threshold: number[], sourceId: string = 'default') =>
+ const execute = (comparator: COMPARATORS, threshold: number[], sourceId: string = 'default') =>
executor({
...mockOptions,
services,
@@ -251,7 +251,7 @@ describe('The custom threshold alert type', () => {
},
});
const setResults = (
- comparator: Comparator,
+ comparator: COMPARATORS,
threshold: number[],
shouldFire: boolean = false,
isNoData: boolean = false
@@ -271,62 +271,62 @@ describe('The custom threshold alert type', () => {
},
]);
test('alerts as expected with the > comparator', async () => {
- setResults(Comparator.GT, [0.75], true);
- await execute(Comparator.GT, [0.75]);
+ setResults(COMPARATORS.GREATER_THAN, [0.75], true);
+ await execute(COMPARATORS.GREATER_THAN, [0.75]);
expect(getLastReportedAlert(instanceID)).toHaveAlertAction();
- setResults(Comparator.GT, [1.5], false);
- await execute(Comparator.GT, [1.5]);
+ setResults(COMPARATORS.GREATER_THAN, [1.5], false);
+ await execute(COMPARATORS.GREATER_THAN, [1.5]);
expect(getLastReportedAlert(instanceID)).toBe(undefined);
});
test('alerts as expected with the < comparator', async () => {
- setResults(Comparator.LT, [1.5], true);
- await execute(Comparator.LT, [1.5]);
+ setResults(COMPARATORS.LESS_THAN, [1.5], true);
+ await execute(COMPARATORS.LESS_THAN, [1.5]);
expect(getLastReportedAlert(instanceID)).toHaveAlertAction();
- setResults(Comparator.LT, [0.75], false);
- await execute(Comparator.LT, [0.75]);
+ setResults(COMPARATORS.LESS_THAN, [0.75], false);
+ await execute(COMPARATORS.LESS_THAN, [0.75]);
expect(getLastReportedAlert(instanceID)).toBe(undefined);
});
test('alerts as expected with the >= comparator', async () => {
- setResults(Comparator.GT_OR_EQ, [0.75], true);
- await execute(Comparator.GT_OR_EQ, [0.75]);
+ setResults(COMPARATORS.GREATER_THAN_OR_EQUALS, [0.75], true);
+ await execute(COMPARATORS.GREATER_THAN_OR_EQUALS, [0.75]);
expect(getLastReportedAlert(instanceID)).toHaveAlertAction();
- setResults(Comparator.GT_OR_EQ, [1.0], true);
- await execute(Comparator.GT_OR_EQ, [1.0]);
+ setResults(COMPARATORS.GREATER_THAN_OR_EQUALS, [1.0], true);
+ await execute(COMPARATORS.GREATER_THAN_OR_EQUALS, [1.0]);
expect(getLastReportedAlert(instanceID)).toHaveAlertAction();
- setResults(Comparator.GT_OR_EQ, [1.5], false);
- await execute(Comparator.GT_OR_EQ, [1.5]);
+ setResults(COMPARATORS.GREATER_THAN_OR_EQUALS, [1.5], false);
+ await execute(COMPARATORS.GREATER_THAN_OR_EQUALS, [1.5]);
expect(getLastReportedAlert(instanceID)).toBe(undefined);
});
test('alerts as expected with the <= comparator', async () => {
- setResults(Comparator.LT_OR_EQ, [1.5], true);
- await execute(Comparator.LT_OR_EQ, [1.5]);
+ setResults(COMPARATORS.LESS_THAN_OR_EQUALS, [1.5], true);
+ await execute(COMPARATORS.LESS_THAN_OR_EQUALS, [1.5]);
expect(getLastReportedAlert(instanceID)).toHaveAlertAction();
- setResults(Comparator.LT_OR_EQ, [1.0], true);
- await execute(Comparator.LT_OR_EQ, [1.0]);
+ setResults(COMPARATORS.LESS_THAN_OR_EQUALS, [1.0], true);
+ await execute(COMPARATORS.LESS_THAN_OR_EQUALS, [1.0]);
expect(getLastReportedAlert(instanceID)).toHaveAlertAction();
- setResults(Comparator.LT_OR_EQ, [0.75], false);
- await execute(Comparator.LT_OR_EQ, [0.75]);
+ setResults(COMPARATORS.LESS_THAN_OR_EQUALS, [0.75], false);
+ await execute(COMPARATORS.LESS_THAN_OR_EQUALS, [0.75]);
expect(getLastReportedAlert(instanceID)).toBe(undefined);
});
test('alerts as expected with the between comparator', async () => {
- setResults(Comparator.BETWEEN, [0, 1.5], true);
- await execute(Comparator.BETWEEN, [0, 1.5]);
+ setResults(COMPARATORS.BETWEEN, [0, 1.5], true);
+ await execute(COMPARATORS.BETWEEN, [0, 1.5]);
expect(getLastReportedAlert(instanceID)).toHaveAlertAction();
- setResults(Comparator.BETWEEN, [0, 0.75], false);
- await execute(Comparator.BETWEEN, [0, 0.75]);
+ setResults(COMPARATORS.BETWEEN, [0, 0.75], false);
+ await execute(COMPARATORS.BETWEEN, [0, 0.75]);
expect(getLastReportedAlert(instanceID)).toBe(undefined);
});
- test('alerts as expected with the outside range comparator', async () => {
- setResults(Comparator.OUTSIDE_RANGE, [0, 0.75], true);
- await execute(Comparator.OUTSIDE_RANGE, [0, 0.75]);
+ test('alerts as expected with the not between comparator', async () => {
+ setResults(COMPARATORS.NOT_BETWEEN, [0, 0.75], true);
+ await execute(COMPARATORS.NOT_BETWEEN, [0, 0.75]);
expect(getLastReportedAlert(instanceID)).toHaveAlertAction();
- setResults(Comparator.OUTSIDE_RANGE, [0, 1.5], false);
- await execute(Comparator.OUTSIDE_RANGE, [0, 1.5]);
+ setResults(COMPARATORS.NOT_BETWEEN, [0, 1.5], false);
+ await execute(COMPARATORS.NOT_BETWEEN, [0, 1.5]);
expect(getLastReportedAlert(instanceID)).toBe(undefined);
});
test('reports expected values to the action context', async () => {
- setResults(Comparator.GT, [0.75], true);
- await execute(Comparator.GT, [0.75]);
+ setResults(COMPARATORS.GREATER_THAN, [0.75], true);
+ await execute(COMPARATORS.GREATER_THAN, [0.75]);
const reportedAlert = getLastReportedAlert(instanceID);
expect(reportedAlert?.context?.group).toBeUndefined();
expect(reportedAlert?.context?.reason).toBe(
@@ -339,7 +339,7 @@ describe('The custom threshold alert type', () => {
beforeEach(() => jest.clearAllMocks());
afterAll(() => clearInstances());
const execute = (
- comparator: Comparator,
+ comparator: COMPARATORS,
threshold: number[],
groupBy: string[] = ['groupByField'],
metrics?: CustomThresholdExpressionMetric[],
@@ -369,7 +369,7 @@ describe('The custom threshold alert type', () => {
{
a: {
...customThresholdNonCountCriterion,
- comparator: Comparator.GT,
+ comparator: COMPARATORS.GREATER_THAN,
threshold: [0.75],
currentValue: 1.0,
timestamp: new Date().toISOString(),
@@ -379,7 +379,7 @@ describe('The custom threshold alert type', () => {
},
b: {
...customThresholdNonCountCriterion,
- comparator: Comparator.GT,
+ comparator: COMPARATORS.GREATER_THAN,
threshold: [0.75],
currentValue: 1.0,
timestamp: new Date().toISOString(),
@@ -389,7 +389,7 @@ describe('The custom threshold alert type', () => {
},
},
]);
- await execute(Comparator.GT, [0.75]);
+ await execute(COMPARATORS.GREATER_THAN, [0.75]);
expect(getLastReportedAlert(instanceIdA)).toHaveAlertAction();
expect(getLastReportedAlert(instanceIdB)).toHaveAlertAction();
});
@@ -398,7 +398,7 @@ describe('The custom threshold alert type', () => {
{
a: {
...customThresholdNonCountCriterion,
- comparator: Comparator.LT,
+ comparator: COMPARATORS.LESS_THAN,
threshold: [1.5],
currentValue: 1.0,
timestamp: new Date().toISOString(),
@@ -408,7 +408,7 @@ describe('The custom threshold alert type', () => {
},
b: {
...customThresholdNonCountCriterion,
- comparator: Comparator.LT,
+ comparator: COMPARATORS.LESS_THAN,
threshold: [1.5],
currentValue: 3,
timestamp: new Date().toISOString(),
@@ -418,7 +418,7 @@ describe('The custom threshold alert type', () => {
},
},
]);
- await execute(Comparator.LT, [1.5]);
+ await execute(COMPARATORS.LESS_THAN, [1.5]);
expect(getLastReportedAlert(instanceIdA)).toHaveAlertAction();
expect(getLastReportedAlert(instanceIdB)).toBe(undefined);
});
@@ -427,7 +427,7 @@ describe('The custom threshold alert type', () => {
{
a: {
...customThresholdNonCountCriterion,
- comparator: Comparator.GT,
+ comparator: COMPARATORS.GREATER_THAN,
threshold: [5],
currentValue: 1.0,
timestamp: new Date().toISOString(),
@@ -437,7 +437,7 @@ describe('The custom threshold alert type', () => {
},
b: {
...customThresholdNonCountCriterion,
- comparator: Comparator.GT,
+ comparator: COMPARATORS.GREATER_THAN,
threshold: [5],
currentValue: 3,
timestamp: new Date().toISOString(),
@@ -447,7 +447,7 @@ describe('The custom threshold alert type', () => {
},
},
]);
- await execute(Comparator.GT, [5]);
+ await execute(COMPARATORS.GREATER_THAN, [5]);
expect(getLastReportedAlert(instanceIdA)).toBe(undefined);
expect(getLastReportedAlert(instanceIdB)).toBe(undefined);
});
@@ -456,7 +456,7 @@ describe('The custom threshold alert type', () => {
{
a: {
...customThresholdNonCountCriterion,
- comparator: Comparator.GT,
+ comparator: COMPARATORS.GREATER_THAN,
threshold: [0.75],
currentValue: 1.0,
timestamp: new Date().toISOString(),
@@ -466,7 +466,7 @@ describe('The custom threshold alert type', () => {
},
b: {
...customThresholdNonCountCriterion,
- comparator: Comparator.GT,
+ comparator: COMPARATORS.GREATER_THAN,
threshold: [0.75],
currentValue: 3,
timestamp: new Date().toISOString(),
@@ -476,7 +476,7 @@ describe('The custom threshold alert type', () => {
},
},
]);
- await execute(Comparator.GT, [0.75]);
+ await execute(COMPARATORS.GREATER_THAN, [0.75]);
expect(getLastReportedAlert(instanceIdA)?.context?.group).toEqual([
{ field: 'groupByField', value: 'a' },
]);
@@ -489,7 +489,7 @@ describe('The custom threshold alert type', () => {
{
a: {
...customThresholdNonCountCriterion,
- comparator: Comparator.GT,
+ comparator: COMPARATORS.GREATER_THAN,
threshold: [0.75],
metrics: [
{
@@ -506,7 +506,7 @@ describe('The custom threshold alert type', () => {
},
b: {
...customThresholdNonCountCriterion,
- comparator: Comparator.GT,
+ comparator: COMPARATORS.GREATER_THAN,
threshold: [0.75],
metrics: [
{
@@ -523,7 +523,7 @@ describe('The custom threshold alert type', () => {
},
c: {
...customThresholdNonCountCriterion,
- comparator: Comparator.GT,
+ comparator: COMPARATORS.GREATER_THAN,
threshold: [0.75],
metrics: [
{
@@ -541,7 +541,7 @@ describe('The custom threshold alert type', () => {
},
]);
const { state: stateResult1 } = await execute(
- Comparator.GT,
+ COMPARATORS.GREATER_THAN,
[0.75],
['groupByField'],
[
@@ -557,7 +557,7 @@ describe('The custom threshold alert type', () => {
{
a: {
...customThresholdNonCountCriterion,
- comparator: Comparator.GT,
+ comparator: COMPARATORS.GREATER_THAN,
threshold: [0.75],
currentValue: 1.0,
timestamp: new Date().toISOString(),
@@ -567,7 +567,7 @@ describe('The custom threshold alert type', () => {
},
b: {
...customThresholdNonCountCriterion,
- comparator: Comparator.GT,
+ comparator: COMPARATORS.GREATER_THAN,
threshold: [0.75],
currentValue: 3,
timestamp: new Date().toISOString(),
@@ -577,7 +577,7 @@ describe('The custom threshold alert type', () => {
},
c: {
...customThresholdNonCountCriterion,
- comparator: Comparator.GT,
+ comparator: COMPARATORS.GREATER_THAN,
threshold: [0.75],
currentValue: null,
timestamp: new Date().toISOString(),
@@ -588,7 +588,7 @@ describe('The custom threshold alert type', () => {
},
]);
const { state: stateResult2 } = await execute(
- Comparator.GT,
+ COMPARATORS.GREATER_THAN,
[0.75],
['groupByField'],
[
@@ -607,7 +607,7 @@ describe('The custom threshold alert type', () => {
{
a: {
...customThresholdNonCountCriterion,
- comparator: Comparator.GT,
+ comparator: COMPARATORS.GREATER_THAN,
threshold: [0.75],
currentValue: 1.0,
timestamp: new Date().toISOString(),
@@ -617,7 +617,7 @@ describe('The custom threshold alert type', () => {
},
b: {
...customThresholdNonCountCriterion,
- comparator: Comparator.GT,
+ comparator: COMPARATORS.GREATER_THAN,
threshold: [0.75],
currentValue: 3,
timestamp: new Date().toISOString(),
@@ -628,7 +628,7 @@ describe('The custom threshold alert type', () => {
},
]);
const { state: stateResult3 } = await execute(
- Comparator.GT,
+ COMPARATORS.GREATER_THAN,
[0.75],
['groupByField', 'groupByField-else'],
[
@@ -644,7 +644,7 @@ describe('The custom threshold alert type', () => {
});
const executeWithFilter = (
- comparator: Comparator,
+ comparator: COMPARATORS,
threshold: number[],
filterQuery: string,
metrics?: any,
@@ -679,7 +679,7 @@ describe('The custom threshold alert type', () => {
{
a: {
...customThresholdNonCountCriterion,
- comparator: Comparator.GT,
+ comparator: COMPARATORS.GREATER_THAN,
threshold: [0.75],
metrics: [
{
@@ -696,7 +696,7 @@ describe('The custom threshold alert type', () => {
},
b: {
...customThresholdNonCountCriterion,
- comparator: Comparator.GT,
+ comparator: COMPARATORS.GREATER_THAN,
threshold: [0.75],
metrics: [
{
@@ -713,7 +713,7 @@ describe('The custom threshold alert type', () => {
},
c: {
...customThresholdNonCountCriterion,
- comparator: Comparator.GT,
+ comparator: COMPARATORS.GREATER_THAN,
threshold: [0.75],
metrics: [
{
@@ -731,7 +731,7 @@ describe('The custom threshold alert type', () => {
},
]);
const { state: stateResult1 } = await executeWithFilter(
- Comparator.GT,
+ COMPARATORS.GREATER_THAN,
[0.75],
JSON.stringify({ query: 'q' }),
'test.metric.2'
@@ -741,7 +741,7 @@ describe('The custom threshold alert type', () => {
{
a: {
...customThresholdNonCountCriterion,
- comparator: Comparator.GT,
+ comparator: COMPARATORS.GREATER_THAN,
threshold: [0.75],
currentValue: 1.0,
timestamp: new Date().toISOString(),
@@ -751,7 +751,7 @@ describe('The custom threshold alert type', () => {
},
b: {
...customThresholdNonCountCriterion,
- comparator: Comparator.GT,
+ comparator: COMPARATORS.GREATER_THAN,
threshold: [0.75],
currentValue: 3,
timestamp: new Date().toISOString(),
@@ -761,7 +761,7 @@ describe('The custom threshold alert type', () => {
},
c: {
...customThresholdNonCountCriterion,
- comparator: Comparator.GT,
+ comparator: COMPARATORS.GREATER_THAN,
threshold: [0.75],
currentValue: null,
timestamp: new Date().toISOString(),
@@ -772,7 +772,7 @@ describe('The custom threshold alert type', () => {
},
]);
const { state: stateResult2 } = await executeWithFilter(
- Comparator.GT,
+ COMPARATORS.GREATER_THAN,
[0.75],
JSON.stringify({ query: 'q' }),
'test.metric.1',
@@ -785,7 +785,7 @@ describe('The custom threshold alert type', () => {
{
a: {
...customThresholdNonCountCriterion,
- comparator: Comparator.GT,
+ comparator: COMPARATORS.GREATER_THAN,
threshold: [0.75],
currentValue: 1.0,
timestamp: new Date().toISOString(),
@@ -795,7 +795,7 @@ describe('The custom threshold alert type', () => {
},
b: {
...customThresholdNonCountCriterion,
- comparator: Comparator.GT,
+ comparator: COMPARATORS.GREATER_THAN,
threshold: [0.75],
currentValue: 3,
timestamp: new Date().toISOString(),
@@ -806,7 +806,7 @@ describe('The custom threshold alert type', () => {
},
]);
const { state: stateResult3 } = await executeWithFilter(
- Comparator.GT,
+ COMPARATORS.GREATER_THAN,
[0.75],
JSON.stringify({ query: 'different' }),
[
@@ -825,7 +825,7 @@ describe('The custom threshold alert type', () => {
{
a: {
...customThresholdNonCountCriterion,
- comparator: Comparator.GT,
+ comparator: COMPARATORS.GREATER_THAN,
threshold: [0.75],
metrics: [
{
@@ -842,7 +842,7 @@ describe('The custom threshold alert type', () => {
},
b: {
...customThresholdNonCountCriterion,
- comparator: Comparator.GT,
+ comparator: COMPARATORS.GREATER_THAN,
threshold: [0.75],
metrics: [
{
@@ -859,7 +859,7 @@ describe('The custom threshold alert type', () => {
},
c: {
...customThresholdNonCountCriterion,
- comparator: Comparator.GT,
+ comparator: COMPARATORS.GREATER_THAN,
threshold: [0.75],
metrics: [
{
@@ -877,7 +877,7 @@ describe('The custom threshold alert type', () => {
},
]);
const { state: stateResult1 } = await executeWithFilter(
- Comparator.GT,
+ COMPARATORS.GREATER_THAN,
[0.75],
JSON.stringify({ query: 'q' }),
'test.metric.2'
@@ -887,7 +887,7 @@ describe('The custom threshold alert type', () => {
{
a: {
...customThresholdNonCountCriterion,
- comparator: Comparator.GT,
+ comparator: COMPARATORS.GREATER_THAN,
threshold: [0.75],
currentValue: 1.0,
timestamp: new Date().toISOString(),
@@ -897,7 +897,7 @@ describe('The custom threshold alert type', () => {
},
b: {
...customThresholdNonCountCriterion,
- comparator: Comparator.GT,
+ comparator: COMPARATORS.GREATER_THAN,
threshold: [0.75],
currentValue: null,
timestamp: new Date().toISOString(),
@@ -907,7 +907,7 @@ describe('The custom threshold alert type', () => {
},
c: {
...customThresholdNonCountCriterion,
- comparator: Comparator.GT,
+ comparator: COMPARATORS.GREATER_THAN,
threshold: [0.75],
currentValue: null,
timestamp: new Date().toISOString(),
@@ -918,7 +918,7 @@ describe('The custom threshold alert type', () => {
},
]);
const { state: stateResult2 } = await executeWithFilter(
- Comparator.GT,
+ COMPARATORS.GREATER_THAN,
[0.75],
JSON.stringify({ query: 'q' }),
'test.metric.1',
@@ -934,7 +934,7 @@ describe('The custom threshold alert type', () => {
{
a: {
...customThresholdNonCountCriterion,
- comparator: Comparator.GT,
+ comparator: COMPARATORS.GREATER_THAN,
threshold: [0.75],
currentValue: 1.0,
timestamp: new Date().toISOString(),
@@ -944,7 +944,7 @@ describe('The custom threshold alert type', () => {
},
b: {
...customThresholdNonCountCriterion,
- comparator: Comparator.GT,
+ comparator: COMPARATORS.GREATER_THAN,
threshold: [0.75],
currentValue: null,
timestamp: new Date().toISOString(),
@@ -957,7 +957,7 @@ describe('The custom threshold alert type', () => {
// Consider c as untracked
services.alertsClient.isTrackedAlert.mockImplementation((id: string) => id !== 'c');
const { state: stateResult3 } = await executeWithFilter(
- Comparator.GT,
+ COMPARATORS.GREATER_THAN,
[0.75],
JSON.stringify({ query: 'q' }),
'test.metric.1',
@@ -973,7 +973,7 @@ describe('The custom threshold alert type', () => {
describe('querying with a groupBy parameter host.name and rule tags', () => {
afterAll(() => clearInstances());
const execute = (
- comparator: Comparator,
+ comparator: COMPARATORS,
threshold: number[],
groupBy: string[] = ['host.name'],
metrics?: any,
@@ -1008,7 +1008,7 @@ describe('The custom threshold alert type', () => {
{
'host-01': {
...customThresholdNonCountCriterion,
- comparator: Comparator.GT,
+ comparator: COMPARATORS.GREATER_THAN,
threshold: [0.75],
currentValue: 1.0,
timestamp: new Date().toISOString(),
@@ -1021,7 +1021,7 @@ describe('The custom threshold alert type', () => {
},
'host-02': {
...customThresholdNonCountCriterion,
- comparator: Comparator.GT,
+ comparator: COMPARATORS.GREATER_THAN,
threshold: [0.75],
currentValue: 3,
timestamp: new Date().toISOString(),
@@ -1034,7 +1034,7 @@ describe('The custom threshold alert type', () => {
},
},
]);
- await execute(Comparator.GT, [0.75]);
+ await execute(COMPARATORS.GREATER_THAN, [0.75]);
expect(getLastReportedAlert(instanceIdA)?.context?.tags).toStrictEqual([
'host-01_tag1',
'host-01_tag2',
@@ -1053,7 +1053,7 @@ describe('The custom threshold alert type', () => {
describe('querying without a groupBy parameter and rule tags', () => {
afterAll(() => clearInstances());
const execute = (
- comparator: Comparator,
+ comparator: COMPARATORS,
threshold: number[],
groupBy: string = '',
metrics?: any,
@@ -1086,7 +1086,7 @@ describe('The custom threshold alert type', () => {
{
'*': {
...customThresholdNonCountCriterion,
- comparator: Comparator.GT,
+ comparator: COMPARATORS.GREATER_THAN,
threshold: [0.75],
currentValue: 1.0,
timestamp: new Date().toISOString(),
@@ -1098,7 +1098,7 @@ describe('The custom threshold alert type', () => {
]);
const instanceID = '*';
- await execute(Comparator.GT, [0.75]);
+ await execute(COMPARATORS.GREATER_THAN, [0.75]);
expect(getLastReportedAlert(instanceID)?.context?.tags).toStrictEqual([
'ruleTag1',
'ruleTag2',
@@ -1109,7 +1109,7 @@ describe('The custom threshold alert type', () => {
describe('querying with multiple criteria', () => {
afterAll(() => clearInstances());
const execute = (
- comparator: Comparator,
+ comparator: COMPARATORS,
thresholdA: number[],
thresholdB: number[],
groupBy: string = '',
@@ -1148,7 +1148,7 @@ describe('The custom threshold alert type', () => {
{
'*': {
...customThresholdNonCountCriterion,
- comparator: Comparator.GT_OR_EQ,
+ comparator: COMPARATORS.GREATER_THAN_OR_EQUALS,
threshold: [1.0],
currentValue: 1.0,
timestamp: new Date().toISOString(),
@@ -1160,7 +1160,7 @@ describe('The custom threshold alert type', () => {
{
'*': {
...customThresholdNonCountCriterion,
- comparator: Comparator.GT_OR_EQ,
+ comparator: COMPARATORS.GREATER_THAN_OR_EQUALS,
threshold: [3.0],
currentValue: 3.0,
timestamp: new Date().toISOString(),
@@ -1171,7 +1171,7 @@ describe('The custom threshold alert type', () => {
},
]);
const instanceID = '*';
- await execute(Comparator.GT_OR_EQ, [1.0], [3.0]);
+ await execute(COMPARATORS.GREATER_THAN_OR_EQUALS, [1.0], [3.0]);
expect(getLastReportedAlert(instanceID)).toHaveAlertAction();
});
test('sends no alert when some, but not all, criteria cross the threshold', async () => {
@@ -1179,7 +1179,7 @@ describe('The custom threshold alert type', () => {
{
'*': {
...customThresholdNonCountCriterion,
- comparator: Comparator.LT_OR_EQ,
+ comparator: COMPARATORS.LESS_THAN_OR_EQUALS,
threshold: [1.0],
currentValue: 1.0,
timestamp: new Date().toISOString(),
@@ -1191,7 +1191,7 @@ describe('The custom threshold alert type', () => {
{},
]);
const instanceID = '*';
- await execute(Comparator.LT_OR_EQ, [1.0], [2.5]);
+ await execute(COMPARATORS.LESS_THAN_OR_EQUALS, [1.0], [2.5]);
expect(getLastReportedAlert(instanceID)).toBe(undefined);
});
test('alerts only on groups that meet all criteria when querying with a groupBy parameter', async () => {
@@ -1199,7 +1199,7 @@ describe('The custom threshold alert type', () => {
{
a: {
...customThresholdNonCountCriterion,
- comparator: Comparator.GT_OR_EQ,
+ comparator: COMPARATORS.GREATER_THAN_OR_EQUALS,
threshold: [1.0],
currentValue: 1.0,
timestamp: new Date().toISOString(),
@@ -1209,7 +1209,7 @@ describe('The custom threshold alert type', () => {
},
b: {
...customThresholdNonCountCriterion,
- comparator: Comparator.GT_OR_EQ,
+ comparator: COMPARATORS.GREATER_THAN_OR_EQUALS,
threshold: [1.0],
currentValue: 3.0,
timestamp: new Date().toISOString(),
@@ -1221,7 +1221,7 @@ describe('The custom threshold alert type', () => {
{
a: {
...customThresholdNonCountCriterion,
- comparator: Comparator.GT_OR_EQ,
+ comparator: COMPARATORS.GREATER_THAN_OR_EQUALS,
threshold: [3.0],
metrics: [
{
@@ -1238,7 +1238,7 @@ describe('The custom threshold alert type', () => {
},
b: {
...customThresholdNonCountCriterion,
- comparator: Comparator.GT_OR_EQ,
+ comparator: COMPARATORS.GREATER_THAN_OR_EQUALS,
threshold: [3.0],
metrics: [
{
@@ -1257,7 +1257,7 @@ describe('The custom threshold alert type', () => {
]);
const instanceIdA = 'a';
const instanceIdB = 'b';
- await execute(Comparator.GT_OR_EQ, [1.0], [3.0], 'groupByField');
+ await execute(COMPARATORS.GREATER_THAN_OR_EQUALS, [1.0], [3.0], 'groupByField');
expect(getLastReportedAlert(instanceIdA)).toHaveAlertAction();
expect(getLastReportedAlert(instanceIdB)).toBe(undefined);
});
@@ -1266,7 +1266,7 @@ describe('The custom threshold alert type', () => {
{
'*': {
...customThresholdNonCountCriterion,
- comparator: Comparator.GT_OR_EQ,
+ comparator: COMPARATORS.GREATER_THAN_OR_EQUALS,
threshold: [1.0],
currentValue: 1.0,
timestamp: new Date().toISOString(),
@@ -1278,7 +1278,7 @@ describe('The custom threshold alert type', () => {
{
'*': {
...customThresholdNonCountCriterion,
- comparator: Comparator.GT_OR_EQ,
+ comparator: COMPARATORS.GREATER_THAN_OR_EQUALS,
threshold: [3.0],
metrics: [
{
@@ -1296,7 +1296,7 @@ describe('The custom threshold alert type', () => {
},
]);
const instanceID = '*';
- await execute(Comparator.GT_OR_EQ, [1.0], [3.0]);
+ await execute(COMPARATORS.GREATER_THAN_OR_EQUALS, [1.0], [3.0]);
const reportedAlert = getLastReportedAlert(instanceID);
const reasons = reportedAlert?.context?.reason;
expect(reasons).toBe(
@@ -1308,7 +1308,7 @@ describe('The custom threshold alert type', () => {
describe('querying with the count aggregator', () => {
afterAll(() => clearInstances());
const instanceID = '*';
- const execute = (comparator: Comparator, threshold: number[], sourceId: string = 'default') =>
+ const execute = (comparator: COMPARATORS, threshold: number[], sourceId: string = 'default') =>
executor({
...mockOptions,
services,
@@ -1329,7 +1329,7 @@ describe('The custom threshold alert type', () => {
{
'*': {
...customThresholdCountCriterion,
- comparator: Comparator.GT,
+ comparator: COMPARATORS.GREATER_THAN,
threshold: [0.9],
currentValue: 1,
timestamp: new Date().toISOString(),
@@ -1339,13 +1339,13 @@ describe('The custom threshold alert type', () => {
},
},
]);
- await execute(Comparator.GT, [0.9]);
+ await execute(COMPARATORS.GREATER_THAN, [0.9]);
expect(getLastReportedAlert(instanceID)).toHaveAlertAction();
setEvaluationResults([
{
'*': {
...customThresholdCountCriterion,
- comparator: Comparator.LT,
+ comparator: COMPARATORS.LESS_THAN,
threshold: [0.5],
currentValue: 1,
timestamp: new Date().toISOString(),
@@ -1355,12 +1355,12 @@ describe('The custom threshold alert type', () => {
},
},
]);
- await execute(Comparator.LT, [0.5]);
+ await execute(COMPARATORS.LESS_THAN, [0.5]);
expect(getLastReportedAlert(instanceID)).toBe(undefined);
});
describe('with a groupBy parameter', () => {
const executeGroupBy = (
- comparator: Comparator,
+ comparator: COMPARATORS,
threshold: number[],
sourceId: string = 'default',
state?: any
@@ -1390,7 +1390,7 @@ describe('The custom threshold alert type', () => {
{
a: {
...customThresholdCountCriterion,
- comparator: Comparator.LT_OR_EQ,
+ comparator: COMPARATORS.LESS_THAN_OR_EQUALS,
threshold: [0],
currentValue: 1,
timestamp: new Date().toISOString(),
@@ -1400,7 +1400,7 @@ describe('The custom threshold alert type', () => {
},
b: {
...customThresholdCountCriterion,
- comparator: Comparator.LT_OR_EQ,
+ comparator: COMPARATORS.LESS_THAN_OR_EQUALS,
threshold: [0],
currentValue: 1,
timestamp: new Date().toISOString(),
@@ -1410,14 +1410,14 @@ describe('The custom threshold alert type', () => {
},
},
]);
- const resultState = await executeGroupBy(Comparator.LT_OR_EQ, [0]);
+ const resultState = await executeGroupBy(COMPARATORS.LESS_THAN_OR_EQUALS, [0]);
expect(getLastReportedAlert(instanceIdA)).toBe(undefined);
expect(getLastReportedAlert(instanceIdB)).toBe(undefined);
setEvaluationResults([
{
a: {
...customThresholdCountCriterion,
- comparator: Comparator.LT_OR_EQ,
+ comparator: COMPARATORS.LESS_THAN_OR_EQUALS,
threshold: [0],
currentValue: 0,
timestamp: new Date().toISOString(),
@@ -1427,7 +1427,7 @@ describe('The custom threshold alert type', () => {
},
b: {
...customThresholdCountCriterion,
- comparator: Comparator.LT_OR_EQ,
+ comparator: COMPARATORS.LESS_THAN_OR_EQUALS,
threshold: [0],
currentValue: 0,
timestamp: new Date().toISOString(),
@@ -1437,7 +1437,7 @@ describe('The custom threshold alert type', () => {
},
},
]);
- await executeGroupBy(Comparator.LT_OR_EQ, [0], 'empty-response', resultState);
+ await executeGroupBy(COMPARATORS.LESS_THAN_OR_EQUALS, [0], 'empty-response', resultState);
expect(getLastReportedAlert(instanceIdA)).toHaveAlertAction();
expect(getLastReportedAlert(instanceIdB)).toHaveAlertAction();
});
@@ -1446,7 +1446,7 @@ describe('The custom threshold alert type', () => {
describe('querying recovered alert with a count aggregator', () => {
afterAll(() => clearInstances());
- const execute = (comparator: Comparator, threshold: number[], sourceId: string = 'default') =>
+ const execute = (comparator: COMPARATORS, threshold: number[], sourceId: string = 'default') =>
executor({
...mockOptions,
services,
@@ -1467,7 +1467,7 @@ describe('The custom threshold alert type', () => {
{
'*': {
...customThresholdCountCriterion,
- comparator: Comparator.GT,
+ comparator: COMPARATORS.GREATER_THAN,
threshold: [0.9],
currentValue: 1,
timestamp: new Date().toISOString(),
@@ -1488,7 +1488,7 @@ describe('The custom threshold alert type', () => {
]),
};
});
- await execute(Comparator.GT, [0.9]);
+ await execute(COMPARATORS.GREATER_THAN, [0.9]);
const ISO_DATE_REGEX = /^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\.\d{3}Z$/;
expect(getViewInAppUrl).toBeCalledWith({
dataViewId: 'c34a7c79-a88b-4b4a-ad19-72f6d24104e4',
@@ -1519,7 +1519,7 @@ describe('The custom threshold alert type', () => {
criteria: [
{
...customThresholdNonCountCriterion,
- comparator: Comparator.GT,
+ comparator: COMPARATORS.GREATER_THAN,
threshold: [1],
metrics: [
{
@@ -1538,7 +1538,7 @@ describe('The custom threshold alert type', () => {
{
'*': {
...customThresholdNonCountCriterion,
- comparator: Comparator.LT,
+ comparator: COMPARATORS.LESS_THAN,
threshold: [1],
metrics: [
{
@@ -1567,7 +1567,7 @@ describe('The custom threshold alert type', () => {
{
'*': {
...customThresholdNonCountCriterion,
- comparator: Comparator.LT,
+ comparator: COMPARATORS.LESS_THAN,
threshold: [1],
metrics: [
{
@@ -1602,7 +1602,7 @@ describe('The custom threshold alert type', () => {
criteria: [
{
...customThresholdNonCountCriterion,
- comparator: Comparator.GT,
+ comparator: COMPARATORS.GREATER_THAN,
threshold: [1],
metrics: [
{
@@ -1614,7 +1614,7 @@ describe('The custom threshold alert type', () => {
},
{
...customThresholdCountCriterion,
- comparator: Comparator.GT,
+ comparator: COMPARATORS.GREATER_THAN,
threshold: [30],
},
],
@@ -1626,7 +1626,7 @@ describe('The custom threshold alert type', () => {
{
'*': {
...customThresholdNonCountCriterion,
- comparator: Comparator.LT,
+ comparator: COMPARATORS.LESS_THAN,
threshold: [1],
metrics: [
{
@@ -1675,7 +1675,7 @@ describe('The custom threshold alert type', () => {
criteria: [
{
...customThresholdNonCountCriterion,
- comparator: Comparator.GT,
+ comparator: COMPARATORS.GREATER_THAN,
threshold: [0],
metrics,
},
@@ -1700,7 +1700,7 @@ describe('The custom threshold alert type', () => {
{
'*': {
...customThresholdNonCountCriterion,
- comparator: Comparator.GT,
+ comparator: COMPARATORS.GREATER_THAN,
threshold: [0],
metrics: [
{
@@ -1723,7 +1723,7 @@ describe('The custom threshold alert type', () => {
{
'*': {
...customThresholdNonCountCriterion,
- comparator: Comparator.GT,
+ comparator: COMPARATORS.GREATER_THAN,
threshold: [0],
metrics: [
{
@@ -1746,7 +1746,7 @@ describe('The custom threshold alert type', () => {
{
a: {
...customThresholdNonCountCriterion,
- comparator: Comparator.GT,
+ comparator: COMPARATORS.GREATER_THAN,
threshold: [0],
currentValue: 1.0,
timestamp: new Date().toISOString(),
@@ -1756,7 +1756,7 @@ describe('The custom threshold alert type', () => {
},
b: {
...customThresholdNonCountCriterion,
- comparator: Comparator.GT,
+ comparator: COMPARATORS.GREATER_THAN,
threshold: [0],
currentValue: 3,
timestamp: new Date().toISOString(),
@@ -1780,7 +1780,7 @@ describe('The custom threshold alert type', () => {
{
a: {
...customThresholdNonCountCriterion,
- comparator: Comparator.GT,
+ comparator: COMPARATORS.GREATER_THAN,
threshold: [0],
metrics: [
{
@@ -1797,7 +1797,7 @@ describe('The custom threshold alert type', () => {
},
b: {
...customThresholdNonCountCriterion,
- comparator: Comparator.GT,
+ comparator: COMPARATORS.GREATER_THAN,
threshold: [0],
metrics: [
{
@@ -1824,7 +1824,7 @@ describe('The custom threshold alert type', () => {
{
a: {
...customThresholdNonCountCriterion,
- comparator: Comparator.GT,
+ comparator: COMPARATORS.GREATER_THAN,
threshold: [0],
metrics: [
{
@@ -1841,7 +1841,7 @@ describe('The custom threshold alert type', () => {
},
b: {
...customThresholdNonCountCriterion,
- comparator: Comparator.GT,
+ comparator: COMPARATORS.GREATER_THAN,
threshold: [0],
metrics: [
{
@@ -1858,7 +1858,7 @@ describe('The custom threshold alert type', () => {
},
c: {
...customThresholdNonCountCriterion,
- comparator: Comparator.GT,
+ comparator: COMPARATORS.GREATER_THAN,
threshold: [0],
metrics: [
{
@@ -1884,7 +1884,7 @@ describe('The custom threshold alert type', () => {
{
a: {
...customThresholdNonCountCriterion,
- comparator: Comparator.GT,
+ comparator: COMPARATORS.GREATER_THAN,
threshold: [0],
currentValue: 1,
timestamp: new Date().toISOString(),
@@ -1894,7 +1894,7 @@ describe('The custom threshold alert type', () => {
},
b: {
...customThresholdNonCountCriterion,
- comparator: Comparator.GT,
+ comparator: COMPARATORS.GREATER_THAN,
threshold: [0],
currentValue: 3,
timestamp: new Date().toISOString(),
@@ -1923,7 +1923,7 @@ describe('The custom threshold alert type', () => {
criteria: [
{
...customThresholdNonCountCriterion,
- comparator: Comparator.GT,
+ comparator: COMPARATORS.GREATER_THAN,
threshold: [0],
metrics,
},
@@ -1944,7 +1944,7 @@ describe('The custom threshold alert type', () => {
{
'*': {
...customThresholdNonCountCriterion,
- comparator: Comparator.GT,
+ comparator: COMPARATORS.GREATER_THAN,
threshold: [0],
metrics: [
{
@@ -1967,7 +1967,7 @@ describe('The custom threshold alert type', () => {
{
'*': {
...customThresholdNonCountCriterion,
- comparator: Comparator.GT,
+ comparator: COMPARATORS.GREATER_THAN,
threshold: [0],
metrics: [
{
@@ -1990,7 +1990,7 @@ describe('The custom threshold alert type', () => {
{
a: {
...customThresholdNonCountCriterion,
- comparator: Comparator.GT,
+ comparator: COMPARATORS.GREATER_THAN,
threshold: [0],
currentValue: 1,
timestamp: new Date().toISOString(),
@@ -2000,7 +2000,7 @@ describe('The custom threshold alert type', () => {
},
b: {
...customThresholdNonCountCriterion,
- comparator: Comparator.GT,
+ comparator: COMPARATORS.GREATER_THAN,
threshold: [0],
currentValue: 3,
timestamp: new Date().toISOString(),
@@ -2022,7 +2022,7 @@ describe('The custom threshold alert type', () => {
{
a: {
...customThresholdNonCountCriterion,
- comparator: Comparator.GT,
+ comparator: COMPARATORS.GREATER_THAN,
threshold: [0],
metrics: [
{
@@ -2039,7 +2039,7 @@ describe('The custom threshold alert type', () => {
},
b: {
...customThresholdNonCountCriterion,
- comparator: Comparator.GT,
+ comparator: COMPARATORS.GREATER_THAN,
threshold: [0],
metrics: [
{
@@ -2116,7 +2116,7 @@ declare global {
}
const customThresholdNonCountCriterion: CustomMetricExpressionParams = {
- comparator: Comparator.GT,
+ comparator: COMPARATORS.GREATER_THAN,
metrics: [
{
aggType: Aggregators.AVERAGE,
@@ -2131,7 +2131,7 @@ const customThresholdNonCountCriterion: CustomMetricExpressionParams = {
const mockedCountFilter = 'mockedCountFilter';
const customThresholdCountCriterion: CustomMetricExpressionParams = {
- comparator: Comparator.GT,
+ comparator: COMPARATORS.GREATER_THAN,
metrics: [
{
aggType: Aggregators.COUNT,
diff --git a/x-pack/plugins/observability_solution/observability/server/lib/rules/custom_threshold/custom_threshold_executor.ts b/x-pack/plugins/observability_solution/observability/server/lib/rules/custom_threshold/custom_threshold_executor.ts
index 21ee4358b595a4..94be15415abb8a 100644
--- a/x-pack/plugins/observability_solution/observability/server/lib/rules/custom_threshold/custom_threshold_executor.ts
+++ b/x-pack/plugins/observability_solution/observability/server/lib/rules/custom_threshold/custom_threshold_executor.ts
@@ -33,11 +33,7 @@ import {
CustomThresholdActionGroup,
CustomThresholdAlert,
} from './types';
-import {
- buildFiredAlertReason,
- buildNoDataAlertReason,
- // buildRecoveredAlertReason,
-} from './messages';
+import { buildFiredAlertReason, buildNoDataAlertReason } from './messages';
import {
createScopedLogger,
hasAdditionalContext,
@@ -91,6 +87,7 @@ export const createCustomThresholdExecutor = ({
} = options;
const { criteria } = params;
+
if (criteria.length === 0) throw new Error('Cannot execute an alert with 0 conditions');
const thresholdLogger = createScopedLogger(logger, 'thresholdRule', {
alertId: ruleId,
diff --git a/x-pack/plugins/observability_solution/observability/server/lib/rules/custom_threshold/lib/create_bucket_selector.ts b/x-pack/plugins/observability_solution/observability/server/lib/rules/custom_threshold/lib/create_bucket_selector.ts
index 9a1dde442983c7..48d355ee4ce33d 100644
--- a/x-pack/plugins/observability_solution/observability/server/lib/rules/custom_threshold/lib/create_bucket_selector.ts
+++ b/x-pack/plugins/observability_solution/observability/server/lib/rules/custom_threshold/lib/create_bucket_selector.ts
@@ -5,6 +5,7 @@
* 2.0.
*/
+import { convertToBuiltInComparators } from '../../../../../common';
import { CustomMetricExpressionParams } from '../../../../../common/custom_threshold_rule/types';
import { createConditionScript } from './create_condition_script';
import { createLastPeriod } from './wrap_in_period';
@@ -24,7 +25,10 @@ export const createBucketSelector = (
buckets_path: {
value: bucketPath,
},
- script: createConditionScript(condition.threshold, condition.comparator),
+ script: createConditionScript(
+ condition.threshold,
+ convertToBuiltInComparators(condition.comparator)
+ ),
},
};
diff --git a/x-pack/plugins/observability_solution/observability/server/lib/rules/custom_threshold/lib/create_condition_script.ts b/x-pack/plugins/observability_solution/observability/server/lib/rules/custom_threshold/lib/create_condition_script.ts
index 2e5eda9fa32b4e..48a105d3700be3 100644
--- a/x-pack/plugins/observability_solution/observability/server/lib/rules/custom_threshold/lib/create_condition_script.ts
+++ b/x-pack/plugins/observability_solution/observability/server/lib/rules/custom_threshold/lib/create_condition_script.ts
@@ -5,10 +5,10 @@
* 2.0.
*/
-import { Comparator } from '../../../../../common/custom_threshold_rule/types';
+import { COMPARATORS } from '@kbn/alerting-comparators';
-export const createConditionScript = (threshold: number[], comparator: Comparator) => {
- if (comparator === Comparator.BETWEEN && threshold.length === 2) {
+export const createConditionScript = (threshold: number[], comparator: COMPARATORS) => {
+ if (comparator === COMPARATORS.BETWEEN && threshold.length === 2) {
return {
source: `params.value > params.threshold0 && params.value < params.threshold1 ? 1 : 0`,
params: {
@@ -17,9 +17,9 @@ export const createConditionScript = (threshold: number[], comparator: Comparato
},
};
}
- if (comparator === Comparator.OUTSIDE_RANGE && threshold.length === 2) {
+ if (comparator === COMPARATORS.NOT_BETWEEN && threshold.length === 2) {
return {
- // OUTSIDE_RANGE/NOT BETWEEN is the opposite of BETWEEN. Use the BETWEEN condition and switch the 1 and 0
+ // NOT BETWEEN is the opposite of BETWEEN. Use the BETWEEN condition and switch the 1 and 0
source: `params.value > params.threshold0 && params.value < params.threshold1 ? 0 : 1`,
params: {
threshold0: threshold[0],
diff --git a/x-pack/plugins/observability_solution/observability/server/lib/rules/custom_threshold/lib/get_data.ts b/x-pack/plugins/observability_solution/observability/server/lib/rules/custom_threshold/lib/get_data.ts
index ac55b7f76f3836..c3c0d8b2eee949 100644
--- a/x-pack/plugins/observability_solution/observability/server/lib/rules/custom_threshold/lib/get_data.ts
+++ b/x-pack/plugins/observability_solution/observability/server/lib/rules/custom_threshold/lib/get_data.ts
@@ -194,7 +194,6 @@ export const getData = async (
const fieldsExisted = groupBy?.includes(KUBERNETES_POD_UID)
? await doFieldsExist(esClient, [CONTAINER_ID], index)
: null;
-
const request = {
index,
allow_no_indices: true,
diff --git a/x-pack/plugins/observability_solution/observability/server/lib/rules/custom_threshold/lib/metric_query.test.ts b/x-pack/plugins/observability_solution/observability/server/lib/rules/custom_threshold/lib/metric_query.test.ts
index b63e72e19fd291..e10a4f4cae9be2 100644
--- a/x-pack/plugins/observability_solution/observability/server/lib/rules/custom_threshold/lib/metric_query.test.ts
+++ b/x-pack/plugins/observability_solution/observability/server/lib/rules/custom_threshold/lib/metric_query.test.ts
@@ -7,12 +7,12 @@
import moment from 'moment';
import {
- Comparator,
Aggregators,
CustomMetricExpressionParams,
SearchConfigurationType,
} from '../../../../../common/custom_threshold_rule/types';
import { getElasticsearchMetricQuery } from './metric_query';
+import { COMPARATORS } from '@kbn/alerting-comparators';
describe("The Metric Threshold Alert's getElasticsearchMetricQuery", () => {
const expressionParams: CustomMetricExpressionParams = {
@@ -26,7 +26,7 @@ describe("The Metric Threshold Alert's getElasticsearchMetricQuery", () => {
timeUnit: 'm',
timeSize: 1,
threshold: [1],
- comparator: Comparator.GT,
+ comparator: COMPARATORS.GREATER_THAN,
};
const searchConfiguration: SearchConfigurationType = {
index: {
diff --git a/x-pack/plugins/observability_solution/observability/server/lib/rules/custom_threshold/messages.ts b/x-pack/plugins/observability_solution/observability/server/lib/rules/custom_threshold/messages.ts
index ca160d06b65739..046b7b58790265 100644
--- a/x-pack/plugins/observability_solution/observability/server/lib/rules/custom_threshold/messages.ts
+++ b/x-pack/plugins/observability_solution/observability/server/lib/rules/custom_threshold/messages.ts
@@ -6,58 +6,58 @@
*/
import { i18n } from '@kbn/i18n';
-import { Comparator } from '../../../../common/custom_threshold_rule/types';
-import { formatDurationFromTimeUnitChar } from '../../../../common';
-import { Evaluation } from './lib/evaluate_rule';
-import { formatAlertResult, FormattedEvaluation } from './lib/format_alert_result';
+import { COMPARATORS } from '@kbn/alerting-comparators';
import {
- BELOW_TEXT,
ABOVE_TEXT,
- BETWEEN_TEXT,
- NOT_BETWEEN_TEXT,
- CUSTOM_EQUATION_I18N,
ABOVE_OR_EQ_TEXT,
+ BELOW_TEXT,
BELOW_OR_EQ_TEXT,
-} from './translations';
+ BETWEEN_TEXT,
+ NOT_BETWEEN_TEXT,
+} from '../../../../common/i18n';
+import { convertToBuiltInComparators, formatDurationFromTimeUnitChar } from '../../../../common';
+import { Evaluation } from './lib/evaluate_rule';
+import { formatAlertResult, FormattedEvaluation } from './lib/format_alert_result';
+import { CUSTOM_EQUATION_I18N } from './translations';
import { UNGROUPED_FACTORY_KEY } from './constants';
const toNumber = (value: number | string) =>
typeof value === 'string' ? parseFloat(value) : value;
const recoveredComparatorToI18n = (
- comparator: Comparator,
+ comparator: COMPARATORS,
threshold: number[],
currentValue: number
) => {
switch (comparator) {
- case Comparator.BETWEEN:
+ case COMPARATORS.BETWEEN:
return currentValue < threshold[0] ? BELOW_TEXT : ABOVE_TEXT;
- case Comparator.OUTSIDE_RANGE:
+ case COMPARATORS.NOT_BETWEEN:
return BETWEEN_TEXT;
- case Comparator.GT:
+ case COMPARATORS.GREATER_THAN:
return ABOVE_TEXT;
- case Comparator.GT_OR_EQ:
+ case COMPARATORS.GREATER_THAN_OR_EQUALS:
return ABOVE_OR_EQ_TEXT;
- case Comparator.LT:
+ case COMPARATORS.LESS_THAN:
return BELOW_TEXT;
- case Comparator.LT_OR_EQ:
+ case COMPARATORS.LESS_THAN_OR_EQUALS:
return BELOW_OR_EQ_TEXT;
}
};
-const alertComparatorToI18n = (comparator: Comparator) => {
+const alertComparatorToI18n = (comparator: COMPARATORS) => {
switch (comparator) {
- case Comparator.BETWEEN:
+ case COMPARATORS.BETWEEN:
return BETWEEN_TEXT;
- case Comparator.OUTSIDE_RANGE:
+ case COMPARATORS.NOT_BETWEEN:
return NOT_BETWEEN_TEXT;
- case Comparator.GT:
+ case COMPARATORS.GREATER_THAN:
return ABOVE_TEXT;
- case Comparator.GT_OR_EQ:
+ case COMPARATORS.GREATER_THAN_OR_EQUALS:
return ABOVE_OR_EQ_TEXT;
- case Comparator.LT:
+ case COMPARATORS.LESS_THAN:
return BELOW_TEXT;
- case Comparator.LT_OR_EQ:
+ case COMPARATORS.LESS_THAN_OR_EQUALS:
return BELOW_OR_EQ_TEXT;
}
};
@@ -124,7 +124,7 @@ const buildAggregationReason: (evaluation: FormattedEvaluation) => string = ({
defaultMessage: '{label} is {currentValue}, {comparator} the threshold of {threshold}',
values: {
label,
- comparator: alertComparatorToI18n(comparator),
+ comparator: alertComparatorToI18n(convertToBuiltInComparators(comparator)),
threshold: thresholdToI18n(threshold),
currentValue,
},
@@ -134,7 +134,7 @@ const buildAggregationReason: (evaluation: FormattedEvaluation) => string = ({
export const buildRecoveredAlertReason: (alertResult: {
group: string;
label?: string;
- comparator: Comparator;
+ comparator: COMPARATORS;
threshold: Array;
currentValue: number | string;
}) => string = ({ group, label = CUSTOM_EQUATION_I18N, comparator, threshold, currentValue }) =>
diff --git a/x-pack/plugins/observability_solution/observability/server/lib/rules/custom_threshold/mocks/custom_threshold_alert_result.ts b/x-pack/plugins/observability_solution/observability/server/lib/rules/custom_threshold/mocks/custom_threshold_alert_result.ts
index b8ab169b7a90d1..08c6e602989391 100644
--- a/x-pack/plugins/observability_solution/observability/server/lib/rules/custom_threshold/mocks/custom_threshold_alert_result.ts
+++ b/x-pack/plugins/observability_solution/observability/server/lib/rules/custom_threshold/mocks/custom_threshold_alert_result.ts
@@ -5,15 +5,15 @@
* 2.0.
*/
+import { COMPARATORS } from '@kbn/alerting-comparators';
import {
Aggregators,
- Comparator,
CustomMetricExpressionParams,
} from '../../../../../common/custom_threshold_rule/types';
import { Evaluation } from '../lib/evaluate_rule';
const customThresholdNonCountCriterion: CustomMetricExpressionParams = {
- comparator: Comparator.GT,
+ comparator: COMPARATORS.GREATER_THAN,
metrics: [
{
aggType: Aggregators.AVERAGE,
@@ -30,7 +30,7 @@ export const alertResultsMultipleConditions: Array> =
{
'*': {
...customThresholdNonCountCriterion,
- comparator: Comparator.GT,
+ comparator: COMPARATORS.GREATER_THAN,
threshold: [0.75],
currentValue: 1.0,
timestamp: new Date().toISOString(),
@@ -42,7 +42,7 @@ export const alertResultsMultipleConditions: Array> =
{
'*': {
...customThresholdNonCountCriterion,
- comparator: Comparator.GT,
+ comparator: COMPARATORS.GREATER_THAN,
threshold: [0.75],
currentValue: 3.0,
timestamp: new Date().toISOString(),
diff --git a/x-pack/plugins/observability_solution/observability/server/lib/rules/custom_threshold/mocks/custom_threshold_metric_params.ts b/x-pack/plugins/observability_solution/observability/server/lib/rules/custom_threshold/mocks/custom_threshold_metric_params.ts
index 6c3eb7557302c8..09e202fcac7d93 100644
--- a/x-pack/plugins/observability_solution/observability/server/lib/rules/custom_threshold/mocks/custom_threshold_metric_params.ts
+++ b/x-pack/plugins/observability_solution/observability/server/lib/rules/custom_threshold/mocks/custom_threshold_metric_params.ts
@@ -5,9 +5,9 @@
* 2.0.
*/
+import { COMPARATORS } from '@kbn/alerting-comparators';
import {
Aggregators,
- Comparator,
CustomMetricExpressionParams,
} from '../../../../../common/custom_threshold_rule/types';
@@ -28,7 +28,7 @@ export const criteriaMultipleConditions: CustomMetricExpressionParams[] = [
timeUnit: 'm',
timeSize: 1,
threshold: [1],
- comparator: Comparator.GT,
+ comparator: COMPARATORS.GREATER_THAN,
},
{
metrics: [
@@ -46,7 +46,7 @@ export const criteriaMultipleConditions: CustomMetricExpressionParams[] = [
timeUnit: 'm',
timeSize: 1,
threshold: [4],
- comparator: Comparator.GT,
+ comparator: COMPARATORS.GREATER_THAN,
},
];
@@ -67,7 +67,7 @@ export const criteriaMultipleConditionsWithIsBetween: CustomMetricExpressionPara
timeUnit: 'm',
timeSize: 1,
threshold: [1, 2],
- comparator: Comparator.BETWEEN,
+ comparator: COMPARATORS.BETWEEN,
},
{
metrics: [
@@ -85,6 +85,6 @@ export const criteriaMultipleConditionsWithIsBetween: CustomMetricExpressionPara
timeUnit: 'm',
timeSize: 1,
threshold: [4],
- comparator: Comparator.GT,
+ comparator: COMPARATORS.GREATER_THAN,
},
];
diff --git a/x-pack/plugins/observability_solution/observability/server/lib/rules/custom_threshold/register_custom_threshold_rule_type.ts b/x-pack/plugins/observability_solution/observability/server/lib/rules/custom_threshold/register_custom_threshold_rule_type.ts
index 8d3a968d85a64d..f198a6c7079686 100644
--- a/x-pack/plugins/observability_solution/observability/server/lib/rules/custom_threshold/register_custom_threshold_rule_type.ts
+++ b/x-pack/plugins/observability_solution/observability/server/lib/rules/custom_threshold/register_custom_threshold_rule_type.ts
@@ -15,9 +15,11 @@ import { IBasePath, Logger } from '@kbn/core/server';
import { legacyExperimentalFieldMap } from '@kbn/alerts-as-data-utils';
import { OBSERVABILITY_THRESHOLD_RULE_TYPE_ID } from '@kbn/rule-data-utils';
import { LicenseType } from '@kbn/licensing-plugin/server';
+import { COMPARATORS } from '@kbn/alerting-comparators';
import { EsQueryRuleParamsExtractedParams } from '@kbn/stack-alerts-plugin/server/rule_types/es_query/rule_type_params';
+import { LEGACY_COMPARATORS } from '../../../../common/utils/convert_legacy_outside_comparator';
import { observabilityFeatureId, observabilityPaths } from '../../../../common';
-import { Aggregators, Comparator } from '../../../../common/custom_threshold_rule/types';
+import { Aggregators } from '../../../../common/custom_threshold_rule/types';
import { THRESHOLD_RULE_REGISTRATION_CONTEXT } from '../../../common/constants';
import {
@@ -75,9 +77,10 @@ export function thresholdRuleType(
logger: Logger,
locators: CustomThresholdLocators
) {
+ const comparators = Object.values({ ...COMPARATORS, ...LEGACY_COMPARATORS });
const baseCriterion = {
threshold: schema.arrayOf(schema.number()),
- comparator: oneOfLiterals(Object.values(Comparator)),
+ comparator: oneOfLiterals(comparators),
timeUnit: schema.string(),
timeSize: schema.number(),
};
diff --git a/x-pack/plugins/observability_solution/observability/server/lib/rules/custom_threshold/translations.ts b/x-pack/plugins/observability_solution/observability/server/lib/rules/custom_threshold/translations.ts
index 020229c27a4ad6..ebae07d124ebbf 100644
--- a/x-pack/plugins/observability_solution/observability/server/lib/rules/custom_threshold/translations.ts
+++ b/x-pack/plugins/observability_solution/observability/server/lib/rules/custom_threshold/translations.ts
@@ -85,50 +85,6 @@ export const CUSTOM_EQUATION_I18N = i18n.translate(
}
);
-// Comparators
-
-export const BELOW_TEXT = i18n.translate(
- 'xpack.observability.customThreshold.rule.threshold.below',
- {
- defaultMessage: 'below',
- }
-);
-
-export const BELOW_OR_EQ_TEXT = i18n.translate(
- 'xpack.observability.customThreshold.rule.threshold.belowOrEqual',
- {
- defaultMessage: 'below or equal',
- }
-);
-
-export const ABOVE_TEXT = i18n.translate(
- 'xpack.observability.customThreshold.rule.threshold.above',
- {
- defaultMessage: 'above',
- }
-);
-
-export const ABOVE_OR_EQ_TEXT = i18n.translate(
- 'xpack.observability.customThreshold.rule.threshold.aboveOrEqual',
- {
- defaultMessage: 'above or equal',
- }
-);
-
-export const BETWEEN_TEXT = i18n.translate(
- 'xpack.observability.customThreshold.rule.threshold.between',
- {
- defaultMessage: 'between',
- }
-);
-
-export const NOT_BETWEEN_TEXT = i18n.translate(
- 'xpack.observability.customThreshold.rule.threshold.notBetween',
- {
- defaultMessage: 'not between',
- }
-);
-
// Action variable descriptions
export const groupByKeysActionVariableDescription = i18n.translate(
diff --git a/x-pack/plugins/observability_solution/observability/tsconfig.json b/x-pack/plugins/observability_solution/observability/tsconfig.json
index b4f617079dc58d..5a0ddfd8678c09 100644
--- a/x-pack/plugins/observability_solution/observability/tsconfig.json
+++ b/x-pack/plugins/observability_solution/observability/tsconfig.json
@@ -98,6 +98,7 @@
"@kbn/data-view-field-editor-plugin",
"@kbn/cases-components",
"@kbn/aiops-log-rate-analysis",
+ "@kbn/alerting-comparators",
"@kbn/react-kibana-context-render",
"@kbn/react-kibana-mount",
],
diff --git a/x-pack/plugins/observability_solution/observability_ai_assistant_app/scripts/evaluation/alert_templates/templates.ts b/x-pack/plugins/observability_solution/observability_ai_assistant_app/scripts/evaluation/alert_templates/templates.ts
index 42d63dced13fd7..e2571795a6e3b7 100644
--- a/x-pack/plugins/observability_solution/observability_ai_assistant_app/scripts/evaluation/alert_templates/templates.ts
+++ b/x-pack/plugins/observability_solution/observability_ai_assistant_app/scripts/evaluation/alert_templates/templates.ts
@@ -5,14 +5,7 @@
* 2.0.
*/
-export enum Comparator {
- GT = '>',
- LT = '<',
- GT_OR_EQ = '>=',
- LT_OR_EQ = '<=',
- BETWEEN = 'between',
- OUTSIDE_RANGE = 'outside',
-}
+import { COMPARATORS } from '@kbn/alerting-comparators';
export enum Aggregators {
COUNT = 'count',
@@ -49,7 +42,7 @@ export const customThresholdAIAssistantLogCount = {
params: {
criteria: [
{
- comparator: Comparator.GT,
+ comparator: COMPARATORS.GREATER_THAN,
threshold: [10],
timeSize: 2,
timeUnit: 'h',
@@ -82,7 +75,7 @@ export const customThresholdAIAssistantMetricAvg = {
params: {
criteria: [
{
- comparator: Comparator.GT,
+ comparator: COMPARATORS.GREATER_THAN,
threshold: [0.5],
timeSize: 2,
timeUnit: 'h',
diff --git a/x-pack/plugins/observability_solution/observability_ai_assistant_app/tsconfig.json b/x-pack/plugins/observability_solution/observability_ai_assistant_app/tsconfig.json
index 90c4f4d4151428..ce98c24be2a256 100644
--- a/x-pack/plugins/observability_solution/observability_ai_assistant_app/tsconfig.json
+++ b/x-pack/plugins/observability_solution/observability_ai_assistant_app/tsconfig.json
@@ -68,7 +68,8 @@
"@kbn/serverless",
"@kbn/task-manager-plugin",
"@kbn/cloud-plugin",
- "@kbn/observability-plugin"
+ "@kbn/observability-plugin",
+ "@kbn/alerting-comparators"
],
"exclude": ["target/**/*"]
}
diff --git a/x-pack/plugins/observability_solution/slo/docs/openapi/slo/bundled.json b/x-pack/plugins/observability_solution/slo/docs/openapi/slo/bundled.json
index 11bf01c8a7328d..90f3e26fa4ed86 100644
--- a/x-pack/plugins/observability_solution/slo/docs/openapi/slo/bundled.json
+++ b/x-pack/plugins/observability_solution/slo/docs/openapi/slo/bundled.json
@@ -190,6 +190,14 @@
"default": "asc"
},
"example": "asc"
+ },
+ {
+ "name": "hideStale",
+ "in": "query",
+ "description": "Hide stale SLOs from the list as defined by stale SLO threshold in SLO settings",
+ "schema": {
+ "type": "boolean"
+ }
}
],
"responses": {
@@ -1768,12 +1776,20 @@
"syncDelay": {
"description": "The synch delay to apply to the transform. Default 1m",
"type": "string",
+ "default": "1m",
"example": "5m"
},
"frequency": {
"description": "Configure how often the transform runs, default 1m",
"type": "string",
+ "default": "1m",
"example": "5m"
+ },
+ "preventInitialBackfill": {
+ "description": "Prevents the transform from backfilling data when it starts.",
+ "type": "boolean",
+ "default": false,
+ "example": true
}
}
},
diff --git a/x-pack/plugins/observability_solution/slo/docs/openapi/slo/bundled.yaml b/x-pack/plugins/observability_solution/slo/docs/openapi/slo/bundled.yaml
index d099474448eae6..6f826fb8f2e10b 100644
--- a/x-pack/plugins/observability_solution/slo/docs/openapi/slo/bundled.yaml
+++ b/x-pack/plugins/observability_solution/slo/docs/openapi/slo/bundled.yaml
@@ -121,6 +121,11 @@ paths:
- desc
default: asc
example: asc
+ - name: hideStale
+ in: query
+ description: Hide stale SLOs from the list as defined by stale SLO threshold in SLO settings
+ schema:
+ type: boolean
responses:
'200':
description: Successful request
@@ -1210,11 +1215,18 @@ components:
syncDelay:
description: The synch delay to apply to the transform. Default 1m
type: string
+ default: 1m
example: 5m
frequency:
description: Configure how often the transform runs, default 1m
type: string
+ default: 1m
example: 5m
+ preventInitialBackfill:
+ description: Prevents the transform from backfilling data when it starts.
+ type: boolean
+ default: false
+ example: true
summary_status:
title: summary status
type: string
diff --git a/x-pack/plugins/observability_solution/slo/docs/openapi/slo/components/schemas/settings.yaml b/x-pack/plugins/observability_solution/slo/docs/openapi/slo/components/schemas/settings.yaml
index 2f4ff275f0d0e8..a50ce0c28c136b 100644
--- a/x-pack/plugins/observability_solution/slo/docs/openapi/slo/components/schemas/settings.yaml
+++ b/x-pack/plugins/observability_solution/slo/docs/openapi/slo/components/schemas/settings.yaml
@@ -5,8 +5,15 @@ properties:
syncDelay:
description: The synch delay to apply to the transform. Default 1m
type: string
+ default: 1m
example: 5m
frequency:
description: Configure how often the transform runs, default 1m
type: string
+ default: 1m
example: 5m
+ preventInitialBackfill:
+ description: Prevents the transform from backfilling data when it starts.
+ type: boolean
+ default: false
+ example: true
diff --git a/x-pack/plugins/observability_solution/slo/public/data/slo/slo.ts b/x-pack/plugins/observability_solution/slo/public/data/slo/slo.ts
index 31ec29c44a31dd..02541ac8a17c72 100644
--- a/x-pack/plugins/observability_solution/slo/public/data/slo/slo.ts
+++ b/x-pack/plugins/observability_solution/slo/public/data/slo/slo.ts
@@ -51,6 +51,7 @@ const baseSlo: Omit = {
settings: {
syncDelay: '1m',
frequency: '1m',
+ preventInitialBackfill: false,
},
summary: {
status: 'HEALTHY',
diff --git a/x-pack/plugins/observability_solution/slo/public/embeddable/slo/alerts/components/slo_alerts_summary.tsx b/x-pack/plugins/observability_solution/slo/public/embeddable/slo/alerts/components/slo_alerts_summary.tsx
index da41a5938baa01..968d1f80a08248 100644
--- a/x-pack/plugins/observability_solution/slo/public/embeddable/slo/alerts/components/slo_alerts_summary.tsx
+++ b/x-pack/plugins/observability_solution/slo/public/embeddable/slo/alerts/components/slo_alerts_summary.tsx
@@ -12,7 +12,7 @@ import { calculateTimeRangeBucketSize } from '@kbn/observability-plugin/public';
import { observabilityAlertFeatureIds } from '@kbn/observability-plugin/common';
import { useSloAlertsQuery } from './slo_alerts_table';
-import { SloEmbeddableDeps } from '../slo_alerts_embeddable';
+import { SloEmbeddableDeps } from '../types';
import { SloItem } from '../types';
const DEFAULT_INTERVAL = '60s';
@@ -50,17 +50,13 @@ export function SloAlertsSummary({
),
[timeRange.from, timeRange.to, timeBuckets]
);
- const alertSummaryTimeRange = useMemo(
- () =>
- getAlertSummaryTimeRange(
- {
- from: timeRange.from,
- to: timeRange.to,
- },
- bucketSize?.intervalString ?? DEFAULT_INTERVAL,
- bucketSize?.dateFormat ?? DEFAULT_DATE_FORMAT
- ),
- [timeRange.from, timeRange.to, bucketSize]
+ const alertSummaryTimeRange = getAlertSummaryTimeRange(
+ {
+ from: timeRange.from,
+ to: timeRange.to,
+ },
+ bucketSize?.intervalString ?? DEFAULT_INTERVAL,
+ bucketSize?.dateFormat ?? DEFAULT_DATE_FORMAT
);
return (
diff --git a/x-pack/plugins/observability_solution/slo/public/embeddable/slo/alerts/components/slo_alerts_table.tsx b/x-pack/plugins/observability_solution/slo/public/embeddable/slo/alerts/components/slo_alerts_table.tsx
index 4642e315e9c541..c53f7c7c73d204 100644
--- a/x-pack/plugins/observability_solution/slo/public/embeddable/slo/alerts/components/slo_alerts_table.tsx
+++ b/x-pack/plugins/observability_solution/slo/public/embeddable/slo/alerts/components/slo_alerts_table.tsx
@@ -9,7 +9,7 @@ import { AlertConsumers } from '@kbn/rule-data-utils';
import type { TimeRange } from '@kbn/es-query';
import { ALL_VALUE } from '@kbn/slo-schema';
import { AlertsTableStateProps } from '@kbn/triggers-actions-ui-plugin/public/application/sections/alerts_table/alerts_table_state';
-import { SloEmbeddableDeps } from '../slo_alerts_embeddable';
+import { SloEmbeddableDeps } from '../types';
import type { SloItem } from '../types';
import { SLO_ALERTS_TABLE_CONFIG_ID } from '../../constants';
@@ -99,7 +99,6 @@ export function SloAlertsTable({
const {
triggersActionsUi: { alertsTableConfigurationRegistry, getAlertsStateTable: AlertsStateTable },
} = deps;
-
return (
DerivedIndexPattern;
+export const SLO_ALERTS_EMBEDDABLE_ID = 'SLO_ALERTS_EMBEDDABLE';
+export const ADD_SLO_ALERTS_ACTION_ID = 'CREATE_SLO_ALERTS_EMBEDDABLE';
diff --git a/x-pack/plugins/observability_solution/slo/public/embeddable/slo/alerts/slo_alerts_embeddable.tsx b/x-pack/plugins/observability_solution/slo/public/embeddable/slo/alerts/slo_alerts_embeddable.tsx
deleted file mode 100644
index 94581361d91b8b..00000000000000
--- a/x-pack/plugins/observability_solution/slo/public/embeddable/slo/alerts/slo_alerts_embeddable.tsx
+++ /dev/null
@@ -1,165 +0,0 @@
-/*
- * 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 React from 'react';
-import ReactDOM from 'react-dom';
-import { QueryClient, QueryClientProvider } from '@tanstack/react-query';
-
-import { i18n } from '@kbn/i18n';
-import { Storage } from '@kbn/kibana-utils-plugin/public';
-import { createBrowserHistory } from 'history';
-import {
- Embeddable as AbstractEmbeddable,
- EmbeddableOutput,
- IContainer,
-} from '@kbn/embeddable-plugin/public';
-import { KibanaContextProvider } from '@kbn/kibana-react-plugin/public';
-import { CasesPublicStart } from '@kbn/cases-plugin/public';
-
-import {
- type CoreStart,
- IUiSettingsClient,
- ApplicationStart,
- NotificationsStart,
-} from '@kbn/core/public';
-import { TriggersAndActionsUIPublicPluginStart } from '@kbn/triggers-actions-ui-plugin/public';
-import type { DataPublicPluginStart } from '@kbn/data-plugin/public';
-import { Router } from '@kbn/shared-ux-router';
-import { SettingsStart } from '@kbn/core-ui-settings-browser';
-import { SecurityPluginStart } from '@kbn/security-plugin/public';
-import type { ChartsPluginStart } from '@kbn/charts-plugin/public';
-import type { UiActionsStart } from '@kbn/ui-actions-plugin/public';
-import { ServerlessPluginStart } from '@kbn/serverless/public';
-
-import { Subject, Subscription } from 'rxjs';
-import { SloAlertsWrapper } from './slo_alerts_wrapper';
-import type { SloAlertsEmbeddableInput } from './types';
-export const SLO_ALERTS_EMBEDDABLE = 'SLO_ALERTS_EMBEDDABLE';
-
-const history = createBrowserHistory();
-
-export interface SloEmbeddableDeps {
- uiSettings: IUiSettingsClient;
- http: CoreStart['http'];
- i18n: CoreStart['i18n'];
- application: ApplicationStart;
- triggersActionsUi: TriggersAndActionsUIPublicPluginStart;
- data: DataPublicPluginStart;
- notifications: NotificationsStart;
- cases: CasesPublicStart;
- settings: SettingsStart;
- security: SecurityPluginStart;
- charts: ChartsPluginStart;
- uiActions: UiActionsStart;
- serverless?: ServerlessPluginStart;
-}
-
-export class SLOAlertsEmbeddable extends AbstractEmbeddable<
- SloAlertsEmbeddableInput,
- EmbeddableOutput
-> {
- public readonly type = SLO_ALERTS_EMBEDDABLE;
- private reloadSubject: Subject;
- private node?: HTMLElement;
- kibanaVersion: string;
- private subscription: Subscription;
-
- constructor(
- private readonly deps: SloEmbeddableDeps,
- initialInput: SloAlertsEmbeddableInput,
- kibanaVersion: string,
- parent?: IContainer
- ) {
- super(initialInput, {}, parent);
- this.deps = deps;
- this.kibanaVersion = kibanaVersion;
- this.reloadSubject = new Subject();
-
- this.subscription = this.getInput$().subscribe((input) => {
- this.reloadSubject.next(input);
- });
-
- this.setTitle(
- this.input.title ||
- i18n.translate('xpack.slo.sloAlertsEmbeddable.displayTitle', {
- defaultMessage: 'SLO Alerts',
- })
- );
- }
- public onRenderComplete() {
- this.renderComplete.dispatchComplete();
- }
-
- public getSloAlertsConfig() {
- return this.getInput();
- }
-
- public updateSloAlertsConfig(next: SloAlertsEmbeddableInput) {
- this.updateInput(next);
- }
-
- setTitle(title: string) {
- this.updateInput({ title });
- }
-
- public render(node: HTMLElement) {
- super.render(node);
- this.node = node;
- // required for the export feature to work
- this.node.setAttribute('data-shared-item', '');
-
- const queryClient = new QueryClient();
-
- const I18nContext = this.deps.i18n.Context;
- const {
- slos,
- timeRange = { from: 'now-15m/m', to: 'now' },
- showAllGroupByInstances,
- } = this.getInput();
-
- const deps = this.deps;
- const kibanaVersion = this.kibanaVersion;
- ReactDOM.render(
-
-
-
-
- this.onRenderComplete()}
- embeddable={this}
- deps={deps}
- slos={slos}
- timeRange={timeRange}
- reloadSubject={this.reloadSubject}
- showAllGroupByInstances={showAllGroupByInstances}
- />
-
-
-
- ,
- node
- );
- }
-
- public reload() {
- this.reloadSubject?.next(undefined);
- }
-
- public destroy() {
- super.destroy();
- this.subscription.unsubscribe();
- if (this.node) {
- ReactDOM.unmountComponentAtNode(this.node);
- }
- }
-}
diff --git a/x-pack/plugins/observability_solution/slo/public/embeddable/slo/alerts/slo_alerts_embeddable_factory.ts b/x-pack/plugins/observability_solution/slo/public/embeddable/slo/alerts/slo_alerts_embeddable_factory.ts
deleted file mode 100644
index 64d0a0755a0e76..00000000000000
--- a/x-pack/plugins/observability_solution/slo/public/embeddable/slo/alerts/slo_alerts_embeddable_factory.ts
+++ /dev/null
@@ -1,71 +0,0 @@
-/*
- * 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 { i18n } from '@kbn/i18n';
-import type { CoreSetup } from '@kbn/core/public';
-import {
- EmbeddableFactory,
- EmbeddableFactoryDefinition,
- ErrorEmbeddable,
- IContainer,
-} from '@kbn/embeddable-plugin/public';
-import { COMMON_SLO_GROUPING } from '../common/constants';
-import { SLO_ALERTS_EMBEDDABLE, SLOAlertsEmbeddable } from './slo_alerts_embeddable';
-import { SloPublicPluginsStart, SloPublicStart } from '../../..';
-import { SloAlertsEmbeddableInput } from './types';
-
-export type SloAlertsEmbeddableFactory = EmbeddableFactory;
-export class SloAlertsEmbeddableFactoryDefinition implements EmbeddableFactoryDefinition {
- public readonly type = SLO_ALERTS_EMBEDDABLE;
-
- public readonly grouping = COMMON_SLO_GROUPING;
-
- constructor(
- private getStartServices: CoreSetup['getStartServices'],
- private kibanaVersion: string
- ) {}
-
- public async isEditable() {
- return true;
- }
-
- public async getExplicitInput(): Promise> {
- const [coreStart, pluginStart] = await this.getStartServices();
- try {
- const { resolveEmbeddableSloUserInput } = await import('./handle_explicit_input');
- return await resolveEmbeddableSloUserInput(coreStart, pluginStart);
- } catch (e) {
- return Promise.reject();
- }
- }
-
- public async create(initialInput: SloAlertsEmbeddableInput, parent?: IContainer) {
- try {
- const [coreStart, pluginsStart] = await this.getStartServices();
- const deps = { ...coreStart, ...pluginsStart };
- return new SLOAlertsEmbeddable(deps, initialInput, this.kibanaVersion, parent);
- } catch (e) {
- return new ErrorEmbeddable(e, initialInput, parent);
- }
- }
-
- public getDescription() {
- return i18n.translate('xpack.slo.sloAlertsEmbeddable.description', {
- defaultMessage: 'Get an overview of your SLO alerts',
- });
- }
-
- public getDisplayName() {
- return i18n.translate('xpack.slo.sloAlertsEmbeddable.displayName', {
- defaultMessage: 'SLO Alerts',
- });
- }
-
- public getIconType() {
- return 'alert';
- }
-}
diff --git a/x-pack/plugins/observability_solution/slo/public/embeddable/slo/alerts/slo_alerts_embeddable_factory.tsx b/x-pack/plugins/observability_solution/slo/public/embeddable/slo/alerts/slo_alerts_embeddable_factory.tsx
new file mode 100644
index 00000000000000..7472c43253454b
--- /dev/null
+++ b/x-pack/plugins/observability_solution/slo/public/embeddable/slo/alerts/slo_alerts_embeddable_factory.tsx
@@ -0,0 +1,133 @@
+/*
+ * 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 { i18n } from '@kbn/i18n';
+import React, { useEffect } from 'react';
+import { Router } from '@kbn/shared-ux-router';
+import { BehaviorSubject, Subject } from 'rxjs';
+import { ReactEmbeddableFactory } from '@kbn/embeddable-plugin/public';
+import {
+ initializeTitles,
+ useBatchedPublishingSubjects,
+ fetch$,
+ FetchContext,
+ useFetchContext,
+} from '@kbn/presentation-publishing';
+import { KibanaContextProvider } from '@kbn/kibana-react-plugin/public';
+import { QueryClient, QueryClientProvider } from '@tanstack/react-query';
+import { createBrowserHistory } from 'history';
+import { Storage } from '@kbn/kibana-utils-plugin/public';
+import { SLO_ALERTS_EMBEDDABLE_ID } from './constants';
+import { SloEmbeddableDeps, SloAlertsEmbeddableState, SloAlertsApi } from './types';
+import { SloAlertsWrapper } from './slo_alerts_wrapper';
+const history = createBrowserHistory();
+const queryClient = new QueryClient();
+
+export const getAlertsPanelTitle = () =>
+ i18n.translate('xpack.slo.sloAlertsEmbeddable.displayTitle', {
+ defaultMessage: 'SLO Alerts',
+ });
+
+export function getAlertsEmbeddableFactory(deps: SloEmbeddableDeps, kibanaVersion: string) {
+ const factory: ReactEmbeddableFactory = {
+ type: SLO_ALERTS_EMBEDDABLE_ID,
+ deserializeState: (state) => {
+ return state.rawState as SloAlertsEmbeddableState;
+ },
+ buildEmbeddable: async (state, buildApi, uuid, parentApi) => {
+ const { titlesApi, titleComparators, serializeTitles } = initializeTitles(state);
+ const defaultTitle$ = new BehaviorSubject(getAlertsPanelTitle());
+ const slos$ = new BehaviorSubject(state.slos);
+ const showAllGroupByInstances$ = new BehaviorSubject(state.showAllGroupByInstances);
+ const reload$ = new Subject();
+ const api = buildApi(
+ {
+ ...titlesApi,
+ defaultPanelTitle: defaultTitle$,
+ serializeState: () => {
+ return {
+ rawState: {
+ ...serializeTitles(),
+ slos: slos$.getValue(),
+ showAllGroupByInstances: showAllGroupByInstances$.getValue(),
+ },
+ };
+ },
+ getSloAlertsConfig: () => {
+ return {
+ slos: slos$.getValue(),
+ showAllGroupByInstances: showAllGroupByInstances$.getValue(),
+ };
+ },
+ updateSloAlertsConfig: (update) => {
+ slos$.next(update.slos);
+ showAllGroupByInstances$.next(update.showAllGroupByInstances);
+ },
+ },
+ {
+ slos: [slos$, (value) => slos$.next(value)],
+ showAllGroupByInstances: [
+ showAllGroupByInstances$,
+ (value) => showAllGroupByInstances$.next(value),
+ ],
+ ...titleComparators,
+ }
+ );
+
+ const fetchSubscription = fetch$(api)
+ .pipe()
+ .subscribe((next) => {
+ reload$.next(next);
+ });
+
+ return {
+ api,
+ Component: () => {
+ const [slos, showAllGroupByInstances] = useBatchedPublishingSubjects(
+ slos$,
+ showAllGroupByInstances$
+ );
+ const fetchContext = useFetchContext(api);
+ const I18nContext = deps.i18n.Context;
+
+ useEffect(() => {
+ return () => {
+ fetchSubscription.unsubscribe();
+ };
+ }, []);
+ return (
+
+
+
+
+
+
+
+
+
+ );
+ },
+ };
+ },
+ };
+
+ return factory;
+}
diff --git a/x-pack/plugins/observability_solution/slo/public/embeddable/slo/alerts/handle_explicit_input.tsx b/x-pack/plugins/observability_solution/slo/public/embeddable/slo/alerts/slo_alerts_open_configuration.tsx
similarity index 82%
rename from x-pack/plugins/observability_solution/slo/public/embeddable/slo/alerts/handle_explicit_input.tsx
rename to x-pack/plugins/observability_solution/slo/public/embeddable/slo/alerts/slo_alerts_open_configuration.tsx
index 54af69acbe13d3..69529270b23b0d 100644
--- a/x-pack/plugins/observability_solution/slo/public/embeddable/slo/alerts/handle_explicit_input.tsx
+++ b/x-pack/plugins/observability_solution/slo/public/embeddable/slo/alerts/slo_alerts_open_configuration.tsx
@@ -4,21 +4,18 @@
* 2.0; you may not use this file except in compliance with the Elastic License
* 2.0.
*/
-
import React from 'react';
-import { toMountPoint } from '@kbn/react-kibana-mount';
-
import type { CoreStart } from '@kbn/core/public';
-import { KibanaContextProvider } from '@kbn/kibana-react-plugin/public';
import { QueryClient, QueryClientProvider } from '@tanstack/react-query';
-import type { EmbeddableSloProps, SloAlertsEmbeddableInput } from './types';
-
-import { SloPublicPluginsStart } from '../../../types';
+import { toMountPoint } from '@kbn/react-kibana-mount';
+import { KibanaContextProvider } from '@kbn/kibana-react-plugin/public';
+import { SloPublicPluginsStart } from '../../..';
import { SloConfiguration } from './slo_configuration';
-export async function resolveEmbeddableSloUserInput(
+import type { EmbeddableSloProps } from './types';
+export async function openSloConfiguration(
coreStart: CoreStart,
pluginStart: SloPublicPluginsStart,
- input?: SloAlertsEmbeddableInput
+ initialState?: EmbeddableSloProps
): Promise {
const { overlays } = coreStart;
const queryClient = new QueryClient();
@@ -34,15 +31,14 @@ export async function resolveEmbeddableSloUserInput(
>
{
modalSession.close();
resolve(update);
}}
onCancel={() => {
modalSession.close();
- // @ts-expect-error
- resolve(undefined);
+ reject();
}}
/>
diff --git a/x-pack/plugins/observability_solution/slo/public/embeddable/slo/alerts/slo_alerts_wrapper.tsx b/x-pack/plugins/observability_solution/slo/public/embeddable/slo/alerts/slo_alerts_wrapper.tsx
index 413f92418d2cb3..9a56bcf0ae0bd2 100644
--- a/x-pack/plugins/observability_solution/slo/public/embeddable/slo/alerts/slo_alerts_wrapper.tsx
+++ b/x-pack/plugins/observability_solution/slo/public/embeddable/slo/alerts/slo_alerts_wrapper.tsx
@@ -10,37 +10,35 @@ import { i18n } from '@kbn/i18n';
import { EuiFlexGroup, EuiFlexItem, EuiLink } from '@elastic/eui';
import type { TimeRange } from '@kbn/es-query';
import { CONTEXT_MENU_TRIGGER } from '@kbn/embeddable-plugin/public';
-import { IEmbeddable, EmbeddableOutput } from '@kbn/embeddable-plugin/public';
import { ActionExecutionContext } from '@kbn/ui-actions-plugin/public';
import { Subject } from 'rxjs';
import styled from 'styled-components';
import { observabilityPaths } from '@kbn/observability-plugin/common';
+import { FetchContext } from '@kbn/presentation-publishing';
import { SloIncludedCount } from './components/slo_included_count';
import { SloAlertsSummary } from './components/slo_alerts_summary';
import { SloAlertsTable } from './components/slo_alerts_table';
-import type { SloItem } from './types';
-import { SloEmbeddableDeps } from './slo_alerts_embeddable';
-import { SloAlertsEmbeddableInput } from './types';
+import type { SloItem, SloEmbeddableDeps } from './types';
import { EDIT_SLO_ALERTS_ACTION } from '../../../ui_actions/edit_slo_alerts_panel';
interface Props {
deps: SloEmbeddableDeps;
slos: SloItem[];
timeRange: TimeRange;
- embeddable: IEmbeddable;
+ embeddable: any;
onRenderComplete?: () => void;
- reloadSubject: Subject;
+ reloadSubject: Subject;
showAllGroupByInstances?: boolean;
}
export function SloAlertsWrapper({
embeddable,
- slos: initialSlos,
+ slos,
deps,
timeRange: initialTimeRange,
onRenderComplete,
reloadSubject,
- showAllGroupByInstances: initialShowAllGroupByInstances,
+ showAllGroupByInstances,
}: Props) {
const {
application: { navigateToUrl },
@@ -48,24 +46,15 @@ export function SloAlertsWrapper({
} = deps;
const [timeRange, setTimeRange] = useState(initialTimeRange);
- const [slos, setSlos] = useState(initialSlos);
- const [showAllGroupByInstances, setShowAllGroupByInstances] = useState(
- initialShowAllGroupByInstances
- );
-
const [lastRefreshTime, setLastRefreshTime] = useState(undefined);
useEffect(() => {
const subs = reloadSubject?.subscribe((input) => {
if (input) {
- const { timeRange: nTimeRange, slos: nSlos } = input;
-
- setSlos(nSlos);
-
+ const { timeRange: nTimeRange } = input;
if (nTimeRange && (nTimeRange.from !== timeRange.from || nTimeRange.to !== timeRange.to)) {
setTimeRange(nTimeRange);
}
- setShowAllGroupByInstances(input.showAllGroupByInstances);
}
setLastRefreshTime(Date.now());
});
@@ -100,10 +89,10 @@ export function SloAlertsWrapper({
},rangeTo:${timeRange.to})`
);
};
-
return (
;
+ initialInput?: EmbeddableSloProps;
onCreate: (props: EmbeddableSloProps) => void;
onCancel: () => void;
}
diff --git a/x-pack/plugins/observability_solution/slo/public/embeddable/slo/alerts/types.ts b/x-pack/plugins/observability_solution/slo/public/embeddable/slo/alerts/types.ts
index 1483dc4898610e..8b660442ca7b66 100644
--- a/x-pack/plugins/observability_solution/slo/public/embeddable/slo/alerts/types.ts
+++ b/x-pack/plugins/observability_solution/slo/public/embeddable/slo/alerts/types.ts
@@ -4,8 +4,27 @@
* 2.0; you may not use this file except in compliance with the Elastic License
* 2.0.
*/
-import { EmbeddableInput } from '@kbn/embeddable-plugin/public';
-import type { TimeRange } from '@kbn/es-query';
+import { DefaultEmbeddableApi, EmbeddableInput } from '@kbn/embeddable-plugin/public';
+import {
+ type CoreStart,
+ IUiSettingsClient,
+ ApplicationStart,
+ NotificationsStart,
+} from '@kbn/core/public';
+import { TriggersAndActionsUIPublicPluginStart } from '@kbn/triggers-actions-ui-plugin/public';
+import type { DataPublicPluginStart } from '@kbn/data-plugin/public';
+import { CasesPublicStart } from '@kbn/cases-plugin/public';
+import { SettingsStart } from '@kbn/core-ui-settings-browser';
+import { SecurityPluginStart } from '@kbn/security-plugin/public';
+import type { ChartsPluginStart } from '@kbn/charts-plugin/public';
+import type { UiActionsStart } from '@kbn/ui-actions-plugin/public';
+import { ServerlessPluginStart } from '@kbn/serverless/public';
+import {
+ SerializedTitles,
+ PublishesWritablePanelTitle,
+ PublishesPanelTitle,
+ EmbeddableApiContext,
+} from '@kbn/presentation-publishing';
export interface SloItem {
id: string;
@@ -16,16 +35,21 @@ export interface SloItem {
export interface EmbeddableSloProps {
slos: SloItem[];
- timeRange?: TimeRange;
- lastReloadRequestTime?: number | undefined;
showAllGroupByInstances?: boolean;
}
export type SloAlertsEmbeddableInput = EmbeddableInput & EmbeddableSloProps;
+export type SloAlertsEmbeddableState = SerializedTitles & EmbeddableSloProps;
+
+export type SloAlertsApi = DefaultEmbeddableApi &
+ PublishesWritablePanelTitle &
+ PublishesPanelTitle &
+ HasSloAlertsConfig;
+
export interface HasSloAlertsConfig {
- getSloAlertsConfig: () => SloAlertsEmbeddableInput;
- updateSloAlertsConfig: (next: SloAlertsEmbeddableInput) => void;
+ getSloAlertsConfig: () => EmbeddableSloProps;
+ updateSloAlertsConfig: (next: EmbeddableSloProps) => void;
}
export const apiHasSloAlertsConfig = (api: unknown | null): api is HasSloAlertsConfig => {
@@ -35,3 +59,23 @@ export const apiHasSloAlertsConfig = (api: unknown | null): api is HasSloAlertsC
typeof (api as HasSloAlertsConfig).updateSloAlertsConfig === 'function'
);
};
+
+export type SloAlertsEmbeddableActionContext = EmbeddableApiContext & {
+ embeddable: SloAlertsApi;
+};
+
+export interface SloEmbeddableDeps {
+ uiSettings: IUiSettingsClient;
+ http: CoreStart['http'];
+ i18n: CoreStart['i18n'];
+ application: ApplicationStart;
+ triggersActionsUi: TriggersAndActionsUIPublicPluginStart;
+ data: DataPublicPluginStart;
+ notifications: NotificationsStart;
+ cases: CasesPublicStart;
+ settings: SettingsStart;
+ security: SecurityPluginStart;
+ charts: ChartsPluginStart;
+ uiActions: UiActionsStart;
+ serverless?: ServerlessPluginStart;
+}
diff --git a/x-pack/plugins/observability_solution/slo/public/locators/slo_edit.test.ts b/x-pack/plugins/observability_solution/slo/public/locators/slo_edit.test.ts
index 5ed997bcec129d..ea85e584796360 100644
--- a/x-pack/plugins/observability_solution/slo/public/locators/slo_edit.test.ts
+++ b/x-pack/plugins/observability_solution/slo/public/locators/slo_edit.test.ts
@@ -20,7 +20,7 @@ describe('SloEditLocator', () => {
it('should return correct url when slo is provided', async () => {
const location = await locator.getLocation(buildSlo({ id: 'foo' }));
expect(location.path).toEqual(
- "/edit/foo?_a=(budgetingMethod:occurrences,createdAt:'2022-12-29T10:11:12.000Z',description:'some%20description%20useful',enabled:!t,groupBy:'*',groupings:(),id:foo,indicator:(params:(filter:'baz:%20foo%20and%20bar%20%3E%202',good:'http_status:%202xx',index:some-index,timestampField:custom_timestamp,total:'a%20query'),type:sli.kql.custom),instanceId:'*',meta:(),name:'super%20important%20level%20service',objective:(target:0.98),revision:1,settings:(frequency:'1m',syncDelay:'1m'),summary:(errorBudget:(consumed:0.064,initial:0.02,isEstimated:!f,remaining:0.936),sliValue:0.99872,status:HEALTHY),tags:!(k8s,production,critical),timeWindow:(duration:'30d',type:rolling),updatedAt:'2022-12-29T10:11:12.000Z',version:2)"
+ "/edit/foo?_a=(budgetingMethod:occurrences,createdAt:'2022-12-29T10:11:12.000Z',description:'some%20description%20useful',enabled:!t,groupBy:'*',groupings:(),id:foo,indicator:(params:(filter:'baz:%20foo%20and%20bar%20%3E%202',good:'http_status:%202xx',index:some-index,timestampField:custom_timestamp,total:'a%20query'),type:sli.kql.custom),instanceId:'*',meta:(),name:'super%20important%20level%20service',objective:(target:0.98),revision:1,settings:(frequency:'1m',preventInitialBackfill:!f,syncDelay:'1m'),summary:(errorBudget:(consumed:0.064,initial:0.02,isEstimated:!f,remaining:0.936),sliValue:0.99872,status:HEALTHY),tags:!(k8s,production,critical),timeWindow:(duration:'30d',type:rolling),updatedAt:'2022-12-29T10:11:12.000Z',version:2)"
);
});
});
diff --git a/x-pack/plugins/observability_solution/slo/public/pages/slo_edit/components/slo_edit_form_objective_section.tsx b/x-pack/plugins/observability_solution/slo/public/pages/slo_edit/components/slo_edit_form_objective_section.tsx
index ebb82504937486..15c51b1b86ce4f 100644
--- a/x-pack/plugins/observability_solution/slo/public/pages/slo_edit/components/slo_edit_form_objective_section.tsx
+++ b/x-pack/plugins/observability_solution/slo/public/pages/slo_edit/components/slo_edit_form_objective_section.tsx
@@ -7,6 +7,7 @@
import {
EuiCallOut,
+ EuiCheckbox,
EuiFieldNumber,
EuiFlexGrid,
EuiFlexItem,
@@ -18,10 +19,10 @@ import {
useGeneratedHtmlId,
} from '@elastic/eui';
import { i18n } from '@kbn/i18n';
+import { FormattedMessage } from '@kbn/i18n-react';
import { TimeWindowType } from '@kbn/slo-schema';
import React, { useEffect, useState } from 'react';
import { Controller, useFormContext } from 'react-hook-form';
-import { FormattedMessage } from '@kbn/i18n-react';
import {
BUDGETING_METHOD_OPTIONS,
CALENDARALIGNED_TIMEWINDOW_OPTIONS,
@@ -43,6 +44,7 @@ export function SloEditFormObjectiveSection() {
const budgetingSelect = useGeneratedHtmlId({ prefix: 'budgetingSelect' });
const timeWindowTypeSelect = useGeneratedHtmlId({ prefix: 'timeWindowTypeSelect' });
const timeWindowSelect = useGeneratedHtmlId({ prefix: 'timeWindowSelect' });
+ const preventBackfillCheckbox = useGeneratedHtmlId({ prefix: 'preventBackfill' });
const timeWindowType = watch('timeWindow.type');
const indicator = watch('indicator.type');
@@ -283,6 +285,43 @@ export function SloEditFormObjectiveSection() {
+
+
+
+
+
+
+ (
+
+ {i18n.translate('xpack.slo.sloEdit.settings.preventInitialBackfill.label', {
+ defaultMessage: 'Prevent initial backfill of data',
+ })}
+
+
+ }
+ checked={Boolean(field.value)}
+ onChange={(event: any) => onChange(event.target.checked)}
+ />
+ )}
+ />
+
+
+
);
}
diff --git a/x-pack/plugins/observability_solution/slo/public/pages/slo_edit/constants.ts b/x-pack/plugins/observability_solution/slo/public/pages/slo_edit/constants.ts
index 2c79f9736fce7f..123ebdc6609478 100644
--- a/x-pack/plugins/observability_solution/slo/public/pages/slo_edit/constants.ts
+++ b/x-pack/plugins/observability_solution/slo/public/pages/slo_edit/constants.ts
@@ -219,6 +219,9 @@ export const SLO_EDIT_FORM_DEFAULT_VALUES: CreateSLOForm = {
target: 99,
},
groupBy: ALL_VALUE,
+ settings: {
+ preventInitialBackfill: false,
+ },
};
export const SLO_EDIT_FORM_DEFAULT_VALUES_CUSTOM_METRIC: CreateSLOForm = {
@@ -235,6 +238,9 @@ export const SLO_EDIT_FORM_DEFAULT_VALUES_CUSTOM_METRIC: CreateSLOForm = {
target: 99,
},
groupBy: ALL_VALUE,
+ settings: {
+ preventInitialBackfill: false,
+ },
};
export const SLO_EDIT_FORM_DEFAULT_VALUES_SYNTHETICS_AVAILABILITY: CreateSLOForm = {
@@ -251,6 +257,9 @@ export const SLO_EDIT_FORM_DEFAULT_VALUES_SYNTHETICS_AVAILABILITY: CreateSLOForm
target: 99,
},
groupBy: SYNTHETICS_DEFAULT_GROUPINGS,
+ settings: {
+ preventInitialBackfill: false,
+ },
};
export const COMPARATOR_GT = i18n.translate('xpack.slo.sloEdit.sliType.timesliceMetric.gtLabel', {
diff --git a/x-pack/plugins/observability_solution/slo/public/pages/slo_edit/helpers/__snapshots__/process_slo_form_values.test.ts.snap b/x-pack/plugins/observability_solution/slo/public/pages/slo_edit/helpers/__snapshots__/process_slo_form_values.test.ts.snap
index 4ff4e452a3475c..3f7ac0ce83bebb 100644
--- a/x-pack/plugins/observability_solution/slo/public/pages/slo_edit/helpers/__snapshots__/process_slo_form_values.test.ts.snap
+++ b/x-pack/plugins/observability_solution/slo/public/pages/slo_edit/helpers/__snapshots__/process_slo_form_values.test.ts.snap
@@ -25,6 +25,9 @@ Object {
"objective": Object {
"target": 99,
},
+ "settings": Object {
+ "preventInitialBackfill": false,
+ },
"tags": Array [],
"timeWindow": Object {
"duration": "30d",
@@ -70,6 +73,9 @@ Object {
"objective": Object {
"target": 99,
},
+ "settings": Object {
+ "preventInitialBackfill": false,
+ },
"tags": Array [],
"timeWindow": Object {
"duration": "30d",
@@ -97,6 +103,9 @@ Object {
"objective": Object {
"target": 99,
},
+ "settings": Object {
+ "preventInitialBackfill": false,
+ },
"tags": Array [],
"timeWindow": Object {
"duration": "30d",
@@ -136,6 +145,9 @@ Object {
"objective": Object {
"target": 99,
},
+ "settings": Object {
+ "preventInitialBackfill": false,
+ },
"tags": Array [],
"timeWindow": Object {
"duration": "30d",
@@ -165,6 +177,9 @@ Object {
"timesliceTarget": 95,
"timesliceWindow": "2",
},
+ "settings": Object {
+ "preventInitialBackfill": false,
+ },
"tags": Array [],
"timeWindow": Object {
"duration": "30d",
@@ -192,6 +207,9 @@ Object {
"objective": Object {
"target": 99,
},
+ "settings": Object {
+ "preventInitialBackfill": false,
+ },
"tags": Array [],
"timeWindow": Object {
"duration": "1M",
@@ -220,6 +238,9 @@ Object {
"objective": Object {
"target": 99,
},
+ "settings": Object {
+ "preventInitialBackfill": false,
+ },
"tags": Array [],
"timeWindow": Object {
"duration": "30d",
@@ -249,6 +270,9 @@ Object {
"objective": Object {
"target": 99,
},
+ "settings": Object {
+ "preventInitialBackfill": false,
+ },
"tags": Array [],
"timeWindow": Object {
"duration": "30d",
@@ -276,6 +300,9 @@ Object {
"objective": Object {
"target": 99,
},
+ "settings": Object {
+ "preventInitialBackfill": false,
+ },
"tags": Array [],
"timeWindow": Object {
"duration": "30d",
@@ -303,6 +330,9 @@ Object {
"objective": Object {
"target": 99,
},
+ "settings": Object {
+ "preventInitialBackfill": false,
+ },
"tags": Array [],
"timeWindow": Object {
"duration": "30d",
diff --git a/x-pack/plugins/observability_solution/slo/public/pages/slo_edit/helpers/process_slo_form_values.ts b/x-pack/plugins/observability_solution/slo/public/pages/slo_edit/helpers/process_slo_form_values.ts
index fd8bb96e2d715b..8bbbcf9d2fee96 100644
--- a/x-pack/plugins/observability_solution/slo/public/pages/slo_edit/helpers/process_slo_form_values.ts
+++ b/x-pack/plugins/observability_solution/slo/public/pages/slo_edit/helpers/process_slo_form_values.ts
@@ -50,6 +50,9 @@ export function transformSloResponseToCreateSloForm(
},
groupBy: [values.groupBy].flat(),
tags: values.tags,
+ settings: {
+ preventInitialBackfill: values.settings?.preventInitialBackfill ?? false,
+ },
};
}
@@ -76,6 +79,9 @@ export function transformCreateSLOFormToCreateSLOInput(values: CreateSLOForm): C
},
tags: values.tags,
groupBy: [values.groupBy].flat(),
+ settings: {
+ preventInitialBackfill: values.settings?.preventInitialBackfill ?? false,
+ },
};
}
@@ -102,6 +108,9 @@ export function transformValuesToUpdateSLOInput(values: CreateSLOForm): UpdateSL
},
tags: values.tags,
groupBy: [values.groupBy].flat(),
+ settings: {
+ preventInitialBackfill: values.settings?.preventInitialBackfill ?? false,
+ },
};
}
@@ -211,5 +220,9 @@ export function transformPartialUrlStateToFormState(
state.timeWindow = { duration: values.timeWindow.duration, type: values.timeWindow.type };
}
+ if (!!values.settings?.preventInitialBackfill) {
+ state.settings = { preventInitialBackfill: values.settings.preventInitialBackfill };
+ }
+
return state;
}
diff --git a/x-pack/plugins/observability_solution/slo/public/pages/slo_edit/types.ts b/x-pack/plugins/observability_solution/slo/public/pages/slo_edit/types.ts
index d876e3a276208d..5eef9a2d0e5bad 100644
--- a/x-pack/plugins/observability_solution/slo/public/pages/slo_edit/types.ts
+++ b/x-pack/plugins/observability_solution/slo/public/pages/slo_edit/types.ts
@@ -23,4 +23,7 @@ export interface CreateSLOForm {
timesliceWindow?: string;
};
groupBy: string[] | string;
+ settings: {
+ preventInitialBackfill: boolean;
+ };
}
diff --git a/x-pack/plugins/observability_solution/slo/public/plugin.ts b/x-pack/plugins/observability_solution/slo/public/plugin.ts
index 99f586790cd99e..e387a7f85a7e3b 100644
--- a/x-pack/plugins/observability_solution/slo/public/plugin.ts
+++ b/x-pack/plugins/observability_solution/slo/public/plugin.ts
@@ -28,6 +28,8 @@ import { ExperimentalFeatures, SloConfig } from '../common/config';
import { SLO_OVERVIEW_EMBEDDABLE_ID } from './embeddable/slo/overview/constants';
import { SloOverviewEmbeddableState } from './embeddable/slo/overview/types';
import { SLO_ERROR_BUDGET_ID } from './embeddable/slo/error_budget/constants';
+import { SLO_ALERTS_EMBEDDABLE_ID } from './embeddable/slo/alerts/constants';
+
export class SloPlugin
implements Plugin
{
@@ -113,17 +115,19 @@ export class SloPlugin
return getOverviewEmbeddableFactory(deps);
}
);
- const registerSloAlertsEmbeddableFactory = async () => {
- const { SloAlertsEmbeddableFactoryDefinition } = await import(
- './embeddable/slo/alerts/slo_alerts_embeddable_factory'
- );
- const factory = new SloAlertsEmbeddableFactoryDefinition(
- coreSetup.getStartServices,
- kibanaVersion
- );
- pluginsSetup.embeddable.registerEmbeddableFactory(factory.type, factory);
- };
- registerSloAlertsEmbeddableFactory();
+
+ pluginsSetup.embeddable.registerReactEmbeddableFactory(
+ SLO_ALERTS_EMBEDDABLE_ID,
+ async () => {
+ const deps = { ...coreStart, ...pluginsStart };
+
+ const { getAlertsEmbeddableFactory } = await import(
+ './embeddable/slo/alerts/slo_alerts_embeddable_factory'
+ );
+
+ return getAlertsEmbeddableFactory(deps, kibanaVersion);
+ }
+ );
pluginsSetup.embeddable.registerReactEmbeddableFactory(SLO_ERROR_BUDGET_ID, async () => {
const deps = { ...coreStart, ...pluginsStart };
diff --git a/x-pack/plugins/observability_solution/slo/public/ui_actions/create_alerts_panel_action.tsx b/x-pack/plugins/observability_solution/slo/public/ui_actions/create_alerts_panel_action.tsx
new file mode 100644
index 00000000000000..b365881bf915a0
--- /dev/null
+++ b/x-pack/plugins/observability_solution/slo/public/ui_actions/create_alerts_panel_action.tsx
@@ -0,0 +1,56 @@
+/*
+ * 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 { i18n } from '@kbn/i18n';
+import type { CoreSetup } from '@kbn/core/public';
+import { apiIsPresentationContainer } from '@kbn/presentation-containers';
+import {
+ IncompatibleActionError,
+ type UiActionsActionDefinition,
+} from '@kbn/ui-actions-plugin/public';
+import { EmbeddableApiContext } from '@kbn/presentation-publishing';
+import {
+ ADD_SLO_ALERTS_ACTION_ID,
+ SLO_ALERTS_EMBEDDABLE_ID,
+} from '../embeddable/slo/alerts/constants';
+import { SloPublicPluginsStart, SloPublicStart } from '..';
+import { COMMON_SLO_GROUPING } from '../embeddable/slo/common/constants';
+
+export function createAddAlertsPanelAction(
+ getStartServices: CoreSetup['getStartServices']
+): UiActionsActionDefinition {
+ return {
+ id: ADD_SLO_ALERTS_ACTION_ID,
+ grouping: COMMON_SLO_GROUPING,
+ getIconType: () => 'alert',
+ isCompatible: async ({ embeddable }) => {
+ return apiIsPresentationContainer(embeddable);
+ },
+ execute: async ({ embeddable }) => {
+ if (!apiIsPresentationContainer(embeddable)) throw new IncompatibleActionError();
+ const [coreStart, deps] = await getStartServices();
+ try {
+ const { openSloConfiguration } = await import(
+ '../embeddable/slo/alerts/slo_alerts_open_configuration'
+ );
+ const initialState = await openSloConfiguration(coreStart, deps);
+ embeddable.addNewPanel(
+ {
+ panelType: SLO_ALERTS_EMBEDDABLE_ID,
+ initialState,
+ },
+ true
+ );
+ } catch (e) {
+ return Promise.reject();
+ }
+ },
+ getDisplayName: () =>
+ i18n.translate('xpack.slo.sloAlertsEmbeddable.displayName', {
+ defaultMessage: 'SLO Alerts',
+ }),
+ };
+}
diff --git a/x-pack/plugins/observability_solution/slo/public/ui_actions/edit_slo_alerts_panel.tsx b/x-pack/plugins/observability_solution/slo/public/ui_actions/edit_slo_alerts_panel.tsx
index 454833a26af942..ce9b4d196ffb5b 100644
--- a/x-pack/plugins/observability_solution/slo/public/ui_actions/edit_slo_alerts_panel.tsx
+++ b/x-pack/plugins/observability_solution/slo/public/ui_actions/edit_slo_alerts_panel.tsx
@@ -17,26 +17,27 @@ import {
CanAccessViewMode,
HasType,
} from '@kbn/presentation-publishing';
-import { createAction } from '@kbn/ui-actions-plugin/public';
-import type { SLOAlertsEmbeddable } from '../embeddable/slo/alerts/slo_alerts_embeddable';
-import { SLO_ALERTS_EMBEDDABLE } from '../embeddable/slo/constants';
+import { type UiActionsActionDefinition } from '@kbn/ui-actions-plugin/public';
+import { SLO_ALERTS_EMBEDDABLE_ID } from '../embeddable/slo/alerts/constants';
import { SloPublicPluginsStart, SloPublicStart } from '..';
-import { HasSloAlertsConfig } from '../embeddable/slo/alerts/types';
-
+import {
+ HasSloAlertsConfig,
+ SloAlertsEmbeddableActionContext,
+} from '../embeddable/slo/alerts/types';
export const EDIT_SLO_ALERTS_ACTION = 'editSloAlertsPanelAction';
type EditSloAlertsPanelApi = CanAccessViewMode & HasType & HasSloAlertsConfig;
const isEditSloAlertsPanelApi = (api: unknown): api is EditSloAlertsPanelApi =>
Boolean(
apiHasType(api) &&
- apiIsOfType(api, SLO_ALERTS_EMBEDDABLE) &&
+ apiIsOfType(api, SLO_ALERTS_EMBEDDABLE_ID) &&
apiCanAccessViewMode(api) &&
getInheritedViewMode(api) === ViewMode.EDIT
);
export function createEditSloAlertsPanelAction(
getStartServices: CoreSetup['getStartServices']
-) {
- return createAction({
+): UiActionsActionDefinition {
+ return {
id: EDIT_SLO_ALERTS_ACTION,
type: EDIT_SLO_ALERTS_ACTION,
getIconType(): string {
@@ -46,7 +47,7 @@ export function createEditSloAlertsPanelAction(
i18n.translate('xpack.slo.actions.editSloAlertsEmbeddableTitle', {
defaultMessage: 'Edit configuration',
}),
- async execute({ embeddable }: EmbeddableApiContext) {
+ async execute({ embeddable }) {
if (!embeddable) {
throw new Error('Not possible to execute an action without the embeddable context');
}
@@ -54,21 +55,21 @@ export function createEditSloAlertsPanelAction(
const [coreStart, pluginStart] = await getStartServices();
try {
- const { resolveEmbeddableSloUserInput } = await import(
- '../embeddable/slo/alerts/handle_explicit_input'
+ const { openSloConfiguration } = await import(
+ '../embeddable/slo/alerts/slo_alerts_open_configuration'
);
- const result = await resolveEmbeddableSloUserInput(
+ const result = await openSloConfiguration(
coreStart,
pluginStart,
- (embeddable as SLOAlertsEmbeddable).getSloAlertsConfig()
+ embeddable.getSloAlertsConfig()
);
- (embeddable as SLOAlertsEmbeddable).updateInput(result);
+ embeddable.updateSloAlertsConfig(result);
} catch (e) {
return Promise.reject();
}
},
isCompatible: async ({ embeddable }: EmbeddableApiContext) =>
isEditSloAlertsPanelApi(embeddable),
- });
+ };
}
diff --git a/x-pack/plugins/observability_solution/slo/public/ui_actions/index.ts b/x-pack/plugins/observability_solution/slo/public/ui_actions/index.ts
index e544a36fd84f7c..76862a3afe90d8 100644
--- a/x-pack/plugins/observability_solution/slo/public/ui_actions/index.ts
+++ b/x-pack/plugins/observability_solution/slo/public/ui_actions/index.ts
@@ -12,6 +12,7 @@ import { createEditSloAlertsPanelAction } from './edit_slo_alerts_panel';
import { createEditSloOverviewPanelAction } from './edit_slo_overview_panel';
import { createOverviewPanelAction } from './create_overview_panel_action';
import { createAddErrorBudgetPanelAction } from './create_error_budget_action';
+import { createAddAlertsPanelAction } from './create_alerts_panel_action';
import { SloPublicPluginsStart, SloPublicStart } from '..';
export function registerSloUiActions(
@@ -23,10 +24,12 @@ export function registerSloUiActions(
const editSloOverviewPanelAction = createEditSloOverviewPanelAction(core.getStartServices);
const addOverviewPanelAction = createOverviewPanelAction(core.getStartServices);
const addErrorBudgetPanelAction = createAddErrorBudgetPanelAction(core.getStartServices);
+ const addAlertsPanelAction = createAddAlertsPanelAction(core.getStartServices);
// Assign triggers
uiActions.addTriggerAction(CONTEXT_MENU_TRIGGER, editSloAlertsPanelAction);
uiActions.addTriggerAction(CONTEXT_MENU_TRIGGER, editSloOverviewPanelAction);
uiActions.addTriggerAction('ADD_PANEL_TRIGGER', addOverviewPanelAction);
uiActions.addTriggerAction('ADD_PANEL_TRIGGER', addErrorBudgetPanelAction);
+ uiActions.addTriggerAction('ADD_PANEL_TRIGGER', addAlertsPanelAction);
}
diff --git a/x-pack/plugins/observability_solution/slo/public/utils/slo/remote_slo_urls.test.ts b/x-pack/plugins/observability_solution/slo/public/utils/slo/remote_slo_urls.test.ts
index 28ca2bd977572a..2c8476b9c2e099 100644
--- a/x-pack/plugins/observability_solution/slo/public/utils/slo/remote_slo_urls.test.ts
+++ b/x-pack/plugins/observability_solution/slo/public/utils/slo/remote_slo_urls.test.ts
@@ -51,7 +51,7 @@ describe('remote SLO URLs Utils', () => {
`"https://cloud.elast.co/app/slos/edit/fixed-id"`
);
expect(createRemoteSloCloneUrl(remoteSlo)).toMatchInlineSnapshot(
- `"https://cloud.elast.co/app/slos/create?_a=(budgetingMethod:occurrences,createdAt:%272022-12-29T10:11:12.000Z%27,description:%27some%20description%20useful%27,enabled:!t,groupBy:%27*%27,groupings:(),indicator:(params:(filter:%27baz:%20foo%20and%20bar%20%3E%202%27,good:%27http_status:%202xx%27,index:some-index,timestampField:custom_timestamp,total:%27a%20query%27),type:sli.kql.custom),instanceId:%27*%27,meta:(),name:%27[Copy]%20super%20important%20level%20service%27,objective:(target:0.98),remote:(kibanaUrl:%27https:/cloud.elast.co/kibana%27,remoteName:remote_cluster),revision:1,settings:(frequency:%271m%27,syncDelay:%271m%27),summary:(errorBudget:(consumed:0.064,initial:0.02,isEstimated:!f,remaining:0.936),sliValue:0.99872,status:HEALTHY),tags:!(k8s,production,critical),timeWindow:(duration:%2730d%27,type:rolling),updatedAt:%272022-12-29T10:11:12.000Z%27,version:2)"`
+ `"https://cloud.elast.co/app/slos/create?_a=(budgetingMethod:occurrences,createdAt:%272022-12-29T10:11:12.000Z%27,description:%27some%20description%20useful%27,enabled:!t,groupBy:%27*%27,groupings:(),indicator:(params:(filter:%27baz:%20foo%20and%20bar%20%3E%202%27,good:%27http_status:%202xx%27,index:some-index,timestampField:custom_timestamp,total:%27a%20query%27),type:sli.kql.custom),instanceId:%27*%27,meta:(),name:%27[Copy]%20super%20important%20level%20service%27,objective:(target:0.98),remote:(kibanaUrl:%27https:/cloud.elast.co/kibana%27,remoteName:remote_cluster),revision:1,settings:(frequency:%271m%27,preventInitialBackfill:!f,syncDelay:%271m%27),summary:(errorBudget:(consumed:0.064,initial:0.02,isEstimated:!f,remaining:0.936),sliValue:0.99872,status:HEALTHY),tags:!(k8s,production,critical),timeWindow:(duration:%2730d%27,type:rolling),updatedAt:%272022-12-29T10:11:12.000Z%27,version:2)"`
);
});
@@ -71,7 +71,7 @@ describe('remote SLO URLs Utils', () => {
`"https://cloud.elast.co/s/my-custom-space/app/slos/edit/fixed-id"`
);
expect(createRemoteSloCloneUrl(remoteSlo, 'my-custom-space')).toMatchInlineSnapshot(
- `"https://cloud.elast.co/s/my-custom-space/app/slos/create?_a=(budgetingMethod:occurrences,createdAt:%272022-12-29T10:11:12.000Z%27,description:%27some%20description%20useful%27,enabled:!t,groupBy:%27*%27,groupings:(),indicator:(params:(filter:%27baz:%20foo%20and%20bar%20%3E%202%27,good:%27http_status:%202xx%27,index:some-index,timestampField:custom_timestamp,total:%27a%20query%27),type:sli.kql.custom),instanceId:%27*%27,meta:(),name:%27[Copy]%20super%20important%20level%20service%27,objective:(target:0.98),remote:(kibanaUrl:%27https:/cloud.elast.co/kibana%27,remoteName:remote_cluster),revision:1,settings:(frequency:%271m%27,syncDelay:%271m%27),summary:(errorBudget:(consumed:0.064,initial:0.02,isEstimated:!f,remaining:0.936),sliValue:0.99872,status:HEALTHY),tags:!(k8s,production,critical),timeWindow:(duration:%2730d%27,type:rolling),updatedAt:%272022-12-29T10:11:12.000Z%27,version:2)"`
+ `"https://cloud.elast.co/s/my-custom-space/app/slos/create?_a=(budgetingMethod:occurrences,createdAt:%272022-12-29T10:11:12.000Z%27,description:%27some%20description%20useful%27,enabled:!t,groupBy:%27*%27,groupings:(),indicator:(params:(filter:%27baz:%20foo%20and%20bar%20%3E%202%27,good:%27http_status:%202xx%27,index:some-index,timestampField:custom_timestamp,total:%27a%20query%27),type:sli.kql.custom),instanceId:%27*%27,meta:(),name:%27[Copy]%20super%20important%20level%20service%27,objective:(target:0.98),remote:(kibanaUrl:%27https:/cloud.elast.co/kibana%27,remoteName:remote_cluster),revision:1,settings:(frequency:%271m%27,preventInitialBackfill:!f,syncDelay:%271m%27),summary:(errorBudget:(consumed:0.064,initial:0.02,isEstimated:!f,remaining:0.936),sliValue:0.99872,status:HEALTHY),tags:!(k8s,production,critical),timeWindow:(duration:%2730d%27,type:rolling),updatedAt:%272022-12-29T10:11:12.000Z%27,version:2)"`
);
});
});
diff --git a/x-pack/plugins/observability_solution/slo/server/domain/services/validate_slo.test.ts b/x-pack/plugins/observability_solution/slo/server/domain/services/validate_slo.test.ts
index 7a4a6fc40005b2..5c06c89ee42aa8 100644
--- a/x-pack/plugins/observability_solution/slo/server/domain/services/validate_slo.test.ts
+++ b/x-pack/plugins/observability_solution/slo/server/domain/services/validate_slo.test.ts
@@ -103,6 +103,7 @@ describe('validateSLO', () => {
settings: {
frequency: sixHours(),
syncDelay: oneMinute(),
+ preventInitialBackfill: false,
},
});
expect(() => validateSLO(slo)).toThrowError('Invalid settings.frequency');
@@ -113,6 +114,7 @@ describe('validateSLO', () => {
settings: {
frequency: oneMinute(),
syncDelay: sixHours(),
+ preventInitialBackfill: false,
},
});
expect(() => validateSLO(slo)).toThrowError('Invalid settings.sync_delay');
diff --git a/x-pack/plugins/observability_solution/slo/server/services/__snapshots__/reset_slo.test.ts.snap b/x-pack/plugins/observability_solution/slo/server/services/__snapshots__/reset_slo.test.ts.snap
index 6c472f3a3450ae..9d231462c03afc 100644
--- a/x-pack/plugins/observability_solution/slo/server/services/__snapshots__/reset_slo.test.ts.snap
+++ b/x-pack/plugins/observability_solution/slo/server/services/__snapshots__/reset_slo.test.ts.snap
@@ -147,6 +147,7 @@ exports[`ResetSLO resets all associated resources 6`] = `
"unit": "m",
"value": 1,
},
+ "preventInitialBackfill": false,
"syncDelay": Duration {
"unit": "m",
"value": 1,
@@ -410,6 +411,7 @@ exports[`ResetSLO resets all associated resources 9`] = `
"unit": "m",
"value": 1,
},
+ "preventInitialBackfill": false,
"syncDelay": Duration {
"unit": "m",
"value": 1,
diff --git a/x-pack/plugins/observability_solution/slo/server/services/__snapshots__/slo_definition_client.test.ts.snap b/x-pack/plugins/observability_solution/slo/server/services/__snapshots__/slo_definition_client.test.ts.snap
index 95b3ca924632eb..671c5c13a39eaa 100644
--- a/x-pack/plugins/observability_solution/slo/server/services/__snapshots__/slo_definition_client.test.ts.snap
+++ b/x-pack/plugins/observability_solution/slo/server/services/__snapshots__/slo_definition_client.test.ts.snap
@@ -36,6 +36,7 @@ Object {
"unit": "m",
"value": 1,
},
+ "preventInitialBackfill": false,
"syncDelay": Duration {
"unit": "m",
"value": 1,
diff --git a/x-pack/plugins/observability_solution/slo/server/services/create_slo.test.ts b/x-pack/plugins/observability_solution/slo/server/services/create_slo.test.ts
index 8f6bee0fe34c58..cefff32016e2b9 100644
--- a/x-pack/plugins/observability_solution/slo/server/services/create_slo.test.ts
+++ b/x-pack/plugins/observability_solution/slo/server/services/create_slo.test.ts
@@ -68,6 +68,7 @@ describe('CreateSLO', () => {
settings: {
syncDelay: oneMinute(),
frequency: oneMinute(),
+ preventInitialBackfill: false,
},
revision: 1,
tags: [],
@@ -108,6 +109,40 @@ describe('CreateSLO', () => {
settings: {
syncDelay: fiveMinute(),
frequency: oneMinute(),
+ preventInitialBackfill: false,
+ },
+ revision: 1,
+ tags: ['one', 'two'],
+ enabled: true,
+ createdAt: expect.any(Date),
+ updatedAt: expect.any(Date),
+ }),
+ { throwOnConflict: true }
+ );
+ });
+
+ it('overrides the settings when provided', async () => {
+ const sloParams = createSLOParams({
+ indicator: createAPMTransactionErrorRateIndicator(),
+ tags: ['one', 'two'],
+ settings: {
+ syncDelay: fiveMinute(),
+ frequency: fiveMinute(),
+ preventInitialBackfill: true,
+ },
+ });
+ mockTransformManager.install.mockResolvedValue('slo-transform-id');
+
+ await createSLO.execute(sloParams);
+
+ expect(mockRepository.save).toHaveBeenCalledWith(
+ expect.objectContaining({
+ ...sloParams,
+ id: expect.any(String),
+ settings: {
+ syncDelay: fiveMinute(),
+ frequency: fiveMinute(),
+ preventInitialBackfill: true,
},
revision: 1,
tags: ['one', 'two'],
diff --git a/x-pack/plugins/observability_solution/slo/server/services/create_slo.ts b/x-pack/plugins/observability_solution/slo/server/services/create_slo.ts
index ce8258a222df3d..60a5da93d9bf7d 100644
--- a/x-pack/plugins/observability_solution/slo/server/services/create_slo.ts
+++ b/x-pack/plugins/observability_solution/slo/server/services/create_slo.ts
@@ -127,6 +127,7 @@ export class CreateSLO {
settings: {
syncDelay: params.settings?.syncDelay ?? new Duration(1, DurationUnit.Minute),
frequency: params.settings?.frequency ?? new Duration(1, DurationUnit.Minute),
+ preventInitialBackfill: params.settings?.preventInitialBackfill ?? false,
},
revision: params.revision ?? 1,
enabled: true,
diff --git a/x-pack/plugins/observability_solution/slo/server/services/find_slo.test.ts b/x-pack/plugins/observability_solution/slo/server/services/find_slo.test.ts
index 239b3aaaec5188..183d4beee19dd5 100644
--- a/x-pack/plugins/observability_solution/slo/server/services/find_slo.test.ts
+++ b/x-pack/plugins/observability_solution/slo/server/services/find_slo.test.ts
@@ -80,6 +80,7 @@ describe('FindSLO', () => {
settings: {
syncDelay: '1m',
frequency: '1m',
+ preventInitialBackfill: false,
},
summary: {
status: 'HEALTHY',
diff --git a/x-pack/plugins/observability_solution/slo/server/services/fixtures/slo.ts b/x-pack/plugins/observability_solution/slo/server/services/fixtures/slo.ts
index 74a548a2ad4c4f..c290523512b9cf 100644
--- a/x-pack/plugins/observability_solution/slo/server/services/fixtures/slo.ts
+++ b/x-pack/plugins/observability_solution/slo/server/services/fixtures/slo.ts
@@ -166,6 +166,7 @@ const defaultSLO: Omit {
settings: {
syncDelay: '1m',
frequency: '1m',
+ preventInitialBackfill: false,
},
summary: {
status: 'HEALTHY',
diff --git a/x-pack/plugins/observability_solution/slo/server/services/slo_repository.ts b/x-pack/plugins/observability_solution/slo/server/services/slo_repository.ts
index 1f8e1d415c484e..9f300a148ac2e3 100644
--- a/x-pack/plugins/observability_solution/slo/server/services/slo_repository.ts
+++ b/x-pack/plugins/observability_solution/slo/server/services/slo_repository.ts
@@ -138,6 +138,11 @@ export class KibanaSavedObjectsSLORepository implements SLORepository {
// if not present, we considered the version to be 1, e.g. not migrated.
// We would need to call the _reset api on this SLO.
version: storedSLO.version ?? 1,
+ // settings.preventInitialBackfill was added in 8.15.0
+ settings: {
+ ...storedSLO.settings,
+ preventInitialBackfill: storedSLO.settings?.preventInitialBackfill ?? false,
+ },
});
if (isLeft(result)) {
diff --git a/x-pack/plugins/observability_solution/slo/server/services/transform_generators/apm_transaction_duration.test.ts b/x-pack/plugins/observability_solution/slo/server/services/transform_generators/apm_transaction_duration.test.ts
index 4a0ade1c9aa68e..2ab6b264429673 100644
--- a/x-pack/plugins/observability_solution/slo/server/services/transform_generators/apm_transaction_duration.test.ts
+++ b/x-pack/plugins/observability_solution/slo/server/services/transform_generators/apm_transaction_duration.test.ts
@@ -150,4 +150,28 @@ describe('APM Transaction Duration Transform Generator', () => {
expect(transform.source.query).toMatchSnapshot();
expect(transform.pivot?.group_by).toMatchSnapshot();
});
+
+ it("overrides the range filter when 'preventInitialBackfill' is true", () => {
+ const slo = createSLO({
+ indicator: createAPMTransactionDurationIndicator(),
+ settings: {
+ frequency: twoMinute(),
+ syncDelay: twoMinute(),
+ preventInitialBackfill: true,
+ },
+ });
+
+ const transform = generator.getTransformParams(slo);
+
+ // @ts-ignore
+ const rangeFilter = transform.source.query.bool.filter.find((f) => 'range' in f);
+
+ expect(rangeFilter).toEqual({
+ range: {
+ '@timestamp': {
+ gte: 'now-300s/m', // 2m + 2m + 60s
+ },
+ },
+ });
+ });
});
diff --git a/x-pack/plugins/observability_solution/slo/server/services/transform_generators/apm_transaction_duration.ts b/x-pack/plugins/observability_solution/slo/server/services/transform_generators/apm_transaction_duration.ts
index 7dde0e0a664e3e..6bbec476754cb7 100644
--- a/x-pack/plugins/observability_solution/slo/server/services/transform_generators/apm_transaction_duration.ts
+++ b/x-pack/plugins/observability_solution/slo/server/services/transform_generators/apm_transaction_duration.ts
@@ -23,7 +23,7 @@ import { getSLOTransformTemplate } from '../../assets/transform_templates/slo_tr
import { APMTransactionDurationIndicator, SLODefinition } from '../../domain/models';
import { InvalidTransformError } from '../../errors';
import { parseIndex } from './common';
-import { getTimesliceTargetComparator } from './common';
+import { getTimesliceTargetComparator, getFilterRange } from './common';
export class ApmTransactionDurationTransformGenerator extends TransformGenerator {
public getTransformParams(slo: SLODefinition): TransformPutTransformRequest {
@@ -71,15 +71,7 @@ export class ApmTransactionDurationTransformGenerator extends TransformGenerator
}
private buildSource(slo: SLODefinition, indicator: APMTransactionDurationIndicator) {
- const queryFilter: estypes.QueryDslQueryContainer[] = [
- {
- range: {
- '@timestamp': {
- gte: `now-${slo.timeWindow.duration.format()}/d`,
- },
- },
- },
- ];
+ const queryFilter: estypes.QueryDslQueryContainer[] = [getFilterRange(slo, '@timestamp')];
if (indicator.params.service !== ALL_VALUE) {
queryFilter.push({
diff --git a/x-pack/plugins/observability_solution/slo/server/services/transform_generators/apm_transaction_error_rate.test.ts b/x-pack/plugins/observability_solution/slo/server/services/transform_generators/apm_transaction_error_rate.test.ts
index c9a85ae5df34e9..5706521cdf2f68 100644
--- a/x-pack/plugins/observability_solution/slo/server/services/transform_generators/apm_transaction_error_rate.test.ts
+++ b/x-pack/plugins/observability_solution/slo/server/services/transform_generators/apm_transaction_error_rate.test.ts
@@ -6,7 +6,7 @@
*/
import { ALL_VALUE } from '@kbn/slo-schema';
-import { twoMinute } from '../fixtures/duration';
+import { oneMinute, twoMinute } from '../fixtures/duration';
import {
createAPMTransactionErrorRateIndicator,
createSLO,
@@ -153,4 +153,28 @@ describe('APM Transaction Error Rate Transform Generator', () => {
expect(transform.source.query).toMatchSnapshot();
expect(transform.pivot?.group_by).toMatchSnapshot();
});
+
+ it("overrides the range filter when 'preventInitialBackfill' is true", () => {
+ const slo = createSLO({
+ indicator: createAPMTransactionErrorRateIndicator(),
+ settings: {
+ frequency: oneMinute(),
+ syncDelay: twoMinute(),
+ preventInitialBackfill: true,
+ },
+ });
+
+ const transform = generator.getTransformParams(slo);
+
+ // @ts-ignore
+ const rangeFilter = transform.source.query.bool.filter.find((f) => 'range' in f);
+
+ expect(rangeFilter).toEqual({
+ range: {
+ '@timestamp': {
+ gte: 'now-240s/m', // 1m + 2m + 60s
+ },
+ },
+ });
+ });
});
diff --git a/x-pack/plugins/observability_solution/slo/server/services/transform_generators/apm_transaction_error_rate.ts b/x-pack/plugins/observability_solution/slo/server/services/transform_generators/apm_transaction_error_rate.ts
index 99730152ea322c..59b753711a0d89 100644
--- a/x-pack/plugins/observability_solution/slo/server/services/transform_generators/apm_transaction_error_rate.ts
+++ b/x-pack/plugins/observability_solution/slo/server/services/transform_generators/apm_transaction_error_rate.ts
@@ -21,8 +21,7 @@ import {
import { getSLOTransformTemplate } from '../../assets/transform_templates/slo_transform_template';
import { APMTransactionErrorRateIndicator, SLODefinition } from '../../domain/models';
import { InvalidTransformError } from '../../errors';
-import { parseIndex } from './common';
-import { getTimesliceTargetComparator } from './common';
+import { parseIndex, getTimesliceTargetComparator, getFilterRange } from './common';
export class ApmTransactionErrorRateTransformGenerator extends TransformGenerator {
public getTransformParams(slo: SLODefinition): TransformPutTransformRequest {
@@ -70,15 +69,7 @@ export class ApmTransactionErrorRateTransformGenerator extends TransformGenerato
}
private buildSource(slo: SLODefinition, indicator: APMTransactionErrorRateIndicator) {
- const queryFilter: estypes.QueryDslQueryContainer[] = [
- {
- range: {
- '@timestamp': {
- gte: `now-${slo.timeWindow.duration.format()}/d`,
- },
- },
- },
- ];
+ const queryFilter: estypes.QueryDslQueryContainer[] = [getFilterRange(slo, '@timestamp')];
if (indicator.params.service !== ALL_VALUE) {
queryFilter.push({
diff --git a/x-pack/plugins/observability_solution/slo/server/services/transform_generators/common.test.ts b/x-pack/plugins/observability_solution/slo/server/services/transform_generators/common.test.ts
index baf02a9102f029..2e52a5442c12e6 100644
--- a/x-pack/plugins/observability_solution/slo/server/services/transform_generators/common.test.ts
+++ b/x-pack/plugins/observability_solution/slo/server/services/transform_generators/common.test.ts
@@ -5,7 +5,10 @@
* 2.0.
*/
-import { getTimesliceTargetComparator, parseIndex } from './common';
+import { fiveMinute, twoMinute } from '../fixtures/duration';
+import { createSLO } from '../fixtures/slo';
+import { thirtyDaysRolling } from '../fixtures/time_window';
+import { getTimesliceTargetComparator, parseIndex, getFilterRange } from './common';
describe('common', () => {
describe('parseIndex', () => {
@@ -30,4 +33,49 @@ describe('common', () => {
expect(getTimesliceTargetComparator(0.000000001)).toBe('>=');
});
});
+
+ describe('getFilterRange', () => {
+ it('starts at now (accounting for delay) when preventInitialBackfill is true', () => {
+ expect(
+ getFilterRange(
+ createSLO({
+ settings: {
+ frequency: twoMinute(),
+ syncDelay: fiveMinute(),
+ preventInitialBackfill: true,
+ },
+ }),
+ '@timestamp'
+ )
+ ).toEqual({
+ range: {
+ '@timestamp': {
+ gte: 'now-480s/m',
+ },
+ },
+ });
+ });
+
+ it('starts at now minus the time window when preventInitialBackfill is false', () => {
+ expect(
+ getFilterRange(
+ createSLO({
+ timeWindow: thirtyDaysRolling(),
+ settings: {
+ frequency: twoMinute(),
+ syncDelay: fiveMinute(),
+ preventInitialBackfill: false,
+ },
+ }),
+ '@timestamp'
+ )
+ ).toEqual({
+ range: {
+ '@timestamp': {
+ gte: 'now-30d/d',
+ },
+ },
+ });
+ });
+ });
});
diff --git a/x-pack/plugins/observability_solution/slo/server/services/transform_generators/common.ts b/x-pack/plugins/observability_solution/slo/server/services/transform_generators/common.ts
index 12822d6b41e68f..fd0a65d9c38874 100644
--- a/x-pack/plugins/observability_solution/slo/server/services/transform_generators/common.ts
+++ b/x-pack/plugins/observability_solution/slo/server/services/transform_generators/common.ts
@@ -6,7 +6,9 @@
*/
import { buildEsQuery, fromKueryExpression, toElasticsearchQuery } from '@kbn/es-query';
-import { QuerySchema, kqlQuerySchema } from '@kbn/slo-schema';
+import { kqlQuerySchema, QuerySchema } from '@kbn/slo-schema';
+import { SLODefinition } from '../../domain/models';
+import { getDelayInSecondsFromSLO } from '../../domain/services/get_delay_in_seconds_from_slo';
import { InvalidTransformError } from '../../errors';
export function getElasticsearchQueryOrThrow(kuery: QuerySchema = '') {
@@ -39,3 +41,26 @@ export function parseIndex(index: string): string | string[] {
export function getTimesliceTargetComparator(timesliceTarget: number) {
return timesliceTarget === 0 ? '>' : '>=';
}
+
+/**
+ * Use the settings.preventInitialBackfill flag to determine the range filter for the rollup transform
+ * preventInitialBackfill == true: we use the current time minus some buffer to account for the ingestion delay
+ * preventInitialBackfill === false: we use the time window duration to get the data for the last N days
+ */
+export function getFilterRange(slo: SLODefinition, timestampField: string) {
+ return slo.settings.preventInitialBackfill === true
+ ? {
+ range: {
+ [timestampField]: {
+ gte: `now-${getDelayInSecondsFromSLO(slo)}s/m`,
+ },
+ },
+ }
+ : {
+ range: {
+ [timestampField]: {
+ gte: `now-${slo.timeWindow.duration.format()}/d`,
+ },
+ },
+ };
+}
diff --git a/x-pack/plugins/observability_solution/slo/server/services/transform_generators/histogram.test.ts b/x-pack/plugins/observability_solution/slo/server/services/transform_generators/histogram.test.ts
index 172d7c50cd59e4..2307956564ba3c 100644
--- a/x-pack/plugins/observability_solution/slo/server/services/transform_generators/histogram.test.ts
+++ b/x-pack/plugins/observability_solution/slo/server/services/transform_generators/histogram.test.ts
@@ -165,4 +165,28 @@ describe('Histogram Transform Generator', () => {
expect(transform.pivot!.aggregations!['slo.denominator']).toMatchSnapshot();
});
+
+ it("overrides the range filter when 'preventInitialBackfill' is true", () => {
+ const slo = createSLO({
+ indicator: createHistogramIndicator(),
+ settings: {
+ frequency: twoMinute(),
+ syncDelay: twoMinute(),
+ preventInitialBackfill: true,
+ },
+ });
+
+ const transform = generator.getTransformParams(slo);
+
+ // @ts-ignore
+ const rangeFilter = transform.source.query.bool.filter.find((f) => 'range' in f);
+
+ expect(rangeFilter).toEqual({
+ range: {
+ log_timestamp: {
+ gte: 'now-300s/m', // 2m + 2m + 60s
+ },
+ },
+ });
+ });
});
diff --git a/x-pack/plugins/observability_solution/slo/server/services/transform_generators/histogram.ts b/x-pack/plugins/observability_solution/slo/server/services/transform_generators/histogram.ts
index 57fbaa630d367d..c8cfb52239f896 100644
--- a/x-pack/plugins/observability_solution/slo/server/services/transform_generators/histogram.ts
+++ b/x-pack/plugins/observability_solution/slo/server/services/transform_generators/histogram.ts
@@ -21,7 +21,7 @@ import { getSLOTransformTemplate } from '../../assets/transform_templates/slo_tr
import { SLODefinition } from '../../domain/models';
import { InvalidTransformError } from '../../errors';
import { GetHistogramIndicatorAggregation } from '../aggregations';
-import { getTimesliceTargetComparator } from './common';
+import { getTimesliceTargetComparator, getFilterRange } from './common';
export class HistogramTransformGenerator extends TransformGenerator {
public getTransformParams(slo: SLODefinition): TransformPutTransformRequest {
@@ -52,13 +52,7 @@ export class HistogramTransformGenerator extends TransformGenerator {
query: {
bool: {
filter: [
- {
- range: {
- [indicator.params.timestampField]: {
- gte: `now-${slo.timeWindow.duration.format()}/d`,
- },
- },
- },
+ getFilterRange(slo, indicator.params.timestampField),
getElasticsearchQueryOrThrow(indicator.params.filter),
],
},
diff --git a/x-pack/plugins/observability_solution/slo/server/services/transform_generators/kql_custom.test.ts b/x-pack/plugins/observability_solution/slo/server/services/transform_generators/kql_custom.test.ts
index 7489ebd06c5f4f..4b74695c8942e3 100644
--- a/x-pack/plugins/observability_solution/slo/server/services/transform_generators/kql_custom.test.ts
+++ b/x-pack/plugins/observability_solution/slo/server/services/transform_generators/kql_custom.test.ts
@@ -121,4 +121,28 @@ describe('KQL Custom Transform Generator', () => {
expect(transform.pivot!.aggregations!['slo.denominator']).toMatchSnapshot();
});
+
+ it("overrides the range filter when 'preventInitialBackfill' is true", () => {
+ const slo = createSLO({
+ indicator: createKQLCustomIndicator(),
+ settings: {
+ frequency: twoMinute(),
+ syncDelay: twoMinute(),
+ preventInitialBackfill: true,
+ },
+ });
+
+ const transform = generator.getTransformParams(slo);
+
+ // @ts-ignore
+ const rangeFilter = transform.source.query.bool.filter.find((f) => 'range' in f);
+
+ expect(rangeFilter).toEqual({
+ range: {
+ log_timestamp: {
+ gte: 'now-300s/m', // 2m + 2m + 60s
+ },
+ },
+ });
+ });
});
diff --git a/x-pack/plugins/observability_solution/slo/server/services/transform_generators/kql_custom.ts b/x-pack/plugins/observability_solution/slo/server/services/transform_generators/kql_custom.ts
index fb52772b762cd2..573a83a5400de9 100644
--- a/x-pack/plugins/observability_solution/slo/server/services/transform_generators/kql_custom.ts
+++ b/x-pack/plugins/observability_solution/slo/server/services/transform_generators/kql_custom.ts
@@ -16,7 +16,7 @@ import {
import { getSLOTransformTemplate } from '../../assets/transform_templates/slo_transform_template';
import { KQLCustomIndicator, SLODefinition } from '../../domain/models';
import { InvalidTransformError } from '../../errors';
-import { getTimesliceTargetComparator } from './common';
+import { getTimesliceTargetComparator, getFilterRange } from './common';
export class KQLCustomTransformGenerator extends TransformGenerator {
public getTransformParams(slo: SLODefinition): TransformPutTransformRequest {
@@ -47,13 +47,7 @@ export class KQLCustomTransformGenerator extends TransformGenerator {
query: {
bool: {
filter: [
- {
- range: {
- [indicator.params.timestampField]: {
- gte: `now-${slo.timeWindow.duration.format()}/d`,
- },
- },
- },
+ getFilterRange(slo, indicator.params.timestampField),
getElasticsearchQueryOrThrow(indicator.params.filter),
],
},
diff --git a/x-pack/plugins/observability_solution/slo/server/services/transform_generators/metric_custom.test.ts b/x-pack/plugins/observability_solution/slo/server/services/transform_generators/metric_custom.test.ts
index 9ebacde28f0ed1..1f6a1638baf1e3 100644
--- a/x-pack/plugins/observability_solution/slo/server/services/transform_generators/metric_custom.test.ts
+++ b/x-pack/plugins/observability_solution/slo/server/services/transform_generators/metric_custom.test.ts
@@ -5,6 +5,7 @@
* 2.0.
*/
+import { twoMinute } from '../fixtures/duration';
import {
createMetricCustomIndicator,
createSLO,
@@ -215,4 +216,28 @@ describe('Metric Custom Transform Generator', () => {
expect(transform.pivot!.aggregations!['slo.denominator']).toMatchSnapshot();
});
+
+ it("overrides the range filter when 'preventInitialBackfill' is true", () => {
+ const slo = createSLO({
+ indicator: createMetricCustomIndicator(),
+ settings: {
+ frequency: twoMinute(),
+ syncDelay: twoMinute(),
+ preventInitialBackfill: true,
+ },
+ });
+
+ const transform = generator.getTransformParams(slo);
+
+ // @ts-ignore
+ const rangeFilter = transform.source.query.bool.filter.find((f) => 'range' in f);
+
+ expect(rangeFilter).toEqual({
+ range: {
+ log_timestamp: {
+ gte: 'now-300s/m', // 2m + 2m + 60s
+ },
+ },
+ });
+ });
});
diff --git a/x-pack/plugins/observability_solution/slo/server/services/transform_generators/metric_custom.ts b/x-pack/plugins/observability_solution/slo/server/services/transform_generators/metric_custom.ts
index 9242e80b092701..d004b3e01d890a 100644
--- a/x-pack/plugins/observability_solution/slo/server/services/transform_generators/metric_custom.ts
+++ b/x-pack/plugins/observability_solution/slo/server/services/transform_generators/metric_custom.ts
@@ -17,7 +17,7 @@ import { getSLOTransformTemplate } from '../../assets/transform_templates/slo_tr
import { MetricCustomIndicator, SLODefinition } from '../../domain/models';
import { InvalidTransformError } from '../../errors';
import { GetCustomMetricIndicatorAggregation } from '../aggregations';
-import { getTimesliceTargetComparator } from './common';
+import { getTimesliceTargetComparator, getFilterRange } from './common';
export const INVALID_EQUATION_REGEX = /[^A-Z|+|\-|\s|\d+|\.|\(|\)|\/|\*|>|<|=|\?|\:|&|\!|\|]+/g;
@@ -50,13 +50,7 @@ export class MetricCustomTransformGenerator extends TransformGenerator {
query: {
bool: {
filter: [
- {
- range: {
- [indicator.params.timestampField]: {
- gte: `now-${slo.timeWindow.duration.format()}/d`,
- },
- },
- },
+ getFilterRange(slo, indicator.params.timestampField),
getElasticsearchQueryOrThrow(indicator.params.filter),
],
},
diff --git a/x-pack/plugins/observability_solution/slo/server/services/transform_generators/synthetics_availability.test.ts b/x-pack/plugins/observability_solution/slo/server/services/transform_generators/synthetics_availability.test.ts
index 78d6da1eb5bcaf..2a3a6f188eaa9a 100644
--- a/x-pack/plugins/observability_solution/slo/server/services/transform_generators/synthetics_availability.test.ts
+++ b/x-pack/plugins/observability_solution/slo/server/services/transform_generators/synthetics_availability.test.ts
@@ -10,6 +10,7 @@ import { SLODefinition } from '../../domain/models';
import { createSLO, createSyntheticsAvailabilityIndicator } from '../fixtures/slo';
import { SyntheticsAvailabilityTransformGenerator } from './synthetics_availability';
import { SYNTHETICS_INDEX_PATTERN } from '../../../common/constants';
+import { twoMinute } from '../fixtures/duration';
const generator = new SyntheticsAvailabilityTransformGenerator();
@@ -404,4 +405,28 @@ describe('Synthetics Availability Transform Generator', () => {
},
});
});
+
+ it("overrides the range filter when 'preventInitialBackfill' is true", () => {
+ const slo = createSLO({
+ indicator: createSyntheticsAvailabilityIndicator(),
+ settings: {
+ frequency: twoMinute(),
+ syncDelay: twoMinute(),
+ preventInitialBackfill: true,
+ },
+ });
+
+ const transform = generator.getTransformParams(slo, 'default');
+
+ // @ts-ignore
+ const rangeFilter = transform.source.query.bool.filter.find((f) => 'range' in f);
+
+ expect(rangeFilter).toEqual({
+ range: {
+ '@timestamp': {
+ gte: 'now-300s/m', // 2m + 2m + 60s
+ },
+ },
+ });
+ });
});
diff --git a/x-pack/plugins/observability_solution/slo/server/services/transform_generators/synthetics_availability.ts b/x-pack/plugins/observability_solution/slo/server/services/transform_generators/synthetics_availability.ts
index ca820f524d7ef3..a98f2a2b3e2320 100644
--- a/x-pack/plugins/observability_solution/slo/server/services/transform_generators/synthetics_availability.ts
+++ b/x-pack/plugins/observability_solution/slo/server/services/transform_generators/synthetics_availability.ts
@@ -24,6 +24,8 @@ import {
import { getSLOTransformTemplate } from '../../assets/transform_templates/slo_transform_template';
import { InvalidTransformError } from '../../errors';
import { SLODefinition } from '../../domain/models';
+import { getFilterRange } from './common';
+
export class SyntheticsAvailabilityTransformGenerator extends TransformGenerator {
public getTransformParams(slo: SLODefinition, spaceId: string): TransformPutTransformRequest {
if (!syntheticsAvailabilityIndicatorSchema.is(slo.indicator)) {
@@ -108,13 +110,7 @@ export class SyntheticsAvailabilityTransformGenerator extends TransformGenerator
const queryFilter: estypes.QueryDslQueryContainer[] = [
{ term: { 'summary.final_attempt': true } },
{ term: { 'meta.space_id': spaceId } },
- {
- range: {
- '@timestamp': {
- gte: `now-${slo.timeWindow.duration.format()}/d`,
- },
- },
- },
+ getFilterRange(slo, '@timestamp'),
];
const { monitorIds, tags, projects } = buildParamValues({
monitorIds: indicator.params.monitorIds || [],
diff --git a/x-pack/plugins/observability_solution/slo/server/services/transform_generators/timeslice_metric.test.ts b/x-pack/plugins/observability_solution/slo/server/services/transform_generators/timeslice_metric.test.ts
index 7d221c25c27ede..1fcd8c6abe892b 100644
--- a/x-pack/plugins/observability_solution/slo/server/services/transform_generators/timeslice_metric.test.ts
+++ b/x-pack/plugins/observability_solution/slo/server/services/transform_generators/timeslice_metric.test.ts
@@ -5,6 +5,7 @@
* 2.0.
*/
+import { twoMinute } from '../fixtures/duration';
import {
createTimesliceMetricIndicator,
createSLOWithTimeslicesBudgetingMethod,
@@ -164,4 +165,28 @@ describe('Timeslice Metric Transform Generator', () => {
},
});
});
+
+ it("overrides the range filter when 'preventInitialBackfill' is true", () => {
+ const slo = createSLOWithTimeslicesBudgetingMethod({
+ indicator: everythingIndicator,
+ settings: {
+ frequency: twoMinute(),
+ syncDelay: twoMinute(),
+ preventInitialBackfill: true,
+ },
+ });
+
+ const transform = generator.getTransformParams(slo);
+
+ // @ts-ignore
+ const rangeFilter = transform.source.query.bool.filter.find((f) => 'range' in f);
+
+ expect(rangeFilter).toEqual({
+ range: {
+ '@timestamp': {
+ gte: 'now-360s/m', // 2m + 2m + 2m slice window
+ },
+ },
+ });
+ });
});
diff --git a/x-pack/plugins/observability_solution/slo/server/services/transform_generators/timeslice_metric.ts b/x-pack/plugins/observability_solution/slo/server/services/transform_generators/timeslice_metric.ts
index 678dc2f4d76d81..719766b0c4efe2 100644
--- a/x-pack/plugins/observability_solution/slo/server/services/transform_generators/timeslice_metric.ts
+++ b/x-pack/plugins/observability_solution/slo/server/services/transform_generators/timeslice_metric.ts
@@ -12,7 +12,6 @@ import {
timesliceMetricIndicatorSchema,
timeslicesBudgetingMethodSchema,
} from '@kbn/slo-schema';
-
import { InvalidTransformError } from '../../errors';
import { getSLOTransformTemplate } from '../../assets/transform_templates/slo_transform_template';
import { getElasticsearchQueryOrThrow, parseIndex, TransformGenerator } from '.';
@@ -23,6 +22,7 @@ import {
} from '../../../common/constants';
import { SLODefinition } from '../../domain/models';
import { GetTimesliceMetricIndicatorAggregation } from '../aggregations';
+import { getFilterRange } from './common';
const INVALID_EQUATION_REGEX = /[^A-Z|+|\-|\s|\d+|\.|\(|\)|\/|\*|>|<|=|\?|\:|&|\!|\|]+/g;
@@ -55,13 +55,7 @@ export class TimesliceMetricTransformGenerator extends TransformGenerator {
query: {
bool: {
filter: [
- {
- range: {
- [indicator.params.timestampField]: {
- gte: `now-${slo.timeWindow.duration.format()}/d`,
- },
- },
- },
+ getFilterRange(slo, indicator.params.timestampField),
getElasticsearchQueryOrThrow(indicator.params.filter),
],
},
diff --git a/x-pack/plugins/observability_solution/slo/server/services/unsafe_federated/__snapshots__/remote_summary_doc_to_slo.test.ts.snap b/x-pack/plugins/observability_solution/slo/server/services/unsafe_federated/__snapshots__/remote_summary_doc_to_slo.test.ts.snap
index 153c007adcfa11..4825ed65e4fc92 100644
--- a/x-pack/plugins/observability_solution/slo/server/services/unsafe_federated/__snapshots__/remote_summary_doc_to_slo.test.ts.snap
+++ b/x-pack/plugins/observability_solution/slo/server/services/unsafe_federated/__snapshots__/remote_summary_doc_to_slo.test.ts.snap
@@ -32,6 +32,7 @@ Object {
"unit": "m",
"value": 1,
},
+ "preventInitialBackfill": false,
"syncDelay": Duration {
"unit": "m",
"value": 1,
@@ -81,6 +82,7 @@ Object {
"unit": "m",
"value": 1,
},
+ "preventInitialBackfill": false,
"syncDelay": Duration {
"unit": "m",
"value": 1,
diff --git a/x-pack/plugins/observability_solution/slo/server/services/unsafe_federated/remote_summary_doc_to_slo.ts b/x-pack/plugins/observability_solution/slo/server/services/unsafe_federated/remote_summary_doc_to_slo.ts
index d63194c8711391..0d98a021f505fc 100644
--- a/x-pack/plugins/observability_solution/slo/server/services/unsafe_federated/remote_summary_doc_to_slo.ts
+++ b/x-pack/plugins/observability_solution/slo/server/services/unsafe_federated/remote_summary_doc_to_slo.ts
@@ -29,7 +29,12 @@ export function fromRemoteSummaryDocumentToSloDefinition(
timesliceTarget: summaryDoc.slo.objective.timesliceTarget ?? undefined,
timesliceWindow: summaryDoc.slo.objective.timesliceWindow ?? undefined,
},
- settings: { syncDelay: '1m', frequency: '1m' },
+ settings: {
+ syncDelay: '1m',
+ frequency: '1m',
+ // added in 8.15.0
+ preventInitialBackfill: false,
+ },
revision: summaryDoc.slo.revision,
enabled: true,
tags: summaryDoc.slo.tags,
diff --git a/x-pack/plugins/observability_solution/slo/server/services/update_slo.test.ts b/x-pack/plugins/observability_solution/slo/server/services/update_slo.test.ts
index e520b952128fd6..974f72561aeff1 100644
--- a/x-pack/plugins/observability_solution/slo/server/services/update_slo.test.ts
+++ b/x-pack/plugins/observability_solution/slo/server/services/update_slo.test.ts
@@ -192,7 +192,11 @@ describe('UpdateSLO', () => {
const slo = createSLO();
mockRepository.findById.mockResolvedValueOnce(slo);
- const newSettings = { ...slo.settings, timestamp_field: 'newField' };
+ const newSettings = {
+ ...slo.settings,
+ frequency: fiveMinute(),
+ preventInitialBackfill: true,
+ };
await updateSLO.execute(slo.id, { settings: newSettings });
expectDeletionOfOriginalSLOResources(slo);
diff --git a/x-pack/plugins/observability_solution/slo/server/services/update_slo.ts b/x-pack/plugins/observability_solution/slo/server/services/update_slo.ts
index a55f4b2ce9fca1..5c8812cd4a8863 100644
--- a/x-pack/plugins/observability_solution/slo/server/services/update_slo.ts
+++ b/x-pack/plugins/observability_solution/slo/server/services/update_slo.ts
@@ -39,6 +39,7 @@ export class UpdateSLO {
const originalSlo = await this.repository.findById(sloId);
let updatedSlo: SLODefinition = Object.assign({}, originalSlo, params, {
groupBy: !!params.groupBy ? params.groupBy : originalSlo.groupBy,
+ settings: mergePartialSettings(originalSlo.settings, params.settings),
});
if (isEqual(originalSlo, updatedSlo)) {
@@ -183,3 +184,13 @@ export class UpdateSLO {
return updateSLOResponseSchema.encode(slo);
}
}
+
+/**
+ * Settings are merged by overwriting the original settings with the optional new partial settings.
+ */
+function mergePartialSettings(
+ originalSettings: SLODefinition['settings'],
+ newPartialSettings: UpdateSLOParams['settings']
+) {
+ return Object.assign({}, originalSettings, newPartialSettings);
+}
diff --git a/x-pack/plugins/observability_solution/uptime/server/legacy_uptime/lib/requests/get_snapshot_counts.ts b/x-pack/plugins/observability_solution/uptime/server/legacy_uptime/lib/requests/get_snapshot_counts.ts
index b128c77fa59153..d3128caf2f8a87 100644
--- a/x-pack/plugins/observability_solution/uptime/server/legacy_uptime/lib/requests/get_snapshot_counts.ts
+++ b/x-pack/plugins/observability_solution/uptime/server/legacy_uptime/lib/requests/get_snapshot_counts.ts
@@ -48,12 +48,8 @@ export const getSnapshotCount: UMElasticsearchQueryFn => {
- const { body: res } = await context.search(
- {
- body: statusCountBody(await context.dateAndCustomFilters(), context),
- },
- 'getSnapshotCount'
- );
+ const body = statusCountBody(await context.dateAndCustomFilters(), context);
+ const { body: res } = await context.search(body, 'getSnapshotCount');
return (
(res.aggregations?.counts?.value as Snapshot) ?? {
diff --git a/x-pack/plugins/observability_solution/uptime/server/legacy_uptime/lib/requests/search/find_potential_matches.ts b/x-pack/plugins/observability_solution/uptime/server/legacy_uptime/lib/requests/search/find_potential_matches.ts
index 2649205d3b4733..7d988ed50c4355 100644
--- a/x-pack/plugins/observability_solution/uptime/server/legacy_uptime/lib/requests/search/find_potential_matches.ts
+++ b/x-pack/plugins/observability_solution/uptime/server/legacy_uptime/lib/requests/search/find_potential_matches.ts
@@ -41,11 +41,7 @@ export const findPotentialMatches = async (
const query = async (queryContext: QueryContext, searchAfter: any, size: number) => {
const body = await queryBody(queryContext, searchAfter, size);
- const params = {
- body,
- };
-
- const response = await queryContext.search(params, 'getMonitorList-potentialMatches');
+ const response = await queryContext.search(body, 'getMonitorList-potentialMatches');
return response;
};
diff --git a/x-pack/plugins/observability_solution/uptime/server/legacy_uptime/lib/requests/search/query_context.ts b/x-pack/plugins/observability_solution/uptime/server/legacy_uptime/lib/requests/search/query_context.ts
index 1ab9d9ece169ff..9f76d8e37b099c 100644
--- a/x-pack/plugins/observability_solution/uptime/server/legacy_uptime/lib/requests/search/query_context.ts
+++ b/x-pack/plugins/observability_solution/uptime/server/legacy_uptime/lib/requests/search/query_context.ts
@@ -7,7 +7,7 @@
import moment from 'moment';
import type { ESFilter } from '@kbn/es-types';
-import type { SearchRequest } from '@kbn/data-plugin/common';
+import type { SearchRequest } from '@elastic/elasticsearch/lib/api/types';
import type { CursorPagination } from './types';
import { CursorDirection, SortOrder } from '../../../../../common/runtime_types';
import { UptimeEsClient } from '../../lib';
diff --git a/x-pack/plugins/observability_solution/uptime/server/legacy_uptime/lib/requests/search/refine_potential_matches.ts b/x-pack/plugins/observability_solution/uptime/server/legacy_uptime/lib/requests/search/refine_potential_matches.ts
index 7956966ec71c56..0b38979676e4ea 100644
--- a/x-pack/plugins/observability_solution/uptime/server/legacy_uptime/lib/requests/search/refine_potential_matches.ts
+++ b/x-pack/plugins/observability_solution/uptime/server/legacy_uptime/lib/requests/search/refine_potential_matches.ts
@@ -5,6 +5,7 @@
* 2.0.
*/
+import type { SearchRequest } from '@elastic/elasticsearch/lib/api/types';
import { QueryContext } from './query_context';
import { MonitorSummary, Ping } from '../../../../../common/runtime_types';
@@ -115,50 +116,48 @@ export const query = async (
queryContext: QueryContext,
potentialMatchMonitorIDs: string[]
): Promise => {
- const params = {
- body: {
- size: 0,
- query: {
- bool: {
- filter: [
- await queryContext.dateRangeFilter(),
- { terms: { 'monitor.id': potentialMatchMonitorIDs } },
- ],
- },
+ const params: SearchRequest = {
+ size: 0,
+ query: {
+ bool: {
+ filter: [
+ await queryContext.dateRangeFilter(),
+ { terms: { 'monitor.id': potentialMatchMonitorIDs } },
+ ],
},
- aggs: {
- monitor: {
- terms: {
- field: 'monitor.id',
- size: potentialMatchMonitorIDs.length,
- order: { _key: queryContext.cursorOrder() },
- },
- aggs: {
- location: {
- terms: { field: 'observer.geo.name', missing: 'N/A', size: 100 },
- aggs: {
- summaries: {
- // only match summary docs because we only want the latest *complete* check group.
- filter: { exists: { field: 'summary' } },
- aggs: {
- latest: {
- top_hits: {
- sort: [{ '@timestamp': 'desc' }],
- size: 1,
- },
+ },
+ aggs: {
+ monitor: {
+ terms: {
+ field: 'monitor.id',
+ size: potentialMatchMonitorIDs.length,
+ order: { _key: queryContext.cursorOrder() },
+ },
+ aggs: {
+ location: {
+ terms: { field: 'observer.geo.name', missing: 'N/A', size: 100 },
+ aggs: {
+ summaries: {
+ // only match summary docs because we only want the latest *complete* check group.
+ filter: { exists: { field: 'summary' } },
+ aggs: {
+ latest: {
+ top_hits: {
+ sort: [{ '@timestamp': 'desc' }],
+ size: 1,
},
},
},
- // We want to find the latest check group, even if it's not part of a summary
- latest_matching: {
- filter: queryContext.filterClause || { match_all: {} },
- aggs: {
- top: {
- top_hits: {
- _source: ['@timestamp'],
- sort: [{ '@timestamp': 'desc' }],
- size: 1,
- },
+ },
+ // We want to find the latest check group, even if it's not part of a summary
+ latest_matching: {
+ filter: queryContext.filterClause || { match_all: {} },
+ aggs: {
+ top: {
+ top_hits: {
+ _source: ['@timestamp'],
+ sort: [{ '@timestamp': 'desc' }],
+ size: 1,
},
},
},
diff --git a/x-pack/plugins/osquery/server/search_strategy/osquery/factory/actions/results/query.action_results.dsl.ts b/x-pack/plugins/osquery/server/search_strategy/osquery/factory/actions/results/query.action_results.dsl.ts
index 2ed9d406895a55..18a9c4fab8332f 100644
--- a/x-pack/plugins/osquery/server/search_strategy/osquery/factory/actions/results/query.action_results.dsl.ts
+++ b/x-pack/plugins/osquery/server/search_strategy/osquery/factory/actions/results/query.action_results.dsl.ts
@@ -47,11 +47,11 @@ export const buildActionResultsQuery = ({
let index: string;
if (useNewDataStream) {
- index = ACTION_RESPONSES_DATA_STREAM_INDEX;
+ index = `${ACTION_RESPONSES_DATA_STREAM_INDEX}*`;
} else if (componentTemplateExists) {
- index = ACTION_RESPONSES_INDEX;
+ index = `${ACTION_RESPONSES_INDEX}*`;
} else {
- index = AGENT_ACTIONS_RESULTS_INDEX;
+ index = `${AGENT_ACTIONS_RESULTS_INDEX}*`;
}
return {
diff --git a/x-pack/plugins/osquery/server/search_strategy/osquery/index.ts b/x-pack/plugins/osquery/server/search_strategy/osquery/index.ts
index 3cc3f8ad6b6c14..efc9dd6582ced8 100644
--- a/x-pack/plugins/osquery/server/search_strategy/osquery/index.ts
+++ b/x-pack/plugins/osquery/server/search_strategy/osquery/index.ts
@@ -40,6 +40,8 @@ export const osquerySearchStrategyProvider = (
}),
newDataStreamIndexExists: esClient.asInternalUser.indices.exists({
index: `${ACTION_RESPONSES_DATA_STREAM_INDEX}*`,
+ allow_no_indices: false,
+ expand_wildcards: 'all',
}),
}).pipe(
mergeMap(({ actionsIndexExists, newDataStreamIndexExists }) => {
diff --git a/x-pack/plugins/rule_registry/tsconfig.json b/x-pack/plugins/rule_registry/tsconfig.json
index 385c3fe82e0f8b..879d2eb9536cc6 100644
--- a/x-pack/plugins/rule_registry/tsconfig.json
+++ b/x-pack/plugins/rule_registry/tsconfig.json
@@ -31,11 +31,11 @@
"@kbn/logging",
"@kbn/securitysolution-io-ts-utils",
"@kbn/share-plugin",
- "@kbn/alerting-state-types",
"@kbn/alerts-as-data-utils",
"@kbn/core-http-router-server-mocks",
"@kbn/core-http-server",
"@kbn/search-types",
+ "@kbn/alerting-state-types"
],
"exclude": [
"target/**/*",
diff --git a/x-pack/plugins/search_playground/__mocks__/fetch_query_source_fields.mock.ts b/x-pack/plugins/search_playground/__mocks__/fetch_query_source_fields.mock.ts
index ecdb85dfaa4457..355494b4a217e2 100644
--- a/x-pack/plugins/search_playground/__mocks__/fetch_query_source_fields.mock.ts
+++ b/x-pack/plugins/search_playground/__mocks__/fetch_query_source_fields.mock.ts
@@ -5,72 +5,135 @@
* 2.0.
*/
+import { SearchResponse } from '@elastic/elasticsearch/lib/api/types';
+
export const ELSER_PASSAGE_CHUNKED_TWO_INDICES_DOCS = [
{
- _index: 'workplace_index',
- _id: '248629d8-64d7-4e91-a4eb-dbd8282d9f24',
- _score: 1,
- _ignored: ['metadata.summary.keyword', 'text.keyword'],
- _source: {
- metadata: {
- summary: 'This policy',
- rolePermissions: ['demo', 'manager'],
- name: 'Work From Home Policy',
- },
- vector: {
- tokens: {},
- model_id: '.elser_model_2',
- },
- text: 'Effective: March 2020',
- },
- },
+ took: 0,
+ timed_out: false,
+ _shards: {
+ total: 1,
+ successful: 1,
+ skipped: 0,
+ failed: 0,
+ },
+ hits: {
+ total: {
+ value: 1,
+ relation: 'eq',
+ },
+ max_score: null,
+ hits: [],
+ },
+ aggregations: {
+ 'vector.model_id': {
+ doc_count_error_upper_bound: 0,
+ sum_other_doc_count: 0,
+ buckets: [
+ {
+ key: '.elser_model_2',
+ doc_count: 1,
+ },
+ ],
+ },
+ },
+ } as SearchResponse,
{
- _index: 'workplace_index2',
- _id: 'b047762c-24eb-4846-aeb5-808346d54c54',
- _score: 1,
- _ignored: ['content.keyword', 'metadata.summary.keyword'],
- _source: {
- metadata: {
- summary:
- 'This policy outlines the guidelines for full-time remote work, including eligibility, equipment and resources, workspace requirements, communication expectations, performance expectations, time tracking and overtime, confidentiality and data security, health and well-being, and policy reviews and updates. Employees are encouraged to direct any questions or concerns',
- rolePermissions: ['demo', 'manager'],
- name: 'Work From Home Policy',
- },
- content: 'Effective',
- content_vector: {
- tokens: {},
- model_id: '.elser_model_2',
- },
- },
- },
+ took: 0,
+ timed_out: false,
+ _shards: {
+ total: 1,
+ successful: 1,
+ skipped: 0,
+ failed: 0,
+ },
+ hits: {
+ total: {
+ value: 1,
+ relation: 'eq',
+ },
+ max_score: null,
+ hits: [],
+ },
+ aggregations: {
+ 'content_vector.model_id': {
+ doc_count_error_upper_bound: 0,
+ sum_other_doc_count: 0,
+ buckets: [
+ {
+ key: '.elser_model_2',
+ doc_count: 1,
+ },
+ ],
+ },
+ },
+ } as SearchResponse,
];
export const DENSE_INPUT_OUTPUT_ONE_INDEX = [
{
- _index: 'index2',
- _id: 'KQ6Wco8BO787m9kIp1Ug',
- _score: 1,
- _source: {
- text_embedding: [0.03889123350381851],
- text: 'hello there',
- model_id: '.multilingual-e5-small',
- },
- },
+ took: 0,
+ timed_out: false,
+ _shards: {
+ total: 1,
+ successful: 1,
+ skipped: 0,
+ failed: 0,
+ },
+ hits: {
+ total: {
+ value: 1,
+ relation: 'eq',
+ },
+ max_score: null,
+ hits: [],
+ },
+ aggregations: {
+ model_id: {
+ doc_count_error_upper_bound: 0,
+ sum_other_doc_count: 0,
+ buckets: [
+ {
+ key: '.multilingual-e5-small',
+ doc_count: 1,
+ },
+ ],
+ },
+ },
+ } as SearchResponse,
];
export const SPARSE_INPUT_OUTPUT_ONE_INDEX = [
{
- _index: 'index',
- _id: 'Iw6Bco8BO787m9kIa1Wo',
- _score: 1,
- _source: {
- text_embedding: {
- interview: 0.42307013,
- },
- text: 'hello there',
- model_id: '.elser_model_2',
- },
- },
+ took: 0,
+ timed_out: false,
+ _shards: {
+ total: 1,
+ successful: 1,
+ skipped: 0,
+ failed: 0,
+ },
+ hits: {
+ total: {
+ value: 1,
+ relation: 'eq',
+ },
+ max_score: null,
+ hits: [],
+ },
+ aggregations: {
+ model_id: {
+ doc_count_error_upper_bound: 0,
+ sum_other_doc_count: 0,
+ buckets: [
+ {
+ key: '.elser_model_2',
+ doc_count: 1,
+ },
+ ],
+ },
+ },
+ } as SearchResponse,
];
export const SPARSE_INPUT_OUTPUT_ONE_INDEX_FIELD_CAPS = {
@@ -111,6 +174,36 @@ export const SPARSE_INPUT_OUTPUT_ONE_INDEX_FIELD_CAPS = {
},
};
+export const SPARSE_INPUT_OUTPUT_ONE_INDEX_FIELD_CAPS_MODEL_ID_KEYWORD = {
+ indices: ['index'],
+ fields: {
+ text_embedding: {
+ sparse_vector: {
+ type: 'sparse_vector',
+ metadata_field: false,
+ searchable: true,
+ aggregatable: false,
+ },
+ },
+ text: {
+ text: {
+ type: 'text',
+ metadata_field: false,
+ searchable: true,
+ aggregatable: false,
+ },
+ },
+ model_id: {
+ keyword: {
+ type: 'keyword',
+ metadata_field: false,
+ searchable: true,
+ aggregatable: true,
+ },
+ },
+ },
+};
+
export const DENSE_INPUT_OUTPUT_ONE_INDEX_FIELD_CAPS = {
indices: ['index2'],
fields: {
@@ -151,572 +244,23 @@ export const DENSE_INPUT_OUTPUT_ONE_INDEX_FIELD_CAPS = {
export const DENSE_VECTOR_DOCUMENT_FIRST = [
{
- _index: 'workplace_index_nested',
- _id: 'MXEeQo4BweykRPD22e0N',
- _score: 1,
- _ignored: ['content.keyword', 'metadata.summary.keyword', 'metadata.content.keyword'],
- _source: {
- metadata: {
- summary:
- 'This policy outlines the guidelines for full-time remote work, including eligibility, equipment and resources, workspace requirements, communication expectations, performance expectations, time tracking and overtime, confidentiality and data security, health and well-being, and policy reviews and updates. Employees are encouraged to direct any questions or concerns',
- _run_ml_inference: true,
- updated_at: '2020-03-01',
- created_on: '2020-03-01',
- rolePermissions: ['demo', 'manager'],
- name: 'Work From Home Policy',
- category: 'teams',
- content: `Effective: March 2020
-Purpose
-
-The purpose of this full-time work-from-home policy is to provide guidelines and support for employees to conduct their work remotely, ensuring the continuity and productivity of business operations during the COVID-19 pandemic and beyond.
-Scope
-
-This policy applies to all employees who are eligible for remote work as determined by their role and responsibilities. It is designed to allow employees to work from home full time while maintaining the same level of performance and collaboration as they would in the office.
-Eligibility
-
-Employees who can perform their work duties remotely and have received approval from their direct supervisor and the HR department are eligible for this work-from-home arrangement.
-Equipment and Resources
-
-The necessary equipment and resources will be provided to employees for remote work, including a company-issued laptop, software licenses, and access to secure communication tools. Employees are responsible for maintaining and protecting the company's equipment and data.
-Workspace
-
-Employees working from home are responsible for creating a comfortable and safe workspace that is conducive to productivity. This includes ensuring that their home office is ergonomically designed, well-lit, and free from distractions.
-Communication
-
-Effective communication is vital for successful remote work. Employees are expected to maintain regular communication with their supervisors, colleagues, and team members through email, phone calls, video conferences, and other approved communication tools.
-Work Hours and Availability
-
-Employees are expected to maintain their regular work hours and be available during normal business hours, unless otherwise agreed upon with their supervisor. Any changes to work hours or availability must be communicated to the employee's supervisor and the HR department.
-Performance Expectations
-
-Employees working from home are expected to maintain the same level of performance and productivity as if they were working in the office. Supervisors and team members will collaborate to establish clear expectations and goals for remote work.
-Time Tracking and Overtime
-
-Employees are required to accurately track their work hours using the company's time tracking system. Non-exempt employees must obtain approval from their supervisor before working overtime.
-Confidentiality and Data Security
-
-Employees must adhere to the company's confidentiality and data security policies while working from home. This includes safeguarding sensitive information, securing personal devices and internet connections, and reporting any security breaches to the IT department.
-Health and Well-being
-
-The company encourages employees to prioritize their health and well-being while working from home. This includes taking regular breaks, maintaining a work-life balance, and seeking support from supervisors and colleagues when needed.
-Policy Review and Updates
-
-This work-from-home policy will be reviewed periodically and updated as necessary, taking into account changes in public health guidance, business needs, and employee feedback.
-Questions and Concerns
-
-Employees are encouraged to direct any questions or concerns about this policy to their supervisor or the HR department.
-`,
- url: './sharepoint/Work from home policy.txt',
- },
- passages: [
- {
- vector: {
- model_id: '.multilingual-e5-small',
- },
- text: 'Effective: March 2020 Purpose',
- },
- {
- vector: {
- model_id: '.multilingual-e5-small',
- },
- text: 'The purpose of this full-time work-from-home policy is to provide guidelines and support for employees to conduct their work remotely, ensuring the continuity and productivity of business operations',
- },
- {
- vector: {
- model_id: '.multilingual-e5-small',
- },
- text: 'of this full-time work-from-home policy is to provide guidelines and support for employees to conduct their work remotely, ensuring the continuity and productivity of business operations during the',
- },
- {
- vector: {
- model_id: '.multilingual-e5-small',
- },
- text: 'full-time work-from-home policy is to provide guidelines and support for employees to conduct their work remotely, ensuring the continuity and productivity of business operations during the COVID-19',
- },
- {
- vector: {
- model_id: '.multilingual-e5-small',
- },
- text: 'work-from-home policy is to provide guidelines and support for employees to conduct their work remotely, ensuring the continuity and productivity of business operations during the COVID-19 pandemic',
- },
- {
- vector: {
- model_id: '.multilingual-e5-small',
- },
- text: 'policy is to provide guidelines and support for employees to conduct their work remotely, ensuring the continuity and productivity of business operations during the COVID-19 pandemic and beyond.',
- },
- {
- vector: {
- model_id: '.multilingual-e5-small',
- },
- text: 'Scope',
- },
- {
- vector: {
- model_id: '.multilingual-e5-small',
- },
- text: 'This policy applies to all employees who are eligible for remote work as determined by their role and responsibilities. It is designed to allow employees to work from home full time while maintaining',
- },
- {
- vector: {
- model_id: '.multilingual-e5-small',
- },
- text: 'policy applies to all employees who are eligible for remote work as determined by their role and responsibilities. It is designed to allow employees to work from home full time while maintaining the',
- },
- {
- vector: {
- model_id: '.multilingual-e5-small',
- },
- text: 'applies to all employees who are eligible for remote work as determined by their role and responsibilities. It is designed to allow employees to work from home full time while maintaining the same',
- },
- {
- vector: {
- model_id: '.multilingual-e5-small',
- },
- text: 'to all employees who are eligible for remote work as determined by their role and responsibilities. It is designed to allow employees to work from home full time while maintaining the same level of',
- },
- {
- vector: {
- model_id: '.multilingual-e5-small',
- },
- text: 'who are eligible for remote work as determined by their role and responsibilities. It is designed to allow employees to work from home full time while maintaining the same level of performance and',
- },
- {
- vector: {
- model_id: '.multilingual-e5-small',
- },
- text: 'for remote work as determined by their role and responsibilities. It is designed to allow employees to work from home full time while maintaining the same level of performance and collaboration as',
- },
- {
- vector: {
- model_id: '.multilingual-e5-small',
- },
- text: 'remote work as determined by their role and responsibilities. It is designed to allow employees to work from home full time while maintaining the same level of performance and collaboration as they',
- },
- {
- vector: {
- model_id: '.multilingual-e5-small',
- },
- text: 'work as determined by their role and responsibilities. It is designed to allow employees to work from home full time while maintaining the same level of performance and collaboration as they would in',
- },
- {
- vector: {
- model_id: '.multilingual-e5-small',
- },
- text: 'as determined by their role and responsibilities. It is designed to allow employees to work from home full time while maintaining the same level of performance and collaboration as they would in the',
- },
- {
- vector: {
- model_id: '.multilingual-e5-small',
- },
- text: 'by their role and responsibilities. It is designed to allow employees to work from home full time while maintaining the same level of performance and collaboration as they would in the office.',
- },
- {
- vector: {
- model_id: '.multilingual-e5-small',
- },
- text: 'Eligibility',
- },
- {
- vector: {
- model_id: '.multilingual-e5-small',
- },
- text: 'Employees who can perform their work duties remotely and have received approval from their direct supervisor and the HR department are eligible for this work-from-home arrangement.',
- },
- {
- vector: {
- model_id: '.multilingual-e5-small',
- },
- text: 'Equipment and Resources',
- },
- {
- vector: {
- model_id: '.multilingual-e5-small',
- },
- text: 'The necessary equipment and resources will be provided to employees for remote work, including a company-issued laptop, software licenses, and access to secure communication tools. Employees are',
- },
- {
- vector: {
- model_id: '.multilingual-e5-small',
- },
- text: 'equipment and resources will be provided to employees for remote work, including a company-issued laptop, software licenses, and access to secure communication tools. Employees are responsible for',
- },
- {
- vector: {
- model_id: '.multilingual-e5-small',
- },
- text: 'and resources will be provided to employees for remote work, including a company-issued laptop, software licenses, and access to secure communication tools. Employees are responsible for maintaining',
- },
- {
- vector: {
- model_id: '.multilingual-e5-small',
- },
- text: 'resources will be provided to employees for remote work, including a company-issued laptop, software licenses, and access to secure communication tools. Employees are responsible for maintaining and',
- },
- {
- vector: {
- model_id: '.multilingual-e5-small',
- },
- text: 'will be provided to employees for remote work, including a company-issued laptop, software licenses, and access to secure communication tools. Employees are responsible for maintaining and protecting',
- },
- {
- vector: {
- model_id: '.multilingual-e5-small',
- },
- text: 'be provided to employees for remote work, including a company-issued laptop, software licenses, and access to secure communication tools. Employees are responsible for maintaining and protecting the',
- },
- {
- vector: {
- model_id: '.multilingual-e5-small',
- },
- text: "to employees for remote work, including a company-issued laptop, software licenses, and access to secure communication tools. Employees are responsible for maintaining and protecting the company's",
- },
- {
- vector: {
- model_id: '.multilingual-e5-small',
- },
- text: "for remote work, including a company-issued laptop, software licenses, and access to secure communication tools. Employees are responsible for maintaining and protecting the company's equipment and",
- },
- {
- vector: {
- model_id: '.multilingual-e5-small',
- },
- text: "remote work, including a company-issued laptop, software licenses, and access to secure communication tools. Employees are responsible for maintaining and protecting the company's equipment and data.",
- },
- {
- vector: {
- model_id: '.multilingual-e5-small',
- },
- text: 'Workspace',
- },
- {
- vector: {
- model_id: '.multilingual-e5-small',
- },
- text: 'Employees working from home are responsible for creating a comfortable and safe workspace that is conducive to productivity. This includes ensuring that their home office is ergonomically designed,',
- },
- {
- vector: {
- model_id: '.multilingual-e5-small',
- },
- text: 'working from home are responsible for creating a comfortable and safe workspace that is conducive to productivity. This includes ensuring that their home office is ergonomically designed, well-lit,',
- },
- {
- vector: {
- model_id: '.multilingual-e5-small',
- },
- text: 'from home are responsible for creating a comfortable and safe workspace that is conducive to productivity. This includes ensuring that their home office is ergonomically designed, well-lit, and free',
- },
- {
- vector: {
- model_id: '.multilingual-e5-small',
- },
- text: 'home are responsible for creating a comfortable and safe workspace that is conducive to productivity. This includes ensuring that their home office is ergonomically designed, well-lit, and free from',
- },
- {
- vector: {
- model_id: '.multilingual-e5-small',
- },
- text: 'for creating a comfortable and safe workspace that is conducive to productivity. This includes ensuring that their home office is ergonomically designed, well-lit, and free from distractions.',
- },
- {
- vector: {
- model_id: '.multilingual-e5-small',
- },
- text: 'Communication',
- },
- {
- vector: {
- model_id: '.multilingual-e5-small',
- },
- text: 'Effective communication is vital for successful remote work. Employees are expected to maintain regular communication with their supervisors, colleagues, and team members through email, phone calls,',
- },
- {
- vector: {
- model_id: '.multilingual-e5-small',
- },
- text: 'communication is vital for successful remote work. Employees are expected to maintain regular communication with their supervisors, colleagues, and team members through email, phone calls, video',
- },
- {
- vector: {
- model_id: '.multilingual-e5-small',
- },
- text: 'is vital for successful remote work. Employees are expected to maintain regular communication with their supervisors, colleagues, and team members through email, phone calls, video conferences, and',
- },
- {
- vector: {
- model_id: '.multilingual-e5-small',
- },
- text: 'for successful remote work. Employees are expected to maintain regular communication with their supervisors, colleagues, and team members through email, phone calls, video conferences, and other',
- },
- {
- vector: {
- model_id: '.multilingual-e5-small',
- },
- text: 'successful remote work. Employees are expected to maintain regular communication with their supervisors, colleagues, and team members through email, phone calls, video conferences, and other approved',
- },
- {
- vector: {
- model_id: '.multilingual-e5-small',
- },
- text: 'work. Employees are expected to maintain regular communication with their supervisors, colleagues, and team members through email, phone calls, video conferences, and other approved communication',
- },
- {
- vector: {
- model_id: '.multilingual-e5-small',
- },
- text: 'Employees are expected to maintain regular communication with their supervisors, colleagues, and team members through email, phone calls, video conferences, and other approved communication tools.',
- },
- {
- vector: {
- model_id: '.multilingual-e5-small',
- },
- text: 'Work Hours and Availability',
- },
- {
- vector: {
- model_id: '.multilingual-e5-small',
- },
- text: 'Employees are expected to maintain their regular work hours and be available during normal business hours, unless otherwise agreed upon with their supervisor. Any changes to work hours or',
- },
- {
- vector: {
- model_id: '.multilingual-e5-small',
- },
- text: 'are expected to maintain their regular work hours and be available during normal business hours, unless otherwise agreed upon with their supervisor. Any changes to work hours or availability must be',
- },
- {
- vector: {
- model_id: '.multilingual-e5-small',
- },
- text: 'to maintain their regular work hours and be available during normal business hours, unless otherwise agreed upon with their supervisor. Any changes to work hours or availability must be communicated',
- },
- {
- vector: {
- model_id: '.multilingual-e5-small',
- },
- text: 'maintain their regular work hours and be available during normal business hours, unless otherwise agreed upon with their supervisor. Any changes to work hours or availability must be communicated to',
- },
- {
- vector: {
- model_id: '.multilingual-e5-small',
- },
- text: 'their regular work hours and be available during normal business hours, unless otherwise agreed upon with their supervisor. Any changes to work hours or availability must be communicated to the',
- },
- {
- vector: {
- model_id: '.multilingual-e5-small',
- },
- text: "regular work hours and be available during normal business hours, unless otherwise agreed upon with their supervisor. Any changes to work hours or availability must be communicated to the employee's",
- },
- {
- vector: {
- model_id: '.multilingual-e5-small',
- },
- text: "hours and be available during normal business hours, unless otherwise agreed upon with their supervisor. Any changes to work hours or availability must be communicated to the employee's supervisor",
- },
- {
- vector: {
- model_id: '.multilingual-e5-small',
- },
- text: "and be available during normal business hours, unless otherwise agreed upon with their supervisor. Any changes to work hours or availability must be communicated to the employee's supervisor and the",
- },
- {
- vector: {
- model_id: '.multilingual-e5-small',
- },
- text: "be available during normal business hours, unless otherwise agreed upon with their supervisor. Any changes to work hours or availability must be communicated to the employee's supervisor and the HR",
- },
- {
- vector: {
- model_id: '.multilingual-e5-small',
- },
- text: "during normal business hours, unless otherwise agreed upon with their supervisor. Any changes to work hours or availability must be communicated to the employee's supervisor and the HR department.",
- },
- {
- vector: {
- model_id: '.multilingual-e5-small',
- },
- text: 'Performance Expectations',
- },
- {
- vector: {
- model_id: '.multilingual-e5-small',
- },
- text: 'Employees working from home are expected to maintain the same level of performance and productivity as if they were working in the office. Supervisors and team members will collaborate to establish',
- },
- {
- vector: {
- model_id: '.multilingual-e5-small',
- },
- text: 'working from home are expected to maintain the same level of performance and productivity as if they were working in the office. Supervisors and team members will collaborate to establish clear',
- },
- {
- vector: {
- model_id: '.multilingual-e5-small',
- },
- text: 'from home are expected to maintain the same level of performance and productivity as if they were working in the office. Supervisors and team members will collaborate to establish clear expectations',
- },
- {
- vector: {
- model_id: '.multilingual-e5-small',
- },
- text: 'home are expected to maintain the same level of performance and productivity as if they were working in the office. Supervisors and team members will collaborate to establish clear expectations and',
- },
- {
- vector: {
- model_id: '.multilingual-e5-small',
- },
- text: 'are expected to maintain the same level of performance and productivity as if they were working in the office. Supervisors and team members will collaborate to establish clear expectations and goals',
- },
- {
- vector: {
- model_id: '.multilingual-e5-small',
- },
- text: 'expected to maintain the same level of performance and productivity as if they were working in the office. Supervisors and team members will collaborate to establish clear expectations and goals for',
- },
- {
- vector: {
- model_id: '.multilingual-e5-small',
- },
- text: 'to maintain the same level of performance and productivity as if they were working in the office. Supervisors and team members will collaborate to establish clear expectations and goals for remote',
- },
- {
- vector: {
- model_id: '.multilingual-e5-small',
- },
- text: 'maintain the same level of performance and productivity as if they were working in the office. Supervisors and team members will collaborate to establish clear expectations and goals for remote work.',
- },
- {
- vector: {
- model_id: '.multilingual-e5-small',
- },
- text: 'Time Tracking and Overtime',
- },
- {
- vector: {
- model_id: '.multilingual-e5-small',
- },
- text: "Employees are required to accurately track their work hours using the company's time tracking system. Non-exempt employees must obtain approval from their supervisor before working overtime.",
- },
- {
- vector: {
- model_id: '.multilingual-e5-small',
- },
- text: 'Confidentiality and Data Security',
- },
- {
- vector: {
- model_id: '.multilingual-e5-small',
- },
- text: "Employees must adhere to the company's confidentiality and data security policies while working from home. This includes safeguarding sensitive information, securing personal devices and internet",
- },
- {
- vector: {
- model_id: '.multilingual-e5-small',
- },
- text: "must adhere to the company's confidentiality and data security policies while working from home. This includes safeguarding sensitive information, securing personal devices and internet connections,",
- },
- {
- vector: {
- model_id: '.multilingual-e5-small',
- },
- text: "adhere to the company's confidentiality and data security policies while working from home. This includes safeguarding sensitive information, securing personal devices and internet connections, and",
- },
- {
- vector: {
- model_id: '.multilingual-e5-small',
- },
- text: "the company's confidentiality and data security policies while working from home. This includes safeguarding sensitive information, securing personal devices and internet connections, and reporting",
- },
- {
- vector: {
- model_id: '.multilingual-e5-small',
- },
- text: "company's confidentiality and data security policies while working from home. This includes safeguarding sensitive information, securing personal devices and internet connections, and reporting any",
- },
- {
- vector: {
- model_id: '.multilingual-e5-small',
- },
- text: 'confidentiality and data security policies while working from home. This includes safeguarding sensitive information, securing personal devices and internet connections, and reporting any security',
- },
- {
- vector: {
- model_id: '.multilingual-e5-small',
- },
- text: 'and data security policies while working from home. This includes safeguarding sensitive information, securing personal devices and internet connections, and reporting any security breaches to the IT',
- },
- {
- vector: {
- model_id: '.multilingual-e5-small',
- },
- text: 'policies while working from home. This includes safeguarding sensitive information, securing personal devices and internet connections, and reporting any security breaches to the IT department.',
- },
- {
- vector: {
- model_id: '.multilingual-e5-small',
- },
- text: 'Health and Well-being',
- },
- {
- vector: {
- model_id: '.multilingual-e5-small',
- },
- text: 'The company encourages employees to prioritize their health and well-being while working from home. This includes taking regular breaks, maintaining a work-life balance, and seeking support from',
- },
- {
- vector: {
- model_id: '.multilingual-e5-small',
- },
- text: 'encourages employees to prioritize their health and well-being while working from home. This includes taking regular breaks, maintaining a work-life balance, and seeking support from supervisors and',
- },
- {
- vector: {
- model_id: '.multilingual-e5-small',
- },
- text: 'employees to prioritize their health and well-being while working from home. This includes taking regular breaks, maintaining a work-life balance, and seeking support from supervisors and colleagues',
- },
- {
- vector: {
- model_id: '.multilingual-e5-small',
- },
- text: 'to prioritize their health and well-being while working from home. This includes taking regular breaks, maintaining a work-life balance, and seeking support from supervisors and colleagues when',
- },
- {
- vector: {
- model_id: '.multilingual-e5-small',
- },
- text: 'prioritize their health and well-being while working from home. This includes taking regular breaks, maintaining a work-life balance, and seeking support from supervisors and colleagues when needed.',
- },
- {
- vector: {
- model_id: '.multilingual-e5-small',
- },
- text: 'Policy Review and Updates',
- },
- {
- vector: {
- model_id: '.multilingual-e5-small',
- },
- text: 'This work-from-home policy will be reviewed periodically and updated as necessary, taking into account changes in public health guidance, business needs, and employee feedback.',
- },
- {
- vector: {
- model_id: '.multilingual-e5-small',
- },
- text: `This work-from-home policy will be reviewed periodically and updated as necessary, taking into account changes in public health guidance, business needs, and employee feedback.
-Questions and Concerns`,
- },
- {
- vector: {
- model_id: '.multilingual-e5-small',
- },
- text: 'Employees are encouraged to direct any questions or concerns about this policy to their supervisor or the HR department.',
- },
- ],
- },
- },
+ took: 0,
+ timed_out: false,
+ _shards: {
+ total: 1,
+ successful: 1,
+ skipped: 0,
+ failed: 0,
+ },
+ hits: {
+ total: {
+ value: 1,
+ relation: 'eq',
+ },
+ max_score: null,
+ hits: [],
+ },
+ } as SearchResponse,
];
export const DENSE_VECTOR_DOCUMENT_FIRST_FIELD_CAPS = {
@@ -1258,51 +802,35 @@ export const ELSER_PASSAGE_CHUNKED = {
};
export const SPARSE_DOC_SINGLE_INDEX = {
- _index: 'search-nethys',
- _id: '662812de44a5e12074edcc6f',
- _score: 1,
- _ignored: ['body_content.enum'],
- _source: {
- last_crawled_at: '2024-04-23T20:05:14Z',
- additional_urls: ['https://2e.aonprd.com/Ancestries.aspx?ID=31'],
- body_content:
- "Ancestry Guide pg. 89 2.0 Fleshwarps are people whose forms were created or radically transformed by magic, alchemy, or unnatural energies. Their unorthodox appearance can make it difficult for them to find a place for themselves in the world. Magic and science that can warp bone and twist sinew are all too common on Golarion. Fleshwarps are those who have been permanently altered by such methods—sometimes a sapient being created whole cloth from inanimate flesh, but often a victim unwillingly transformed by strange energies or sadistic creators. The ancestry name “fleshwarp” is an umbrella term, since on Golarion the actual fleshwarping process is more infamously well-known than are alterations caused by uncontrolled magic, technology, or fringe science. Whether practiced by Thassilonian wizards, Nexian fleshcrafters, or the drow of the Darklands, fleshwarping is the craft of reshaping flesh and mind in vats of foul magical reagents. This has led some scholars of monsters to argue that only those beings created by traditional fleshwarping should be considered fleshwarps. Regardless of the source of their altered forms, fleshwarps bear their new shape forever, transformed beings living a wild and strange existence beyond what was possible for their original ancestry. Although fleshwarps are humanoid, no two look the same. One might possess limbs in unusual places and skin as smooth as glass, while another might have a thick matting of spiny fur. Some might have animalistic features, like a boar snout, scales, or cloven hooves. Others have entirely alien appearances, such as bulging eyes on the backs of their hands. Some may have only subtly uncanny features that differentiate them, such as glowing teeth, smoking eyes, or fingernails made of bone. The only commonality among fleshwarps is their mismatched nature. Let your imagination run wild when creating a fleshwarp character! If you want a character who is tough and hardy, can change their form as they grow, and can use their wholly unique appearance to inspire awe or fear in others, you should play a fleshwarp. You Might... Embrace your unusual appearance to inspire respect or fear. Be used to relying on yourself. Distrust large groups of people, particularly mobs, based on past experiences. Others Probably... Find your physiology fascinating or terrifying. Assume you are an expert on strange creatures or occult phenomena. Consider you an enigmatic and unpredictable—and perhaps even dangerous—outsider. Physical Description Fleshwarps are humanoids, ranging from 5 to 7 feet tall and from just under 100 pounds to more than 300 pounds. The proportion and appearance of their limbs and features differ widely, but fleshwarps functionally have two legs, two arms, and a single head; a fleshwarp with more limbs than this should consider an appropriate ancestry feat to reflect this variance, or one of their limbs might be vestigial and mostly nonfunctional. Fleshwarps differ widely in their appearance due to the unique circumstances of their creation. Even fleshwarp siblings or two people transformed through the same procedure might look wildly different. Society Fleshwarps are so few in number that congregations of them are rare. They most often live on their own, with a small family group, or at the outskirts of a community. Some thrive in cities, however, where they can remain anonymous among the crowds while pursuing careers that allow them to avoid contact with people who might fear or persecute them. Fleshwarps value endurance and are quick to learn from others, so those who come into contact with others of their kind usually share stories that help each other survive, hide, or thrive more effectively. How a fleshwarp formed can be a painful or horrifying subject, one they consider rude to discuss with anyone besides close friends or loved ones. Alignment and Religion Fleshwarps have little to gain from the broader society, and therefore rarely work to support society in turn, beyond perhaps helping other fleshwarps. They need to be able to adapt quickly to survive on their own. As a consequence, few fleshwarps are lawful. Although bigoted or short-sighted people view fleshwarps as monsters, fleshwarps are no more or less prone to evil than any other people, and most seek only to live their lives without trouble. Most are neutral in alignment, for while alienation doesn't force a fleshwarp to feel contempt for others, neither does it encourage a fleshwarp to avoid it. This is especially true for fleshwarps living in the societies that gave birth to their traumatic transformation. Fleshwarps aren't often casually religious; most either have little to do with faith at all (viewing themselves as scorned by the gods or simply seeing faith as impractical for survival) or are exceptionally devout. Religious fleshwarps often revere Arazni , Calistria , Desna , or Gozreh ; evil fleshwarps typically turn to Lamashtu , finding consolation in the Mother of Monsters. Adventurers Fleshwarps often live on the margins of society. The hermit , hunter , nomad , or street urchin backgrounds work well for many fleshwarps; others might be criminals , entertainers , or prisoners . The need to defend themselves leads many fleshwarps to become barbarians , fighters , rogues , or rangers . champions and druids are common callings among fleshwarps who seek to defend and better the lot of others of their kind. Names Fleshwarps can come from—and thus have names from—any culture or ancestry, but some give themselves new names after being transformed, whether to celebrate the change, recognize a new phase of their lives, or conceal their past identity. Many fleshwarps also carry a descriptive nickname granted to them by others, such as “Triple Handed,” “Barkfoot,” or “Many-Mouth.” Fleshwarps don't keep nicknames they find personally offensive, but they tend to keep ones that describe their distinctive appearances or that are given by people they care about. Sample Names Borble, Dag, Feff, Hurn, Kemp, Omber, Ostro, Shurni, Surm, Wumpin Other Information Fleshforges In the city of Ecanus, the archmage Nex created the Fleshforges—massive edifices that churn and tremble with the birth sequences' roar of smelting flesh and printing bone—to produce fleshwarp soldiers to fuel his war against Geb. The Fleshforgers still engineer a bedazzling array of fleshwarps here, from chimeric messengers, who meld house pet and golem, to disciplined scale-sheathed cataphracts and stupendous dreadnoughts, whose fists and footsteps bend steel and pulverize stone. Recently, the Fleshforges have experienced uninitiated activations with alarming frequency, delivering atypical fleshwarps unconfined by design purviews or production schedules. Ecanus's authorities fervently hunt these unlicensed creations, but some escape, lurching into the night to hide in the city's recesses or venturing afield into the Mana Wastes. Fleshwarp Legends Legends of famous fleshwarps travel quickly amid fleshwarp communities. Lady Kedley : A wealthy noble in a life she doesn't remember, Kedley emerged transformed from deep below Westcrown. She uses her family's vast fortune to aid other fleshwarps. Spinhead Vanluk : This Mana Wastes warlord brings mutants and fleshwarps under his banner. He (literally) has eyes in the back of his head. Fleshwarp Motives Fleshwarps have a variety of reasons for taking up the life of an adventurer. Some are turned out of their homes by an uncaring parent or a suspicious mob. Other fleshwarps travel to learn more about their own transformation or to seek out others of their kind. A few even actively seek the means—either technological or magical—to undo their transformations or adopt a new form that won't incite repulsion or fear in common people. Still others understand that a good way to earn respect is to solve a community's problems—then quickly leave the area—and therefore fall into the role of itinerant adventurers-for-hire. Fleshwarp Settlements No settlements consisting entirely of fleshwarps exist openly outside of the Mana Wastes; elsewhere, citizens keep the secret so well that their community's existence isn't known to the world at large. Fleshwarps are more likely to live on the fringes of other settlements, working in industries where their hardy constitution is an advantage and their uncanny appearance isn't a liability. Some are herbalists or trappers, working in the wilderness and interacting with others only rarely. Locals might come to consider a fleshwarp their equal or friend, and take umbrage at outsiders who make a big deal out of the “monster” in their midst. Sentiment might turn quickly upon supernatural events or strange attacks, however, and, tragically, more than a few fleshwarps have been turned out of homes they've occupied for decades when faced with a misguided mob. The Mana Wastes The Mana Wastes are the vast swaths of desolation adjoining once-warring Geb and Nex. Over more than a thousand years, both nations' unrestricted use of magical fusillades, creeping plagues, and other atrocities of spellcraft transformed a once fertile and beautiful land into a desert where reality screams and bleeds. Wellspring surges of magic form into riptides and whirlwinds of chaotic force throughout the Mana Wastes, rending and twisting everything in their path. Many fleshwarps make their homes in this inhospitable land. Some are native to the region, mutated by the Mana Wastes' volatile outbursts, while others are exiles and refugees from across the Impossible Lands who find the otherworldly hazards of the Mana Wastes preferable to the all-too-worldly persecution of their former homelands and compatriots. Fleshwarp Mechanics Hit Points 10 Size Medium or Small Speed 25 feet Ability Boosts Constitution Free Languages Common Additional languages equal to your Intelligence modifier (if positive). Choose from Aklo , Draconic , Dwarven , Elven , Goblin , Undercommon , and any other languages to which you have access (such as the languages prevalent in your region). Low-Light Vision You can see in dim light as though it were bright light, and you ignore the concealed condition due to dim light. Unusual Anatomy Your unorthodox body resists physical afflictions meant for other creatures. You gain a +1 circumstance bonus to saves against diseases and poisons .",
- domains: ['https://2e.aonprd.com'],
- title: 'Fleshwarp - Ancestries - Archives of Nethys: Pathfinder 2nd Edition Database',
- meta_keywords:
- 'Archives, Nethys, Wiki, Archives of Nethys, Pathfinder, Official, AoN, AoNPRD, PRD, PFSRD, 2E, 2nd Edition, Ancestries, Ancestry, Fleshwarp',
- url: 'https://2e.aonprd.com/Ancestries.aspx?ID=31',
- url_scheme: 'https',
- meta_description:
- 'Magic and science that can warp bone and twist sinew are all too common on Golarion. Fleshwarps are those who have been permanently altered by such methods—sometimes a sapient being created whole cloth from inanimate flesh, but often a victim unwillingly transformed by strange energies or sadistic creators.
The ancestry name “fleshwarp” is an umbrella term, since on Golarion the actual fleshwarping process is more infamously well-known than are alterations caused by uncontrolled magic, technology, or fringe science. Whether practiced by Thassilonian wizards, Nexian fleshcrafters, or the drow of the Darklands, fleshwarping is the craft of reshaping flesh and mind in vats of foul magical reagents. This has led some scholars of monsters to argue that only those beings created by traditional fleshwarping should be considered fleshwarps. Regardless of the source of their altered forms, fleshwarps bear their new shape forever, transformed beings living a wild and strange existence beyond what w…',
- _ingest: {
- processors: [
+ took: 0,
+ timed_out: false,
+ _shards: {
+ total: 1,
+ successful: 1,
+ skipped: 0,
+ failed: 0,
+ },
+ hits: {
+ total: {
+ value: 1,
+ relation: 'eq',
+ },
+ max_score: null,
+ hits: [],
+ },
+ aggregations: {
+ 'ml.inference.body_content_expanded.model_id': {
+ doc_count_error_upper_bound: 0,
+ sum_other_doc_count: 0,
+ buckets: [
{
- pipeline: 'ml.inference.nethys',
- model_version: '12.0.0',
- types: ['pytorch', 'text_expansion'],
- processed_timestamp: '2024-04-23T20:05:15.723072191Z',
+ key: '.elser_model_2_linux-x86_64',
+ doc_count: 1,
},
],
},
- headings: ['Alchemist'],
- links: ['https://2e.aonprd.com/Causes.aspx'],
- id: '662812de44a5e12074edcc6f',
- url_port: 443,
- url_host: '2e.aonprd.com',
- url_path: '/Ancestries.aspx',
- url_path_dir1: 'Ancestries.aspx',
- ml: {
- inference: {
- body_content_expanded: {
- predicted_value: {},
- is_truncated: true,
- model_id: '.elser_model_2_linux-x86_64',
- },
- },
- },
},
-};
+} as SearchResponse;
export const DENSE_PASSAGE_FIRST_SINGLE_INDEX_FIELD_CAPS = {
indices: ['search-example-main'],
@@ -1663,37 +1191,32 @@ export const DENSE_PASSAGE_FIRST_SINGLE_INDEX_FIELD_CAPS = {
};
export const DENSE_PASSAGE_FIRST_SINGLE_INDEX_DOC = {
- _index: 'search-example-main',
- _id: 'id',
- _version: 1,
- _seq_no: 2,
- _primary_term: 1,
- found: true,
- _source: {
- page_notification: '-',
- 'main_button.button_new_tab': '-',
- page_content_key: '',
- label: '',
- bread_crumbs: 'breadcrumbs',
- title: 'title',
- type: '11',
- url: '/',
- page_content_text: 'page_content_text',
- page_id: '2,061',
- 'buttons.button_title': '-',
- page_content_e5_embbeding: {
- predicted_value: [0.09232209622859955],
- model_id: '.multilingual-e5-small_linux-x86_64',
- },
- category_id: 'category_id',
- filter_list: 'filter',
- 'buttons.button_link': '-',
- 'buttons.button_new_tab': '-',
- 'main_button.button_title': '-',
- title_text: 'title_text',
- 'main_button.button_link': '-',
- page_content: 'bla',
- updated_date: '2024-03-21T11:23:12.503000',
- title_keyword: 'title_keyword',
+ took: 0,
+ timed_out: false,
+ _shards: {
+ total: 1,
+ successful: 1,
+ skipped: 0,
+ failed: 0,
},
-};
+ hits: {
+ total: {
+ value: 1,
+ relation: 'eq',
+ },
+ max_score: null,
+ hits: [],
+ },
+ aggregations: {
+ 'page_content_e5_embbeding.model_id': {
+ doc_count_error_upper_bound: 0,
+ sum_other_doc_count: 0,
+ buckets: [
+ {
+ key: '.multilingual-e5-small_linux-x86_64',
+ doc_count: 1,
+ },
+ ],
+ },
+ },
+} as SearchResponse;
diff --git a/x-pack/plugins/search_playground/server/lib/fetch_query_source_fields.test.ts b/x-pack/plugins/search_playground/server/lib/fetch_query_source_fields.test.ts
index 70b640f1ea70da..108ddabb0a73fd 100644
--- a/x-pack/plugins/search_playground/server/lib/fetch_query_source_fields.test.ts
+++ b/x-pack/plugins/search_playground/server/lib/fetch_query_source_fields.test.ts
@@ -18,8 +18,13 @@ import {
DENSE_INPUT_OUTPUT_ONE_INDEX_FIELD_CAPS,
SPARSE_INPUT_OUTPUT_ONE_INDEX,
SPARSE_INPUT_OUTPUT_ONE_INDEX_FIELD_CAPS,
+ SPARSE_INPUT_OUTPUT_ONE_INDEX_FIELD_CAPS_MODEL_ID_KEYWORD,
} from '../../__mocks__/fetch_query_source_fields.mock';
-import { parseFieldsCapabilities } from './fetch_query_source_fields';
+import {
+ fetchFields,
+ getModelIdFields,
+ parseFieldsCapabilities,
+} from './fetch_query_source_fields';
describe('fetch_query_source_fields', () => {
describe('parseFieldsCapabilities', () => {
@@ -252,4 +257,92 @@ describe('fetch_query_source_fields', () => {
});
});
});
+
+ describe('getModelIdFields', () => {
+ it('should return the model_id field for field specific - dense', () => {
+ expect(getModelIdFields(DENSE_PASSAGE_FIRST_SINGLE_INDEX_FIELD_CAPS)).toEqual([
+ {
+ aggField: 'page_content_e5_embbeding.model_id.keyword',
+ path: 'page_content_e5_embbeding.model_id',
+ },
+ { aggField: 'page_content_ner.model_id', path: 'page_content_ner.model_id' },
+ ]);
+ });
+
+ it('should return the model_id field for field specific - elser', () => {
+ expect(getModelIdFields(DENSE_VECTOR_DOCUMENT_FIRST_FIELD_CAPS)).toEqual([
+ { aggField: 'passages.vector.model_id.keyword', path: 'passages.vector.model_id' },
+ ]);
+ });
+
+ it('should return top level model_id', () => {
+ expect(getModelIdFields(SPARSE_INPUT_OUTPUT_ONE_INDEX_FIELD_CAPS)).toEqual([
+ { aggField: 'model_id.keyword', path: 'model_id' },
+ ]);
+ });
+
+ it('should return the model_id as aggField if its a keyword field', () => {
+ expect(getModelIdFields(SPARSE_INPUT_OUTPUT_ONE_INDEX_FIELD_CAPS_MODEL_ID_KEYWORD)).toEqual([
+ { aggField: 'model_id', path: 'model_id' },
+ ]);
+ });
+ });
+
+ describe('fetchFields', () => {
+ it('should perform a search request with the correct parameters', async () => {
+ const client = {
+ asCurrentUser: {
+ fieldCaps: jest.fn().mockResolvedValue(DENSE_PASSAGE_FIRST_SINGLE_INDEX_FIELD_CAPS),
+ search: jest.fn().mockResolvedValue(DENSE_PASSAGE_FIRST_SINGLE_INDEX_DOC),
+ },
+ } as any;
+ const indices = ['search-example-main'];
+ await fetchFields(client, indices);
+ expect(client.asCurrentUser.search).toHaveBeenCalledWith({
+ index: 'search-example-main',
+ body: {
+ size: 0,
+ aggs: {
+ 'page_content_e5_embbeding.model_id': {
+ terms: {
+ field: 'page_content_e5_embbeding.model_id.keyword',
+ size: 1,
+ },
+ },
+ 'page_content_ner.model_id': {
+ terms: {
+ field: 'page_content_ner.model_id',
+ size: 1,
+ },
+ },
+ },
+ },
+ });
+ });
+
+ it('should perform a search request with the correct parameters with top level model id', async () => {
+ const client = {
+ asCurrentUser: {
+ fieldCaps: jest.fn().mockResolvedValue(SPARSE_INPUT_OUTPUT_ONE_INDEX_FIELD_CAPS),
+ search: jest.fn().mockResolvedValue(SPARSE_INPUT_OUTPUT_ONE_INDEX),
+ },
+ } as any;
+ const indices = ['index'];
+ await fetchFields(client, indices);
+ expect(client.asCurrentUser.search).toHaveBeenCalledWith({
+ index: 'index',
+ body: {
+ size: 0,
+ aggs: {
+ model_id: {
+ terms: {
+ field: 'model_id.keyword',
+ size: 1,
+ },
+ },
+ },
+ },
+ });
+ });
+ });
});
diff --git a/x-pack/plugins/search_playground/server/lib/fetch_query_source_fields.ts b/x-pack/plugins/search_playground/server/lib/fetch_query_source_fields.ts
index 6bea3f8f03978b..b333a0e95962bb 100644
--- a/x-pack/plugins/search_playground/server/lib/fetch_query_source_fields.ts
+++ b/x-pack/plugins/search_playground/server/lib/fetch_query_source_fields.ts
@@ -5,11 +5,51 @@
* 2.0.
*/
-import { FieldCapsResponse, SearchHit } from '@elastic/elasticsearch/lib/api/typesWithBodyKey';
+import { SearchResponse, FieldCapsResponse } from '@elastic/elasticsearch/lib/api/types';
import { IScopedClusterClient } from '@kbn/core-elasticsearch-server';
-import { get, has } from 'lodash';
import { IndicesQuerySourceFields } from '../types';
+interface FieldModelId {
+ field: string;
+ modelId: string | undefined;
+}
+
+interface IndexFieldModel {
+ index: string;
+ fields: FieldModelId[];
+}
+
+export const getModelIdFields = (fieldCapsResponse: FieldCapsResponse) => {
+ const { fields } = fieldCapsResponse;
+ return Object.keys(fields).reduce>((acc, fieldKey) => {
+ const field = fields[fieldKey];
+ if (fieldKey.endsWith('model_id')) {
+ if ('keyword' in field && field.keyword.aggregatable) {
+ acc.push({
+ path: fieldKey,
+ aggField: fieldKey,
+ });
+ return acc;
+ }
+ const keywordModelIdField = fields[fieldKey + '.keyword'];
+
+ if (
+ keywordModelIdField &&
+ `keyword` in keywordModelIdField &&
+ keywordModelIdField.keyword.aggregatable
+ ) {
+ acc.push({
+ path: fieldKey,
+ aggField: fieldKey + '.keyword',
+ });
+ return acc;
+ }
+ }
+
+ return acc;
+ }, []);
+};
+
export const fetchFields = async (
client: IScopedClusterClient,
indices: string[]
@@ -21,56 +61,51 @@ export const fetchFields = async (
index: indices,
});
- const indexDocs = [];
+ const modelIdFields = getModelIdFields(fieldCapabilities);
- for (const index of indices) {
- const x = await client.asCurrentUser.search({
+ const indicesAggs = await Promise.all(
+ indices.map(async (index) => ({
index,
- body: {
- query: {
- match_all: {},
- },
- size: 1,
- },
- });
-
- if (x.hits.total !== 0) {
- indexDocs.push({
+ doc: await client.asCurrentUser.search({
index,
- doc: x.hits.hits[0],
- });
- }
- }
+ body: {
+ size: 0,
+ aggs: modelIdFields.reduce(
+ (sum, modelIdField) => ({
+ ...sum,
+ [modelIdField.path]: {
+ terms: {
+ field: modelIdField.aggField,
+ size: 1,
+ },
+ },
+ }),
+ {}
+ ),
+ },
+ }),
+ }))
+ );
- return parseFieldsCapabilities(fieldCapabilities, indexDocs);
+ return parseFieldsCapabilities(fieldCapabilities, indicesAggs);
};
const INFERENCE_MODEL_FIELD_REGEXP = /\.predicted_value|\.tokens/;
-const hasModelField = (field: string, indexDoc: any, nestedField: string | false) => {
- if (field.match(INFERENCE_MODEL_FIELD_REGEXP)) {
- const path = nestedField ? field.replace(`${nestedField}.`, `${nestedField}[0].`) : field;
- return has(
- indexDoc.doc,
- `_source.${[path.replace(INFERENCE_MODEL_FIELD_REGEXP, '.model_id')]}`
- );
- }
- return false;
-};
-
-// For input_output inferred fields, the model_id is at the top level
-const hasTopLevelModelField = (indexDoc: any) => {
- return has(indexDoc.doc, `_source.model_id`);
-};
+const getModelField = (field: string, modelIdFields: FieldModelId[]) => {
+ // For input_output inferred fields, the model_id is at the top level
+ const topLevelModelField = modelIdFields.find(
+ (modelIdField) => modelIdField.field === 'model_id'
+ )?.modelId;
-const getModelField = (field: string, indexDoc: any, nestedField: string | false) => {
- if (hasTopLevelModelField(indexDoc)) {
- return get(indexDoc.doc, `_source.model_id`);
+ if (topLevelModelField) {
+ return topLevelModelField;
}
- // If the field is nested, we need to get the first occurrence as its an array
- const path = nestedField ? field.replace(`${nestedField}.`, `${nestedField}[0].`) : field;
- return get(indexDoc.doc, `_source.${[path.replace(INFERENCE_MODEL_FIELD_REGEXP, '.model_id')]}`);
+ return modelIdFields.find(
+ (modelIdField) =>
+ modelIdField.field === field.replace(INFERENCE_MODEL_FIELD_REGEXP, '.model_id')
+ )?.modelId;
};
const isFieldNested = (field: string, fieldCapsResponse: FieldCapsResponse) => {
@@ -94,11 +129,25 @@ const isFieldNested = (field: string, fieldCapsResponse: FieldCapsResponse) => {
export const parseFieldsCapabilities = (
fieldCapsResponse: FieldCapsResponse,
- indexDocs: Array<{ index: string; doc: SearchHit }>
+ aggDocs: Array<{ index: string; doc: SearchResponse }>
): IndicesQuerySourceFields => {
const { fields, indices: indexOrIndices } = fieldCapsResponse;
const indices = Array.isArray(indexOrIndices) ? indexOrIndices : [indexOrIndices];
+ const indexModelIdFields = aggDocs.map((aggDoc) => {
+ const modelIdFields = Object.keys(aggDoc.doc.aggregations || {}).map((field) => {
+ return {
+ field,
+ modelId: (aggDoc.doc.aggregations![field] as any)?.buckets?.[0]?.key,
+ };
+ });
+
+ return {
+ index: aggDoc.index,
+ fields: modelIdFields,
+ };
+ });
+
const indicesFieldsMap = indices.reduce((acc, index) => {
acc[index] = {
elser_query_fields: [],
@@ -125,20 +174,21 @@ export const parseFieldsCapabilities = (
: (indices as unknown as string[]);
for (const index of indicesPresentIn) {
- const indexDoc = indexDocs.find((x) => x.index === index);
+ const modelIdFields = indexModelIdFields.find(
+ (indexModelIdField) => indexModelIdField.index === index
+ )!.fields;
+
if ('rank_features' in field || 'sparse_vector' in field) {
const nestedField = isFieldNested(fieldKey, fieldCapsResponse);
+ const modelId = getModelField(fieldKey, modelIdFields);
// Check if the sparse vector field has a model_id associated with it
// skip this field if has no model associated with it
// and the vectors were embedded outside of stack
- if (
- (hasModelField(fieldKey, indexDoc, nestedField) || hasTopLevelModelField(indexDoc)) &&
- !nestedField
- ) {
+ if (modelId && !nestedField) {
const elserModelField = {
field: fieldKey,
- model_id: getModelField(fieldKey, indexDoc, nestedField),
+ model_id: modelId,
nested: !!isFieldNested(fieldKey, fieldCapsResponse),
indices: indicesPresentIn,
};
@@ -148,17 +198,15 @@ export const parseFieldsCapabilities = (
}
} else if ('dense_vector' in field) {
const nestedField = isFieldNested(fieldKey, fieldCapsResponse);
+ const modelId = getModelField(fieldKey, modelIdFields);
// Check if the dense vector field has a model_id associated with it
// skip this field if has no model associated with it
// and the vectors were embedded outside of stack
- if (
- (hasModelField(fieldKey, indexDoc, nestedField) || hasTopLevelModelField(indexDoc)) &&
- !nestedField
- ) {
+ if (modelId && !nestedField) {
const denseVectorField = {
field: fieldKey,
- model_id: getModelField(fieldKey, indexDoc, nestedField),
+ model_id: modelId,
nested: !!nestedField,
indices: indicesPresentIn,
};
diff --git a/x-pack/plugins/security_solution/common/api/detection_engine/rule_monitoring/index.ts b/x-pack/plugins/security_solution/common/api/detection_engine/rule_monitoring/index.ts
index ddb132ebf64bbb..216b32b0136277 100644
--- a/x-pack/plugins/security_solution/common/api/detection_engine/rule_monitoring/index.ts
+++ b/x-pack/plugins/security_solution/common/api/detection_engine/rule_monitoring/index.ts
@@ -20,5 +20,6 @@ export * from './model/execution_result.gen';
export * from './model/execution_settings';
export * from './model/execution_status.gen';
export * from './model/execution_status';
+export * from './model/execution_run_type.gen';
export * from './model/execution_summary.gen';
export * from './model/log_level';
diff --git a/x-pack/plugins/security_solution/common/api/detection_engine/rule_monitoring/model/execution_result.gen.ts b/x-pack/plugins/security_solution/common/api/detection_engine/rule_monitoring/model/execution_result.gen.ts
index a1706fe0f41416..8a4c49d049d56c 100644
--- a/x-pack/plugins/security_solution/common/api/detection_engine/rule_monitoring/model/execution_result.gen.ts
+++ b/x-pack/plugins/security_solution/common/api/detection_engine/rule_monitoring/model/execution_result.gen.ts
@@ -41,6 +41,15 @@ export const RuleExecutionResult = z.object({
gap_duration_s: z.number().int(),
security_status: z.string(),
security_message: z.string(),
+ /**
+ * Backfill information for the rule execution result with source event date range
+ */
+ backfill: z
+ .object({
+ from: z.string().datetime(),
+ to: z.string().datetime(),
+ })
+ .optional(),
});
/**
diff --git a/x-pack/plugins/security_solution/common/api/detection_engine/rule_monitoring/model/execution_result.schema.yaml b/x-pack/plugins/security_solution/common/api/detection_engine/rule_monitoring/model/execution_result.schema.yaml
index 3c8d91d3b9d7f9..f8cf67bd423eaf 100644
--- a/x-pack/plugins/security_solution/common/api/detection_engine/rule_monitoring/model/execution_result.schema.yaml
+++ b/x-pack/plugins/security_solution/common/api/detection_engine/rule_monitoring/model/execution_result.schema.yaml
@@ -52,6 +52,19 @@ components:
type: string
security_message:
type: string
+ backfill:
+ type: object
+ description: Backfill information for the rule execution result with source event date range
+ properties:
+ from:
+ type: string
+ format: date-time
+ to:
+ type: string
+ format: date-time
+ required:
+ - from
+ - to
required:
- execution_uuid
- timestamp
diff --git a/x-pack/plugins/security_solution/common/api/detection_engine/rule_monitoring/model/execution_run_type.gen.ts b/x-pack/plugins/security_solution/common/api/detection_engine/rule_monitoring/model/execution_run_type.gen.ts
new file mode 100644
index 00000000000000..425d5c9e922afb
--- /dev/null
+++ b/x-pack/plugins/security_solution/common/api/detection_engine/rule_monitoring/model/execution_run_type.gen.ts
@@ -0,0 +1,25 @@
+/*
+ * 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 { z } from 'zod';
+
+/*
+ * NOTICE: Do not edit this file manually.
+ * This file is automatically generated by the OpenAPI Generator, @kbn/openapi-generator.
+ *
+ * info:
+ * title: Execution Run Type Schema
+ * version: not applicable
+ */
+
+/**
+ * Type of rule execution run.
+ */
+export type RuleRunType = z.infer;
+export const RuleRunType = z.enum(['backfill', 'standard']);
+export type RuleRunTypeEnum = typeof RuleRunType.enum;
+export const RuleRunTypeEnum = RuleRunType.enum;
diff --git a/x-pack/plugins/security_solution/common/api/detection_engine/rule_monitoring/model/execution_run_type.schema.yaml b/x-pack/plugins/security_solution/common/api/detection_engine/rule_monitoring/model/execution_run_type.schema.yaml
new file mode 100644
index 00000000000000..689e8393bcbe4a
--- /dev/null
+++ b/x-pack/plugins/security_solution/common/api/detection_engine/rule_monitoring/model/execution_run_type.schema.yaml
@@ -0,0 +1,14 @@
+openapi: 3.0.0
+info:
+ title: Execution Run Type Schema
+ version: not applicable
+paths: {}
+components:
+ x-codegen-enabled: true
+ schemas:
+ RuleRunType:
+ type: string
+ description: Type of rule execution run.
+ enum:
+ - backfill
+ - standard
\ No newline at end of file
diff --git a/x-pack/plugins/security_solution/common/api/detection_engine/rule_monitoring/rule_execution_logs/get_rule_execution_results/get_rule_execution_results_route.gen.ts b/x-pack/plugins/security_solution/common/api/detection_engine/rule_monitoring/rule_execution_logs/get_rule_execution_results/get_rule_execution_results_route.gen.ts
index 50cb863588a066..0c65eb39b88f4a 100644
--- a/x-pack/plugins/security_solution/common/api/detection_engine/rule_monitoring/rule_execution_logs/get_rule_execution_results/get_rule_execution_results_route.gen.ts
+++ b/x-pack/plugins/security_solution/common/api/detection_engine/rule_monitoring/rule_execution_logs/get_rule_execution_results/get_rule_execution_results_route.gen.ts
@@ -18,6 +18,7 @@ import { ArrayFromString } from '@kbn/zod-helpers';
*/
import { RuleExecutionStatus } from '../../model/execution_status.gen';
+import { RuleRunType } from '../../model/execution_run_type.gen';
import {
SortFieldOfRuleExecutionResult,
RuleExecutionResult,
@@ -44,6 +45,10 @@ export const GetRuleExecutionResultsRequestQuery = z.object({
* Comma-separated list of rule execution statuses to filter results by
*/
status_filters: ArrayFromString(RuleExecutionStatus).optional().default([]),
+ /**
+ * Comma-separated list of rule run types to filter results by
+ */
+ run_type_filters: ArrayFromString(RuleRunType).optional().default([]),
/**
* Field to sort results by
*/
diff --git a/x-pack/plugins/security_solution/common/api/detection_engine/rule_monitoring/rule_execution_logs/get_rule_execution_results/get_rule_execution_results_route.schema.yaml b/x-pack/plugins/security_solution/common/api/detection_engine/rule_monitoring/rule_execution_logs/get_rule_execution_results/get_rule_execution_results_route.schema.yaml
index 8bba4b2811e31c..42f8d54a2e6166 100644
--- a/x-pack/plugins/security_solution/common/api/detection_engine/rule_monitoring/rule_execution_logs/get_rule_execution_results/get_rule_execution_results_route.schema.yaml
+++ b/x-pack/plugins/security_solution/common/api/detection_engine/rule_monitoring/rule_execution_logs/get_rule_execution_results/get_rule_execution_results_route.schema.yaml
@@ -48,6 +48,15 @@ paths:
items:
$ref: '../../model/execution_status.schema.yaml#/components/schemas/RuleExecutionStatus'
default: []
+ - name: run_type_filters
+ in: query
+ required: false
+ description: Comma-separated list of rule run types to filter results by
+ schema:
+ type: array
+ items:
+ $ref: '../../model/execution_run_type.schema.yaml#/components/schemas/RuleRunType'
+ default: []
- name: sort_field
in: query
required: false
diff --git a/x-pack/plugins/security_solution/common/api/detection_engine/rule_monitoring/rule_execution_logs/get_rule_execution_results/get_rule_execution_results_route.test.ts b/x-pack/plugins/security_solution/common/api/detection_engine/rule_monitoring/rule_execution_logs/get_rule_execution_results/get_rule_execution_results_route.test.ts
index 742290de8bf43e..4a3a7e74e9d356 100644
--- a/x-pack/plugins/security_solution/common/api/detection_engine/rule_monitoring/rule_execution_logs/get_rule_execution_results/get_rule_execution_results_route.test.ts
+++ b/x-pack/plugins/security_solution/common/api/detection_engine/rule_monitoring/rule_execution_logs/get_rule_execution_results/get_rule_execution_results_route.test.ts
@@ -255,6 +255,7 @@ describe('Request schema of Get rule execution results', () => {
sort_order: 'desc',
start: '2021-08-01T00:00:00.000Z',
status_filters: [],
+ run_type_filters: [],
});
});
});
diff --git a/x-pack/plugins/security_solution/common/constants.ts b/x-pack/plugins/security_solution/common/constants.ts
index 5be5462a805f91..c477a069c9c2ee 100644
--- a/x-pack/plugins/security_solution/common/constants.ts
+++ b/x-pack/plugins/security_solution/common/constants.ts
@@ -434,6 +434,9 @@ export const NEW_FEATURES_TOUR_STORAGE_KEYS = {
export const RULE_DETAILS_EXECUTION_LOG_TABLE_SHOW_METRIC_COLUMNS_STORAGE_KEY =
'securitySolution.ruleDetails.ruleExecutionLog.showMetrics.v8.2';
+export const RULE_DETAILS_EXECUTION_LOG_TABLE_SHOW_SOURCE_EVENT_TIME_RANGE_STORAGE_KEY =
+ 'securitySolution.ruleDetails.ruleExecutionLog.showSourceEventTimeRange.v8.15';
+
// TODO: https://github.com/elastic/kibana/pull/142950
/**
* Error codes that can be thrown during _bulk_action API dry_run call and be processed and displayed to end user
diff --git a/x-pack/plugins/security_solution/common/detection_engine/rule_management/execution_log.ts b/x-pack/plugins/security_solution/common/detection_engine/rule_management/execution_log.ts
new file mode 100644
index 00000000000000..9a2205b0b42c2f
--- /dev/null
+++ b/x-pack/plugins/security_solution/common/detection_engine/rule_management/execution_log.ts
@@ -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 type { RuleExecutionStatus, RuleRunType } from '../../api/detection_engine/rule_monitoring';
+import {
+ RuleExecutionStatusEnum,
+ RuleRunTypeEnum,
+} from '../../api/detection_engine/rule_monitoring';
+
+export const RUN_TYPE_FILTERS: RuleRunType[] = [RuleRunTypeEnum.standard, RuleRunTypeEnum.backfill];
+
+export const STATUS_FILTERS: RuleExecutionStatus[] = [
+ RuleExecutionStatusEnum.succeeded,
+ RuleExecutionStatusEnum.failed,
+ RuleExecutionStatusEnum['partial failure'],
+];
diff --git a/x-pack/plugins/security_solution/common/experimental_features.ts b/x-pack/plugins/security_solution/common/experimental_features.ts
index 01f03d4ac09ea4..c3b6a09470a8a6 100644
--- a/x-pack/plugins/security_solution/common/experimental_features.ts
+++ b/x-pack/plugins/security_solution/common/experimental_features.ts
@@ -286,6 +286,11 @@ export const allowedExperimentalValues = Object.freeze({
* Enables the new rule's bulk action to manage custom highlighted fields
*/
bulkCustomHighlightedFieldsEnabled: false,
+
+ /**
+ * Enables the manual rule run
+ */
+ manualRuleRunEnabled: false,
});
type ExperimentalConfigKeys = Array;
diff --git a/x-pack/plugins/security_solution/public/common/components/control_columns/row_action/index.test.tsx b/x-pack/plugins/security_solution/public/common/components/control_columns/row_action/index.test.tsx
index 0dd60a0f9c2f8f..a6500a2ba5d10c 100644
--- a/x-pack/plugins/security_solution/public/common/components/control_columns/row_action/index.test.tsx
+++ b/x-pack/plugins/security_solution/public/common/components/control_columns/row_action/index.test.tsx
@@ -32,6 +32,7 @@ jest.mock('../../../utils/route/use_route_spy');
jest.mock('@kbn/expandable-flyout', () => {
return {
useExpandableFlyoutApi: () => ({ openFlyout: mockOpenFlyout }),
+ useExpandableFlyoutState: () => ({ left: false }),
};
});
@@ -55,6 +56,7 @@ jest.mock('@kbn/kibana-react-plugin/public', () => {
...original,
};
});
+jest.mock('../../guided_onboarding_tour/tour_step');
const mockRouteSpy: RouteSpyState = {
pageName: SecurityPageName.overview,
diff --git a/x-pack/plugins/security_solution/public/common/components/control_columns/row_action/index.tsx b/x-pack/plugins/security_solution/public/common/components/control_columns/row_action/index.tsx
index bc9969d2a7e42f..181b707e88d2d1 100644
--- a/x-pack/plugins/security_solution/public/common/components/control_columns/row_action/index.tsx
+++ b/x-pack/plugins/security_solution/public/common/components/control_columns/row_action/index.tsx
@@ -30,6 +30,8 @@ import type { TimelineItem, TimelineNonEcsData } from '../../../../../common/sea
import type { ColumnHeaderOptions, OnRowSelected } from '../../../../../common/types/timeline';
import { TimelineId } from '../../../../../common/types';
import { useIsExperimentalFeatureEnabled } from '../../../hooks/use_experimental_features';
+import { useTourContext } from '../../guided_onboarding_tour';
+import { AlertsCasesTourSteps, SecurityStepId } from '../../guided_onboarding_tour/tour_config';
type Props = EuiDataGridCellValueElementProps & {
columnHeaders: ColumnHeaderOptions[];
@@ -83,6 +85,11 @@ const RowActionComponent = ({
const isExpandableFlyoutInCreateRuleEnabled = useIsExperimentalFeatureEnabled(
'expandableFlyoutInCreateRuleEnabled'
);
+ const { activeStep, isTourShown } = useTourContext();
+ const shouldFocusOnOverviewTab =
+ (activeStep === AlertsCasesTourSteps.expandEvent ||
+ activeStep === AlertsCasesTourSteps.reviewAlertDetailsFlyout) &&
+ isTourShown(SecurityStepId.alertsCases);
const columnValues = useMemo(
() =>
@@ -123,6 +130,7 @@ const RowActionComponent = ({
openFlyout({
right: {
id: DocumentDetailsRightPanelKey,
+ path: shouldFocusOnOverviewTab ? { tab: 'overview' } : undefined,
params: {
id: eventId,
indexName,
@@ -156,7 +164,17 @@ const RowActionComponent = ({
})
);
}
- }, [dispatch, eventId, indexName, openFlyout, tabType, tableId, showExpandableFlyout, telemetry]);
+ }, [
+ eventId,
+ indexName,
+ showExpandableFlyout,
+ tableId,
+ openFlyout,
+ shouldFocusOnOverviewTab,
+ telemetry,
+ dispatch,
+ tabType,
+ ]);
const Action = controlColumn.rowCellRender;
diff --git a/x-pack/plugins/security_solution/public/common/components/event_details/event_details.test.tsx b/x-pack/plugins/security_solution/public/common/components/event_details/event_details.test.tsx
index f03e204301d87f..d7e4a92fe5a2a0 100644
--- a/x-pack/plugins/security_solution/public/common/components/event_details/event_details.test.tsx
+++ b/x-pack/plugins/security_solution/public/common/components/event_details/event_details.test.tsx
@@ -57,6 +57,12 @@ jest.mock('../../../detection_engine/rule_management/logic/use_rule_with_fallbac
};
});
+jest.mock('../guided_onboarding_tour/tour_step', () => ({
+ GuidedOnboardingTourStep: jest.fn(({ children }) => (
+
;
+const incrementStep = jest.fn();
+
+const defaultUseTourContextValue = {
+ activeStep: AlertsCasesTourSteps.pointToAlertName,
+ incrementStep,
+ endTourStep: jest.fn(),
+ isTourShown: jest.fn(() => true),
+ hidden: false,
+};
describe('GuidedOnboardingTourStep', () => {
- const incrementStep = jest.fn();
beforeEach(() => {
- (useTourContext as jest.Mock).mockReturnValue({
- activeStep: 1,
- incrementStep,
- isTourShown: () => true,
- });
jest.clearAllMocks();
+ mockUseTourContext.mockReturnValue(defaultUseTourContextValue);
+ useHiddenByFlyoutMock.mockReturnValue(false);
});
it('renders as a tour step', () => {
const { getByTestId } = render(
@@ -57,6 +94,17 @@ describe('GuidedOnboardingTourStep', () => {
expect(tourStep).toBeInTheDocument();
expect(header).toBeInTheDocument();
});
+ it('useHiddenByFlyout equals to true, just render children', () => {
+ useHiddenByFlyoutMock.mockReturnValue(true);
+ const { getByTestId, queryByTestId } = render(
+ {mockChildren},
+ { wrapper: TestProviders }
+ );
+ const tourStep = queryByTestId('tourStepMock');
+ const header = getByTestId('h1');
+ expect(tourStep).not.toBeInTheDocument();
+ expect(header).toBeInTheDocument();
+ });
it('isTourAnchor={false}, just render children', () => {
const { getByTestId, queryByTestId } = render(
@@ -100,19 +148,14 @@ describe('GuidedOnboardingTourStep', () => {
describe('SecurityTourStep', () => {
const { isTourAnchor: _, ...stepDefaultProps } = defaultProps;
beforeEach(() => {
- (useTourContext as jest.Mock).mockReturnValue({
- activeStep: 1,
- incrementStep: jest.fn(),
- isTourShown: () => true,
- });
+ (useTourContext as jest.Mock).mockReturnValue(defaultUseTourContextValue);
jest.clearAllMocks();
});
it('does not render if tour step does not exist', () => {
- (useTourContext as jest.Mock).mockReturnValue({
+ mockUseTourContext.mockReturnValue({
+ ...defaultUseTourContextValue,
activeStep: 99,
- incrementStep: jest.fn(),
- isTourShown: () => true,
});
render(
@@ -134,10 +177,10 @@ describe('SecurityTourStep', () => {
});
it('does not render if security tour step is not shown', () => {
- (useTourContext as jest.Mock).mockReturnValue({
+ mockUseTourContext.mockReturnValue({
+ ...defaultUseTourContextValue,
activeStep: 1,
- incrementStep: jest.fn(),
- isTourShown: () => false,
+ isTourShown: jest.fn(() => false),
});
render({mockChildren}, {
wrapper: TestProviders,
@@ -166,10 +209,9 @@ describe('SecurityTourStep', () => {
});
it('renders next button', () => {
- (useTourContext as jest.Mock).mockReturnValue({
+ mockUseTourContext.mockReturnValue({
+ ...defaultUseTourContextValue,
activeStep: 3,
- incrementStep: jest.fn(),
- isTourShown: () => true,
});
const { getByTestId } = render(
@@ -182,9 +224,8 @@ describe('SecurityTourStep', () => {
it('if a step has an anchor declared, the tour step should be a sibling of the mockChildren', () => {
(useTourContext as jest.Mock).mockReturnValue({
+ ...defaultUseTourContextValue,
activeStep: 3,
- incrementStep: jest.fn(),
- isTourShown: () => true,
});
const { container } = render(
@@ -203,10 +244,9 @@ describe('SecurityTourStep', () => {
});
it('if a step does not an anchor declared, the tour step should be the parent of the mockChildren', () => {
- (useTourContext as jest.Mock).mockReturnValue({
+ mockUseTourContext.mockReturnValue({
+ ...defaultUseTourContextValue,
activeStep: 2,
- incrementStep: jest.fn(),
- isTourShown: () => true,
});
const { container } = render(
@@ -265,9 +305,8 @@ describe('SecurityTourStep', () => {
it('does not render next button if step hideNextButton=true ', () => {
(useTourContext as jest.Mock).mockReturnValue({
+ ...defaultUseTourContextValue,
activeStep: 6,
- incrementStep: jest.fn(),
- isTourShown: () => true,
});
const { queryByTestId } = render(
diff --git a/x-pack/plugins/security_solution/public/common/components/guided_onboarding_tour/tour_step.tsx b/x-pack/plugins/security_solution/public/common/components/guided_onboarding_tour/tour_step.tsx
index 156604160be747..4f3d06eac53d5c 100644
--- a/x-pack/plugins/security_solution/public/common/components/guided_onboarding_tour/tour_step.tsx
+++ b/x-pack/plugins/security_solution/public/common/components/guided_onboarding_tour/tour_step.tsx
@@ -18,6 +18,7 @@ import { timelineDefaults } from '../../../timelines/store/defaults';
import { timelineSelectors } from '../../../timelines/store';
import { useTourContext } from './tour';
import { AlertsCasesTourSteps, SecurityStepId, securityTourConfig } from './tour_config';
+import { useHiddenByFlyout } from './use_hidden_by_flyout';
interface SecurityTourStep {
children?: React.ReactElement;
@@ -37,104 +38,113 @@ const StyledTourStep = styled(EuiTourStep) {
- const { activeStep, incrementStep, isTourShown } = useTourContext();
- const tourStep = useMemo(
- () => securityTourConfig[tourId].find((config) => config.step === step),
- [step, tourId]
- );
-
- const getTimeline = useMemo(() => timelineSelectors.getTimelineByIdSelector(), []);
- const showTimeline = useShallowEqualSelector(
- (state) => (getTimeline(state, TimelineId.active) ?? timelineDefaults).show
- );
-
- const onClickNext = useCallback(
- // onClick should call incrementStep itself
- () => (onClick ? onClick() : incrementStep(tourId)),
- [incrementStep, onClick, tourId]
- );
-
- // EUI bug, will remove once bug resolve. will link issue here as soon as i have it
- const onKeyDown = useCallback((e) => {
- if (e.key === 'Enter') {
- e.stopPropagation();
+export const SecurityTourStep = React.memo(
+ ({ children, onClick, step, tourId }: SecurityTourStep) => {
+ const { activeStep, incrementStep, isTourShown } = useTourContext();
+ const tourStep = useMemo(
+ () => securityTourConfig[tourId].find((config) => config.step === step),
+ [step, tourId]
+ );
+
+ const getTimeline = useMemo(() => timelineSelectors.getTimelineByIdSelector(), []);
+ const showTimeline = useShallowEqualSelector(
+ (state) => (getTimeline(state, TimelineId.active) ?? timelineDefaults).show
+ );
+ const onClickNext = useCallback(
+ // onClick should call incrementStep itself
+ () => (onClick ? onClick() : incrementStep(tourId)),
+ [incrementStep, onClick, tourId]
+ );
+
+ // EUI bug, will remove once bug resolve. will link issue here as soon as i have it
+ const onKeyDown = useCallback((e) => {
+ if (e.key === 'Enter') {
+ e.stopPropagation();
+ }
+ }, []);
+
+ // steps in Cases app are out of context.
+ // If we mount this step, we know we need to render it
+ // we are also managing the context on the siem end in the background
+ const overrideContext = isStepExternallyMounted(tourId, step);
+
+ if (
+ tourStep == null ||
+ ((step !== activeStep || !isTourShown(tourId)) && !overrideContext) ||
+ showTimeline
+ ) {
+ return children ? children : null;
}
- }, []);
-
- // steps in Cases app are out of context.
- // If we mount this step, we know we need to render it
- // we are also managing the context on the siem end in the background
- const overrideContext = isStepExternallyMounted(tourId, step);
-
- if (
- tourStep == null ||
- ((step !== activeStep || !isTourShown(tourId)) && !overrideContext) ||
- showTimeline
- ) {
- return children ? children : null;
- }
- const { anchor, content, imageConfig, dataTestSubj, hideNextButton = false, ...rest } = tourStep;
- const footerAction: EuiTourStepProps['footerAction'] = !hideNextButton ? (
-
-
-
- ) : (
- <>
- {/* Passing empty element instead of undefined. If undefined "Skip tour" button is shown, we do not want that*/}
-
- );
-
- const commonProps = {
- ...rest,
- content: (
+ const {
+ anchor,
+ content,
+ imageConfig,
+ dataTestSubj,
+ hideNextButton = false,
+ ...rest
+ } = tourStep;
+ const footerAction: EuiTourStepProps['footerAction'] = !hideNextButton ? (
+
+
+
+ ) : (
<>
-
-
{content}
-
- {imageConfig && (
- <>
-
-
-
- )}
+ {/* Passing empty element instead of undefined. If undefined "Skip tour" button is shown, we do not want that*/}
- ),
- footerAction,
- // we would not have mounted this component if it was not open
- isStepOpen: true,
- // guided onboarding does not allow skipping tour through the steps
- onFinish: () => null,
- stepsTotal: securityTourConfig[tourId].length,
- panelProps: {
- 'data-test-subj': dataTestSubj,
- },
- };
-
- // tour step either needs children or an anchor element
- // see type EuiTourStepAnchorProps
- return anchor != null ? (
- <>
-
- <>{children}
-
- ) : children != null ? (
-
- {children}
-
- ) : null;
-};
+ );
+
+ const commonProps = {
+ ...rest,
+ content: (
+ <>
+
+
{content}
+
+ {imageConfig && (
+ <>
+
+
+
+ )}
+
+ ),
+ footerAction,
+ // we would not have mounted this component if it was not open
+ isStepOpen: true,
+ // guided onboarding does not allow skipping tour through the steps
+ onFinish: () => null,
+ stepsTotal: securityTourConfig[tourId].length,
+ panelProps: {
+ 'data-test-subj': dataTestSubj,
+ },
+ };
+
+ // tour step either needs children or an anchor element
+ // see type EuiTourStepAnchorProps
+ return anchor != null ? (
+ <>
+
+ <>{children}
+
+ ) : children != null ? (
+
+ {children}
+
+ ) : null;
+ }
+);
+SecurityTourStep.displayName = 'SecurityTourStep';
interface GuidedOnboardingTourStep extends SecurityTourStep {
// can be false if the anchor is an iterative element
@@ -145,11 +155,30 @@ interface GuidedOnboardingTourStep extends SecurityTourStep {
// wraps tour anchor component
// and gives the tour step itself a place to mount once it is active
// mounts the tour step with a delay to ensure the anchor will render first
-export const GuidedOnboardingTourStep = ({
- children,
- // can be false if the anchor is an iterative element
- // do not use this as an "is tour active" check, the SecurityTourStep checks that anyway
- isTourAnchor = true,
- ...props
-}: GuidedOnboardingTourStep) =>
- isTourAnchor ? {children} : <>{children};
+export const GuidedOnboardingTourStep = React.memo(
+ ({
+ children,
+ // can be false if the anchor is an iterative element
+ // do not use this as an "is tour active" check, the SecurityTourStep checks that anyway
+ isTourAnchor = true,
+ ...props
+ }: GuidedOnboardingTourStep) => {
+ return isTourAnchor ? (
+ {children}
+ ) : (
+ <>{children}
+ );
+ }
+);
+GuidedOnboardingTourStep.displayName = 'GuidedOnboardingTourStep';
+
+const SecurityTourStepAnchor = React.memo(({ children, ...props }: SecurityTourStep) => {
+ const { hidden: allStepsHidden } = useTourContext();
+ const hiddenByFlyout = useHiddenByFlyout({ tourId: props.tourId, step: props.step });
+ return !allStepsHidden && !hiddenByFlyout ? (
+ {children}
+ ) : (
+ <>{children}
+ );
+});
+SecurityTourStepAnchor.displayName = 'SecurityTourStepAnchor';
diff --git a/x-pack/plugins/security_solution/public/common/components/guided_onboarding_tour/use_hidden_by_flyout.ts b/x-pack/plugins/security_solution/public/common/components/guided_onboarding_tour/use_hidden_by_flyout.ts
new file mode 100644
index 00000000000000..c0c96be21610f0
--- /dev/null
+++ b/x-pack/plugins/security_solution/public/common/components/guided_onboarding_tour/use_hidden_by_flyout.ts
@@ -0,0 +1,60 @@
+/*
+ * 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 { useMemo } from 'react';
+import { useLocation } from 'react-router-dom';
+import type { RisonValue } from '@kbn/rison';
+import type { AlertsCasesTourSteps } from './tour_config';
+import {
+ hiddenWhenCaseFlyoutExpanded,
+ hiddenWhenLeftExpandableFlyoutExpanded,
+ SecurityStepId,
+} from './tour_config';
+import { useKibana } from '../../lib/kibana';
+import { URL_PARAM_KEY } from '../../hooks/use_url_state';
+import { getObjectFromQueryString } from '../../utils/global_query_string/helpers';
+
+interface UseHiddenByFlyoutProps {
+ tourId: SecurityStepId;
+ step: AlertsCasesTourSteps;
+}
+
+/*
+ ** To check if given Guided tour step should be hidden when the LEFT expandable flyout
+ ** or any case modal is opened
+ */
+export const useHiddenByFlyout = ({ tourId, step }: UseHiddenByFlyoutProps) => {
+ const { useIsAddToCaseOpen } = useKibana().services.cases.hooks;
+ const isAddToCaseOpen = useIsAddToCaseOpen();
+
+ const { search } = useLocation();
+
+ const expandableFlyoutKey = useMemo(
+ () =>
+ getObjectFromQueryString<{ left: RisonValue; right: RisonValue }>(
+ URL_PARAM_KEY.flyout,
+ search
+ ),
+ [search]
+ );
+
+ const isExpandableFlyoutExpanded = expandableFlyoutKey?.left;
+
+ const hiddenWhenExpandableFlyoutOpened = useMemo(
+ () =>
+ isExpandableFlyoutExpanded &&
+ hiddenWhenLeftExpandableFlyoutExpanded[SecurityStepId.alertsCases]?.includes(step),
+ [isExpandableFlyoutExpanded, step]
+ );
+
+ const hiddenWhenCasesModalFlyoutExpanded = useMemo(
+ () => isAddToCaseOpen && hiddenWhenCaseFlyoutExpanded[tourId]?.includes(step),
+ [isAddToCaseOpen, tourId, step]
+ );
+
+ return hiddenWhenExpandableFlyoutOpened || hiddenWhenCasesModalFlyoutExpanded;
+};
diff --git a/x-pack/plugins/security_solution/public/common/components/header_actions/actions.test.tsx b/x-pack/plugins/security_solution/public/common/components/header_actions/actions.test.tsx
index c2f6f8af965f86..9c79d28ce20698 100644
--- a/x-pack/plugins/security_solution/public/common/components/header_actions/actions.test.tsx
+++ b/x-pack/plugins/security_solution/public/common/components/header_actions/actions.test.tsx
@@ -19,7 +19,12 @@ import { SecurityStepId } from '../guided_onboarding_tour/tour_config';
import { Actions } from './actions';
import { initialUserPrivilegesState as mockInitialUserPrivilegesState } from '../user_privileges/user_privileges_context';
import { useUserPrivileges } from '../user_privileges';
+import { useHiddenByFlyout } from '../guided_onboarding_tour/use_hidden_by_flyout';
+const useHiddenByFlyoutMock = useHiddenByFlyout as jest.Mock;
+jest.mock('../guided_onboarding_tour/use_hidden_by_flyout', () => ({
+ useHiddenByFlyout: jest.fn(),
+}));
jest.mock('../guided_onboarding_tour');
jest.mock('../user_privileges');
jest.mock('../../../detections/components/user_info', () => ({
@@ -203,6 +208,19 @@ describe('Actions', () => {
expect(wrapper.find(SecurityTourStep).exists()).toEqual(true);
});
+ test('if left expandable flyout is expanded, SecurityTourStep not active', () => {
+ useHiddenByFlyoutMock.mockReturnValue(true);
+
+ const wrapper = mount(
+
+
+
+ );
+
+ expect(wrapper.find(GuidedOnboardingTourStep).exists()).toEqual(true);
+ expect(wrapper.find(SecurityTourStep).exists()).toEqual(false);
+ });
+
test('on expand event click and SecurityTourStep is active, incrementStep', () => {
const wrapper = mount(
diff --git a/x-pack/plugins/security_solution/public/common/translations.ts b/x-pack/plugins/security_solution/public/common/translations.ts
index 126aa4eabe3b0b..9720baa0d5aa0e 100644
--- a/x-pack/plugins/security_solution/public/common/translations.ts
+++ b/x-pack/plugins/security_solution/public/common/translations.ts
@@ -113,3 +113,17 @@ export const getAgentTypeName = (agentType: ResponseActionAgentType) => {
return agentType;
}
};
+
+export const RULE_EXECUTION_TYPE_BACKFILL = i18n.translate(
+ 'xpack.securitySolution.detectionEngine.executionRunType.backfill',
+ {
+ defaultMessage: 'Manual',
+ }
+);
+
+export const RULE_EXECUTION_TYPE_STANDARD = i18n.translate(
+ 'xpack.securitySolution.detectionEngine.executionRunType.standard',
+ {
+ defaultMessage: 'Scheduled',
+ }
+);
diff --git a/x-pack/plugins/security_solution/public/common/utils/alerts.ts b/x-pack/plugins/security_solution/public/common/utils/alerts.ts
index 031fa556b7ab09..780ab831f8dbb2 100644
--- a/x-pack/plugins/security_solution/public/common/utils/alerts.ts
+++ b/x-pack/plugins/security_solution/public/common/utils/alerts.ts
@@ -9,7 +9,7 @@ import { merge } from '@kbn/std';
import { isPlainObject } from 'lodash';
import type { Ecs } from '@kbn/cases-plugin/common';
import { TableId } from '@kbn/securitysolution-data-table';
-import type { GroupOption } from '@kbn/securitysolution-grouping';
+import type { GroupOption } from '@kbn/grouping';
import * as i18n from './translations';
export const buildAlertsQuery = (alertIds: string[]) => {
diff --git a/x-pack/plugins/security_solution/public/common/utils/global_query_string/helpers.test.tsx b/x-pack/plugins/security_solution/public/common/utils/global_query_string/helpers.test.tsx
new file mode 100644
index 00000000000000..69f1b5fcbf4e05
--- /dev/null
+++ b/x-pack/plugins/security_solution/public/common/utils/global_query_string/helpers.test.tsx
@@ -0,0 +1,127 @@
+/*
+ * 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 {
+ isDetectionsPages,
+ getQueryStringFromLocation,
+ getParamFromQueryString,
+ getObjectFromQueryString,
+ useGetInitialUrlParamValue,
+ encodeQueryString,
+ useReplaceUrlParams,
+ createHistoryEntry,
+} from './helpers';
+import { renderHook } from '@testing-library/react-hooks';
+import { createMemoryHistory } from 'history';
+import { Router } from 'react-router-dom';
+import React from 'react';
+
+const flyoutString =
+ "(left:(id:document-details-left,params:(id:'04cf6ea970ab702721f17755b718c1296b5f8b5fcf7b74b053eab9bc885ceb9c',indexName:.internal.alerts-security.alerts-default-000001,scopeId:alerts-page)),right:(id:document-details-right,params:(id:'04cf6ea970ab702721f17755b718c1296b5f8b5fcf7b74b053eab9bc885ceb9c',indexName:.internal.alerts-security.alerts-default-000001,scopeId:alerts-page)))";
+const testString = `sourcerer=(default:(id:security-solution-default,selectedPatterns:!(.alerts-security.alerts-default)))&timerange=(global:(linkTo:!(),timerange:(from:%272024-05-14T23:00:00.000Z%27,fromStr:now%2Fd,kind:relative,to:%272024-05-15T22:59:59.999Z%27,toStr:now%2Fd)),timeline:(linkTo:!(),timerange:(from:%272024-05-14T09:32:36.347Z%27,kind:absolute,to:%272024-05-15T09:32:36.347Z%27)))&timeline=(activeTab:query,graphEventId:%27%27,isOpen:!f)&pageFilters=!((exclude:!f,existsSelected:!f,fieldName:kibana.alert.workflow_status,hideActionBar:!t,selectedOptions:!(open),title:Status),(exclude:!f,existsSelected:!f,fieldName:kibana.alert.severity,hideActionBar:!t,selectedOptions:!(),title:Severity),(exclude:!f,existsSelected:!f,fieldName:user.name,hideActionBar:!f,selectedOptions:!(),title:User),(exclude:!f,existsSelected:!f,fieldName:host.name,hideActionBar:!f,selectedOptions:!(),title:Host))&flyout=${flyoutString}&timelineFlyout=()`;
+
+const flyoutObject = {
+ left: {
+ id: 'document-details-left',
+ params: {
+ id: '04cf6ea970ab702721f17755b718c1296b5f8b5fcf7b74b053eab9bc885ceb9c',
+ indexName: '.internal.alerts-security.alerts-default-000001',
+ scopeId: 'alerts-page',
+ },
+ },
+ right: {
+ id: 'document-details-right',
+ params: {
+ id: '04cf6ea970ab702721f17755b718c1296b5f8b5fcf7b74b053eab9bc885ceb9c',
+ indexName: '.internal.alerts-security.alerts-default-000001',
+ scopeId: 'alerts-page',
+ },
+ },
+};
+
+describe('helpers', () => {
+ describe('isDetectionsPages', () => {
+ it('returns true for detections pages', () => {
+ expect(isDetectionsPages('alerts')).toBe(true);
+ expect(isDetectionsPages('rules')).toBe(true);
+ expect(isDetectionsPages('rules-add')).toBe(true);
+ expect(isDetectionsPages('rules-create')).toBe(true);
+ expect(isDetectionsPages('exceptions')).toBe(true);
+ });
+
+ it('returns false for non-detections pages', () => {
+ expect(isDetectionsPages('otherPage')).toBe(false);
+ });
+ });
+
+ describe('getQueryStringFromLocation', () => {
+ it('returns the query string without the leading "?"', () => {
+ expect(getQueryStringFromLocation('?param=value')).toBe('param=value');
+ });
+ });
+
+ describe('getParamFromQueryString', () => {
+ it('returns the value of the specified query parameter', () => {
+ expect(getParamFromQueryString(testString, 'flyout')).toBe(flyoutString);
+ });
+
+ it('returns undefined if the query parameter is not found', () => {
+ expect(getParamFromQueryString(testString, 'param')).toBeUndefined();
+ });
+
+ it('returns the first value if the query parameter is an array', () => {
+ const queryString = 'param1=value1¶m1=value2';
+ expect(getParamFromQueryString(queryString, 'param1')).toBe('value1');
+ });
+ });
+
+ describe('getObjectFromQueryString', () => {
+ it('returns the decoded value of the specified query parameter', () => {
+ expect(getObjectFromQueryString('flyout', testString)).toEqual(flyoutObject);
+ });
+
+ it('returns null if the query parameter is not found', () => {
+ expect(getObjectFromQueryString('param', testString)).toBeNull();
+ });
+ });
+
+ describe('useGetInitialUrlParamValue', () => {
+ it('returns a function that gets the initial URL parameter value', () => {
+ window.history.pushState({}, '', `?${testString}`);
+ const { result } = renderHook(() => useGetInitialUrlParamValue('flyout'));
+ expect(result.current()).toEqual(flyoutObject);
+ });
+ });
+
+ describe('encodeQueryString', () => {
+ it('returns an encoded query string from the given parameters', () => {
+ const params = { param1: 'value1', param2: 'value2' };
+ expect(encodeQueryString(params)).toBe('param1=value1¶m2=value2');
+ });
+ });
+
+ describe('useReplaceUrlParams', () => {
+ it('replaces URL parameters correctly', () => {
+ const history = createMemoryHistory();
+ const Wrapper: React.FC<{ children: React.ReactNode }> = ({ children }) => (
+ {children}
+ );
+ const { result } = renderHook(() => useReplaceUrlParams(), { wrapper: Wrapper });
+
+ window.history.pushState({}, '', '?param1=value1');
+ result.current({ param1: 'value2' });
+ expect(history.location.search).toBe('?param1=value2');
+ });
+ });
+
+ describe('createHistoryEntry', () => {
+ it('creates a new history entry', () => {
+ const initialHistoryLength = window.history.length;
+ createHistoryEntry();
+ expect(window.history.length).toBe(initialHistoryLength + 1);
+ });
+ });
+});
diff --git a/x-pack/plugins/security_solution/public/common/utils/global_query_string/helpers.ts b/x-pack/plugins/security_solution/public/common/utils/global_query_string/helpers.ts
index 1be01959e2d0a7..af3cd8161a778e 100644
--- a/x-pack/plugins/security_solution/public/common/utils/global_query_string/helpers.ts
+++ b/x-pack/plugins/security_solution/public/common/utils/global_query_string/helpers.ts
@@ -33,6 +33,17 @@ export const getParamFromQueryString = (
return Array.isArray(queryParam) ? queryParam[0] : queryParam;
};
+export const getObjectFromQueryString = (
+ urlParamKey: string,
+ search?: string
+) => {
+ const rawParamValue = getParamFromQueryString(
+ getQueryStringFromLocation(search ?? window.location.search),
+ urlParamKey
+ );
+ return safeDecode(rawParamValue ?? '') as State | null;
+};
+
/**
*
* Gets the value of the URL param from the query string.
@@ -44,15 +55,10 @@ export const useGetInitialUrlParamValue = (
): (() => State | null) => {
// window.location.search provides the most updated representation of the url search.
// It also guarantees that we don't overwrite URL param managed outside react-router.
- const getInitialUrlParamValue = useCallback((): State | null => {
- const rawParamValue = getParamFromQueryString(
- getQueryStringFromLocation(window.location.search),
- urlParamKey
- );
- const paramValue = safeDecode(rawParamValue ?? '') as State | null;
-
- return paramValue;
- }, [urlParamKey]);
+ const getInitialUrlParamValue = useCallback(
+ (): State | null => getObjectFromQueryString(urlParamKey),
+ [urlParamKey]
+ );
return getInitialUrlParamValue;
};
diff --git a/x-pack/plugins/security_solution/public/detection_engine/rule_details_ui/pages/rule_details/__mocks__/rule_details_context.tsx b/x-pack/plugins/security_solution/public/detection_engine/rule_details_ui/pages/rule_details/__mocks__/rule_details_context.tsx
index a853e8f1422c79..45e84fcd24db93 100644
--- a/x-pack/plugins/security_solution/public/detection_engine/rule_details_ui/pages/rule_details/__mocks__/rule_details_context.tsx
+++ b/x-pack/plugins/security_solution/public/detection_engine/rule_details_ui/pages/rule_details/__mocks__/rule_details_context.tsx
@@ -31,6 +31,8 @@ export const useRuleDetailsContextMock = {
sortField: 'timestamp',
sortDirection: 'desc',
},
+ runTypeFilters: [],
+ showSourceEventTimeRange: true,
},
actions: {
setEnd: jest.fn(),
@@ -45,6 +47,8 @@ export const useRuleDetailsContextMock = {
setSortField: jest.fn(),
setStart: jest.fn(),
setStatusFilters: jest.fn(),
+ setRunTypeFilters: jest.fn(),
+ setShowSourceEventTimeRange: jest.fn(),
},
},
}),
diff --git a/x-pack/plugins/security_solution/public/detection_engine/rule_details_ui/pages/rule_details/execution_log_table/__snapshots__/execution_log_search_bar.test.tsx.snap b/x-pack/plugins/security_solution/public/detection_engine/rule_details_ui/pages/rule_details/execution_log_table/__snapshots__/execution_log_search_bar.test.tsx.snap
index 241f363d4885f4..009e6dcc58acee 100644
--- a/x-pack/plugins/security_solution/public/detection_engine/rule_details_ui/pages/rule_details/execution_log_table/__snapshots__/execution_log_search_bar.test.tsx.snap
+++ b/x-pack/plugins/security_solution/public/detection_engine/rule_details_ui/pages/rule_details/execution_log_table/__snapshots__/execution_log_search_bar.test.tsx.snap
@@ -10,17 +10,25 @@ exports[`ExecutionLogSearchBar snapshots renders correctly against snapshot 1`]
-
+
+
+
+
+
`;
diff --git a/x-pack/plugins/security_solution/public/detection_engine/rule_details_ui/pages/rule_details/execution_log_table/execution_log_columns.tsx b/x-pack/plugins/security_solution/public/detection_engine/rule_details_ui/pages/rule_details/execution_log_table/execution_log_columns.tsx
index c8bacabbbbc4f5..4428d6cca6de6b 100644
--- a/x-pack/plugins/security_solution/public/detection_engine/rule_details_ui/pages/rule_details/execution_log_table/execution_log_columns.tsx
+++ b/x-pack/plugins/security_solution/public/detection_engine/rule_details_ui/pages/rule_details/execution_log_table/execution_log_columns.tsx
@@ -25,6 +25,10 @@ import type {
import { getEmptyValue } from '../../../../../common/components/empty_value';
import { FormattedDate } from '../../../../../common/components/formatted_date';
+import {
+ RULE_EXECUTION_TYPE_BACKFILL,
+ RULE_EXECUTION_TYPE_STANDARD,
+} from '../../../../../common/translations';
import { ExecutionStatusIndicator } from '../../../../rule_monitoring';
import { PopoverTooltip } from '../../../../rule_management_ui/components/rules_table/popover_tooltip';
import { TableHeaderTooltipCell } from '../../../../rule_management_ui/components/rules_table/table_header_tooltip_cell';
@@ -79,6 +83,19 @@ export const EXECUTION_LOG_COLUMNS: Array {
+ return (
+
+ {record.backfill ? RULE_EXECUTION_TYPE_BACKFILL : RULE_EXECUTION_TYPE_STANDARD}
+
+ );
+ },
+ },
{
field: 'timestamp',
name: (
@@ -139,6 +156,34 @@ export const getMessageColumn = (width: string) => ({
width,
});
+export const getSourceEventTimeRangeColumns = () => [
+ {
+ name: (
+
+ ),
+ field: 'backfill',
+ render: (backfill: { to: string; from: string }) => {
+ return backfill ? (
+