Alerting plugin - experimental cross cluster monitor support documentation #6350
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
AWSHurneyt
requested review from
hdhalter,
kolchfa-aws,
Naarcha-AWS,
vagimeli,
AMoo-Miki,
natebower and
dlvenable
as code owners
…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 <[email protected]>
AWSHurneyt
force-pushed
the
3.0-cross-cluster-monitors-experimental
branch
from
aedee93 to
aea15c0
Compare
|
@vagimeli Here's the PR for the documentation. |
hdhalter
added
release-notes
3 tasks
vagimeli
approved these changes
Feb 5, 2024
There was a problem hiding this comment.
@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. |
Co-authored-by: Melissa Vagi <[email protected]> Signed-off-by: AWSHurneyt <[email protected]>
Co-authored-by: Melissa Vagi <[email protected]> Signed-off-by: AWSHurneyt <[email protected]>
Co-authored-by: Melissa Vagi <[email protected]> Signed-off-by: AWSHurneyt <[email protected]>
vagimeli
added
Editorial review
natebower
reviewed
Feb 5, 2024
| @@ -13,6 +13,10 @@ Per query monitors are a type of alert monitor that can be used to identify and | |||
|
|
|||
| Per bucket monitors are a type of alert monitor that can be used to identify and alert on specific buckets of data that are created by a query against an OpenSearch index. | |||
|
|
|||
| 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"/> | |||
There was a problem hiding this comment.
The image should be introduced in the text that precedes it.
Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Melissa Vagi <[email protected]>
Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Melissa Vagi <[email protected]>
Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Melissa Vagi <[email protected]>
Signed-off-by: Melissa Vagi <[email protected]>
hdhalter
added
3 - Done
and removed
Editorial review
1 task
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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
For more information on following Developer Certificate of Origin and signing off your commits, please check here.