Create new alerting HTTP APIs that use the new terminology #93977

mikecote · 2021-03-08T17:55:21Z

Resolves #90377
Resolves #85639

This PR creates new alerting HTTP APIs that use the terminology and deprecates the existing alert APIs.

The new HTTP APIs are as follows:

Create rule: POST /api/alerting/rule/<id>
Get rule: GET /api/alerting/rule/<id>
Update rule: PUT /api/alerting/rule/<id>
Delete rule: DELETE: /api/alerting/rule/<id>
Disable rule: POST /api/alerting/rule/<id>/_disable
Enable rule: POST /api/alerting/rule/<id>/_enable
Find rules: GET /api/alerting/rules/_find
Get Alerting framework health: GET /api/alerting/_health
List rule types: GET /api/alerting/rule_types
Mute alert: POST /api/alerting/rule/<rule_id>/alert/<alert_id>/_mute
Unmute alert: POST /api/alerting/rule/<rule_id>/alert/<alert_id>/_unmute
Mute all alerts: POST /api/alerting/rule/<id>/_mute_all
Unmute all alerts: POST /api/alerting/rule/<id>/_unmute_all

Sub-PRs merged into this feature branch:

Move current alert HTTP APIs to legacy folder Move current alert HTTP APIs to legacy folder #93943
- Renaming BASE_ALERT_API_PATH to LEGACY_BASE_ALERT_API_PATH
- Move all APIs within a legacy subfolder
- Create a defineRoutes function to define all alerting routes
- Create a defineLegacyRoutes function to define all legacy alerting routes
Create new rule HTTP APIs Create new rule HTTP APIs #93980
- Adds new APIs using the new terminology. See Create new rule HTTP APIs that use the new terminology #90377 (comment) for the delta.
- Fixes alerts client “create” function to return "SanitizedAlert” type instead of “Alert” (including stack monitoring and security solution impacts).
- Adds “BASE_ALERTING_API_PATH” as the new const for new APIs.
Update documentation Create docs for new rule HTTP APIs, deprecate old docs #94745
- Moves old HTTP API docs to /legacy
- Updates existing docs to use new terminology
Make API integration tests to use new APIs Make alerting tests use new rules APIs #95159
- Converts the API integration tests to solely use the new APIs from Create new rule HTTP APIs #93980
- Converts the end to end tests to use the new APIs from Create new rule HTTP APIs #93980
Add some API integration coverage for the legacy APIs Add API integration tests for legacy alert APIs #95333
- Adds a light amount of API integration tests to cover our legacy alert APIs.
Doc fixes for alerting HTTP APIs Fix alerting API docs w/ new terminology #95457
- Fixes ids within [[...]] to follow best practice by keeping it all lower case and follow the heading text. (they determine the URL path to the doc like: /create-rule-api.html)
- Renames "Rules APIs" to "Alerting APIs"
- Renames asciidoc files to a more detailed name (ex: create -> create_rule)
- Revert old doc ids to their original value (on master). This will help with bookmarks on old pages, switching doc release versions and applying redirects.
Move internal APIs to /internal Move some new alerting APIs to /internal #95461
- Moves /api/alerting/rules/_aggregate to /internal/alerting/rules/_aggregate
- Moves /api/alerting/rule/{id}/_alert_summary to /internal/alerting/rule/{id}/_alert_summary
- Moves /api/alerting/rule/{id}/state to /internal/alerting/rule/{id}/state
- Moves /api/alerting/rule/{id}/_update_api_key to /internal/alerting/rule/{id}/_update_api_key

Docs preview: https://kibana_93977.docs-preview.app.elstc.co/guide/en/kibana/master/index.html

Release Notes

