[RAC] Replace usages of kibana.alert.status: open with active #109033

marshallmain · 2021-08-18T02:48:09Z

Summary

Addresses #108607
Per the schema, kibana.alert.status is to be populated with active or recovered. A few places were using open and closed instead, which are the values for kibana.alert.workflow_status. This PR replaces those usages with the correct values.

Checklist

Delete any items that are not applicable to this PR.

Any text added follows EUI's writing guidelines, uses sentence case text and includes i18n support
Documentation was added for features that require explanation or tutorials
Unit or functional tests were updated or added to match the most common scenarios
Any UI touched in this PR is usable by keyboard only (learn more about keyboard accessibility)
Any UI touched in this PR does not create any new axe failures (run axe in browser: FF, Chrome)
If a plugin configuration key changed, check if it needs to be allowlisted in the cloud and added to the docker list
This renders correctly on smaller devices using a responsive layout. (You can test this in your browser)
This was checked for cross-browser compatibility

Risk Matrix

Delete this section if it is not applicable to this PR.

Before closing this PR, invite QA, stakeholders, and other developers to identify risks that should be tested prior to the change/feature release.

When forming the risk matrix, consider some of the following examples and how they may potentially impact the change:

Risk	Probability	Severity	Mitigation/Notes
Multiple Spaces—unexpected behavior in non-default Kibana Space.	Low	High	Integration tests will verify that all features are still supported in non-default Kibana Space and when user switches between spaces.
Multiple nodes—Elasticsearch polling might have race conditions when multiple Kibana nodes are polling for the same tasks.	High	Low	Tasks are idempotent, so executing them multiple times will not result in logical error, but will degrade performance. To test for this case we add plenty of unit tests around this logic and document manual testing procedure.
Code should gracefully handle cases when feature X or plugin Y are disabled.	Medium	High	Unit tests will verify that any feature flag or plugin combination still results in our service operational.
See more potential risk examples

For maintainers

This was checked for breaking API changes and was labeled appropriately

elasticmachine · 2021-08-18T23:58:48Z

Pinging @elastic/security-solution (Team: SecuritySolution)

elasticmachine · 2021-08-18T23:58:48Z

Pinging @elastic/security-detections-response (Team:Detections and Resp)

elasticmachine · 2021-08-19T05:10:29Z

Pinging @elastic/uptime (Team:uptime)

elasticmachine · 2021-08-19T05:10:29Z

Pinging @elastic/apm-ui (Team:apm)

smith

APM changes look good

justinkambic

LGTM

marshallmain · 2021-08-20T21:15:55Z

@elasticmachine merge upstream

marshallmain · 2021-08-23T15:06:45Z

@elasticmachine merge upstream

mgiota · 2021-08-24T19:47:42Z

@marshallmain We also replace usages of kibana.alert.status: open with active in this PR #108679. Your PR is missing some changes for the Observability alerts page 9142be5.

Could you review our open PR again? Failing tests are fixed and PR is ready for review.

marshallmain · 2021-08-24T20:04:56Z

@mgiota thanks for the heads up, I'll review that PR now! For this PR, I'll wait until #108679 is merged since there's some overlap and then make another pass through the code base to make sure this PR catches the remaining places where ALERT_STATUS has unexpected values.

…ibana into update-alert-status-usage

kibanamachine · 2021-08-26T18:31:04Z

💚 Build Succeeded

Metrics [docs]

Async chunks

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

id	before	after	diff
`securitySolution`	6.5MB	6.5MB	+54.0B

Page load bundle

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

id	before	after	diff
`uptime`	36.7KB	36.8KB	+50.0B

History

💚 Build #147802 succeeded 477c7c4
💚 Build #147534 succeeded 3d0b71c
💚 Build #147519 succeeded 902ff37
💔 Build #147171 failed 35b18e5
💔 Build #147140 failed 736b94b

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

spong · 2021-08-26T19:26:51Z

x-pack/plugins/rule_registry/README.md

