[Stack Monitoring] Enable OOTB alerts in RAC page and multiple rules of a rule type #106457

neptunian · 2021-07-21T19:07:57Z

Summary

Resolves #91145
Resolves #100142
Resolves #92128

Enables OOTB alerts to be managed in Stack Management -> RAC
Adds support for allowing multiples rules of a rule type

Test

Test alert menus with 2 rules of the same type
- Create the OOTB default alerts first when prompted by the modal or use the dropdown
- Edit one of the rules like CPU Usage to have something very low to trigger an alert. Select "notify me when alert is active" and to notify very 1 minute. Make sure an alert gets created.
- Navigate to Stack Management -> Rules and Connectors
- click "Create Rule". In the Flytout name the new rule (eg CPU USage 2) and select the same rule modified earlier like CPU Usage under Stack Monitoring and use the same settings as above. Wait for alerts to be created.
- Click on orange "x alerts" badge. Make sure its set to "Group by Alert Type"
- You should now see in the menu both rules of the same rule type listed, with each node with the alert nested under it
- Click on orange "x alerts" badge. Make sure its set to "Group by Node Type"
- You should see a list of each node with the number of alerts it has in parenthesis
- Clicking on the node you should see each rule that's being alerted for that node
- Assure that the count "x alerts" on the badge, matches the actual alerts in the menu
Test other pages
- Clicking on any of the pages such as Nodes you should not have any errors. The alerts should be in a callout at the top and the alert count should match the number of alerts
- The detailed Node page has alerts for all the rules (note 2 CPU usage alerts)

neptunian · 2021-07-21T19:13:41Z

x-pack/plugins/monitoring/common/constants.ts

@@ -566,7 +566,7 @@ export const ALERT_ACTION_TYPE_LOG = '.server-log';
 /**
 * To enable modifing of alerts in under actions
 */
-export const ALERT_REQUIRES_APP_CONTEXT = true;
+export const ALERT_REQUIRES_APP_CONTEXT = false;


allows rules to be managed in Stack Management -> RAC

neptunian · 2021-07-21T19:17:13Z

x-pack/plugins/monitoring/public/alerts/lib/get_alert_panels_by_category.tsx

+  CommonAlert,
+  CommonAlertState,
+  CommonAlertStatus,
+} from '../../../common/types/alerts';
 import { PanelItem } from '../types';
 import { sortByNewestAlert } from './sort_by_newest_alert';
 import { Legacy } from '../../legacy_shims';



This view creates the nested alerts menu when clicking on the badges. It's very confusing but I tried to get rid of some for loops and add some types. The logic change is that it's accommodating the fact that there can be more than one type of a rule and we should show them both in the menu.

Agreed that it's still very confusing. I would like to pull it apart more but not during this PR. For now, can we rename alerts on the incoming getAlertPanelsByCategory function, to something that is more descriptive? It's really hard to keep track of what "alerts" means at any given time.

Also, can we add a bunch of comments for now about what these functions are doing step by step?

I was playing around with the code to see if I could understand it better. This is where I ended up: https://gist.github.com/jasonrhodes/a6ad54b808943d46f85082df2bbfb200

I don't think we should do any of that right now, or ever necessarily. I think what you've done here is a good step for what we need right now, but if you look that over it may help you see where some comments might be useful based on how badly I've misunderstood some things, etc.

neptunian · 2021-07-21T19:18:12Z

x-pack/plugins/monitoring/public/alerts/lib/get_alert_panels_by_category.tsx

-        menu.push({
-          ...category,
-          alerts: alertsInCategory.map(({ alertName }) => {
-            const alertStatus = alertsContext.allAlerts[alertName];


I don't see the point in using the alertsContext which has a list of the OOTB alerts to get the instance there since we fetch for the same data at an interval and it exists in the component state.

neptunian · 2021-07-21T19:20:08Z

x-pack/plugins/monitoring/public/alerts/lib/get_alert_panels_by_node.test.tsx

+          alertTypeId: ALERT_NODES_CHANGED,
+          name: `${ALERT_NODES_CHANGED}_label_2`,
+          ...mockAlert,
+        },


Add a rule of the same rule type and except that rule to be shown.

neptunian · 2021-07-21T19:21:00Z

x-pack/plugins/monitoring/public/alerts/lib/get_alert_panels_by_node.tsx

+        count: 0,
+      };
+      alertsByNodes[state.nodeId][alertId].count++;
+      alertsByNodes[state.nodeId][alertId].states.push(alertState);


groups by alertId (rule id - unique UUID) instead of alertTypeId (eg: monitoring_cpu_usage) which can now happen twice due to support of multiple types of rules allowed.

Perfect, thanks.

neptunian · 2021-07-21T19:22:14Z

x-pack/plugins/monitoring/public/alerts/lib/should_show_alert_badge.ts

+  const alertExists = alertTypeIds.find(
+    (name) => alerts[name] && alerts[name].find((rule) => rule.states.length > 0)
+  );
+  return inSetupMode || alertExists;


search in all types of rules

neptunian · 2021-07-21T19:23:29Z

x-pack/plugins/monitoring/public/alerts/status.tsx

-    return cnt;
-  }, 0);
+      return cnt;
+    }, 0);


