Skip to content
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.

Sign up for GitHub

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

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

Merged
merged 3 commits into from
Feb 25, 2021
Merged

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

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
633435d
[Alerts][Docs] Extended README.md and the user docs with the licensin…
YulNaumenko Feb 24, 2021
01acaa0
Apply suggestions from code review
YulNaumenko Feb 24, 2021
17cfd85
fixed due to comments
YulNaumenko Feb 25, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions docs/user/alerting/alert-types.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,14 @@ For domain-specific alerts, refer to the documentation for that app.
* <<geo-alerting, Maps alerts>>
* <<xpack-ml, ML alerts>>

[NOTE]
==============================================
Some alert types are subscription features, while others are free features.
For a comparison of the Elastic subscription levels,
see {subscriptions}[the subscription page].
==============================================


include::stack-alerts/index-threshold.asciidoc[]
include::stack-alerts/es-query.asciidoc[]
include::maps-alerts/geo-alert-types.asciidoc[]
15 changes: 15 additions & 0 deletions x-pack/plugins/alerts/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,9 @@ Table of Contents
- [Alert types](#alert-types)
- [Methods](#methods)
- [Executor](#executor)
- [Licensing](#licensing)
- [Documentation](#documentation)
- [Tests](#tests)
- [Example](#example)
- [Role Based Access-Control](#role-based-access-control)
- [Alert Navigation](#alert-navigation)
Expand Down Expand Up @@ -124,6 +127,18 @@ For example, if the `context` has one variable `foo` which is an object that has
}
```

## Licensing

Currently most of the alerts are free features. But some alert types are subscription features, such as the tracking containment alert.

## Documentation

You should create documentation for the new alert type. Make an entry in the alert type index [`docs/user/alerting/alert-types.asciidoc`](../../../docs/user/alerting/alert-types.asciidoc) that points to a new document for the alert type that should be in the directory [`docs/user/alerting/alert-types`](../../../docs/user/alerting/alert-types).

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Presumably solution specific alert types should be under their directories rather than docs/user/alerting/alert-types/? 🤔

If so, best to clarify that

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I will replace this part with more generic definition. 👍

## Tests

The alert type should have both jest tests and functional tests.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is it worth clarifying what should be tested (such as alert specific action groups, parameters etc.) vs. things that we guarantee as a framework and do not need to be independently tested by each alert type? 🤔


### Example

This example receives server and threshold as parameters. It will read the CPU usage of the server and schedule actions to be executed (asynchronously by the task manager) if the reading is greater than the threshold.
Expand Down