Introduce basic alerting and actions plugin #37042

mikecote · 2019-05-23T23:50:20Z

This PR merges the feature branch of alerting. See #35679 and #37043 for the information about the two plugins we're adding in this PR.

* Basic alerting plugin with actions * Remove relative imports * Code cleanup * Split service into 3 parts, change connector structure * Ability to disable plugin, ability to get actions * Add slack connector * Add email connector * Ability to validate params and connector options * Remove connectorOptionsSecrets for now * Fix plugin config validation * Add tests for slack connector * Default connectors register on plugin init, console renamed to log, slack to message_slack * Add remaining API endpoints for action CRUD * Add list connectors API * Change actions CRUD APIs to be closer with saved objects structure * WIP * Fix broken tests * Add encrypted attribute support * Add params and connectorOptions for email * WIP * Remove action's ability to have custom ids * Remove ts-ignore * Fix broken test * Remove default connectors from this branch * Fix API integration tests to use fixture connector * Rename connector terminology to action type * Rename actionTypeOptions to actionTypeConfig * Code cleanup * Fix broken tests * Rename alerting plugin to actions * Some code cleanup and add API unit tests * Change signature of action type service execute function * Add some plugin api integration tests * Fix type check failure * Code cleanup * Create an actions client instead of an action service * Apply Bill's PR feedback * Fix broken test * Find function to have destructured params * Add tests to ensure encrypted attributes are not returned * Fix broken test * Add tests for validation * Ensure actions can be updated without re-passing the config * Remove dead code * Test cleanup * Fix eslint issue * Apply Peter's PR feedback * Code cleanup and fix broken tests * Apply Brandon's PR feedback * Add namespace support * Fix broken test

elasticmachine · 2019-05-28T17:27:37Z

Pinging @elastic/kibana-stack-services

* Pass services to action executors * Fix tests * Apply PR feedback * Apply PR feedback pt2

* Cleanup actions, move code from alerting plugin PR * Rename service terminology to registry * Use static encryption key for encrypted attributes plugin inside of tests * Empty data after create test is done running * Fix type checks * Fix inconsistent naming

adds the first "builtin" alertType for performing a `server.log()`

@ts-ignore

* WIP * Rename fire function and remove @ts-ignore in all places * Change naming in alerting service * Remove alert instance class for now, support interval configuration * Cleanup TS * Split alerting between registry and client * Use saved object alongside task manager instance * Add remaining alerting APIs * Change create structure * Rename some variables, change actionGroups structure * Use handlebars for templating strings at fire time * Fix params given to alert type execute function * Use alert instance class * Alert instances support meta attributes * Move alert instances deserialization * Change interval to be ms * Rename actions es archive * Fix tests to use encrypted esArchive for action record * Add create alert test to demo end to end flow * Fix type check issue * Alerts to use references to action objects * Only update task manager tasks after saved objects are fully updated * Use scope in task manager * Fix type check * Use task manager to execute actions * Convert ids into references and back * Apply PR feedback * Fix broken test * Fix some bugs * Fix test errors * Alert interval to be previous runAt + interval instead of now + interval * Add range support * Remove extra line * Cleanup * Add alert_instance.test.ts * Add alert_type_registry.test.ts * Move tests around * Create generic task manager mock * Add note about saved objects client mock * Create alert_type_registry.mock.ts * Add alerts_client.test.ts * Add create_alert_instance_factory.test.ts * Add create_fire_handler.test.ts * WIP * Fix get_create_task_runner_function.test.ts and make test pass * Make get_create_task_runner_function.test.ts 100% coverage * Add unit tests for routes * Move files around * Created transform_action_params.ts * Add get_next_run_at.ts * Add comment explaining why we copy nextRunAt * Re-use state within alert instance * Finalize code coverage in unit tests * Create base api integration tests * Add a test that ensures end to end functionality of an alert * Fix ui capabilities test * Fix broken plugin api integration test * Fix jest tests with new saved objects client * Fix broken integration tests * Change api integration test fixture to make more sense, add functions for future tests * Move alerts integration testing into own file, prep to add more tests * Add tests to ensure failed task instances get retried * Add get_create_task_runner_function.test.ts for actions, create encrypted saved objects mock * Add action validation tests * Ensure action type validation occurs on update * Test 400 on unregistered alert types * Ensure alertTypeId can't be updated * Add validation test for alert create / update * Fix broken checks / tests * Skip failing test for now * Cleanup jest tests * Ensure action objects can be updated while keeping encrypted attributes readable * Remove partial update sopport, remove ability to change actionTypeId, require config * Ensure actionTypeConfig is validated on create and update * Add alertTypeParams validation support * Fix failing tests * Ensure alert cleanup errors don't replace the original error * Pass callCluster as a service to alerts and actions * Only pass log to alerts client * Pass savedObjectsClient as a service to alerting and actions * Fix failing tests * Remove range support, provide when current and previous task got scheduled * Ensure Joi validation happens before every execute * Remove skipped tests, to be done in future PR * Apply self feedback pt1 * Apply self feedback pt2 * Fix broken tests * Apply PR feedback * PR feedback pt1 * Apply security team PR feedback * PR feedback pt1 * PR feedback pt2 * PR feedback pt3 * Fix broken tests * Fix callCluster to have signature * Revert f11a6ae * PR feedback pt4 * Remove __jest__ folders * PR feedback pt5 * Fix Joi from leaking secrets * Fire instance actions in parallel instead of series

