Skip to content

Commit

Permalink
[8.13] [DOCS] Add alert.consecutiveMatches and rule.url action variab…
Browse files Browse the repository at this point in the history
…les (elastic#179018) (elastic#179114)

# Backport

This will backport the following commits from `main` to `8.13`:
- [[DOCS] Add alert.consecutiveMatches and rule.url action variables
(elastic#179018)](elastic#179018)

<!--- Backport version: 9.4.3 -->

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

<!--BACKPORT [{"author":{"name":"Lisa
Cawley","email":"[email protected]"},"sourceCommit":{"committedDate":"2024-03-20T21:45:05Z","message":"[DOCS]
Add alert.consecutiveMatches and rule.url action variables
(elastic#179018)","sha":"0bc830ea29c3abb87f66e11eaa9f471c4bb88826","branchLabelMapping":{"^v8.14.0$":"main","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["Feature:Alerting","release_note:skip","Team:ResponseOps","docs","v8.14.0","v8.13.1"],"title":"[DOCS]
Add alert.consecutiveMatches and rule.url action
variables","number":179018,"url":"https://github.com/elastic/kibana/pull/179018","mergeCommit":{"message":"[DOCS]
Add alert.consecutiveMatches and rule.url action variables
(elastic#179018)","sha":"0bc830ea29c3abb87f66e11eaa9f471c4bb88826"}},"sourceBranch":"main","suggestedTargetBranches":["8.13"],"targetPullRequestStates":[{"branch":"main","label":"v8.14.0","branchLabelMappingKey":"^v8.14.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/179018","number":179018,"mergeCommit":{"message":"[DOCS]
Add alert.consecutiveMatches and rule.url action variables
(elastic#179018)","sha":"0bc830ea29c3abb87f66e11eaa9f471c4bb88826"}},{"branch":"8.13","label":"v8.13.1","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"}]}]
BACKPORT-->

Co-authored-by: Lisa Cawley <[email protected]>
  • Loading branch information
kibanamachine and lcawl authored Mar 20, 2024
1 parent 5b21dc4 commit 371b0a8
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions docs/user/alerting/action-variables.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,7 @@ All rule types pass the following variables:
`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.
`rule.url`:: The URL for the rule that generated the alert. This will be an empty string if the `server.publicBaseUrl` setting is not configured.

[float]
[role="child_attributes"]
Expand Down Expand Up @@ -107,6 +108,7 @@ If the rule's action frequency is not a summary of alerts, it passes the followi
`alert.actionGroup`:: The ID of the action group of the alert that scheduled the action.
`alert.actionGroupName`:: The name of the action group of the alert that scheduled the action.
`alert.actionSubgroup`:: The action subgroup of the alert that scheduled the action.
`alert.consecutiveMatches`:: The number of consecutive runs that meet the rule conditions.
`alert.flapping`:: A flag on the alert that indicates whether the alert status is changing repeatedly.
`alert.id`:: The ID of the alert that scheduled the action.
`alert.uuid`:: A universally unique identifier for the alert. While the alert is active, the UUID value remains unchanged each time the rule runs. preview:[]
Expand Down

0 comments on commit 371b0a8

Please sign in to comment.