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

pmuellr · 2021-02-24T22:06:01Z

Summary

resolves #90006

For task manager, adds a note about the fact that the max_workers will be
limited to 100 starting in 8.0. Currently we allow any value (because we
always have), but do print a "deprecation" warning that the limit cannot
be exceeded starting in 8.0.

For alerting, adds note about the JSON expansion of action variables which are objects.

Checklist

Delete any items that are not applicable to this PR.

Any text added follows EUI's writing guidelines, uses sentence case text and includes i18n support
Documentation was added for features that require explanation or tutorials
~~Unit or functional tests were updated or added to match the most common scenarios~~
~~Any UI touched in this PR is usable by keyboard only (learn more about keyboard accessibility)~~
~~Any UI touched in this PR does not create any new axe failures (run axe in browser: FF, Chrome)~~
~~If a plugin configuration key changed, check if it needs to be allowlisted in the cloud and added to the [docker list]~~(https://github.com/elastic/kibana/blob/c29adfef29e921cc447d2a5ed06ac2047ceab552/src/dev/build/tasks/os_packages/docker_generator/resources/bin/kibana-docker)
~~This renders correctly on smaller devices using a responsive layout. (You can test this in your browser)~~
~~This was checked for cross-browser compatibility~~

For maintainers

~~This was checked for breaking API changes and was labeled appropriately~~

…r max_workers resolves elastic#90006 For task manager, adds a note about the fact that the max_workers will be limited to 100 starting in 8.0. Currently we allow any value (because we always have), but do print a "deprecation" warning that the limit cannot be exceeded starting in 8.0

elasticmachine · 2021-02-24T22:49:25Z

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

YulNaumenko

LGTM

ymao1

LGTM. Just one suggestion for removing a duplication inside a sentence.

ymao1 · 2021-02-25T12:56:26Z

docs/user/alerting/defining-alerts.asciidoc

@@ -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.


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.

gchaps

LGTM with suggested changes.

…r max_workers (elastic#92720) resolves elastic#90006 For task manager, adds a note about the fact that the max_workers will be limited to 100 starting in 8.0. Currently we allow any value (because we always have), but do print a "deprecation" warning that the limit cannot be exceeded starting in 8.0 For alerting, adds note about the JSON expansion of action variables which are objects.

kibanamachine · 2021-03-03T21:51:45Z

💚 Backport successful

✅ 7.11 / #93519
✅ 7.12 / #93520
✅ 7.x / #93521

Successful backport PRs will be merged automatically after passing CI.

…r max_workers (#92720) (#93521) resolves #90006 For task manager, adds a note about the fact that the max_workers will be limited to 100 starting in 8.0. Currently we allow any value (because we always have), but do print a "deprecation" warning that the limit cannot be exceeded starting in 8.0 For alerting, adds note about the JSON expansion of action variables which are objects. Co-authored-by: Patrick Mueller <[email protected]>

…r max_workers (#92720) (#93520) resolves #90006 For task manager, adds a note about the fact that the max_workers will be limited to 100 starting in 8.0. Currently we allow any value (because we always have), but do print a "deprecation" warning that the limit cannot be exceeded starting in 8.0 For alerting, adds note about the JSON expansion of action variables which are objects. Co-authored-by: Patrick Mueller <[email protected]>

…r max_workers (#92720) (#93519) resolves #90006 For task manager, adds a note about the fact that the max_workers will be limited to 100 starting in 8.0. Currently we allow any value (because we always have), but do print a "deprecation" warning that the limit cannot be exceeded starting in 8.0 For alerting, adds note about the JSON expansion of action variables which are objects. Co-authored-by: Patrick Mueller <[email protected]>

* master: (48 commits) Fix wrong import in data plugin causing 100kB bundle increase (elastic#93448) [Fleet] Correctly track install status of an integration (elastic#93464) Reviews data frame analytics UI text (elastic#93033) Display multiple copyable fields for process.args in resolver node detail panel (elastic#93280) [Security Solution][Detections] ML Popover overflow fix (elastic#93525) chore(NA): do not use execa on bazel workspace status update script (elastic#93532) Bump dependencies (elastic#93511) [dev/build_ts_refs] support disabling the ts-refs build completely (elastic#93529) [Security Solution] fix data provider cypress test (elastic#93465) Fix service map for All environment single service (elastic#93517) [Fleet] Fix package version comparaison in the UI (elastic#93498) [alerting] adds doc on JSON-expanded action variables and task manager max_workers (elastic#92720) [dev/build_ts_refs] ignore type checking failures when building ts refs (elastic#93473) [core-new-docs] Adds a dev-doc for core documentation (elastic#92976) remove opacity from maps legacy style (elastic#93456) [Security Solution][Lists] Escape quotes in list ids and quote the id in KQL query (elastic#93176) Revert "Make tests deterministic by providing unique timestamps (elastic#93350)" [Discover] Fix link from dashboard saved search to Discover (elastic#92937) update public api docs App Search - Polishing Analytics Views (elastic#92939) ...

pmuellr added Feature:Alerting release_note:skip Skip the PR/issue when compiling release notes Team:ResponseOps Label for the ResponseOps team (formerly the Cases and Alerting teams) v7.12.0 v8.0.0 labels Feb 24, 2021

pmuellr marked this pull request as ready for review February 24, 2021 22:49

pmuellr requested a review from a team as a code owner February 24, 2021 22:49

YulNaumenko requested a review from gchaps February 25, 2021 02:53

YulNaumenko approved these changes Feb 25, 2021

View reviewed changes

ymao1 approved these changes Feb 25, 2021

View reviewed changes

gchaps approved these changes Feb 25, 2021

View reviewed changes

pmuellr added 2 commits March 3, 2021 15:50

Merge branch 'master' into alerting/docs-update-7-12

28a6a00

fix issues from PR comments

04e6e3c

pmuellr added v7.13.0 v7.11.2 v7.11.0 auto-backport Deprecated - use backport:version if exact versions are needed and removed v7.11.2 labels Mar 3, 2021

pmuellr merged commit 60adc73 into elastic:master Mar 3, 2021

kibanamachine mentioned this pull request Mar 3, 2021

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

Merged

kibanamachine mentioned this pull request Mar 3, 2021

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

Merged

kibanamachine mentioned this pull request Mar 3, 2021

[7.x] [alerting] adds doc on JSON-expanded action variables and task manager max_workers (#92720) #93521

Merged

pmuellr added the backported label Mar 4, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

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

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

pmuellr commented Feb 24, 2021 •

edited

Loading

elasticmachine commented Feb 24, 2021

YulNaumenko left a comment

ymao1 left a comment

ymao1 Feb 25, 2021 •

edited by gchaps

Loading

gchaps left a comment

kibanamachine commented Mar 3, 2021

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

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

Conversation

pmuellr commented Feb 24, 2021 • edited Loading

Summary

Checklist

For maintainers

elasticmachine commented Feb 24, 2021

YulNaumenko left a comment

Choose a reason for hiding this comment

ymao1 left a comment

Choose a reason for hiding this comment

ymao1 Feb 25, 2021 • edited by gchaps Loading

Choose a reason for hiding this comment

gchaps left a comment

Choose a reason for hiding this comment

kibanamachine commented Mar 3, 2021

💚 Backport successful

pmuellr commented Feb 24, 2021 •

edited

Loading

ymao1 Feb 25, 2021 •

edited by gchaps

Loading