kibana/oas_docs/examples/update_rule_request.yaml
Kibana Machine d282c328f9
[8.x] [OpenAPI][ResponseOps] Edit descriptions for alerting rule API examples (#194080) (#194327)
# Backport

This will backport the following commits from `main` to `8.x`:
- [[OpenAPI][ResponseOps] Edit descriptions for alerting rule API
examples (#194080)](https://github.com/elastic/kibana/pull/194080)

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

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

<!--BACKPORT [{"author":{"name":"Lisa
Cawley","email":"lcawley@elastic.co"},"sourceCommit":{"committedDate":"2024-09-27T16:45:44Z","message":"[OpenAPI][ResponseOps]
Edit descriptions for alerting rule API examples
(#194080)","sha":"539ad61d377f8982f3358b1a753be45408c4998c","branchLabelMapping":{"^v9.0.0$":"main","^v8.16.0$":"8.x","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["Feature:Alerting","release_note:skip","v9.0.0","docs","v8.16.0","backport:version"],"title":"[OpenAPI][ResponseOps]
Edit descriptions for alerting rule API
examples","number":194080,"url":"https://github.com/elastic/kibana/pull/194080","mergeCommit":{"message":"[OpenAPI][ResponseOps]
Edit descriptions for alerting rule API examples
(#194080)","sha":"539ad61d377f8982f3358b1a753be45408c4998c"}},"sourceBranch":"main","suggestedTargetBranches":["8.x"],"targetPullRequestStates":[{"branch":"main","label":"v9.0.0","branchLabelMappingKey":"^v9.0.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/194080","number":194080,"mergeCommit":{"message":"[OpenAPI][ResponseOps]
Edit descriptions for alerting rule API examples
(#194080)","sha":"539ad61d377f8982f3358b1a753be45408c4998c"}},{"branch":"8.x","label":"v8.16.0","branchLabelMappingKey":"^v8.16.0$","isSourceBranch":false,"state":"NOT_CREATED"}]}]
BACKPORT-->

Co-authored-by: Lisa Cawley <lcawley@elastic.co>
2024-09-27 13:16:38 -05:00

28 lines
No EOL
934 B
YAML

summary: Index threshold rule
description: Update an index threshold rule that uses a server log connector to send notifications when the threshold is met.
value:
actions:
- frequency:
summary: false
notify_when: onActionGroupChange
group: threshold met
id: 96b668d0-a1b6-11ed-afdf-d39a49596974
params:
level: info
message: "Rule {{rule.name}} is active for group {{context.group}}:\n\n- Value: {{context.value}}\n- Conditions Met: {{context.conditions}} over {{rule.params.timeWindowSize}}{{rule.params.timeWindowUnit}}\n- Timestamp: {{context.date}}"
params:
aggField: sheet.version
aggType: avg
index: [".updated-index"]
groupBy: top
termField: name.keyword
termSize: 6
threshold: [1000]
thresholdComparator: ">"
timeField: "@timestamp"
timeWindowSize: 5
timeWindowUnit: m
name: new name
schedule:
interval: 1m
tags: []