[RAM] Add shareable rule status filter #130705

JiaweiWu · 2022-04-20T16:56:07Z

Summary

Adds a shareable rule status filter, this is a new component that does not exist as a part of the rule list. Therefore, it is not being used, expect as a shareable component.

Also renames the existing rule_status_filter to rule_execution_status_filter.

…-fix'

mgiota · 2022-04-20T18:18:47Z

.../triggers_actions_ui/public/application/sections/rules_list/components/rule_state_filter.tsx

+import { FormattedMessage } from '@kbn/i18n-react';
+import { EuiFilterButton, EuiPopover, EuiFilterGroup, EuiFilterSelectItem } from '@elastic/eui';
+
+type State = 'enabled' | 'muted' | 'disabled';


@JiaweiWu I know this PR is still a draft, but I would like to give an input at this stage. It should be snoozed instead of muted

mgiota · 2022-04-20T18:20:11Z

x-pack/plugins/triggers_actions_ui/public/plugin.ts

@@ -75,6 +77,7 @@ export interface TriggersAndActionsUIPublicPluginStart {
  ) => ReactElement<RuleEditProps>;
  getAlertsTable: (props: AlertsTableProps) => ReactElement<AlertsTableProps>;
  getRuleStatusDropdown: (props: RuleStatusDropdownProps) => ReactElement<RuleStatusDropdownProps>;
+  getRuleStateFilter: (props: RuleStateFilterProps) => ReactElement<RuleStateFilterProps>;


@JiaweiWu Do you think we should call it getRuleStatusFilter instead?

mgiota · 2022-04-20T18:48:26Z

@JiaweiWu As we discussed for the status filter to work, we need some API changes as well, since we are currently using loadRules from triggers_actions_ui plugin https://github.com/elastic/kibana/blob/main/x-pack/plugins/observability/public/hooks/use_fetch_rules.ts#L10.

That being said I expect some changes in this function call https://github.com/elastic/kibana/blob/main/x-pack/plugins/triggers_actions_ui/public/application/lib/rule_api/rules.ts#L40, where we need to pass the new statusFilter along with the rest filters that are currently being passed. This means that this file https://github.com/elastic/kibana/blob/main/x-pack/plugins/triggers_actions_ui/public/application/lib/rule_api/map_filters_to_kql.ts needs to be changed as well.

JiaweiWu · 2022-04-26T04:27:19Z

@elasticmachine merge upstream

JiaweiWu · 2022-04-26T06:29:16Z

@mgiota I added changes to the loadRules so feel free to test it. As for renaming to status, I will have a discussion with the team because we already have a component called rule_status_filter.

JiaweiWu · 2022-04-26T20:24:29Z

@elasticmachine merge upstream

elasticmachine · 2022-04-28T23:09:37Z

Pinging @elastic/response-ops (Team:ResponseOps)

kibana-ci · 2022-04-28T23:25:43Z

💔 Build Failed

Failed CI Steps

Test Failures

[job] [logs] Default CI Group #6 / Discover alerting Search source Alert should navigate to discover via view in app link
[job] [logs] Default CI Group #6 / Discover alerting Search source Alert should navigate to discover via view in app link
[job] [logs] Jest Tests #2 / execution duration overview render last execution status
[job] [logs] Jest Tests #2 / execution duration overview renders average execution duration
[job] [logs] Jest Tests #2 / execution duration overview renders execution duration chart
[job] [logs] Jest Tests #2 / execution duration overview renders warning when average execution duration exceeds rule timeout
[job] [logs] Jest Tests #2 / rules render a hidden field with duration epoch
[job] [logs] Jest Tests #2 / rules render a list of rules
[job] [logs] Jest Tests #2 / rules render all active rules
[job] [logs] Jest Tests #2 / rules render all inactive rules
[job] [logs] Jest Tests #2 / tabbed content tabbed content renders when the event log experiment is on

Metrics [docs]

Module Count

Fewer modules leads to a faster build time

id	before	after	diff
`triggersActionsUi`	370	373	+3

Public APIs missing comments

