License checks for alerts plugin #85649

YulNaumenko · 2020-12-10T21:41:30Z

In this PR, we're making alert types license aware and adding the proper behaviors to the APIs.
This branch is a feature branch that sub PRs are merging into until the feature is complete.

[Alerts][License] Define minimum license required for each alert type (#84997)

Add a minimumLicenseRequired attribute to each alert type definition
Define a minimum license requirement in each alert type
Only '.geo-containment' and '.geo-threshold' is under the gold+ license. The rest of alert types was set to basic

[Alerts][License] Add license checks to alerts HTTP APIs and execution (#85223)

Was added 403 Forbidder response for executing alert API (create, update, enable, disable, muteAll, unmuteAll, muteInstance, unmuteInstance) with the higher level alert type license.
Delete API remain available to remove higher license alerts.
When the task is running for a scheduled alert with the higher level license, the event log will provide the next execution status:

executionStatus: {lastExecutionDate: "2020-12-09T06:30:15.749Z", status: "error", error: {reason: "license",…}}
error: {reason: "license",…}
message: "Alert type .geo-threshold is disabled because your basic license does not support it. Please upgrade your license."
reason: "license"
lastExecutionDate: "2020-12-09T06:30:15.749Z"
status: "error"

[Alerting UI][License] Disable alert types in UI when the license doesn't support it. (#85496)

Current PR covers the licensing UI for the alert types.

In the Alert flyouts (Create and Edit), alert types disabled by the license restriction is displayed similarly as unavailable action types in the Connector flyout:

The sort order is a bit more complicated then for action types, because we have groups of alert types by the solution.
Current PR implements sort order by keeping the solutions alphabet order if the solution contains at least one available alert type and if all alert types under solution is disabled by the license restriction it will be sorted after the solutions with available alert types.
Then inside the solution group we sort solution items inside by the license availability and then alphabetically by alert type name.
Alerts, which has alert type belongs to the higher order license displayed disabled with the tooltip in the alerts list in Management UI, similarly as it designed for connectors list, but without icon tip, because details link is available.

User have a possibility to delete alerts with the higher order alert type license (same as for the action types).
There is an option to navigate to the alert details page. The purpose of this usage is to see the error message generated by the current alert execution behavior for the expired alerts - continue running with the error license reason.

User is able to manage the license from this message.

All messages for licensing tooltips are corresponding to the action types design.

…#84997) * Define minimum license required for each alert type * fixed typechecks * fixed tests * fixed tests * fixed due to comments * fixed due to comments * removed file * removed casting to LicenseType

#85223) * [Alerts][License] Add license checks to alerts HTTP APIs and execution * fixed typechecks * resolved conflicts * resolved conflicts * added router tests * fixed typechecks * added license check support for alert task running * fixed typechecks * added integration tests * fixed due to comments * fixed due to comments * fixed tests * fixed typechecks

…sn't support it. (#85496) * [Alerting UI][License] Disable alert types in UI when the license doesn't support it. * fixed typechecks * added licensing for alert list and details page * fixed multy select menu * fixed due to comments * fixed due to comments * fixed due to comments

elasticmachine · 2020-12-10T22:24:53Z

Pinging @elastic/kibana-alerting-services (Team:Alerting Services)

mdefazio

Approving—nothing looks different from the previous PR :)

elasticmachine · 2020-12-10T22:28:31Z

Pinging @elastic/uptime (Team:uptime)

elasticmachine · 2020-12-10T22:28:31Z

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

phillipb

Infra change LGTM

gchaps · 2020-12-10T22:56:46Z

Suggestions for texxt:

Error in 1 alert

View | Dismiss

Cannot run alert

Alert metrics.alert.inventory.threshold is disabled because it requires a Gold license.

Dismiss | Manage license

@alexfrancoeur Can you please weigh in the wording around licensing?

smith

APM changes look good.

FrankHassanabad

LGTM

gmmorris · 2020-12-14T11:21:40Z

@elasticmachine merge upstream

mikecote

Feature LGTM! I ran a scenario where I created an alert in gold, downgraded my license and saw the proper error and UX. 👍

ymao1

LGTM! Works as expected.

alexfrancoeur · 2020-12-14T16:43:23Z

What do you think about this @gchaps? Adding a CTA.

Cannot run alert

Alert metrics.alert.inventory.threshold is disabled because it requires a Gold license. Contact your administrator to upgrade your license.

Dismiss | Manage license

gchaps · 2020-12-14T16:58:55Z

@alexfrancoeur, @YulNaumenko. I like the the second sentence with the CTA to contact your administrator. In which, case I think we should remove the "Manage license" link":

Cannot run alert

Alert metrics.alert.inventory.threshold is disabled because it requires a Gold license. Contact your administrator to upgrade your license.

Dismiss

alexfrancoeur · 2020-12-14T20:15:16Z

I think it's fine keeping the manage your license link, if they are the administrator, a streamlined navigation experience couldn't hurt. Is there a way we can phrase the text in which the CTA can live with the manage license button?

YulNaumenko · 2020-12-14T20:55:29Z

I think it's fine keeping the manage your license link, if they are the administrator, a streamlined navigation experience couldn't hurt. Is there a way we can phrase the text in which the CTA can live with the manage license button?

Need to check this with @mikecote.
Current design is like this:

gchaps · 2020-12-15T00:30:17Z

For the message

Remove the period at the end of the title: Cannot run alert

We could make the text "upgrade your license" the link. But that still means removing the Manage license button.

YulNaumenko · 2020-12-15T00:43:18Z

For the message

Remove the period at the end of the title: Cannot run alert

We could make the text "upgrade your license" the link. But that still means removing the Manage license button.

I have no objections about naming the link as "upgrade your license". Only wanted to have the same as Connectors UX has.

kibanamachine · 2020-12-15T03:17:19Z

💚 Build Succeeded

continuous-integration/kibana-ci/pull-request
Commit: 91990e9

Metrics [docs]

Module Count

Fewer modules leads to a faster build time

id	before	after	diff
`triggersActionsUi`	298	309	+11

Async chunks

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

id	before	after	diff
`triggersActionsUi`	1.5MB	1.6MB	+10.4KB

Distributable file count

id	before	after	diff
`default`	47138	47902	+764

Page load bundle

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

id	before	after	diff
`alerts`	68.5KB	68.6KB	+54.0B
`apm`	48.8KB	49.0KB	+124.0B
total			+178.0B

History

💔 Build #94238 failed 3100644
💔 Build #94204 failed b5e8b8e
💔 Build #94166 failed a1815da
💚 Build #93946 succeeded 76b4f17
💔 Build #93698 failed 78991f4

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

* master: (66 commits) [Alerting] fixes broken Alerting Example plugin (elastic#85774) [APM] Service overview instances table (elastic#85770) [Security Solution] Unskip timeline creation Cypress test (elastic#85871) properly recognize enterprise licenses (elastic#85849) [SecuritySolution][Detections] Adds SavedObject persistence to Signals Migrations (elastic#85690) [TSVB] Fix functional tests flakiness and unskip them (elastic#85388) [Fleet] Change permissions for Fleet enroll role (elastic#85802) Gauge visualization can no longer be clicked to filter on values since Kibana 7.10.0 (elastic#84768) [Security Solution][Detections] Add alert source to detection rule action context (elastic#85488) [Discover] Don't display hide/show button for histogram when there's no time filter (elastic#85424) skip flaky suite (elastic#78553) License checks for alerts plugin (elastic#85649) skip flaky suite (elastic#84992) skip 'query return results valid for scripted field' elastic#78553 Allow action types to perform their own mustache variable escaping in parameter templates (elastic#83919) [ML] More machine learning links in doc_links_service.ts (elastic#85365) Removed Alerting & Event Log deprecated fields that should not be using (elastic#85652) Closes elastic#79995 by adding new tab in transaction details to show related trace logs. (elastic#85859) Fix outdated jest snapshot [Maps] Surface on prem EMS (elastic#85729) ...

YulNaumenko and others added 5 commits December 8, 2020 12:41

[Alerts][License] Define minimum license required for each alert type (…

b20db60

…#84997) * Define minimum license required for each alert type * fixed typechecks * fixed tests * fixed tests * fixed due to comments * fixed due to comments * removed file * removed casting to LicenseType

Merge remote-tracking branch upstream/master

6e6a088

Merge remote-tracking branch upstream/master

09d437f

YulNaumenko added Feature:Alerting v8.0.0 release_note:skip Skip the PR/issue when compiling release notes needs_docs Team:ResponseOps Label for the ResponseOps team (formerly the Cases and Alerting teams) v7.11.0 labels Dec 10, 2020

YulNaumenko self-assigned this Dec 10, 2020

Merge remote-tracking branch upstream/master

78991f4

YulNaumenko marked this pull request as ready for review December 10, 2020 22:24

YulNaumenko requested review from a team as code owners December 10, 2020 22:24

YulNaumenko requested a review from a team December 10, 2020 22:24

YulNaumenko requested a review from a team as a code owner December 10, 2020 22:24

YulNaumenko requested a review from gchaps December 10, 2020 22:25

mdefazio approved these changes Dec 10, 2020

View reviewed changes

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

fixed typechecks

04584bc

phillipb approved these changes Dec 10, 2020

View reviewed changes

smith approved these changes Dec 10, 2020

View reviewed changes

FrankHassanabad approved these changes Dec 10, 2020

View reviewed changes

shahzad31 approved these changes Dec 14, 2020

View reviewed changes

Merge branch 'master' into alerts/license-checks

76b4f17

mikecote self-requested a review December 14, 2020 13:14

mikecote approved these changes Dec 14, 2020

View reviewed changes

chrisronline approved these changes Dec 14, 2020

View reviewed changes

ymao1 approved these changes Dec 14, 2020

View reviewed changes

YulNaumenko added 2 commits December 14, 2020 11:42

fixed license error message

69941de

Merge remote-tracking branch upstream/master

a1815da

fixed license error message

b5e8b8e

fixed typechecks

3100644

fixed license error message

91990e9

YulNaumenko merged commit 37525f8 into master Dec 15, 2020

YulNaumenko mentioned this pull request Dec 15, 2020

[7.x] License checks for alerts plugin (#85649) #85904

Merged

This was referenced Feb 24, 2021

[Alerts][Docs] Extended README.md and the user docs with the licensing information. #92564

Merged

Catch-up release documentation - @YulNaumenko #90008

Closed

spalger deleted the alerts/license-checks branch May 8, 2022 22:00

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

License checks for alerts plugin #85649

License checks for alerts plugin #85649

YulNaumenko commented Dec 10, 2020 •

edited

Loading

elasticmachine commented Dec 10, 2020

mdefazio left a comment

elasticmachine commented Dec 10, 2020

elasticmachine commented Dec 10, 2020

phillipb left a comment

gchaps commented Dec 10, 2020

smith left a comment

FrankHassanabad left a comment

gmmorris commented Dec 14, 2020

mikecote left a comment

ymao1 left a comment

alexfrancoeur commented Dec 14, 2020

gchaps commented Dec 14, 2020

alexfrancoeur commented Dec 14, 2020

YulNaumenko commented Dec 14, 2020

gchaps commented Dec 15, 2020

YulNaumenko commented Dec 15, 2020

kibanamachine commented Dec 15, 2020

License checks for alerts plugin #85649

License checks for alerts plugin #85649

Conversation

YulNaumenko commented Dec 10, 2020 • edited Loading

[Alerts][License] Define minimum license required for each alert type (#84997)

[Alerts][License] Add license checks to alerts HTTP APIs and execution (#85223)

[Alerting UI][License] Disable alert types in UI when the license doesn't support it. (#85496)

elasticmachine commented Dec 10, 2020

mdefazio left a comment

Choose a reason for hiding this comment

elasticmachine commented Dec 10, 2020

elasticmachine commented Dec 10, 2020

phillipb left a comment

Choose a reason for hiding this comment

gchaps commented Dec 10, 2020

smith left a comment

Choose a reason for hiding this comment

FrankHassanabad left a comment

Choose a reason for hiding this comment

gmmorris commented Dec 14, 2020

mikecote left a comment

Choose a reason for hiding this comment

ymao1 left a comment

Choose a reason for hiding this comment

alexfrancoeur commented Dec 14, 2020

gchaps commented Dec 14, 2020

alexfrancoeur commented Dec 14, 2020

YulNaumenko commented Dec 14, 2020

gchaps commented Dec 15, 2020

YulNaumenko commented Dec 15, 2020

kibanamachine commented Dec 15, 2020

💚 Build Succeeded

Metrics [docs]

Module Count

Async chunks

Distributable file count

Page load bundle

History

YulNaumenko commented Dec 10, 2020 •

edited

Loading