@@ -129,12 +132,11 @@ The following fields are defined in the technical field component template and s
 - `kibana.alert.rule.consumer`: the feature which produced the alert (inherited from the rule producer field). Usually a Kibana feature id like `apm`, `siem`...
 - `kibana.alert.id`: the id of the alert, that is unique within the context of the rule execution it was created in. E.g., for a rule that monitors latency for all services in all environments, this might be `opbeans-java:production`.
 - `kibana.alert.uuid`: the unique identifier for the alert during its lifespan. If an alert recovers (or closes), this identifier is re-generated when it is opened again.
- `kibana.alert.status`: the status of the alert. Can be `open` or `closed`.
+- `kibana.alert.status`: the status of the alert. Can be `active` or `recovered`.


Should we have an entry for kibana.alert.workflow_status as well?

Yeah, the readme is pretty out of date so I'm planning to update the rest of it in a follow up PR

spong

Checked out, tested locally, reviewed code, and all LGTM! 👍 🚀

One note, in testing it was discovered that if you have the xpack.securitySolution.signalsIndex kibana.yml configuration set, the Alerts table bsearch will still query the specified .siem-signals index instead of the AAD index, and can result in no documents being displays. This configuration isn't officially supported, but wanted to note the behavior. The histogram and counts table continues to use the find API and returns data though. cc @XavierM

…c#109033) * Replace usages of alert.status: open with active * Update unit tests * Add back home.disableWelcomeScreen=true * Only disable welcome screen within APM ftr config * Add disableWelcomeScreen option to security solution cypress config * Fix reference to workflow status * oops * Remove duplicate disableWelcomeScreen * Update README.md Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>

kibanamachine · 2021-08-26T23:01:54Z

💚 Backport successful

Status	Branch	Result
✅	7.15
✅	7.x

The backport PRs will be merged automatically after passing CI.

…c#109033) * Replace usages of alert.status: open with active * Update unit tests * Add back home.disableWelcomeScreen=true * Only disable welcome screen within APM ftr config * Add disableWelcomeScreen option to security solution cypress config * Fix reference to workflow status * oops * Remove duplicate disableWelcomeScreen * Update README.md Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>