The /api/alerts/* APIs are deprecated and will be removed in 8.0. Use one of the new /api/alerting/* APIs.

* Move current HTTP APIs to legacy folder * Rename BASE_ALERT_API_PATH to LEGACY_BASE_ALERT_API_PATH * Fix failing tests and extra files

* Move current HTTP APIs to legacy folder * Rename BASE_ALERT_API_PATH to LEGACY_BASE_ALERT_API_PATH * Fix failing tests and extra files * Move current alert HTTP APIs to legacy folder (#93943) * Move current HTTP APIs to legacy folder * Rename BASE_ALERT_API_PATH to LEGACY_BASE_ALERT_API_PATH * Fix failing tests and extra files * Add necessary files * Create rule route * Get rule API * Update rule API * Delete rule route * Aggregate rules API * Disable rule API * Enable rule API * Find rules API * Fix Update API * Get rule alert summary API * Get rule state API * Health API * Rule types API * Mute all API * Mute alert API * Unmute all API * Unmute alert route * Update API key API * corrected tpye by making it much more complicated * removed unneeded cocde * Fixes * Add back health route * mutedInstanceIds -> mutedAlertIds * lastRun -> last_run * alert_type_state -> rule_type_state & alert_instances -> alerts Co-authored-by: Gidi Meir Morris <[email protected]>

mikecote · 2021-03-18T14:57:56Z

@elasticmachine merge upstream

* Create docs for new APIs, deprecate old docs * Remove connector_type_id * Update docs * Add link to legacy APIs from rules API docs * Remove connector_type_id references * [DOCS] Add legacy APIs to index.asciidoc * Fix camel case Co-authored-by: lcawl <[email protected]>

* Make API integration tests use new HTTP APIs * Fix end to end tests * Fix test failures * Fix more test failures * Rename some files

…bana into alerting/http-api-terminology

mikecote · 2021-03-26T12:13:39Z

@gchaps the doc changes are ready for review (preview link in description). The summary of the changes are captured in the following PR descriptions:

Create docs for new rule HTTP APIs, deprecate old docs Create docs for new rule HTTP APIs, deprecate old docs #94745
Fix alerting API docs w/ new terminology Fix alerting API docs w/ new terminology #95457

gchaps

In the Deprecated APIs section, I'd use this as the warning.

Deprecated in 7.13.0. Use Create rule instead.

Note: remove "the" before the API name.

* Initial commit * Update README.md * Use internal API

mikecote · 2021-03-26T17:53:14Z

@gchaps fixed in 0e295af. The docs preview should update soon, I think.

mikecote · 2021-03-26T18:01:15Z

@elasticmachine merge upstream

elasticmachine · 2021-03-26T18:15:09Z

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

YulNaumenko

LGTM, since the PR contains the changes from a reviewed PRs!

gchaps

Docs look good to me. In the title "Deprecated 7.x APIs", will readers know what 7.x refers to?

ymao1

LGTM!

mikecote · 2021-03-29T11:54:48Z

@elasticmachine merge upstream

kibanamachine · 2021-03-29T14:05:32Z

💚 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`	748.1KB	748.1KB	+28.0B

Page load bundle

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

id	before	after	diff
`alerting`	60.8KB	61.4KB	+567.0B
`triggersActionsUi`	100.3KB	100.3KB	+7.0B
total			+574.0B

History

💛 Build #115583 was flaky 35a5274
💚 Build #115568 succeeded 0e295af
💚 Build #115561 succeeded b4f991e
💚 Build #115443 succeeded 0769632
💚 Build #115161 succeeded 354e3ec

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

cc @mikecote

kibanamachine · 2021-03-30T12:30:09Z

💔 Backport failed

❌ 7.x: Commit could not be cherrypicked due to conflicts

To backport manually run:
node scripts/backport --pr 93977

…3977) * Move current alert HTTP APIs to legacy folder (elastic#93943) * Move current HTTP APIs to legacy folder * Rename BASE_ALERT_API_PATH to LEGACY_BASE_ALERT_API_PATH * Fix failing tests and extra files * Create new rule HTTP APIs (elastic#93980) * Move current HTTP APIs to legacy folder * Rename BASE_ALERT_API_PATH to LEGACY_BASE_ALERT_API_PATH * Fix failing tests and extra files * Move current alert HTTP APIs to legacy folder (elastic#93943) * Move current HTTP APIs to legacy folder * Rename BASE_ALERT_API_PATH to LEGACY_BASE_ALERT_API_PATH * Fix failing tests and extra files * Add necessary files * Create rule route * Get rule API * Update rule API * Delete rule route * Aggregate rules API * Disable rule API * Enable rule API * Find rules API * Fix Update API * Get rule alert summary API * Get rule state API * Health API * Rule types API * Mute all API * Mute alert API * Unmute all API * Unmute alert route * Update API key API * corrected tpye by making it much more complicated * removed unneeded cocde * Fixes * Add back health route * mutedInstanceIds -> mutedAlertIds * lastRun -> last_run * alert_type_state -> rule_type_state & alert_instances -> alerts Co-authored-by: Gidi Meir Morris <[email protected]> * Create docs for new rule HTTP APIs, deprecate old docs (elastic#94745) * Create docs for new APIs, deprecate old docs * Remove connector_type_id * Update docs * Add link to legacy APIs from rules API docs * Remove connector_type_id references * [DOCS] Add legacy APIs to index.asciidoc * Fix camel case Co-authored-by: lcawl <[email protected]> * Make alerting tests use new rules APIs (elastic#95159) * Make API integration tests use new HTTP APIs * Fix end to end tests * Fix test failures * Fix more test failures * Rename some files * Add tests for legacy APIs (elastic#95333) * Initial commit (elastic#95457) * Move some new alerting APIs to /internal (elastic#95461) * Initial commit * Update README.md * Use internal API * Merge deprecated warning w/ alternative solution * Update API docs Co-authored-by: Gidi Meir Morris <[email protected]> Co-authored-by: Kibana Machine <[email protected]> Co-authored-by: lcawl <[email protected]> # Conflicts: # api_docs/core.json

…95781) * Move current alert HTTP APIs to legacy folder (#93943) * Move current HTTP APIs to legacy folder * Rename BASE_ALERT_API_PATH to LEGACY_BASE_ALERT_API_PATH * Fix failing tests and extra files * Create new rule HTTP APIs (#93980) * Move current HTTP APIs to legacy folder * Rename BASE_ALERT_API_PATH to LEGACY_BASE_ALERT_API_PATH * Fix failing tests and extra files * Move current alert HTTP APIs to legacy folder (#93943) * Move current HTTP APIs to legacy folder * Rename BASE_ALERT_API_PATH to LEGACY_BASE_ALERT_API_PATH * Fix failing tests and extra files * Add necessary files * Create rule route * Get rule API * Update rule API * Delete rule route * Aggregate rules API * Disable rule API * Enable rule API * Find rules API * Fix Update API * Get rule alert summary API * Get rule state API * Health API * Rule types API * Mute all API * Mute alert API * Unmute all API * Unmute alert route * Update API key API * corrected tpye by making it much more complicated * removed unneeded cocde * Fixes * Add back health route * mutedInstanceIds -> mutedAlertIds * lastRun -> last_run * alert_type_state -> rule_type_state & alert_instances -> alerts Co-authored-by: Gidi Meir Morris <[email protected]> * Create docs for new rule HTTP APIs, deprecate old docs (#94745) * Create docs for new APIs, deprecate old docs * Remove connector_type_id * Update docs * Add link to legacy APIs from rules API docs * Remove connector_type_id references * [DOCS] Add legacy APIs to index.asciidoc * Fix camel case Co-authored-by: lcawl <[email protected]> * Make alerting tests use new rules APIs (#95159) * Make API integration tests use new HTTP APIs * Fix end to end tests * Fix test failures * Fix more test failures * Rename some files * Add tests for legacy APIs (#95333) * Initial commit (#95457) * Move some new alerting APIs to /internal (#95461) * Initial commit * Update README.md * Use internal API * Merge deprecated warning w/ alternative solution * Update API docs Co-authored-by: Gidi Meir Morris <[email protected]> Co-authored-by: Kibana Machine <[email protected]> Co-authored-by: lcawl <[email protected]> # Conflicts: # api_docs/core.json

mikecote added release_note:deprecation Feature:Alerting v8.0.0 Team:ResponseOps Label for the ResponseOps team (formerly the Cases and Alerting teams) v7.13.0 labels Mar 8, 2021

mikecote self-assigned this Mar 8, 2021

mikecote mentioned this pull request Mar 8, 2021

Create new rule HTTP APIs #93980

Merged

mikecote mentioned this pull request Mar 16, 2021

Create docs for new rule HTTP APIs, deprecate old docs #94745

Merged

Move current alert HTTP APIs to legacy folder (#93943)

09e8a3b

* Move current HTTP APIs to legacy folder * Rename BASE_ALERT_API_PATH to LEGACY_BASE_ALERT_API_PATH * Fix failing tests and extra files

mikecote force-pushed the alerting/http-api-terminology branch from 3a69fd8 to 09e8a3b Compare March 16, 2021 18:47

mikecote mentioned this pull request Mar 16, 2021

[8.0 only] Alert notifyWhen field should not be nullable #85639

Closed

mikecote and others added 2 commits March 17, 2021 12:10

Merge with master, fix health APIs

a38ec48

kibanamachine and others added 2 commits March 18, 2021 10:57

Merge branch 'master' into alerting/http-api-terminology

cd68091

This was referenced Mar 23, 2021

Make alerting tests use new rules APIs #95159

Merged

Add API integration tests for legacy alert APIs #95333

Merged

Make alerting tests use new rules APIs (#95159)

354e3ec

* Make API integration tests use new HTTP APIs * Fix end to end tests * Fix test failures * Fix more test failures * Rename some files

This was referenced Mar 25, 2021

Fix alerting API docs w/ new terminology #95457

Merged

Move some new alerting APIs to /internal #95461

Merged

mikecote added 4 commits March 26, 2021 07:22

Add tests for legacy APIs (#95333)

93067e5

Initial commit (#95457)

ff31eb5

Merge with master

d9de5d8

Merge branch 'alerting/http-api-terminology' of github.com:elastic/ki…

0769632

…bana into alerting/http-api-terminology

mikecote requested a review from gchaps March 26, 2021 12:13

mikecote changed the title ~~Create new rule HTTP APIs that use the new terminology~~ Create new alerting HTTP APIs that use the new terminology Mar 26, 2021

gchaps reviewed Mar 26, 2021

View reviewed changes

Move some new alerting APIs to /internal (#95461)

b4f991e

* Initial commit * Update README.md * Use internal API

Merge deprecated warning w/ alternative solution

0e295af

Merge branch 'master' into alerting/http-api-terminology

362397e

mikecote marked this pull request as ready for review March 26, 2021 18:15

mikecote requested review from a team as code owners March 26, 2021 18:15

mikecote added the auto-backport Deprecated - use backport:version if exact versions are needed label Mar 26, 2021

YulNaumenko approved these changes Mar 26, 2021

View reviewed changes

Update API docs

35a5274

gchaps approved these changes Mar 26, 2021

View reviewed changes

ymao1 approved these changes Mar 26, 2021

View reviewed changes

Merge branch 'master' into alerting/http-api-terminology

03f8a23

mikecote merged commit 3abb79a into master Mar 30, 2021

mikecote mentioned this pull request Mar 30, 2021

Make alerting UIs use new rule APIs #90381

Closed

mikecote mentioned this pull request Mar 30, 2021

[7.x] Create new alerting HTTP APIs that use the new terminology (#93977) #95781

Merged

mikecote deleted the alerting/http-api-terminology branch May 10, 2021 14:47

pmuellr mentioned this pull request Nov 11, 2021

[Alerting] Update internal API calls use new Alerting APIs #116939

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Create new alerting HTTP APIs that use the new terminology #93977

Create new alerting HTTP APIs that use the new terminology #93977

mikecote commented Mar 8, 2021 •

edited

Loading

mikecote commented Mar 18, 2021

mikecote commented Mar 26, 2021

gchaps left a comment

mikecote commented Mar 26, 2021

mikecote commented Mar 26, 2021

elasticmachine commented Mar 26, 2021

YulNaumenko left a comment

gchaps left a comment

ymao1 left a comment

mikecote commented Mar 29, 2021

kibanamachine commented Mar 29, 2021

kibanamachine commented Mar 30, 2021

Create new alerting HTTP APIs that use the new terminology #93977

Create new alerting HTTP APIs that use the new terminology #93977

Conversation

mikecote commented Mar 8, 2021 • edited Loading

Release Notes

mikecote commented Mar 18, 2021

mikecote commented Mar 26, 2021

gchaps left a comment

Choose a reason for hiding this comment

mikecote commented Mar 26, 2021

mikecote commented Mar 26, 2021

elasticmachine commented Mar 26, 2021

YulNaumenko left a comment

Choose a reason for hiding this comment

gchaps left a comment

Choose a reason for hiding this comment

ymao1 left a comment

Choose a reason for hiding this comment

mikecote commented Mar 29, 2021

kibanamachine commented Mar 29, 2021

💚 Build Succeeded

Metrics [docs]

Async chunks

Page load bundle

History

kibanamachine commented Mar 30, 2021

💔 Backport failed

mikecote commented Mar 8, 2021 •

edited

Loading