[Uptime] migrate to observability rules registry #100699

dominiqueclarke · 2021-05-26T16:03:54Z

Fixes #98382

This PR registers uptime alerts in the new rules registry by taking the following steps.

Registering our index templates and server side rule types in the sever plugin.ts
Registering our rule types in the public plugin.ts
Calling the new alertWithLifecycle service passing along with relevant fields to populate our alerts in the Observability alerts table
Adjusting our public rule types to pass the reason and link field to integrate with the Observability alerts table UI.

Author Checklist

Accessibility has been considered, relevant aria tags and other accessibility features implemented
note: This feature is purely technical in nature, and does not directly touch UI elements that need accessibility considerations.
Telemetry has been added where relevant @justinkambic @shahzad31 Do we currently have telemetry in place for alerts?
Docs have been added to this PR covering any new, changed, or removed features
Testing for expected behavior is in place
- Automated tests exist to cover expected and edge case conditions
- User acceptance testing has been carried out to ensure the feature functions as expected within the context of how it will be used
- Any special/edge cases that need to be manually tested must be documented
- Ensure the new layout works responsively (including down to small phone widths, where makes sense for the user flow, e.g. the error page when reacting to an alert)

Reviewer Checklist

Accessibility has been considered, relevant aria tags and other accessibility features implemented
Telemetry has been added where relevant
Docs have been added to this PR covering any new, changed, or removed features
Testing for expected behavior is in place
- Automated tests exist to cover expected and edge case conditions
- User acceptance testing has been carried out to ensure the feature functions as expected within the context of how it will be used
- Any special/edge cases that need to be manually tested must be documented
- Ensure the new layout works responsively (including down to small phone widths, where makes sense for the user flow, e.g. the error page when reacting to an alert)

Testing

kibana.dev.yaml keys

xpack.ruleRegistry.index: '.kibana-alerts'
xpack.ruleRegistry.write.enabled: true

[ ] - Ensure that rules appear on the Observability alerts table found at /app/observability/alerts
[ ] - Ensure that reason is configured correctly in the Observability alerts table
[ ] - Ensure that View in App from the Observability alerts table takes you to the correct context in Uptime
[ ] - Smoke test that action connectors are appropriately sending alert messages
[ ] - Smoke test that the rules are appearing appropriately in the rules and connectors page.

Edge case

[ ] - Smoke test that the legacy Uptime TLS rule still works as expected, by configuring it from the Rules and Connectors page, which is the only place it should be accessible. Ensure that this rule does not appear in the Observability alerts table