count rules for all types of rules. flatten first, then reduce.

neptunian · 2021-07-21T19:24:05Z

x-pack/plugins/monitoring/server/alerts/alerts_factory.test.ts

+            id: 1,
+          },
+          {
+            id: 2,


add test for returning multiple rules of a type instead of expecting only 1

neptunian · 2021-07-21T19:24:25Z

x-pack/plugins/monitoring/server/alerts/alerts_factory.ts

-
-    const [rawAlert] = alertClientAlerts.data as [Alert];
-    return new alertCls(rawAlert) as BaseAlert;
+    return alertClientAlerts.data.map((alert) => new alertCls(alert as Alert) as BaseAlert);


return all the rules of a type instead of the first one

neptunian · 2021-07-21T19:24:56Z

x-pack/plugins/monitoring/server/lib/alerts/fetch_status.test.ts

+        {
+          rawAlert: { id: 2 },
+          states: [],
+        },


expect more than one rule per rule type to be returned

elasticmachine · 2021-07-21T21:22:21Z

Pinging @elastic/logs-metrics-ui (Team:logs-metrics-ui)

neptunian · 2021-07-26T15:59:29Z

@elasticmachine merge upstream

neptunian · 2021-07-28T18:39:58Z

@elasticmachine merge upstream

neptunian · 2021-08-02T20:21:06Z

@elasticmachine merge upstream

jasonrhodes

LGTM if we can add a few renames/comments in the bulky part of this code path.

jasonrhodes · 2021-08-02T23:54:52Z

x-pack/plugins/monitoring/public/alerts/lib/get_alert_panels_by_category.tsx

+  CommonAlert,
+  CommonAlertState,
+  CommonAlertStatus,
+} from '../../../common/types/alerts';
 import { PanelItem } from '../types';
 import { sortByNewestAlert } from './sort_by_newest_alert';
 import { Legacy } from '../../legacy_shims';



Agreed that it's still very confusing. I would like to pull it apart more but not during this PR. For now, can we rename alerts on the incoming getAlertPanelsByCategory function, to something that is more descriptive? It's really hard to keep track of what "alerts" means at any given time.

Also, can we add a bunch of comments for now about what these functions are doing step by step?

jasonrhodes · 2021-08-02T23:58:47Z

x-pack/plugins/monitoring/public/alerts/lib/get_alert_panels_by_category.tsx

+  CommonAlert,
+  CommonAlertState,
+  CommonAlertStatus,
+} from '../../../common/types/alerts';
 import { PanelItem } from '../types';
 import { sortByNewestAlert } from './sort_by_newest_alert';
 import { Legacy } from '../../legacy_shims';



I was playing around with the code to see if I could understand it better. This is where I ended up: https://gist.github.com/jasonrhodes/a6ad54b808943d46f85082df2bbfb200

I don't think we should do any of that right now, or ever necessarily. I think what you've done here is a good step for what we need right now, but if you look that over it may help you see where some comments might be useful based on how badly I've misunderstood some things, etc.

jasonrhodes · 2021-08-02T23:59:28Z

x-pack/plugins/monitoring/public/alerts/lib/get_alert_panels_by_node.tsx

+        count: 0,
+      };
+      alertsByNodes[state.nodeId][alertId].count++;
+      alertsByNodes[state.nodeId][alertId].states.push(alertState);


Perfect, thanks.

kibanamachine · 2021-08-03T22:22:49Z

💚 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
`monitoring`	730.0KB	729.4KB	-654.0B

History

💔 Build #142699 failed d9b279a
💚 Build #142477 succeeded 595bf99a86ddb3d71ce573101dad0644bd273a8b
💚 Build #141456 succeeded 2958496a02d6d0366b7975ccf351cb285ada314b
💚 Build #140785 succeeded ce1c12fbf9aa6b0c50a2315700fbf5c092794906
💚 Build #140368 succeeded 4f6aee6

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

cc @jasonrhodes @neptunian

