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

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

Browse source
This commit is contained in:
Lisa Cawley 2023-07-12 09:56:57 -07:00 • committed by GitHub
parent 78700f3691
commit 7f3c9e8c81
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]