Total count of every public API that lacks a comment. Target amount is 0. Run node scripts/build_api_docs --plugin [yourplugin] --stats comments for more detailed information.

id	before	after	diff
`triggersActionsUi`	310	313	+3

Async chunks

Total size of all lazy-loaded chunks that will be downloaded as the user navigates the app

id	before	after	diff
`observability`	428.0KB	428.0KB	+9.0B
`triggersActionsUi`	724.4KB	727.5KB	+3.2KB
total			+3.2KB

Public APIs missing exports

Total count of every type that is part of your API that should be exported but is not. This will cause broken links in the API documentation system. Target amount is 0. Run node scripts/build_api_docs --plugin [yourplugin] --stats exports for more detailed information.

id	before	after	diff
`triggersActionsUi`	26	28	+2

Page load bundle

Size of the bundles that are downloaded on every page load. Target size is below 100kb

id	before	after	diff
`triggersActionsUi`	99.7KB	100.5KB	+783.0B

Unknown metric groups

API count

id	before	after	diff
`triggersActionsUi`	324	327	+3

async chunk count

id	before	after	diff
`triggersActionsUi`	79	80	+1

ESLint disabled in files

id	before	after	diff
`apm`	15	14	-1
`securitySolution`	69	68	-1
`synthetics`	7	6	-1
total			-3

ESLint disabled line counts

id	before	after	diff
`apm`	92	89	-3
`enterpriseSearch`	9	7	-2
`synthetics`	53	47	-6
`triggersActionsUi`	170	171	+1
total			-10

Total ESLint disabled count

id	before	after	diff
`apm`	107	103	-4
`enterpriseSearch`	9	7	-2
`securitySolution`	511	510	-1
`synthetics`	60	53	-7
`triggersActionsUi`	176	177	+1
total			-13

History

💔 Build #40700 failed 6f1b580
💔 Build #40425 failed b42c959
💚 Build #40414 succeeded 2e6ded4
💔 Build #39555 failed 31aa11b

To update your PR or re-run it, just comment with:
@elasticmachine merge upstream

mgiota · 2022-04-29T09:04:15Z

@JiaweiWu I just checked out your branch locally and Stack Management rules page is currently broken.

It is most probably related to the refactoring you did to the executionStatus.

I will try to use now the shared component in Observability and will give update you on this.

mgiota · 2022-04-29T09:41:53Z

@JiaweiWu I confirm that getRuleStatusFilter works fine in Observability

I just had to make one small change in triggers_actions_ui plugin to make it work. I will leave a comment inline to export RuleStatus

mgiota · 2022-04-29T09:43:57Z

...plugins/triggers_actions_ui/public/application/sections/rules_list/components/rules_list.tsx

@@ -58,6 +58,7 @@ import {
  RuleTableItem,
  RuleType,
  RuleTypeIndex,
+  RuleStatus,


Could you export RuleStatus here https://github.com/elastic/kibana/blob/main/x-pack/plugins/triggers_actions_ui/public/index.ts#L15, so that we don't have to redefine the same type in observability?

mgiota · 2022-04-29T09:47:47Z

...plugins/triggers_actions_ui/public/application/sections/rules_list/components/rules_list.tsx

@@ -163,6 +167,8 @@ export const RulesList: React.FunctionComponent = () => {
  );
  const [showErrors, setShowErrors] = useState(false);

+  const isRuleStatusFilterEnabled = getIsExperimentalFeatureEnabled('ruleStatusFilter');


@JiaweiWu Should we also check in observability if the experimental feature is enabled? In this case, could you export getIsExperimentalFeatureEnabled in this file, so that we can reuse it?

oh no, you shouldn't need to check the experiment in o11y.

I'm doing it here because this is a new filter for the rules list and we don't want to expose it to the user yet (until we get design feedback). So the experiment hides it for the triggers actions UI rules list.

Ok I see, thanks for clarifying!

mgiota · 2022-04-29T09:51:39Z

x-pack/plugins/triggers_actions_ui/public/application/lib/rule_api/aggregate.ts

 }): Promise<RuleAggregations> {
-  const filters = mapFiltersToKql({ typesFilter, actionTypesFilter, ruleStatusesFilter });


@JiaweiWu Out of curiosity I was wondering why the new ruleStatusesFilter is not included here. Is it because the options of the rule status filter is a static hardcoded list (enabled, disabled, snoozed)?

do we want to filter the aggregate results as well? I suppose we do, I can add it

mgiota

LGTM!

chrisronline

LGTM! One comment about adding a test

chrisronline · 2022-05-02T16:32:47Z

x-pack/plugins/triggers_actions_ui/public/application/lib/rule_api/map_filters_to_kql.test.ts

      })
    ).toEqual(['alert.attributes.executionStatus.status:(alert or statuses or filter)']);
  });

