mirror of
https://github.com/elastic/kibana.git
synced 2025-04-24 17:59:23 -04:00
d282c328f9
# 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>
67 lines
2 KiB
YAML
67 lines
2 KiB
YAML
summary: Index threshold rule
|
|
description: A response that contains information about an index threshold rule.
|
|
value:
|
|
page: 1
|
|
total: 1
|
|
per_page: 10
|
|
data:
|
|
- id: 3583a470-74f6-11ed-9801-35303b735aef
|
|
consumer: alerts
|
|
tags:
|
|
- cpu
|
|
name: my alert
|
|
enabled: true
|
|
throttle: null
|
|
schedule:
|
|
interval: 1m
|
|
params:
|
|
aggType: avg
|
|
termSize: 6
|
|
thresholdComparator: ">"
|
|
timeWindowSize: 5
|
|
timeWindowUnit: m
|
|
groupBy: top
|
|
threshold:
|
|
- 1000
|
|
index:
|
|
- test-index
|
|
timeField: "@timestamp"
|
|
aggField: sheet.version
|
|
termField: name.keyword
|
|
revision: 1
|
|
rule_type_id: .index-threshold
|
|
created_by: elastic
|
|
updated_by: elastic
|
|
created_at: '2022-12-05T23:40:33.132Z'
|
|
updated_at: '2022-12-05T23:40:33.132Z'
|
|
api_key_owner: elastic
|
|
mute_all: false
|
|
muted_alert_ids: []
|
|
scheduled_task_id: 3583a470-74f6-11ed-9801-35303b735aef
|
|
execution_status:
|
|
status: ok
|
|
last_execution_date: '2022-12-06T01:44:23.983Z'
|
|
last_duration: 48
|
|
actions:
|
|
- id: 9dca3e00-74f5-11ed-9801-35303b735aef
|
|
group: threshold met
|
|
uuid: 1c7a1280-f28c-4e06-96b2-e4e5f05d1d61
|
|
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}}"
|
|
connector_type_id: .server-log
|
|
frequency:
|
|
summary: false
|
|
notify_when: onActionGroupChange
|
|
throttle: null
|
|
last_run:
|
|
alerts_count:
|
|
new: 0
|
|
ignored: 0
|
|
recovered: 0
|
|
active: 0
|
|
outcome_msg: null
|
|
warning: null
|
|
outcome: succeeded
|
|
next_run: '2022-12-06T01:45:23.912Z'
|
|
api_key_created_by_user: false
|