[Alerting] Update README #100478
Merged
[Alerting] Update README #100478
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ymao1
commented
May 24, 2021
| |tags|The tags associated with this rule. This will eventually be removed in favor of `rule.tags`.| | ||
| |createdBy|The user ID of the user that created this rule. This will eventually be removed in favor of `rule.createdBy`.| | ||
| |updatedBy|The user ID of the user that last updated this rule. This will eventually be removed in favor of `rule.updatedBy`.| | ||
| |rule.name|The name of this rule.| |
There was a problem hiding this comment.
These rule inputs were added in this PR
ymao1
commented
May 24, 2021
| - `get` | ||
| - `getAlertState` | ||
| - `getRuleState` | ||
| - `getAlertSummary` |
There was a problem hiding this comment.
These privilege strings were updated in this PR
ymao1
added
Feature:Alerting
release_note:skip
|
Pinging @elastic/kibana-alerting-services (Team:Alerting Services) |
ymao1
commented
May 24, 2021
| ## Terminology | ||
|
|
||
| **Alert Type**: A function that takes parameters and executes actions to alert instances. | ||
| > Disclaimer: We are actively working to update the terminology of the Alerting Framework. While all user-facing terminology has been updated, much of the codebase is still a work in progress. |
There was a problem hiding this comment.
Terminology disclaimer added here.
💚 Build Succeeded
Metrics [docs]Unknown metric groupsReferences to deprecated APIs
History
To update your PR or re-run it, just comment with: cc @ymao1 |
ymao1
added
the
auto-backport
kibanamachine
pushed a commit
to kibanamachine/kibana
that referenced
this pull request
May 24, 2021
* Updating readme * Updating readme * Fix plugin list docs
💚 Backport successful
This backport PR will be merged automatically after passing CI. |
kibanamachine
added a commit
that referenced
this pull request
May 24, 2021
* Updating readme * Updating readme * Fix plugin list docs Co-authored-by: ymao1 <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Updated Alerting README to reflect updated terminology. Also updated some sections that should have been updated with recent PR changes.