Skip to content

Alerting plugin - experimental cross cluster monitor support documentation#6350

Merged
vagimeli merged 9 commits intoopensearch-project:mainfrom
AWSHurneyt:3.0-cross-cluster-monitors-experimental
Feb 6, 2024
Merged

Alerting plugin - experimental cross cluster monitor support documentation#6350
vagimeli merged 9 commits intoopensearch-project:mainfrom
AWSHurneyt:3.0-cross-cluster-monitors-experimental

Conversation

@AWSHurneyt
Copy link
Copy Markdown
Contributor

@AWSHurneyt AWSHurneyt commented Feb 5, 2024

Description

Added documentation for supporting cluster metrics monitors that can monitor remote clusters. Added documentation for configuring query and bucket monitors through the UI that can query remote indexes.

These are experimental for v2.12.

Issues Resolved

Closes #4438

Checklist

  • By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license and subject to the Developers Certificate of Origin.
    For more information on following Developer Certificate of Origin and signing off your commits, please check here.

…monitor remote clusters. Added documentation for configuring query and bucket monitors through the UI that can query remote indexes. These are experimental for v2.12.

Signed-off-by: AWSHurneyt <hurneyt@amazon.com>
@AWSHurneyt AWSHurneyt force-pushed the 3.0-cross-cluster-monitors-experimental branch from aedee93 to aea15c0 Compare February 5, 2024 17:26
@AWSHurneyt
Copy link
Copy Markdown
Contributor Author

@vagimeli Here's the PR for the documentation.

@hdhalter hdhalter added release-notes PR: Include this PR in the automated release notes experimental v2.12.0 Doc review PR: Doc review in progress labels Feb 5, 2024
Copy link
Copy Markdown
Contributor

@vagimeli vagimeli left a comment

Choose a reason for hiding this comment

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

@AWSHurneyt Minimal edits. For the UI, please lowercase "Documentation" and remove the closing punctuation after "visit forum.opensearch.org".

@AWSHurneyt
Copy link
Copy Markdown
Contributor Author

@AWSHurneyt Minimal edits. For the UI, please lowercase "Documentation" and remove the closing punctuation after "visit forum.opensearch.org".

@vagimeli Thank you! I've edited the banner accordingly.

AWSHurneyt and others added 3 commits February 5, 2024 12:41
Co-authored-by: Melissa Vagi <vagimeli@amazon.com>
Signed-off-by: AWSHurneyt <hurneyt@amazon.com>
Co-authored-by: Melissa Vagi <vagimeli@amazon.com>
Signed-off-by: AWSHurneyt <hurneyt@amazon.com>
Co-authored-by: Melissa Vagi <vagimeli@amazon.com>
Signed-off-by: AWSHurneyt <hurneyt@amazon.com>
@vagimeli vagimeli added 5 - Final Editorial Review and removed Doc review PR: Doc review in progress labels Feb 5, 2024
Copy link
Copy Markdown
Contributor

@natebower natebower left a comment

Choose a reason for hiding this comment

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

@vagimeli Please see my comments and changes and let me know if you have any questions. Thanks!


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.

<img src="{{site.url}}{{site.baseurl}}/images/alerting/cross-cluster-per-query-per-bucket-monitors.png" alt="Cluster metrics monitor" width="700"/>
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

The image should be introduced in the text that precedes it.

vagimeli and others added 3 commits February 6, 2024 09:37
Co-authored-by: Nathan Bower <nbower@amazon.com>
Signed-off-by: Melissa Vagi <vagimeli@amazon.com>
Co-authored-by: Nathan Bower <nbower@amazon.com>
Signed-off-by: Melissa Vagi <vagimeli@amazon.com>
Co-authored-by: Nathan Bower <nbower@amazon.com>
Signed-off-by: Melissa Vagi <vagimeli@amazon.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

experimental release-notes PR: Include this PR in the automated release notes v2.12.0

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[DOC] Cross Cluster search support for Alerting Plugin

4 participants