…of a rule type (elastic#106457) * allow rules to be managed in RAC page * return all rules of a rule type instead of first one * update UI to handle multiple rule types * add comments about creating the menus by category for alerts and rules * fix parsing of cluster alerts

…of a rule type (#106457) (#107643) * allow rules to be managed in RAC page * return all rules of a rule type instead of first one * update UI to handle multiple rule types * add comments about creating the menus by category for alerts and rules * fix parsing of cluster alerts

…of a rule type (elastic#106457) * allow rules to be managed in RAC page * return all rules of a rule type instead of first one * update UI to handle multiple rule types * add comments about creating the menus by category for alerts and rules * fix parsing of cluster alerts

neptunian added 3 commits July 21, 2021 14:59

allow rules to be managed in RAC page

206853a

return all rules of a rule type instead of first one

026ef91

update UI to handle multiple rule types

9104cd5

neptunian added release_note:enhancement v8.0.0 Team:Infra Monitoring UI - DEPRECATED DEPRECATED - Label for the Infra Monitoring UI team. Use Team:obs-ux-infra_services Feature:Stack Monitoring v7.15.0 labels Jul 21, 2021

neptunian self-assigned this Jul 21, 2021

neptunian added the Epic: Stack Monitoring Alerting Alignment label Jul 21, 2021

neptunian commented Jul 21, 2021

View reviewed changes

neptunian marked this pull request as ready for review July 21, 2021 21:22

neptunian requested a review from a team July 21, 2021 21:22

fix merge conflict alertsClient to rulesClient

4f6aee6

jasonrhodes self-assigned this Jul 27, 2021

neptunian added 2 commits July 28, 2021 14:47

Merge branch 'master' into 100142-multiple-rule-types

755d826

Merge branch 'master' into 100142-multiple-rule-types

4703ef1

estermv self-requested a review August 2, 2021 16:29

jasonrhodes approved these changes Aug 2, 2021

View reviewed changes

estermv removed their request for review August 3, 2021 06:53

neptunian added 2 commits August 3, 2021 10:09

Merge branch 'master' into 100142-multiple-rule-types

5171b5a

add comments about creating the menus by category for alerts and rules

d9b279a

neptunian force-pushed the 100142-multiple-rule-types branch from 595bf99 to d9b279a Compare August 3, 2021 15:52

fix parsing of cluster alerts

165bf83

neptunian merged commit b03d85a into elastic:master Aug 4, 2021

neptunian mentioned this pull request Aug 4, 2021

[7.x] [Stack Monitoring] Enable OOTB alerts in RAC page and multiple rules of a rule type (#106457) #107643

Merged

ymao1 mentioned this pull request Aug 4, 2021

[Alerting] Include stack monitoring rules in import/export #103599

Open

neptunian mentioned this pull request Aug 4, 2021

[Stack Monitoring] update docs for changes in stack monitoring rules #107670

Merged

ravikesarwani mentioned this pull request Aug 13, 2021

Elastic Cloud - Changing slack connector in one monitoring setup impacts the other one #88423

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Stack Monitoring] Enable OOTB alerts in RAC page and multiple rules of a rule type #106457

[Stack Monitoring] Enable OOTB alerts in RAC page and multiple rules of a rule type #106457

neptunian commented Jul 21, 2021 •

edited by jasonrhodes

Loading

neptunian Jul 21, 2021

neptunian Jul 21, 2021 •

edited

Loading

jasonrhodes Aug 2, 2021

jasonrhodes Aug 2, 2021

neptunian Jul 21, 2021

neptunian Jul 21, 2021

neptunian Jul 21, 2021 •

edited

Loading

jasonrhodes Aug 2, 2021

neptunian Jul 21, 2021

neptunian Jul 21, 2021

neptunian Jul 21, 2021

neptunian Jul 21, 2021

neptunian Jul 21, 2021

elasticmachine commented Jul 21, 2021

neptunian commented Jul 26, 2021

neptunian commented Jul 28, 2021

neptunian commented Aug 2, 2021

jasonrhodes left a comment

jasonrhodes Aug 2, 2021

jasonrhodes Aug 2, 2021

jasonrhodes Aug 2, 2021

kibanamachine commented Aug 3, 2021

[Stack Monitoring] Enable OOTB alerts in RAC page and multiple rules of a rule type #106457

[Stack Monitoring] Enable OOTB alerts in RAC page and multiple rules of a rule type #106457

Conversation

neptunian commented Jul 21, 2021 • edited by jasonrhodes Loading

Summary

Test

Choose a reason for hiding this comment

neptunian Jul 21, 2021 • 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

Choose a reason for hiding this comment

neptunian Jul 21, 2021 • 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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

elasticmachine commented Jul 21, 2021

neptunian commented Jul 26, 2021

neptunian commented Jul 28, 2021

neptunian commented Aug 2, 2021

jasonrhodes left a comment

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

kibanamachine commented Aug 3, 2021

💚 Build Succeeded

Metrics [docs]

Async chunks

History

neptunian commented Jul 21, 2021 •

edited by jasonrhodes

Loading

neptunian Jul 21, 2021 •

edited

Loading

neptunian Jul 21, 2021 •

edited

Loading