Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add documentation to support composite monitors in Alerting #4127

Merged
merged 64 commits into from
Jul 21, 2023
Merged
Show file tree
Hide file tree
Changes from 45 commits
Commits
Show all changes
64 commits
Select commit Hold shift + click to select a range
6be16dd
fix#4056 composite monitors
cwillum May 18, 2023
e77f2cb
fix#4056 composite monitors
cwillum May 20, 2023
200cba2
fix#4056 composite monitors
cwillum May 20, 2023
223712e
fix#4056 composite monitors
cwillum May 21, 2023
74f53bb
fix#4056 composite monitors
cwillum May 21, 2023
3468405
fix#4056 composite monitors
cwillum May 22, 2023
2f31c60
fix#4056 composite monitors
cwillum Jun 15, 2023
2e2b407
fix#4056 composite monitors
cwillum Jun 16, 2023
8e4e044
fix#4056 composite monitors
cwillum Jun 16, 2023
bf4a308
fix#4056 composite monitors
cwillum Jun 16, 2023
de205c4
fix#4056 composite monitors
cwillum Jun 16, 2023
675a2f2
fix#4056 composite monitors
cwillum Jun 16, 2023
2cce78f
fix#4056 composite monitors
cwillum Jun 16, 2023
60da830
fix#4056 composite monitors
cwillum Jun 19, 2023
3450ea3
fix#4056 composite monitors
cwillum Jun 20, 2023
bb9affc
fix#4056 composite monitors
cwillum Jun 20, 2023
8ec1ecf
fix#4056 composite monitors
cwillum Jun 20, 2023
2cc491b
fix#4056 composite monitors
cwillum Jun 20, 2023
c7e7ff8
fix#4056 composite monitors
cwillum Jun 21, 2023
6cfbbbc
fix#4056 composite monitors
cwillum Jun 21, 2023
0b40231
fix#4056 composite monitors
cwillum Jun 21, 2023
0fb515f
fix#4056 composite monitors
cwillum Jun 22, 2023
5299f64
fix#4056 composite monitors
cwillum Jun 22, 2023
8f3f5b9
fix#4056 composite monitors
cwillum Jun 22, 2023
106f98f
fix#4056 composite monitors
cwillum Jun 22, 2023
4d9752d
fix#4056 composite monitors
cwillum Jun 22, 2023
9e7fd9d
fix#4056 composite monitors
cwillum Jun 22, 2023
6c95f1b
fix#4056 composite monitors
cwillum Jun 23, 2023
7a180e7
fix#4056 composite monitors
cwillum Jun 23, 2023
916f358
fix#4056 composite monitors
cwillum Jul 3, 2023
014d11a
fix#4056 composite monitors
cwillum Jul 14, 2023
ba437da
fix#4056 composite monitors
cwillum Jul 14, 2023
531c0b9
fix#4056 composite monitors
cwillum Jul 18, 2023
da02419
fix#4056 composite monitors
cwillum Jul 18, 2023
f61629e
fix#4056 composite monitors
cwillum Jul 18, 2023
65158f1
fix#4056 composite monitors
cwillum Jul 18, 2023
db3d2d8
fix#4056 composite monitors
cwillum Jul 18, 2023
1391d3f
fix#4056 composite monitors
cwillum Jul 18, 2023
7859d02
fix#4056 composite monitors
cwillum Jul 19, 2023
7613775
fix#4056 composite monitors
cwillum Jul 19, 2023
79b72e2
fix#4056 composite monitors
cwillum Jul 19, 2023
4ad8c39
fix#4056 composite monitors
cwillum Jul 19, 2023
5ca7439
fix#4056 composite monitors
cwillum Jul 19, 2023
d85ac16
fix#4056 composite monitors
cwillum Jul 19, 2023
6b942a5
fix#4056 composite monitors
cwillum Jul 19, 2023
c6d0ea7
fix#4056 composite monitors
cwillum Jul 19, 2023
1b48d08
fix#4056 composite monitors
cwillum Jul 19, 2023
bc8a4f9
fix#4056 composite monitors
cwillum Jul 20, 2023
d76bd63
fix#4056 composite monitors
cwillum Jul 20, 2023
a2d7b3f
fix#4056 composite monitors
cwillum Jul 20, 2023
8453143
fix#4056 composite monitors
cwillum Jul 21, 2023
626f69a
fix#4056 composite monitors
cwillum Jul 21, 2023
12887e3
fix#4056 composite monitors
cwillum Jul 21, 2023
3b68f27
fix#4056 composite monitors
cwillum Jul 21, 2023
4b93944
fix#4056 composite monitors
cwillum Jul 21, 2023
32cc9a1
fix#4056 composite monitors
cwillum Jul 21, 2023
22f2914
fix#4056 composite monitors
cwillum Jul 21, 2023
94c7be6
fix#4056 composite monitors
cwillum Jul 21, 2023
68a1228
fix#4056 composite monitors
cwillum Jul 21, 2023
6d1bdf4
fix#4056 composite monitors
cwillum Jul 21, 2023
e435d93
fix#4056 composite monitors
cwillum Jul 21, 2023
ed7f0da
fix#4056 composite monitors
cwillum Jul 21, 2023
3806eb2
fix#4056 composite monitors
cwillum Jul 21, 2023
f2b37b9
Merge branch 'main' into fix#4056-composite-monitors
cwillum Jul 21, 2023
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions _includes/gif-pause.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
<head>
<link rel="stylesheet" type="text/css" href="{{ "/assets/css/gif.css" | relative_url }}">
</head>
<div class="object-and-details">
<img src="{{site.url}}{{site.baseurl}}/images/alerting/chained-findings.gif" alt="Animated: workflow for chained findings" width="90%">
<details>
<!-- added role=button to summary to resolve iOS funkiness -->
<summary role="button" aria-label="static image"></summary>
<div class="object-and-details1">
<img src="{{site.url}}{{site.baseurl}}/images/alerting/chained-findings.jpg" alt="Static: workflow for chained findings" width="90%">
</div>
</details>
</div>
13 changes: 13 additions & 0 deletions _includes/gif-pause2.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
<head>
<link rel="stylesheet" type="text/css" href="{{ "/assets/css/gif.css" | relative_url }}">
</head>
<div class="object-and-details">
<img src="{{site.url}}{{site.baseurl}}/images/alerting/chained-alerts.gif" alt="Animated: workflow for chained alerts" width="90%">
<details>
<!-- added role=button to summary to resolve iOS funkiness -->
<summary role="button" aria-label="static image"></summary>
<div class="object-and-details1">
<img src="{{site.url}}{{site.baseurl}}/images/alerting/chained-alerts.jpg" alt="Static: workflow for chained alerts" width="90%">
</div>
</details>
</div>
513 changes: 513 additions & 0 deletions _observing-your-data/alerting/comp-monitors.md