rudolf

Core/SavedObjects changes LGTM

bmcconaghy

LGTM for merging to master.

azasypkin

LGMT, nothing jumps out at me security-wise, just a bunch of minor questions .

azasypkin · 2019-06-19T15:15:36Z

x-pack/plugins/actions/server/builtin_action_types/server_log.ts

+  message: Joi.string().required(),
+  tags: Joi.array()
+    .items(Joi.string())
+    .optional()


nit: I'm curious, do we really need optional if we have default?

per the joi doc:

Used to annotate the schema for readability as all keys are optional by default.

I've tended to always add one of required() or optional() for "readability", but should probably go with the flow of whatever else is done in Kibana. Did a quick check, didn't notice anywhere both were used, so we should probably get dir of the .optional() line. Since one person was curious, likely others will be too :-)

azasypkin · 2019-06-19T15:31:56Z

x-pack/plugins/actions/server/routes/find.ts

+      validate: {
+        query: Joi.object()
+          .keys({
+            per_page: Joi.number()


question: what is the point\use case to have 0 items per page? Why not min(1)?

This was a straight copy / paste from the saved objects client find API. I didn't take a chance to process what was already there.

azasypkin · 2019-06-19T15:33:27Z

x-pack/plugins/actions/server/routes/find.ts

+              .default(1),
+            search: Joi.string()
+              .allow('')
+              .optional(),


question: is this optional just for clarity? I thought that all fields are optional by default in Joi (e.g. for sort_field you don't use optional).

x-pack/plugins/actions/server/routes/update.ts

x-pack/plugins/alerting/server/alerts_client.ts

x-pack/plugins/alerting/server/lib/alert_instance.ts

x-pack/plugins/alerting/server/lib/transform_action_params.ts

x-pack/test/api_integration/apis/actions/delete.ts

* Throw error when alert instance already fired * shouldFire doesn't need its own boolean value

elasticmachine · 2019-06-20T13:26:41Z

💚 Build Succeeded

continuous-integration/kibana-ci/pull-request

* Initial user guides * Cleanup * Typos, example changes * Switch to tables, use ordered list for usage * Start docs around alert instances and templating * Documentation changes * Some adjustments * Apply PR feedback * Apply suggestions from code review Co-Authored-By: gchaps <[email protected]> * PR feedback pt2 * Provide better examples for alert types * Apply PR feedback * Update README locations

elasticmachine · 2019-06-20T21:34:50Z

💔 Build Failed

continuous-integration/kibana-ci/pull-request

mikecote · 2019-06-20T21:46:17Z

retest

elasticmachine · 2019-06-20T22:48:48Z

💚 Build Succeeded

continuous-integration/kibana-ci/pull-request

@ts-ignore

* Create actions plugin (elastic#35679) * Basic alerting plugin with actions * Remove relative imports * Code cleanup * Split service into 3 parts, change connector structure * Ability to disable plugin, ability to get actions * Add slack connector * Add email connector * Ability to validate params and connector options * Remove connectorOptionsSecrets for now * Fix plugin config validation * Add tests for slack connector * Default connectors register on plugin init, console renamed to log, slack to message_slack * Add remaining API endpoints for action CRUD * Add list connectors API * Change actions CRUD APIs to be closer with saved objects structure * WIP * Fix broken tests * Add encrypted attribute support * Add params and connectorOptions for email * WIP * Remove action's ability to have custom ids * Remove ts-ignore * Fix broken test * Remove default connectors from this branch * Fix API integration tests to use fixture connector * Rename connector terminology to action type * Rename actionTypeOptions to actionTypeConfig * Code cleanup * Fix broken tests * Rename alerting plugin to actions * Some code cleanup and add API unit tests * Change signature of action type service execute function * Add some plugin api integration tests * Fix type check failure * Code cleanup * Create an actions client instead of an action service * Apply Bill's PR feedback * Fix broken test * Find function to have destructured params * Add tests to ensure encrypted attributes are not returned * Fix broken test * Add tests for validation * Ensure actions can be updated without re-passing the config * Remove dead code * Test cleanup * Fix eslint issue * Apply Peter's PR feedback * Code cleanup and fix broken tests * Apply Brandon's PR feedback * Add namespace support * Fix broken test * Pass services to action executors (elastic#37194) * Pass services to action executors * Fix tests * Apply PR feedback * Apply PR feedback pt2 * Cleanup actions plugin (elastic#37250) * Cleanup actions, move code from alerting plugin PR * Rename service terminology to registry * Use static encryption key for encrypted attributes plugin inside of tests * Empty data after create test is done running * Fix type checks * Fix inconsistent naming * add server log action for alerting (elastic#37530) adds the first "builtin" alertType for performing a `server.log()` * Create alerting plugin (elastic#37043) * WIP * Rename fire function and remove @ts-ignore in all places * Change naming in alerting service * Remove alert instance class for now, support interval configuration * Cleanup TS * Split alerting between registry and client * Use saved object alongside task manager instance * Add remaining alerting APIs * Change create structure * Rename some variables, change actionGroups structure * Use handlebars for templating strings at fire time * Fix params given to alert type execute function * Use alert instance class * Alert instances support meta attributes * Move alert instances deserialization * Change interval to be ms * Rename actions es archive * Fix tests to use encrypted esArchive for action record * Add create alert test to demo end to end flow * Fix type check issue * Alerts to use references to action objects * Only update task manager tasks after saved objects are fully updated * Use scope in task manager * Fix type check * Use task manager to execute actions * Convert ids into references and back * Apply PR feedback * Fix broken test * Fix some bugs * Fix test errors * Alert interval to be previous runAt + interval instead of now + interval * Add range support * Remove extra line * Cleanup * Add alert_instance.test.ts * Add alert_type_registry.test.ts * Move tests around * Create generic task manager mock * Add note about saved objects client mock * Create alert_type_registry.mock.ts * Add alerts_client.test.ts * Add create_alert_instance_factory.test.ts * Add create_fire_handler.test.ts * WIP * Fix get_create_task_runner_function.test.ts and make test pass * Make get_create_task_runner_function.test.ts 100% coverage * Add unit tests for routes * Move files around * Created transform_action_params.ts * Add get_next_run_at.ts * Add comment explaining why we copy nextRunAt * Re-use state within alert instance * Finalize code coverage in unit tests * Create base api integration tests * Add a test that ensures end to end functionality of an alert * Fix ui capabilities test * Fix broken plugin api integration test * Fix jest tests with new saved objects client * Fix broken integration tests * Change api integration test fixture to make more sense, add functions for future tests * Move alerts integration testing into own file, prep to add more tests * Add tests to ensure failed task instances get retried * Add get_create_task_runner_function.test.ts for actions, create encrypted saved objects mock * Add action validation tests * Ensure action type validation occurs on update * Test 400 on unregistered alert types * Ensure alertTypeId can't be updated * Add validation test for alert create / update * Fix broken checks / tests * Skip failing test for now * Cleanup jest tests * Ensure action objects can be updated while keeping encrypted attributes readable * Remove partial update sopport, remove ability to change actionTypeId, require config * Ensure actionTypeConfig is validated on create and update * Add alertTypeParams validation support * Fix failing tests * Ensure alert cleanup errors don't replace the original error * Pass callCluster as a service to alerts and actions * Only pass log to alerts client * Pass savedObjectsClient as a service to alerting and actions * Fix failing tests * Remove range support, provide when current and previous task got scheduled * Ensure Joi validation happens before every execute * Remove skipped tests, to be done in future PR * Apply self feedback pt1 * Apply self feedback pt2 * Fix broken tests * Apply PR feedback * PR feedback pt1 * Apply security team PR feedback * PR feedback pt1 * PR feedback pt2 * PR feedback pt3 * Fix broken tests * Fix callCluster to have signature * Revert f11a6ae * PR feedback pt4 * Remove __jest__ folders * PR feedback pt5 * Fix Joi from leaking secrets * Fire instance actions in parallel instead of series * Fix failing jest tests * Accept core api changes * Fix saved objects client mock * PR feedback pt1 * Fix eslint issues * Throw error when alert instance already fired (elastic#39251) * Throw error when alert instance already fired * shouldFire doesn't need its own boolean value * Actions & alerting getting started user guides (elastic#39093) * Initial user guides * Cleanup * Typos, example changes * Switch to tables, use ordered list for usage * Start docs around alert instances and templating * Documentation changes * Some adjustments * Apply PR feedback * Apply suggestions from code review Co-Authored-By: gchaps <[email protected]> * PR feedback pt2 * Provide better examples for alert types * Apply PR feedback * Update README locations

@ts-ignore

* Create actions plugin (#35679) * Basic alerting plugin with actions * Remove relative imports * Code cleanup * Split service into 3 parts, change connector structure * Ability to disable plugin, ability to get actions * Add slack connector * Add email connector * Ability to validate params and connector options * Remove connectorOptionsSecrets for now * Fix plugin config validation * Add tests for slack connector * Default connectors register on plugin init, console renamed to log, slack to message_slack * Add remaining API endpoints for action CRUD * Add list connectors API * Change actions CRUD APIs to be closer with saved objects structure * WIP * Fix broken tests * Add encrypted attribute support * Add params and connectorOptions for email * WIP * Remove action's ability to have custom ids * Remove ts-ignore * Fix broken test * Remove default connectors from this branch * Fix API integration tests to use fixture connector * Rename connector terminology to action type * Rename actionTypeOptions to actionTypeConfig * Code cleanup * Fix broken tests * Rename alerting plugin to actions * Some code cleanup and add API unit tests * Change signature of action type service execute function * Add some plugin api integration tests * Fix type check failure * Code cleanup * Create an actions client instead of an action service * Apply Bill's PR feedback * Fix broken test * Find function to have destructured params * Add tests to ensure encrypted attributes are not returned * Fix broken test * Add tests for validation * Ensure actions can be updated without re-passing the config * Remove dead code * Test cleanup * Fix eslint issue * Apply Peter's PR feedback * Code cleanup and fix broken tests * Apply Brandon's PR feedback * Add namespace support * Fix broken test * Pass services to action executors (#37194) * Pass services to action executors * Fix tests * Apply PR feedback * Apply PR feedback pt2 * Cleanup actions plugin (#37250) * Cleanup actions, move code from alerting plugin PR * Rename service terminology to registry * Use static encryption key for encrypted attributes plugin inside of tests * Empty data after create test is done running * Fix type checks * Fix inconsistent naming * add server log action for alerting (#37530) adds the first "builtin" alertType for performing a `server.log()` * Create alerting plugin (#37043) * WIP * Rename fire function and remove @ts-ignore in all places * Change naming in alerting service * Remove alert instance class for now, support interval configuration * Cleanup TS * Split alerting between registry and client * Use saved object alongside task manager instance * Add remaining alerting APIs * Change create structure * Rename some variables, change actionGroups structure * Use handlebars for templating strings at fire time * Fix params given to alert type execute function * Use alert instance class * Alert instances support meta attributes * Move alert instances deserialization * Change interval to be ms * Rename actions es archive * Fix tests to use encrypted esArchive for action record * Add create alert test to demo end to end flow * Fix type check issue * Alerts to use references to action objects * Only update task manager tasks after saved objects are fully updated * Use scope in task manager * Fix type check * Use task manager to execute actions * Convert ids into references and back * Apply PR feedback * Fix broken test * Fix some bugs * Fix test errors * Alert interval to be previous runAt + interval instead of now + interval * Add range support * Remove extra line * Cleanup * Add alert_instance.test.ts * Add alert_type_registry.test.ts * Move tests around * Create generic task manager mock * Add note about saved objects client mock * Create alert_type_registry.mock.ts * Add alerts_client.test.ts * Add create_alert_instance_factory.test.ts * Add create_fire_handler.test.ts * WIP * Fix get_create_task_runner_function.test.ts and make test pass * Make get_create_task_runner_function.test.ts 100% coverage * Add unit tests for routes * Move files around * Created transform_action_params.ts * Add get_next_run_at.ts * Add comment explaining why we copy nextRunAt * Re-use state within alert instance * Finalize code coverage in unit tests * Create base api integration tests * Add a test that ensures end to end functionality of an alert * Fix ui capabilities test * Fix broken plugin api integration test * Fix jest tests with new saved objects client * Fix broken integration tests * Change api integration test fixture to make more sense, add functions for future tests * Move alerts integration testing into own file, prep to add more tests * Add tests to ensure failed task instances get retried * Add get_create_task_runner_function.test.ts for actions, create encrypted saved objects mock * Add action validation tests * Ensure action type validation occurs on update * Test 400 on unregistered alert types * Ensure alertTypeId can't be updated * Add validation test for alert create / update * Fix broken checks / tests * Skip failing test for now * Cleanup jest tests * Ensure action objects can be updated while keeping encrypted attributes readable * Remove partial update sopport, remove ability to change actionTypeId, require config * Ensure actionTypeConfig is validated on create and update * Add alertTypeParams validation support * Fix failing tests * Ensure alert cleanup errors don't replace the original error * Pass callCluster as a service to alerts and actions * Only pass log to alerts client * Pass savedObjectsClient as a service to alerting and actions * Fix failing tests * Remove range support, provide when current and previous task got scheduled * Ensure Joi validation happens before every execute * Remove skipped tests, to be done in future PR * Apply self feedback pt1 * Apply self feedback pt2 * Fix broken tests * Apply PR feedback * PR feedback pt1 * Apply security team PR feedback * PR feedback pt1 * PR feedback pt2 * PR feedback pt3 * Fix broken tests * Fix callCluster to have signature * Revert f11a6ae * PR feedback pt4 * Remove __jest__ folders * PR feedback pt5 * Fix Joi from leaking secrets * Fire instance actions in parallel instead of series * Fix failing jest tests * Accept core api changes * Fix saved objects client mock * PR feedback pt1 * Fix eslint issues * Throw error when alert instance already fired (#39251) * Throw error when alert instance already fired * shouldFire doesn't need its own boolean value * Actions & alerting getting started user guides (#39093) * Initial user guides * Cleanup * Typos, example changes * Switch to tables, use ordered list for usage * Start docs around alert instances and templating * Documentation changes * Some adjustments * Apply PR feedback * Apply suggestions from code review Co-Authored-By: gchaps <[email protected]> * PR feedback pt2 * Provide better examples for alert types * Apply PR feedback * Update README locations

mikecote added the Feature:Alerting label May 23, 2019

mikecote self-assigned this May 23, 2019

mikecote added the :Stack Services label May 24, 2019

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

1671d5d

mikecote added :Stack Services and removed :Stack Services labels May 28, 2019

mikecote and others added 9 commits May 28, 2019 14:40

Pass services to action executors (#37194)

ac7b3e2

* Pass services to action executors * Fix tests * Apply PR feedback * Apply PR feedback pt2

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

9ea8594

add server log action for alerting (#37530)

4be76d3

adds the first "builtin" alertType for performing a `server.log()`

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

3c46d13

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

1c501dd

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

b1a6583

Merge with master

3074ef2

This comment has been minimized.

Sign in to view

mikecote added 2 commits June 18, 2019 09:47

Fix failing jest tests

91a4219

Accept core api changes

f8b39a5

This comment has been minimized.

Sign in to view

Fix saved objects client mock

5839a9d

This comment has been minimized.

Sign in to view

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

a762bff

This comment has been minimized.

Sign in to view

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

76ec667

This comment has been minimized.

Sign in to view

mikecote marked this pull request as ready for review June 19, 2019 12:53

mikecote added release_note:skip Skip the PR/issue when compiling release notes v7.3.0 v8.0.0 labels Jun 19, 2019

rudolf approved these changes Jun 19, 2019

View reviewed changes

rudolf mentioned this pull request Jun 19, 2019

Implement saved queries and filters #39140

Merged

27 tasks

bmcconaghy approved these changes Jun 19, 2019

View reviewed changes

azasypkin approved these changes Jun 19, 2019

View reviewed changes

mikecote added 2 commits June 19, 2019 13:22

PR feedback pt1

68445b1

Fix eslint issues

49ac129

This comment has been minimized.

Sign in to view

Throw error when alert instance already fired (#39251)

8478d21

* Throw error when alert instance already fired * shouldFire doesn't need its own boolean value

mikecote added 2 commits June 20, 2019 16:05

Merge with master

d771163

This comment has been minimized.

Sign in to view

mikecote merged commit 98f7c75 into master Jun 20, 2019

mikecote mentioned this pull request Jun 20, 2019

[7.x] Introduce basic alerting and actions plugin (#37042) #39416

Merged

cachedout mentioned this pull request Jul 8, 2019

Migration of existing Watcher alerts to Alerting Framework #40505

Closed

6 tasks

njd5475 mentioned this pull request Sep 13, 2019

Alerting and action services #24214

Closed

19 tasks

mikecote deleted the feature/alerting branch October 9, 2019 16:43

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Introduce basic alerting and actions plugin #37042

Introduce basic alerting and actions plugin #37042

mikecote commented May 23, 2019 •

edited

Loading

elasticmachine commented May 28, 2019

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

rudolf left a comment

bmcconaghy left a comment

azasypkin left a comment

azasypkin Jun 19, 2019

pmuellr Jun 19, 2019

azasypkin Jun 19, 2019

mikecote Jun 19, 2019 •

edited

Loading

azasypkin Jun 19, 2019

This comment has been minimized.

This comment has been minimized.

elasticmachine commented Jun 20, 2019

This comment has been minimized.

elasticmachine commented Jun 20, 2019

mikecote commented Jun 20, 2019

elasticmachine commented Jun 20, 2019

Introduce basic alerting and actions plugin #37042

Introduce basic alerting and actions plugin #37042

Conversation

mikecote commented May 23, 2019 • edited Loading

elasticmachine commented May 28, 2019

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

rudolf left a comment

Choose a reason for hiding this comment

bmcconaghy left a comment

Choose a reason for hiding this comment

azasypkin left a comment

Choose a reason for hiding this comment

azasypkin Jun 19, 2019

Choose a reason for hiding this comment

pmuellr Jun 19, 2019

Choose a reason for hiding this comment

azasypkin Jun 19, 2019

Choose a reason for hiding this comment

mikecote Jun 19, 2019 • edited Loading

Choose a reason for hiding this comment

azasypkin Jun 19, 2019

Choose a reason for hiding this comment

This comment has been minimized.

This comment has been minimized.

elasticmachine commented Jun 20, 2019

💚 Build Succeeded

This comment has been minimized.

elasticmachine commented Jun 20, 2019

💔 Build Failed

mikecote commented Jun 20, 2019

elasticmachine commented Jun 20, 2019

💚 Build Succeeded

mikecote commented May 23, 2019 •

edited

Loading

mikecote Jun 19, 2019 •

edited

Loading