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

[FEATURE ENHANCEMENT UX] Cross cluster search support in the OpenSearch alerting plugin #796

Open
canascar opened this issue Nov 7, 2023 · 1 comment
Assignees
Labels
enhancement New feature or request v2.12.0

Comments

@canascar
Copy link
Member

canascar commented Nov 7, 2023

Is your feature request related to a problem?
Currently the plug-in’s Per query, Per bucket, and Per document monitors are only able to query data sources on the local cluster.

What solution would you like?

We want to provide alerting capabilities for customers that need to query data across multiple clusters.

** UX Updates to plug-in interface **
Updates include changes to the Create monitor flow data source section:

  1. Add a Combo box dropdown field for multiple selection of available local and remote clusters (defaulted to local cluster)
Screenshot 2023-11-07 at 10 51 22 AM
  1. Update the index dropdown to display indexes categorized by selected clusters
Screenshot 2023-11-07 at 10 51 50 AM
  1. Display an invalid field onBlur when cluster field is cleared
Screenshot 2023-11-07 at 10 58 18 AM

If there are issues with remote cluster performance, the Preview and query performance accordion should automatically open once the service runs a query to display possible issues with the data sources selected:
Screenshot 2023-11-03 at 2 08 18 PM

If the customer continued with the monitor creation, a modal detailing impact on performance should launch giving users the option to tweak configurations:
Screenshot 2023-11-03 at 2 08 26 PM


Update to the Monitor details page includes:

  1. Display of a data source defined in the overview. If multiple data sources (clusters) have been selected, we display one source and a clickable badge with the number of sources defined.
Screenshot 2023-11-03 at 2 08 42 PM
  1. Upon clicking of the bade, a medium sized flyout should open to display data sources (cluster with index) in a table:
Screenshot 2023-11-03 at 2 08 51 PM
  1. If Per document, the document under the Alert listing table should be clickable to launch a medium sized flyout with alert details that defines a data source (clust
Screenshot 2023-11-03 at 2 09 29 PM er:index)
  1. From the Alerts list item tab, users should be able to click the alert which will trigger a medium size flyout with alert details including Monitor data sources (cluster:index)
Screenshot 2023-11-03 at 2 09 52 PM Screenshot 2023-11-03 at 2 10 01 PM
@canascar canascar added enhancement New feature or request untriaged v2.12.0 labels Nov 7, 2023
@canascar canascar assigned canascar and AWSHurneyt and unassigned canascar Nov 7, 2023
@canascar canascar changed the title [FEATURE ENHANCEMENT] Cross cluster search support in the OpenSearch alerting plugin [FEATURE ENHANCEMENT UX] Cross cluster search support in the OpenSearch alerting plugin Nov 7, 2023
@canascar canascar assigned kgcreative and unassigned kgcreative Nov 7, 2023
@smuthukaruppannp
Copy link

I have submitted a PR to address 570. I believe it addresses some of the items in this enhancement. I will appreciate your review and feedback on PR #799

cwperks pushed a commit to opensearch-project/security that referenced this issue Feb 8, 2024
…alerting plugin feature #4027 (#4029)

### Description
We added a new API to the alerting plugin to support enhancements to the
UI
([link](https://github.com/opensearch-project/alerting/blob/main/alerting/src/main/kotlin/org/opensearch/alerting/action/GetRemoteIndexesAction.kt#L13)).
The enhancements allow users to configure per query, and per bucket
monitors that can query remote clusters via the UI. Previously, such
monitors could only be configured using devtools/API commands.

In addition, we added support for configuring cluster metrics monitors
which can execute various API ([link to full list of supported
API](https://opensearch.org/docs/latest/observing-your-data/alerting/per-cluster-metrics-monitors/#supported-apis))
against remote clusters. The new API is used by the frontend to also
support creating these monitors via the UI.

* Category (Enhancement, New feature, Bug fix, Test fix, Refactoring,
Maintenance, Documentation)
  * New experimental feature
  * Enhancement to existing features
* Why these changes are required?
* To include this API permission in the reserved role that's shipped
with the default distribution of OpenSearch.
* What is the old behavior before changes and new behavior after
changes?
* This API was not available before the experimental launch. With the
experimental feature enabled, this API can be used to retrieve a list of
connect remote clusters, the indexes/aliases on those clusters along
with their health statuses, and optionally the mappings for those
indexes.

### Issues Resolved

opensearch-project/alerting-dashboards-plugin#796

Is this a backport? If so, please add backport PR # and/or commits #
#4027

### Testing
Executed E2E tests with and without the experimental feature enabled to
help ensure no regressions.

### Check List
- [x] New functionality includes testing
- [x] New functionality has been documented
- [x] Commits are signed per the DCO using --signoff

By submitting this pull request, I confirm that my contribution is made
under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and
signing off your commits, please check
[here](https://github.com/opensearch-project/OpenSearch/blob/main/CONTRIBUTING.md#developer-certificate-of-origin).

---------

Signed-off-by: AWSHurneyt <hurneyt@amazon.com>
@github-project-automation github-project-automation bot moved this to Planned work items in Test roadmap format Apr 9, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request v2.12.0
Projects
Status: Planned work items
Development

No branches or pull requests

4 participants