Skip to content

Commit 1d7ead6

Browse files
Alerting plugin - GA cross cluster monitor support documentation (#7159)
* Revised for feature GA launch. Signed-off-by: AWSHurneyt <[email protected]> * Reworded "via" based on style recommendations. Signed-off-by: AWSHurneyt <[email protected]> * Reworded sentence based off PM feedback. Signed-off-by: AWSHurneyt <[email protected]> * Apply suggestions from code review Signed-off-by: Naarcha-AWS <[email protected]> --------- Signed-off-by: AWSHurneyt <[email protected]> Signed-off-by: Naarcha-AWS <[email protected]> Co-authored-by: Naarcha-AWS <[email protected]> (cherry picked from commit 462313a) Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
1 parent 388b1fc commit 1d7ead6

File tree

6 files changed

+8
-1
lines changed

6 files changed

+8
-1
lines changed

_observing-your-data/alerting/per-cluster-metrics-monitors.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -115,6 +115,9 @@ The `script` parameter points the `source` to the Painless script `for (cluster
115115
```
116116
The dashboards interface supports the selection of clusters to be monitored and the desired API. A view of the interface is shown in the following image.
117117

118+
The following [permissions]({{site.url}}{{site.baseurl}}/security/access-control/permissions/) are required in order to create a cross-cluster monitor through the dashboards UI: `cluster:admin/opensearch/alerting/remote/indexes/get`, `indices:admin/resolve/index`, `cluster:monitor/health`, and `indices:admin/mappings/get`.
119+
{: .note}
120+
118121
<img src="{{site.url}}{{site.baseurl}}/images/alerting/cross-cluster-cluster-metrics-monitors.png" alt="Cluster metrics monitor" width="700"/>
119122

120123
### Limitations

_observing-your-data/alerting/per-query-bucket-monitors.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,9 @@ Per bucket monitors are a type of alert monitor that can be used to identify and
1515

1616
Both monitor types support querying remote indexes using the same `cluster-name:index-name` pattern used by [cross-cluster search](https://opensearch.org/docs/latest/security/access-control/cross-cluster-search/) or by using OpenSearch Dashboards 2.12 or later.
1717

18+
The following [permissions]({{site.url}}{{site.baseurl}}/security/access-control/permissions/) are required in order to create a cross-cluster monitor through the dashboards UI: `cluster:admin/opensearch/alerting/remote/indexes/get`, `indices:admin/resolve/index`, `cluster:monitor/health`, and `indices:admin/mappings/get`.
19+
{: .note}
20+
1821
<img src="{{site.url}}{{site.baseurl}}/images/alerting/cross-cluster-per-query-per-bucket-monitors.png" alt="Cluster metrics monitor" width="700"/>
1922

2023
## Creating a per query or per bucket monitor

_observing-your-data/alerting/settings.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ Setting | Default | Description
5454
`plugins.alerting.alert_history_retention_period` | 60d | The amount of time to keep history indexes before automatically deleting them.
5555
`plugins.alerting.destination.allow_list` | ["chime", "slack", "custom_webhook", "email", "test_action"] | The list of allowed destinations. If you don't want to allow users to a certain type of destination, you can remove it from this list, but we recommend leaving this setting as-is.
5656
`plugins.alerting.filter_by_backend_roles` | "false" | Restricts access to monitors by backend role. See [Alerting security]({{site.url}}{{site.baseurl}}/monitoring-plugins/alerting/security/).
57-
`plugins.alerting.remote_monitoring_enabled` | "false" | Toggles whether cluster metrics monitors support executing against remote clusters.
57+
`plugins.alerting.cross_cluster_monitoring_enabled` | "false" | Toggles whether cluster metrics monitors support running against remote clusters.
5858
`plugins.scheduled_jobs.sweeper.period` | 5m | The alerting feature uses its "job sweeper" component to periodically check for new or updated jobs. This setting is the rate at which the sweeper checks to see if any jobs (monitors) have changed and need to be rescheduled.
5959
`plugins.scheduled_jobs.sweeper.page_size` | 100 | The page size for the sweeper. You shouldn't need to change this value.
6060
`plugins.scheduled_jobs.sweeper.backoff_millis` | 50ms | The amount of time the sweeper waits between retries---increases exponentially after each failed retry.

_security/access-control/permissions.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -232,6 +232,7 @@ See [Alerting API]({{site.url}}{{site.baseurl}}/observing-your-data/alerting/api
232232
- cluster:admin/opendistro/alerting/monitor/get
233233
- cluster:admin/opendistro/alerting/monitor/search
234234
- cluster:admin/opendistro/alerting/monitor/write
235+
- cluster:admin/opensearch/alerting/remote/indexes/get
235236

236237
### Asynchronous Search permissions
237238

-19 KB
Loading
60.2 KB
Loading

0 commit comments

Comments
 (0)