…TypeBase`.

…-uptime-migrate-to-observability-rules-registry

elasticmachine · 2021-05-26T16:03:56Z

Pinging @elastic/uptime (Team:uptime)

dominiqueclarke · 2021-05-26T16:05:06Z

x-pack/plugins/uptime/common/translations.ts

@@ -37,3 +37,60 @@ export const MonitorStatusTranslations = {
    defaultMessage: 'Alert when a monitor is down or an availability threshold is breached.',
  }),
 };
+
+export const TlsTranslations = {


Moved alert translations to common, in order to use them within server to derive reason message.

dominiqueclarke · 2021-05-26T16:05:51Z

x-pack/plugins/uptime/public/lib/alert_types/duration_anomaly.tsx

@@ -30,4 +32,8 @@ export const initDurationAnomalyAlertType: AlertTypeInitializer = ({
  validate: () => ({ errors: {} }),
  defaultActionMessage,
  requiresAppContext: true,
+  format: ({ alert }) => ({


dominiqueclarke · 2021-05-26T16:06:47Z

x-pack/plugins/uptime/public/components/overview/alerts/settings_message_expression_popover.tsx

@@ -27,7 +27,7 @@ export const SettingsMessageExpressionPopover: React.FC<SettingsMessageExpressio
  id,
 }) => {
  const kibana = useKibana();
-  const path = kibana.services?.application?.getUrlForApp('uptime', { path: 'settings' });
+  const settingsPath = kibana.services?.http?.basePath.prepend('uptime/settings');


Because alerts are registered in the setup function, this component no longer has access to getUrlForApp.

dominiqueclarke · 2021-05-26T16:27:30Z

x-pack/plugins/uptime/common/rules/uptime_rule_field_map.ts

+    type: 'keyword',
+  },
+  // tls alert fields
+  'cert.count': {


@shahzad31 We can't use the ecs fields here, since the fields represent a single instance of a cert, but these are meant to represent all the found expiring/aging certs to the entire alert. (Also this is supposed to be cert_status.count, like the rest of the items below).

++ that makes senese

dominiqueclarke · 2021-07-06T20:13:07Z

@elasticmachine merge upstream

…ity-rules-registry

…istry' of https://github.com/dominiqueclarke/kibana into feature/98382-uptime-migrate-to-observability-rules-registry

shahzad31 · 2021-07-07T14:46:17Z

just noticed this , description is inverted

shahzad31

Looks good can see the alerts and code looks good as well. !!

justinkambic

LGTM, tested this out with a few basic alerts and didn't see any red flags.

justinkambic · 2021-07-07T19:52:36Z

x-pack/plugins/uptime/server/lib/alerts/duration_anomaly.ts

-      const { anomalies } =
-        (await getAnomalies(plugins, savedObjectsClient, params, state.lastCheckedAt)) ?? {};
+    if (foundAnomalies) {
+      const monitorInfo = await libs.requests.getLatestMonitor({


I don't know if there was a particular reason we were doing it as a direct import. Given that we are supplying all the dependencies in either case, I think it doesn't hurt to use the libs version.

dominiqueclarke · 2021-07-09T14:26:04Z

@elasticmachine merge upstream

…ity-rules-registry

…-uptime-migrate-to-observability-rules-registry

…istry' of https://github.com/dominiqueclarke/kibana into feature/98382-uptime-migrate-to-observability-rules-registry

…ity-rules-registry

kibanamachine · 2021-07-15T15:37:30Z

💚 Build Succeeded

Metrics [docs]

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
`ruleRegistry`	58	60	+2

Async chunks

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

id	before	after	diff
`uptime`	949.7KB	946.5KB	-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
`ruleRegistry`	10	9	-1

Page load bundle

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

id	before	after	diff
`uptime`	22.7KB	29.3KB	+6.6KB

Unknown metric groups

API count

id	before	after	diff
`ruleRegistry`	58	60	+2

History

💚 Build #138342 succeeded ee2468b
💚 Build #138038 succeeded ed532b6
💔 Build #137557 failed 4ce1026
💚 Build #136745 succeeded 1f4f4d7
💔 Build #136707 failed d541c85

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

justinkambic

Tested this again with some more alerts. LGTM

* uptime - migrate to observability rules registry * Modify Uptime alert types to work with server rule registry. * Export `RuleType` type for consumption by client plugins. * Add platinum as an option for `minimumLicenseRequired` field of `RuleTypeBase`. * Simplify alert bootstrapping, inherit `RuleType` for alert factories. * update rule field map * adjust rule registery to be created within setup instead of mount * adjust plugin setup to account for rule registry changes * export types from rule registry * move alert action message translations to common * update rule field map * update monitor status public alert model * update tls public alert model * update monitor status alert server model * update tls alert sever model * update server plugin file to scope alerts indices to synthetics * add initContext to server Plugin class * adjust public plugin to register alerts when core start is availabile * update mappings * update asset names * adjust dependencies for alert initialization * adjust duration anomaly server alert model * adjust duration anomaly and monitor status public alert model to account for undefined types * add duration_anomaly tests * add anomaly severity * adjust types * update uptime server plugin * remove test_helpers * add getMonitorRouteFromMonitorId helper * export AlertTypeWithExecutor from rule_registry * adjust types * mock time zone * update types * update types for legacy tls alert * update mappings * update monitor status check tls types * update tls types and indexed fields * update duration anomaly types and indexed fields * update mappings * delete unnecessary file * adjust types * adjust ruleDataClient initialization * index anomaly bucket span * update types * adjust registration of legacy tls alert type * adjust types * update index alias name * update anomaly detection rule mappings * adjust import for certificate alert * adjust rbac settings * adjust content * adjust uptime server plugin Co-authored-by: Justin Kambic <justin.kambic@elastic.co> Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>

kibanamachine · 2021-07-16T19:36:51Z

💚 Backport successful

Status	Branch	Result
✅	7.x

This backport PR will be merged automatically after passing CI.

* uptime - migrate to observability rules registry * Modify Uptime alert types to work with server rule registry. * Export `RuleType` type for consumption by client plugins. * Add platinum as an option for `minimumLicenseRequired` field of `RuleTypeBase`. * Simplify alert bootstrapping, inherit `RuleType` for alert factories. * update rule field map * adjust rule registery to be created within setup instead of mount * adjust plugin setup to account for rule registry changes * export types from rule registry * move alert action message translations to common * update rule field map * update monitor status public alert model * update tls public alert model * update monitor status alert server model * update tls alert sever model * update server plugin file to scope alerts indices to synthetics * add initContext to server Plugin class * adjust public plugin to register alerts when core start is availabile * update mappings * update asset names * adjust dependencies for alert initialization * adjust duration anomaly server alert model * adjust duration anomaly and monitor status public alert model to account for undefined types * add duration_anomaly tests * add anomaly severity * adjust types * update uptime server plugin * remove test_helpers * add getMonitorRouteFromMonitorId helper * export AlertTypeWithExecutor from rule_registry * adjust types * mock time zone * update types * update types for legacy tls alert * update mappings * update monitor status check tls types * update tls types and indexed fields * update duration anomaly types and indexed fields * update mappings * delete unnecessary file * adjust types * adjust ruleDataClient initialization * index anomaly bucket span * update types * adjust registration of legacy tls alert type * adjust types * update index alias name * update anomaly detection rule mappings * adjust import for certificate alert * adjust rbac settings * adjust content * adjust uptime server plugin Co-authored-by: Justin Kambic <justin.kambic@elastic.co> Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com> Co-authored-by: Dominique Clarke <doclarke71@gmail.com> Co-authored-by: Justin Kambic <justin.kambic@elastic.co>

dominiqueclarke and others added 18 commits April 30, 2021 09:43

uptime - migrate to observability rules registry

52564d2

Modify Uptime alert types to work with server rule registry.

18683b5

Export RuleType type for consumption by client plugins.

73a2dd7

Add platinum as an option for minimumLicenseRequired field of `Rule…

