[DOCS] Add UUID to rule actions (#157942)

This commit is contained in:
Lisa Cawley 2023-05-17 18:43:20 -07:00 committed by GitHub
parent fc5a39aa5f
commit 1cb0ee6d72
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
8 changed files with 36 additions and 0 deletions

View file

@ -143,6 +143,7 @@ Any modifications made to this file will be overwritten.
"params" : {
"key" : ""
},
"uuid" : "1c7a1280-f28c-4e06-96b2-e4e5f05d1d61",
"connector_type_id" : ".server-log",
"frequency" : {
"summary" : true,
@ -155,6 +156,7 @@ Any modifications made to this file will be overwritten.
"params" : {
"key" : ""
},
"uuid" : "1c7a1280-f28c-4e06-96b2-e4e5f05d1d61",
"connector_type_id" : ".server-log",
"frequency" : {
"summary" : true,
@ -440,6 +442,7 @@ Any modifications made to this file will be overwritten.
"params" : {
"key" : ""
},
"uuid" : "1c7a1280-f28c-4e06-96b2-e4e5f05d1d61",
"connector_type_id" : ".server-log",
"frequency" : {
"summary" : true,
@ -452,6 +455,7 @@ Any modifications made to this file will be overwritten.
"params" : {
"key" : ""
},
"uuid" : "1c7a1280-f28c-4e06-96b2-e4e5f05d1d61",
"connector_type_id" : ".server-log",
"frequency" : {
"summary" : true,
@ -507,6 +511,7 @@ Any modifications made to this file will be overwritten.
"params" : {
"key" : ""
},
"uuid" : "1c7a1280-f28c-4e06-96b2-e4e5f05d1d61",
"connector_type_id" : ".server-log",
"frequency" : {
"summary" : true,
@ -519,6 +524,7 @@ Any modifications made to this file will be overwritten.
"params" : {
"key" : ""
},
"uuid" : "1c7a1280-f28c-4e06-96b2-e4e5f05d1d61",
"connector_type_id" : ".server-log",
"frequency" : {
"summary" : true,
@ -689,6 +695,7 @@ Any modifications made to this file will be overwritten.
"params" : {
"key" : ""
},
"uuid" : "1c7a1280-f28c-4e06-96b2-e4e5f05d1d61",
"connector_type_id" : ".server-log",
"frequency" : {
"summary" : true,
@ -701,6 +708,7 @@ Any modifications made to this file will be overwritten.
"params" : {
"key" : ""
},
"uuid" : "1c7a1280-f28c-4e06-96b2-e4e5f05d1d61",
"connector_type_id" : ".server-log",
"frequency" : {
"summary" : true,
@ -2048,6 +2056,7 @@ Any modifications made to this file will be overwritten.
"params" : {
"key" : ""
},
"uuid" : "1c7a1280-f28c-4e06-96b2-e4e5f05d1d61",
"connector_type_id" : ".server-log",
"frequency" : {
"summary" : true,
@ -2060,6 +2069,7 @@ Any modifications made to this file will be overwritten.
"params" : {
"key" : ""
},
"uuid" : "1c7a1280-f28c-4e06-96b2-e4e5f05d1d61",
"connector_type_id" : ".server-log",
"frequency" : {
"summary" : true,
@ -2236,6 +2246,7 @@ Any modifications made to this file will be overwritten.
<div class="param">group (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The group name for the actions. If you don't need to group actions, set to <code>default</code>. </div>
<div class="param">id (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The identifier for the connector saved object. </div>
<div class="param">params (optional)</div><div class="param-desc"><span class="param-type"><a href="#AnyType">map[String, oas_any_type_not_mapped]</a></span> The parameters for the action, which are sent to the connector. The <code>params</code> are handled as Mustache templates and passed a default set of context. </div>
<div class="param">uuid (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> A universally unique identifier (UUID) for the action. </div>
</div> <!-- field-items -->
</div>
<div class="model">

View file

@ -2516,6 +2516,11 @@
"type": "object",
"description": "The parameters for the action, which are sent to the connector. The `params` are handled as Mustache templates and passed a default set of context.",
"additionalProperties": true
},
"uuid": {
"type": "string",
"description": "A universally unique identifier (UUID) for the action.",
"example": "1c7a1280-f28c-4e06-96b2-e4e5f05d1d61"
}
}
}
@ -3020,6 +3025,7 @@
{
"group": "threshold met",
"id": "1007a0c0-7a6e-11ed-89d5-abec321c0def",
"uuid": "1c7a1280-f28c-4e06-96b2-e4e5f05d1d61",
"params": {
"level": "info",
"message": "alert {{alertName}} is active for group {{context.group}}:\n\n- Value: {{context.value}}\n- Conditions Met: {{context.conditions}} over {{params.timeWindowSize}}{{params.timeWindowUnit}}\n- Timestamp: {{context.date}",
@ -3136,6 +3142,7 @@
"message": "alert {{alertName}} is active for group {{context.group}}:\n\n- Value: {{context.value}}\n- Conditions Met: {{context.conditions}} over {{params.timeWindowSize}}{{params.timeWindowUnit}}\n- Timestamp: {{context.date}"
},
"id": "96b668d0-a1b6-11ed-afdf-d39a49596974",
"uuid": "07aef2a0-9eed-4ef9-94ec-39ba58eb609d",
"connector_type_id": ".server-log",
"frequency": {
"summary": false,
@ -3211,6 +3218,7 @@
{
"group": "threshold met",
"id": "dceeb5d0-6b41-11eb-802b-85b0c1bc8ba2",
"uuid": "07aef2a0-9eed-4ef9-94ec-39ba58eb609d",
"frequency": {
"notify_when": "onActionGroupChange",
"summary": false,
@ -3323,6 +3331,7 @@
{
"id": "9dca3e00-74f5-11ed-9801-35303b735aef",
"group": "threshold met",
"uuid": "1c7a1280-f28c-4e06-96b2-e4e5f05d1d61",
"params": {
"level": "info",
"message": "alert {{alertName}} is active for group {{context.group}}:\n\n- Value: {{context.value}}\n- Conditions Met: {{context.conditions}} over {{params.timeWindowSize}}{{params.timeWindowUnit}}\n- Timestamp: {{context.date}}",

View file

@ -1603,6 +1603,10 @@ components:
type: object
description: The parameters for the action, which are sent to the connector. The `params` are handled as Mustache templates and passed a default set of context.
additionalProperties: true
uuid:
type: string
description: A universally unique identifier (UUID) for the action.
example: 1c7a1280-f28c-4e06-96b2-e4e5f05d1d61
schedule:
type: object
description: The check interval, which specifies how frequently the rule conditions are checked. The interval is specified in seconds, minutes, hours, or days.
@ -1986,6 +1990,7 @@ components:
actions:
- group: threshold met
id: 1007a0c0-7a6e-11ed-89d5-abec321c0def
uuid: 1c7a1280-f28c-4e06-96b2-e4e5f05d1d61
params:
level: info
message: |-
@ -2092,6 +2097,7 @@ components:
- Conditions Met: {{context.conditions}} over {{params.timeWindowSize}}{{params.timeWindowUnit}}
- Timestamp: {{context.date}
id: 96b668d0-a1b6-11ed-afdf-d39a49596974
uuid: 07aef2a0-9eed-4ef9-94ec-39ba58eb609d
connector_type_id: .server-log
frequency:
summary: false
@ -2152,6 +2158,7 @@ components:
actions:
- group: threshold met
id: dceeb5d0-6b41-11eb-802b-85b0c1bc8ba2
uuid: 07aef2a0-9eed-4ef9-94ec-39ba58eb609d
frequency:
notify_when: onActionGroupChange
summary: false
@ -2249,6 +2256,7 @@ components:
actions:
- id: 9dca3e00-74f5-11ed-9801-35303b735aef
group: threshold met
uuid: 1c7a1280-f28c-4e06-96b2-e4e5f05d1d61
params:
level: info
message: |-

View file

@ -3,6 +3,7 @@ value:
actions:
- group: threshold met
id: dceeb5d0-6b41-11eb-802b-85b0c1bc8ba2
uuid: 07aef2a0-9eed-4ef9-94ec-39ba58eb609d
frequency:
notify_when: onActionGroupChange
summary: false

View file

@ -44,6 +44,7 @@ value:
actions:
- id: 9dca3e00-74f5-11ed-9801-35303b735aef
group: threshold met
uuid: 1c7a1280-f28c-4e06-96b2-e4e5f05d1d61
params:
level: info
message: "alert {{alertName}} is active for group {{context.group}}:\n\n- Value: {{context.value}}\n- Conditions Met: {{context.conditions}} over {{params.timeWindowSize}}{{params.timeWindowUnit}}\n- Timestamp: {{context.date}}"

View file

@ -40,6 +40,7 @@ value:
actions:
- group: threshold met
id: 1007a0c0-7a6e-11ed-89d5-abec321c0def
uuid: 1c7a1280-f28c-4e06-96b2-e4e5f05d1d61
params:
level: info
message: "alert {{alertName}} is active for group {{context.group}}:\n\n- Value: {{context.value}}\n- Conditions Met: {{context.conditions}} over {{params.timeWindowSize}}{{params.timeWindowUnit}}\n- Timestamp: {{context.date}"

View file

@ -40,6 +40,7 @@ value:
level: info
message: "alert {{alertName}} is active for group {{context.group}}:\n\n- Value: {{context.value}}\n- Conditions Met: {{context.conditions}} over {{params.timeWindowSize}}{{params.timeWindowUnit}}\n- Timestamp: {{context.date}"
id: 96b668d0-a1b6-11ed-afdf-d39a49596974
uuid: 07aef2a0-9eed-4ef9-94ec-39ba58eb609d
connector_type_id: .server-log
frequency:
summary: false

View file

@ -41,3 +41,7 @@ items:
type: object
description: The parameters for the action, which are sent to the connector. The `params` are handled as Mustache templates and passed a default set of context.
additionalProperties: true
uuid:
type: string
description: A universally unique identifier (UUID) for the action.
example: 1c7a1280-f28c-4e06-96b2-e4e5f05d1d61