…109033) (#110384) * [RAC] Replace usages of kibana.alert.status: open with active (#109033) * Replace usages of alert.status: open with active * Update unit tests * Add back home.disableWelcomeScreen=true * Only disable welcome screen within APM ftr config * Add disableWelcomeScreen option to security solution cypress config * Fix reference to workflow status * oops * Remove duplicate disableWelcomeScreen * Update README.md Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com> * Fix remaining reference to ALERT_STATUS Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>

…109033) (#110383) * [RAC] Replace usages of kibana.alert.status: open with active (#109033) * Replace usages of alert.status: open with active * Update unit tests * Add back home.disableWelcomeScreen=true * Only disable welcome screen within APM ftr config * Add disableWelcomeScreen option to security solution cypress config * Fix reference to workflow status * oops * Remove duplicate disableWelcomeScreen * Update README.md Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com> * Fix remaining reference to ALERT_STATUS Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>

Replace usages of alert.status: open with active

c08c054

marshallmain changed the title ~~Replace usages of alert.status: open with active~~ [RAC] Replace usages of alert.status: open with active Aug 18, 2021

marshallmain changed the title ~~[RAC] Replace usages of alert.status: open with active~~ [RAC] Replace usages of kibana.alert.status: open with active Aug 18, 2021

marshallmain and others added 8 commits August 17, 2021 22:05

Update unit tests

080010d

Add back home.disableWelcomeScreen=true

aceee9d

Only disable welcome screen within APM ftr config

fc2afb3

Merge branch 'master' into update-alert-status-usage

23b237c

Add disableWelcomeScreen option to security solution cypress config

509056c

Merge branch 'master' into update-alert-status-usage

8fe9523

Fix reference to workflow status

b3c5545

Merge branch 'master' into update-alert-status-usage

7c96cb6

marshallmain marked this pull request as ready for review August 18, 2021 23:58

marshallmain requested review from a team as code owners August 18, 2021 23:58

oops

032152c

botelastic bot added Team:APM All issues that need APM UI Team support Team:Uptime - DEPRECATED Synthetics & RUM sub-team of Application Observability labels Aug 19, 2021

smith approved these changes Aug 19, 2021

View reviewed changes

justinkambic approved these changes Aug 20, 2021

View reviewed changes

kibanamachine and others added 2 commits August 20, 2021 17:15

Merge branch 'master' into update-alert-status-usage

902ff37

Merge branch 'master' into update-alert-status-usage

3d0b71c

Merge branch 'master' into update-alert-status-usage

477c7c4

marshallmain requested a review from a team August 23, 2021 16:51

weltenwort mentioned this pull request Aug 24, 2021

[RAC] 7.15 Observability Checklist #107933

Closed

52 tasks

weltenwort mentioned this pull request Aug 25, 2021

[RAC] Populate common rule fields in alert helpers #108679

Merged

marshallmain added 3 commits August 26, 2021 08:49

Merge branch 'master' into update-alert-status-usage

883808e

Update README.md

f7db200

Merge branch 'update-alert-status-usage' of github.com:marshallmain/k…

bd22132

…ibana into update-alert-status-usage

spong reviewed Aug 26, 2021

View reviewed changes

spong approved these changes Aug 26, 2021

View reviewed changes

marshallmain merged commit 682bc7c into elastic:master Aug 26, 2021

This was referenced Aug 26, 2021

[7.15] [RAC] Replace usages of kibana.alert.status: open with active (#109033) #110369

Closed

[7.x] [RAC] Replace usages of kibana.alert.status: open with active (#109033) #110370

Closed

This was referenced Aug 26, 2021

[Security Solution] Fix another reference to ALERT_STATUS #110376

Merged

[7.x] [RAC] Replace usages of kibana.alert.status: open with active (#109033) #110383

Merged

marshallmain mentioned this pull request Aug 27, 2021

[7.15] [RAC] Replace usages of kibana.alert.status: open with active (#109033) #110384

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[RAC] Replace usages of kibana.alert.status: open with active #109033

[RAC] Replace usages of kibana.alert.status: open with active #109033

marshallmain commented Aug 18, 2021 •

edited

Loading

elasticmachine commented Aug 18, 2021

elasticmachine commented Aug 18, 2021

elasticmachine commented Aug 19, 2021

elasticmachine commented Aug 19, 2021

smith left a comment

justinkambic left a comment

marshallmain commented Aug 20, 2021

marshallmain commented Aug 23, 2021

mgiota commented Aug 24, 2021

marshallmain commented Aug 24, 2021

kibanamachine commented Aug 26, 2021

spong Aug 26, 2021

marshallmain Aug 26, 2021

spong left a comment

kibanamachine commented Aug 26, 2021

[RAC] Replace usages of kibana.alert.status: open with active #109033

[RAC] Replace usages of kibana.alert.status: open with active #109033

Conversation

marshallmain commented Aug 18, 2021 • edited Loading

Summary

Checklist

Risk Matrix

For maintainers

elasticmachine commented Aug 18, 2021

elasticmachine commented Aug 18, 2021

elasticmachine commented Aug 19, 2021

elasticmachine commented Aug 19, 2021

smith left a comment

Choose a reason for hiding this comment

justinkambic left a comment

Choose a reason for hiding this comment

marshallmain commented Aug 20, 2021

marshallmain commented Aug 23, 2021

mgiota commented Aug 24, 2021

marshallmain commented Aug 24, 2021

kibanamachine commented Aug 26, 2021

💚 Build Succeeded

Metrics [docs]

Async chunks

Page load bundle

History

spong Aug 26, 2021

Choose a reason for hiding this comment

marshallmain Aug 26, 2021

Choose a reason for hiding this comment

spong left a comment

Choose a reason for hiding this comment

kibanamachine commented Aug 26, 2021

💚 Backport successful

marshallmain commented Aug 18, 2021 •

edited

Loading