995cb88

…TypeBase`.

Simplify alert bootstrapping, inherit RuleType for alert factories.

881a1cc

update rule field map

1753bbc

adjust rule registery to be created within setup instead of mount

d5a597b

merge master

8e247b5

adjust plugin setup to account for rule registry changes

31ac049

export types from rule registry

7f8f6ef

move alert action message translations to common

493b55e

update rule field map

fbb530e

update monitor status public alert model

d9b3294

update tls public alert model

804ad55

update monitor status alert server model

17aa286

update tls alert sever model

53a05bc

update server plugin file to scope alerts indices to synthetics

cbc95a6

Merge branch 'master' of github.com:elastic/kibana into feature/98382…

24036d5

…-uptime-migrate-to-observability-rules-registry

dominiqueclarke requested a review from a team as a code owner May 26, 2021 16:03

dominiqueclarke marked this pull request as draft May 26, 2021 16:04

dominiqueclarke commented May 26, 2021

View reviewed changes

add initContext to server Plugin class

96e1ddb

dominiqueclarke added 6 commits July 1, 2021 15:52

update types

cef6cb4

adjust registration of legacy tls alert type

8302df4

adjust types

664f122

merge master

992c04f

update index alias name

36c8a4c

update anomaly detection rule mappings

64c2091

kibanamachine and others added 3 commits July 6, 2021 16:13

Merge branch 'master' into feature/98382-uptime-migrate-to-observabil…

d541c85

…ity-rules-registry

adjust import for certificate alert

294137a

Merge branch 'feature/98382-uptime-migrate-to-observability-rules-reg…

1f4f4d7

…istry' of https://github.com/dominiqueclarke/kibana into feature/98382-uptime-migrate-to-observability-rules-registry

shahzad31 approved these changes Jul 7, 2021

View reviewed changes

justinkambic approved these changes Jul 7, 2021

View reviewed changes

kibanamachine and others added 8 commits July 9, 2021 10:26

Merge branch 'master' into feature/98382-uptime-migrate-to-observabil…

4ce1026

…ity-rules-registry

Merge branch 'master' of github.com:elastic/kibana into feature/98382…

7d41f4f

…-uptime-migrate-to-observability-rules-registry

adjust rbac settings

dcdc486

Merge branch 'feature/98382-uptime-migrate-to-observability-rules-reg…

d350d81

…istry' of https://github.com/dominiqueclarke/kibana into feature/98382-uptime-migrate-to-observability-rules-registry

adjust content

ed532b6

merge master

1cf9f33

adjust uptime server plugin

ee2468b

Merge branch 'master' into feature/98382-uptime-migrate-to-observabil…

e5b5d0f

…ity-rules-registry

justinkambic approved these changes Jul 16, 2021

View reviewed changes

dominiqueclarke merged commit 743c8c2 into elastic:master Jul 16, 2021

dominiqueclarke deleted the feature/98382-uptime-migrate-to-observability-rules-registry branch July 16, 2021 19:34

kibanamachine mentioned this pull request Jul 16, 2021

[7.x] [Uptime] migrate to observability rules registry (#100699) #106019

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Uptime] migrate to observability rules registry #100699

[Uptime] migrate to observability rules registry #100699

dominiqueclarke commented May 26, 2021 •

edited

Loading

elasticmachine commented May 26, 2021

dominiqueclarke May 26, 2021

dominiqueclarke May 26, 2021

dominiqueclarke May 26, 2021

dominiqueclarke May 26, 2021

shahzad31 May 26, 2021

dominiqueclarke commented Jul 6, 2021

shahzad31 commented Jul 7, 2021

shahzad31 left a comment

justinkambic left a comment

justinkambic Jul 7, 2021

dominiqueclarke commented Jul 9, 2021

kibanamachine commented Jul 15, 2021

API count

justinkambic left a comment

kibanamachine commented Jul 16, 2021

[Uptime] migrate to observability rules registry #100699

[Uptime] migrate to observability rules registry #100699

Conversation

dominiqueclarke commented May 26, 2021 • edited Loading

Author Checklist

Reviewer Checklist

Testing

kibana.dev.yaml keys

Edge case

elasticmachine commented May 26, 2021

dominiqueclarke May 26, 2021

Choose a reason for hiding this comment

dominiqueclarke May 26, 2021

Choose a reason for hiding this comment

dominiqueclarke May 26, 2021

Choose a reason for hiding this comment

dominiqueclarke May 26, 2021

Choose a reason for hiding this comment

shahzad31 May 26, 2021

Choose a reason for hiding this comment

dominiqueclarke commented Jul 6, 2021

shahzad31 commented Jul 7, 2021

shahzad31 left a comment

Choose a reason for hiding this comment

justinkambic left a comment

Choose a reason for hiding this comment

justinkambic Jul 7, 2021

Choose a reason for hiding this comment

dominiqueclarke commented Jul 9, 2021

kibanamachine commented Jul 15, 2021

💚 Build Succeeded

Metrics [docs]

Public APIs missing comments

Async chunks

Public APIs missing exports

Page load bundle

API count

History

justinkambic left a comment

Choose a reason for hiding this comment

kibanamachine commented Jul 16, 2021

💚 Backport successful

dominiqueclarke commented May 26, 2021 •

edited

Loading