github-mirrors/kibana
1
0
Fork 0
mirror of https://github.com/elastic/kibana.git synced 2025-04-23 09:19:04 -04:00
Code Issues Projects Releases Packages Wiki Activity

[8.9] [DOCS] Add rule.params to rule action variables (#161714) (#161792)

Browse source 
# Backport

This will backport the following commits from `main` to `8.9`:
- [[DOCS] Add rule.params to rule action variables
(#161714)](https://github.com/elastic/kibana/pull/161714)

<!--- Backport version: 8.9.7 -->

### Questions ?
Please refer to the [Backport tool
documentation](https://github.com/sqren/backport)

<!--BACKPORT [{"author":{"name":"Lisa
Cawley","email":"lcawley@elastic.co"},"sourceCommit":{"committedDate":"2023-07-12T16:56:57Z","message":"[DOCS]
Add rule.params to rule action variables
(#161714)","sha":"7f3c9e8c811c0eff75a3d8d27ce337eeaddeded1","branchLabelMapping":{"^v8.10.0$":"main","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["release_note:skip","Team:ResponseOps","docs","Feature:Alerting/RuleActions","backport:prev-minor","v8.9.0","v8.10.0"],"number":161714,"url":"https://github.com/elastic/kibana/pull/161714","mergeCommit":{"message":"[DOCS]
Add rule.params to rule action variables
(#161714)","sha":"7f3c9e8c811c0eff75a3d8d27ce337eeaddeded1"}},"sourceBranch":"main","suggestedTargetBranches":["8.9"],"targetPullRequestStates":[{"branch":"8.9","label":"v8.9.0","labelRegex":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"main","label":"v8.10.0","labelRegex":"^v8.10.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/161714","number":161714,"mergeCommit":{"message":"[DOCS]
Add rule.params to rule action variables
(#161714)","sha":"7f3c9e8c811c0eff75a3d8d27ce337eeaddeded1"}}]}]
BACKPORT-->

Co-authored-by: Lisa Cawley <lcawley@elastic.co>
This commit is contained in:
Kibana Machine 2023-07-12 13:22:05 -04:00 • committed by GitHub
parent 5442b6b330
commit 1489f70e08
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 8 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

11
docs/user/alerting/action-variables.asciidoc
View file

@ -1,5 +1,9 @@
[[rule-action-variables]]
== Rule action variables
:frontmatter-description: A summary of common variables for use in {kib} alerting rule actions.
:frontmatter-tags-products: [alerting]
:frontmatter-tags-content-type: [reference]
:frontmatter-tags-user-goals: [configure]
Alerting rules can use the https://mustache.github.io/mustache.5.html[Mustache] template syntax
(`{{variable name}}`) to pass values when the actions run.
@ -30,9 +34,10 @@ All rule types pass the following variables:
`date`:: The date the rule scheduled the action, in ISO format.
`kibanaBaseUrl`:: The configured <<server-publicBaseUrl,`server.publicBaseUrl`>>. If not configured, this will be empty.
`rule.id`:: The ID of the rule.
`rule.name`:: The name of the rule.
`rule.spaceId`:: The ID of the space for the rule.
`rule.id`:: The rule identifier.
`rule.name`:: The rule name.
`rule.params`:: The rule parameters, which vary by rule type.
`rule.spaceId`:: The space identifier for the rule.
`rule.tags`:: The list of tags applied to the rule.
[float]