+  test('should handle ruleStatusesFilter', () => {
+    expect(


should we add a test for just disabled too?

yep, good idea!

JiaweiWu · 2022-05-03T20:57:02Z

@elasticmachine merge upstream

kibana-ci · 2022-05-03T22:02:50Z

💛 Build succeeded, but was flaky

Test Failures

[job] [logs] Default CI Group #4 / Snapshots app Home page Repositories Tab cleanup repository

Metrics [docs]

Module Count

Fewer modules leads to a faster build time

id	before	after	diff
`triggersActionsUi`	370	373	+3

Public APIs missing comments

Total count of every public API that lacks a comment. Target amount is 0. Run node scripts/build_api_docs --plugin [yourplugin] --stats comments for more detailed information.

id	before	after	diff
`triggersActionsUi`	311	316	+5

Async chunks

Total size of all lazy-loaded chunks that will be downloaded as the user navigates the app

id	before	after	diff
`observability`	440.3KB	440.3KB	+9.0B
`triggersActionsUi`	724.3KB	727.7KB	+3.4KB
total			+3.4KB

Public APIs missing exports

Total count of every type that is part of your API that should be exported but is not. This will cause broken links in the API documentation system. Target amount is 0. Run node scripts/build_api_docs --plugin [yourplugin] --stats exports for more detailed information.

id	before	after	diff
`triggersActionsUi`	26	27	+1

Page load bundle

Size of the bundles that are downloaded on every page load. Target size is below 100kb

id	before	after	diff
`triggersActionsUi`	99.7KB	100.5KB	+825.0B

Unknown metric groups

API count

id	before	after	diff
`triggersActionsUi`	325	330	+5

async chunk count

id	before	after	diff
`triggersActionsUi`	79	80	+1

ESLint disabled line counts

id	before	after	diff
`triggersActionsUi`	170	171	+1

Total ESLint disabled count

id	before	after	diff
`triggersActionsUi`	176	177	+1

History

💚 Build #41584 succeeded 1084bbb
💔 Build #41552 failed 82170a2
💔 Build #41335 failed be1505c
💔 Build #40700 failed 6f1b580
💔 Build #40425 failed b42c959
💚 Build #40414 succeeded 2e6ded4

To update your PR or re-run it, just comment with:
@elasticmachine merge upstream

* rule state filter * turn off experiment * [CI] Auto-commit changed files from 'node scripts/eslint --no-cache --fix' * Status filter API call * Fix tests * rename state to status, added tests * Address comments and fix tests * Revert experiment flag * Remove unused translations * Addressed comments Co-authored-by: kibanamachine <[email protected]>

* Add severity field to create API and migration * Adds integration test for severity field migration * remove exclusive test * Change severity levels * Update integration tests for post case * Add more integration tests * Fix all cases list test * Fix some server test * Fix util server test * Fix client util test * Convert event log's duration from number to string in Kibana (keep as "long" in Elasticsearch) (#130819) * Convert event.duration to string in TypeScript, keep as long in Elasticsearch * Fix jest test * Fix functional tests * Add ecsStringOrNumber to event log schema * Fix jest test * Add utility functions to event log plugin * Use new event log utility functions * PR fixes Co-authored-by: Kibana Machine <[email protected]> * filter o11y rule aggregations (#131301) * [Cloud Posture] Display and save rules per benchmark (#131412) * Adding aria-label for discover data grid select document checkbox (#131277) * Update API docs (#130999) Co-authored-by: Kibana Machine <[email protected]> * [CI] Use GCS buckets for bazel remote caching (#131345) * [Actionable Observability] Add license modal to rules table (#131232) * Add fix license link * fix localization * fix CI error * fix more translation issues Co-authored-by: Kibana Machine <[email protected]> * [RAM] Add shareable rule status filter (#130705) * rule state filter * turn off experiment * [CI] Auto-commit changed files from 'node scripts/eslint --no-cache --fix' * Status filter API call * Fix tests * rename state to status, added tests * Address comments and fix tests * Revert experiment flag * Remove unused translations * Addressed comments Co-authored-by: kibanamachine <[email protected]> * [storybook] Watch for changes in packages (#131467) * [storybook] Watch for changes in packages * Update default_config.ts * Improve saved objects migrations failure errors and logs (#131359) * [Unified observability] Add tour step to guided setup (#131149) * [Lens] Improved interval input (#131372) * [Vega] Adjust vega doc for usage of ems files (#130948) * adjust vega doc * Update docs/user/dashboard/vega-reference.asciidoc Co-authored-by: Nick Peihl <[email protected]> * Update docs/user/dashboard/vega-reference.asciidoc Co-authored-by: Nick Peihl <[email protected]> * Update docs/user/dashboard/vega-reference.asciidoc Co-authored-by: Nick Peihl <[email protected]> * Update docs/user/dashboard/vega-reference.asciidoc Co-authored-by: Nick Peihl <[email protected]> * Update docs/user/dashboard/vega-reference.asciidoc Co-authored-by: Nick Peihl <[email protected]> Co-authored-by: Kibana Machine <[email protected]> Co-authored-by: Nick Peihl <[email protected]> * Excess intersections * Create severity user action * Add severity to create_case user action * Fix and add integration tests * Minor improvements Co-authored-by: Mike Côté <[email protected]> Co-authored-by: Kibana Machine <[email protected]> Co-authored-by: mgiota <[email protected]> Co-authored-by: Jordan <[email protected]> Co-authored-by: Bhavya RM <[email protected]> Co-authored-by: Thomas Neirynck <[email protected]> Co-authored-by: Brian Seeders <[email protected]> Co-authored-by: Jiawei Wu <[email protected]> Co-authored-by: Clint Andrew Hall <[email protected]> Co-authored-by: Christiane (Tina) Heiligers <[email protected]> Co-authored-by: Alejandro Fernández Gómez <[email protected]> Co-authored-by: Joe Reuter <[email protected]> Co-authored-by: Nick Peihl <[email protected]> Co-authored-by: Christos Nasikas <[email protected]>

* rule state filter * turn off experiment * [CI] Auto-commit changed files from 'node scripts/eslint --no-cache --fix' * Status filter API call * Fix tests * rename state to status, added tests * Address comments and fix tests * Revert experiment flag * Remove unused translations * Addressed comments Co-authored-by: kibanamachine <[email protected]>

* Add severity field to create API and migration * Adds integration test for severity field migration * remove exclusive test * Change severity levels * Update integration tests for post case * Add more integration tests * Fix all cases list test * Fix some server test * Fix util server test * Fix client util test * Convert event log's duration from number to string in Kibana (keep as "long" in Elasticsearch) (elastic#130819) * Convert event.duration to string in TypeScript, keep as long in Elasticsearch * Fix jest test * Fix functional tests * Add ecsStringOrNumber to event log schema * Fix jest test * Add utility functions to event log plugin * Use new event log utility functions * PR fixes Co-authored-by: Kibana Machine <[email protected]> * filter o11y rule aggregations (elastic#131301) * [Cloud Posture] Display and save rules per benchmark (elastic#131412) * Adding aria-label for discover data grid select document checkbox (elastic#131277) * Update API docs (elastic#130999) Co-authored-by: Kibana Machine <[email protected]> * [CI] Use GCS buckets for bazel remote caching (elastic#131345) * [Actionable Observability] Add license modal to rules table (elastic#131232) * Add fix license link * fix localization * fix CI error * fix more translation issues Co-authored-by: Kibana Machine <[email protected]> * [RAM] Add shareable rule status filter (elastic#130705) * rule state filter * turn off experiment * [CI] Auto-commit changed files from 'node scripts/eslint --no-cache --fix' * Status filter API call * Fix tests * rename state to status, added tests * Address comments and fix tests * Revert experiment flag * Remove unused translations * Addressed comments Co-authored-by: kibanamachine <[email protected]> * [storybook] Watch for changes in packages (elastic#131467) * [storybook] Watch for changes in packages * Update default_config.ts * Improve saved objects migrations failure errors and logs (elastic#131359) * [Unified observability] Add tour step to guided setup (elastic#131149) * [Lens] Improved interval input (elastic#131372) * [Vega] Adjust vega doc for usage of ems files (elastic#130948) * adjust vega doc * Update docs/user/dashboard/vega-reference.asciidoc Co-authored-by: Nick Peihl <[email protected]> * Update docs/user/dashboard/vega-reference.asciidoc Co-authored-by: Nick Peihl <[email protected]> * Update docs/user/dashboard/vega-reference.asciidoc Co-authored-by: Nick Peihl <[email protected]> * Update docs/user/dashboard/vega-reference.asciidoc Co-authored-by: Nick Peihl <[email protected]> * Update docs/user/dashboard/vega-reference.asciidoc Co-authored-by: Nick Peihl <[email protected]> Co-authored-by: Kibana Machine <[email protected]> Co-authored-by: Nick Peihl <[email protected]> * Excess intersections * Create severity user action * Add severity to create_case user action * Fix and add integration tests * Minor improvements Co-authored-by: Mike Côté <[email protected]> Co-authored-by: Kibana Machine <[email protected]> Co-authored-by: mgiota <[email protected]> Co-authored-by: Jordan <[email protected]> Co-authored-by: Bhavya RM <[email protected]> Co-authored-by: Thomas Neirynck <[email protected]> Co-authored-by: Brian Seeders <[email protected]> Co-authored-by: Jiawei Wu <[email protected]> Co-authored-by: Clint Andrew Hall <[email protected]> Co-authored-by: Christiane (Tina) Heiligers <[email protected]> Co-authored-by: Alejandro Fernández Gómez <[email protected]> Co-authored-by: Joe Reuter <[email protected]> Co-authored-by: Nick Peihl <[email protected]> Co-authored-by: Christos Nasikas <[email protected]>

JiaweiWu added 2 commits April 20, 2022 09:51

rule state filter

b337f96

turn off experiment

0576f50

[CI] Auto-commit changed files from 'node scripts/eslint --no-cache -…

31aa11b

…-fix'

mgiota reviewed Apr 20, 2022

View reviewed changes

kibanamachine and others added 2 commits April 25, 2022 23:27

Merge branch 'main' into issue-130160-state-filter

2e6ded4

Status filter API call

b42c959

Fix tests

10ece1c

kibanamachine and others added 2 commits April 26, 2022 15:24

Merge branch 'main' into issue-130160-state-filter

6f1b580

rename state to status, added tests

c18a582

JiaweiWu changed the title ~~[RAM] Add shareable rule state filter~~ [RAM] Add shareable rule status filter Apr 28, 2022

merge conflicts

be1505c

JiaweiWu marked this pull request as ready for review April 28, 2022 23:09

JiaweiWu requested a review from a team as a code owner April 28, 2022 23:09

mgiota requested changes Apr 29, 2022

View reviewed changes

mgiota reviewed Apr 29, 2022

View reviewed changes

mgiota mentioned this pull request Apr 29, 2022

[Actionable Observability] consume shareable status filter #131219

Merged

JiaweiWu added 2 commits April 29, 2022 11:04

Address comments and fix tests

6882021

Revert experiment flag

82170a2

mgiota self-requested a review April 29, 2022 18:12

mgiota approved these changes Apr 29, 2022

View reviewed changes

Remove unused translations

1084bbb

This was referenced May 1, 2022

[Actionable Observability] [Rules page] Sync Status filtering with urlbar #131302

Closed

Provide filtering in Rules view to get to muted / disabled / error rules #119102

Closed

Link to filtered view from Alerts summary counts #130985

Closed

chrisronline approved these changes May 2, 2022

View reviewed changes

Addressed comments

c59e3d8

Merge branch 'main' into issue-130160-state-filter

0be9814

JiaweiWu merged commit 07985db into elastic:main May 3, 2022

spalger mentioned this pull request May 4, 2022

Failing test: Chrome X-Pack UI Functional Tests.x-pack/test/functional_with_es_ssl/apps/triggers_actions_ui/alerts_list·ts - Actions and Triggers app rules list should filter alerts by the rule status #131535

Closed

Zacqary mentioned this pull request May 10, 2022

[RAM] Add data model for scheduled and recurring snoozes #131019

Merged

1 task

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[RAM] Add shareable rule status filter #130705

[RAM] Add shareable rule status filter #130705

JiaweiWu commented Apr 20, 2022 •

edited

Loading

mgiota Apr 20, 2022

mgiota Apr 20, 2022

mgiota commented Apr 20, 2022

JiaweiWu commented Apr 26, 2022

JiaweiWu commented Apr 26, 2022

JiaweiWu commented Apr 26, 2022

elasticmachine commented Apr 28, 2022

kibana-ci commented Apr 28, 2022 •

edited

Loading

API count

async chunk count

ESLint disabled in files

ESLint disabled line counts

Total ESLint disabled count

mgiota commented Apr 29, 2022

mgiota commented Apr 29, 2022

mgiota Apr 29, 2022 •

edited

Loading

mgiota Apr 29, 2022

JiaweiWu Apr 29, 2022

mgiota Apr 29, 2022

mgiota Apr 29, 2022 •

edited

Loading

JiaweiWu Apr 29, 2022

mgiota left a comment

chrisronline left a comment

chrisronline May 2, 2022

JiaweiWu May 3, 2022

JiaweiWu commented May 3, 2022

kibana-ci commented May 3, 2022

API count

async chunk count

ESLint disabled line counts

Total ESLint disabled count

		}): Promise<RuleAggregations> {
		const filters = mapFiltersToKql({ typesFilter, actionTypesFilter, ruleStatusesFilter });

[RAM] Add shareable rule status filter #130705

[RAM] Add shareable rule status filter #130705

Conversation

JiaweiWu commented Apr 20, 2022 • edited Loading

Summary

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mgiota commented Apr 20, 2022

JiaweiWu commented Apr 26, 2022

JiaweiWu commented Apr 26, 2022

JiaweiWu commented Apr 26, 2022

elasticmachine commented Apr 28, 2022

kibana-ci commented Apr 28, 2022 • edited Loading

💔 Build Failed

Failed CI Steps

Test Failures

Metrics [docs]

Module Count

Public APIs missing comments

Async chunks

Public APIs missing exports

Page load bundle

API count

async chunk count

ESLint disabled in files

ESLint disabled line counts

Total ESLint disabled count

History

mgiota commented Apr 29, 2022

mgiota commented Apr 29, 2022

mgiota Apr 29, 2022 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mgiota Apr 29, 2022 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mgiota left a comment

Choose a reason for hiding this comment

chrisronline left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

JiaweiWu commented May 3, 2022

kibana-ci commented May 3, 2022

💛 Build succeeded, but was flaky

Test Failures

Metrics [docs]

Module Count

Public APIs missing comments

Async chunks

Public APIs missing exports

Page load bundle

API count

async chunk count

ESLint disabled line counts

Total ESLint disabled count

History

JiaweiWu commented Apr 20, 2022 •

edited

Loading

kibana-ci commented Apr 28, 2022 •

edited

Loading

mgiota Apr 29, 2022 •

edited

Loading

mgiota Apr 29, 2022 •

edited

Loading