-
Notifications
You must be signed in to change notification settings - Fork 165
Add OOB alerts and alert rule template as asset type #3537
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from 5 commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
b79810b
Alert rule template as asset type
karenzone 9c59a26
Add alert templates
karenzone c1eb956
Merge branch 'main' into 2760-alert-rule
karenzone f272cca
Merge branch 'main' into 2760-alert-rule
karenzone 346c963
Incorporate review comments
karenzone 1929768
Merge branch 'main' into 2760-alert-rule
karenzone File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Some comments aren't visible on the classic Files Changed page.
There are no files selected for viewing
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,40 @@ | ||
| --- | ||
| mapped_pages: | ||
| - https://www.elastic.co/guide/en/fleet/current/data-streams.html | ||
| applies_to: | ||
| stack: ga 9.2 | ||
| serverless: ga | ||
| products: | ||
| - id: fleet | ||
| - id: elastic-agent | ||
| navigation_title: Built-in alerts and templates | ||
| --- | ||
|
|
||
| # Built-in alerts and templates [built-in-alerts] | ||
|
|
||
| ## {{agent}} out-of-the-box alert rules [ea-alert-rules] | ||
|
|
||
| When you install or upgrade {{agent}}, new alert rules are created automatically. You can configure and customize out-of-the-box alerts to get them up and running quickly. | ||
|
|
||
| ::::{note} | ||
| The built-in alerts feature for {{agent}} is available only for some subscription levels. The license (or a trial license) must be in place before you install or upgrade {{agent}} before this feature is available. | ||
karenzone marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| Refer [Elastic subscriptions](https://www.elastic.co/subscriptions) for more information. | ||
karenzone marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| :::: | ||
|
|
||
| In {{kib}}, you can enable out-of-the-box rules pre-configured with reasonable defaults to provide immediate value for managing agents. | ||
| You can use [ES|QL](/explore-analyze/discover/try-esql.md) to author conditions for each rule. | ||
karenzone marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| Connectors are not added to rules automatically, but you can attach a connector to route alerts to your platform of choice -- Slack or email, for example. | ||
| In addition, you can add filters for policies, tags, or hostnames to scope alerts to specific sets of agents | ||
karenzone marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| You can find these rules in **Stack Management** > **Alerts and Insights** > **Rules**. | ||
karenzone marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
|
|
||
| ## Alert templates assets for integrations [alert-templates] | ||
karenzone marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| Some integration packages include alerting rule template assets that provide pre-made definitions of alerting rules. You can use the templates to create your own custom alerting rules that you can enable and fine tune. | ||
karenzone marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| When you click a template, you get a pre-filled rule creation form. You can define and adjust values, set up connectors, and define rule actions to create your custom alerting rule. | ||
|
|
||
| You can see available templates in the **integrations/detail/<package>/assets** view. | ||
karenzone marked this conversation as resolved.
Show resolved
Hide resolved
|
This file contains hidden or 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
This file contains hidden or 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
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.
Uh oh!
There was an error while loading. Please reload this page.