Large diffs are not rendered by default.

8 changes: 5 additions & 3 deletions _observing-your-data/alerting/monitors.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,11 +18,12 @@ redirect_from:

## Monitor types

The OpenSearch Dashboard Alerting plugin provides four monitor types:
The OpenSearch Dashboard Alerting plugin provides four basic monitor types, as well as a composite monitor that can utilize any or all monitor types:
cwillum marked this conversation as resolved.
Show resolved Hide resolved
* **per query** – This monitor runs a query and generates alert notifications based on criteria that matches.
* **per bucket** – This monitor runs a query that evaluates trigger criteria based on aggregated values in the dataset.
* **per cluster metrics** – This monitor runs API requests on the cluster to monitor its health.
* **per document** – This monitor runs a query (or multiple queries combined by a tag) that returns individual documents that match the alert notification trigger condition.
* **composite monitor** — The composite monitor allows you to chain the execution of multiple monitors of different types into a single flow, where the analysis and findings of one monitor becomes the input or source data of the next monitor in the chain. See [Composite monitors]({{site.url}}{{site.baseurl}}/notifications-plugin/index) for information on creating and using these types of monitors.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We don't chain the output of one monitor for the other. For now, we execute the selected monitors and then based on the trigger condition we decide whether the added action should be executed.
@eirsep Can you help here?


## Key terms

Expand All @@ -35,7 +36,7 @@ Alert | An event associated with a trigger. When an alert is created, the trigge
Action | The information that you want the monitor to send out after being triggered. Actions have a *destination*, a message subject, and a message body.
Destination | A reusable location for an action. Supported locations are Amazon Chime, Email, Slack, or custom webhook.
Finding | An entry for an individual document found by a per document monitor query that contains the document ID, index name, and timestamp. Findings are stored in the Findings index: `.opensearch-alerting-finding*`.
Channel | A notification channel to use in an action. See [notifications]({{site.url}}{{site.baseurl}}/notifications-plugin/index) for more information.
Channel | A notification channel to use in an action. See [notifications]({{site.url}}{{site.baseurl}}/observing-your-data/alerting/comp-monitors) for more information.
cwillum marked this conversation as resolved.
Show resolved Hide resolved

## Per document monitors

Expand Down Expand Up @@ -341,10 +342,11 @@ if (score > 99) {
}
```

Below are some variables you can include in your message using Mustache templates to see more information about your monitors.

### Available variables

You can include the following variables in your message using Mustache templates to see more information about your monitors.

#### Monitor variables

Variable | Data type | Description
Expand Down
64 changes: 64 additions & 0 deletions assets/css/gif.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
.object-and-details {
display: inline-block;
position: relative;
}

summary {
color: #fff;
background: #000;
width: 2rem;
height: 2rem;
position: absolute;
left: 82%;
top: 8%;
right: 0.5rem;
z-index: 2;
border-radius: 50%;
background-image: url("https://assets.codepen.io/128034/pause_circle_filled-24px.svg");
background-size: 90% auto;
background-repeat: no-repeat;
background-position: center;
background-color:white;
}

[open] summary {
background-image: url("https://assets.codepen.io/128034/play_circle_filled-24px.svg");
box-shadow: 0 0 0 2px #fff;
background-color:white;
}

/* for blink/webkit */
details summary::-webkit-details-marker
{ display:none; }
/* for firefox */
details > summary:first-of-type {
list-style:none}

summary + * {
position: absolute;
top: 0;
left: 0;
right: 0;
bottom: 0;
padding: 1rem;
padding-top: 3rem;
background: #fff;
color: #fff;
overflow-y: auto;
}

summary + * a {
color: #fff;
}
summary:focus {
box-shadow: 0 0 0 0.25rem #F5F7FA;
outline:transparent;
}

.object-and-details1 img {
display: inline-block;
position: absolute;
top:0px;
left:0px;
overflow: visible;
}
Binary file added images/alerting/chained-alerts.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/alerting/chained-alerts.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/alerting/chained-findings.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/alerting/chained-findings.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/alerting/extract-q-editor.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/alerting/trash-can-icon.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/alerting/trigger1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/alerting/vis-editor.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/dashboards/view-monitor-icon.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.