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

[alerting] adds doc on JSON-expanded action variables and task manager max_workers #92720

Merged
merged 3 commits into from
Mar 3, 2021
Merged

[alerting] adds doc on JSON-expanded action variables and task manager max_workers #92720

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a1229c2
[alerting] adds doc on JSON-expanded action variables and task manage…
pmuellr Feb 24, 2021
28a6a00
Merge branch 'master' into alerting/docs-update-7-12
pmuellr Mar 3, 2021
04e6e3c
fix issues from PR comments
pmuellr Mar 3, 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
2 changes: 1 addition & 1 deletion docs/settings/task-manager-settings.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,6 @@ Task Manager runs background tasks by polling for work on an interval. You can

| `xpack.task_manager.max_workers`
| The maximum number of tasks that this Kibana instance will run simultaneously. Defaults to 10.

Starting in 8.0, it will not be possible to set the value greater than 100.

|===
4 changes: 4 additions & 0 deletions docs/user/alerting/defining-alerts.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -94,6 +94,10 @@ Some cases exist where the variable values will be "escaped", when used in a con

Mustache also supports "triple braces" of the form `{{{variable name}}}`, which indicates no escaping should be done at all. Care should be used when using this form, as it could end up rendering the variable content in such a way as to make the resulting parameter invalid or formatted incorrectly.

Each alert type defines additional variables as properties of the variable `context`. For example, if an alert type defines a variable `value`, it can be used in an action parameter as `{{context.value}}`.

For diagnostic or exploratory purposes, action variables whose values are themselves objects, such as `context`, can be referenced directly as variables. The resulting value will be a JSON representation of the object. For example, if an action parameter includes `{{context}}` in an action parameter, it will expand to the JSON representation of all the variables and values provided by the alert type.
Copy link
Contributor

@ymao1 ymao1 Feb 25, 2021 •
edited by gchaps
Loading

Choose a reason for hiding this comment

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

Suggested change
For diagnostic or exploratory purposes, action variables whose values are themselves objects, such as `context`, can be referenced directly as variables. The resulting value will be a JSON representation of the object. For example, if an action parameter includes `{{context}}` in an action parameter, it will expand to the JSON representation of all the variables and values provided by the alert type.
For diagnostic or exploratory purposes, action variables whose values are objects, such as `context`, can be referenced directly as variables. The resulting value will be a JSON representation of the object. For example, if an action parameter includes `{{context}}`, it will expand to the JSON representation of all the variables and values provided by the alert type.


You can attach more than one action. Clicking the "Add action" button will prompt you to select another alert type and repeat the above steps again.

[role="screenshot"]
Expand Down