OpenSearch Community Meeting - 2023-0328

kris · March 29, 2023, 4:02pm

Notifications on index operation statuses RFC:

github.com/opensearch-project/index-management-dashboards-plugin

[RFC] Notification on index operation statuses

opened 07:16PM - 27 Mar 23 UTC

closed 09:29PM - 03 Aug 23 UTC

kamingleung

enhancement

## Problem statement ## Index operations may take tens of minutes or even hours… to complete (e.g. reindex, split). However, there is no way for admins to get informed on status or the completion of long running operations. Admins also do not currently have any visibility to track their jobs and get notified when an operation is complete through the channel of their choice. Currently they have to be actively on Dashboards UI to see updates via toast notification banners, but others won’t be able to see the toast because they are not in the same UI session. Another workaround is to manually run different APIs to check the operation status until it’s done, which is not convenient at all. We plan to enhance this experience through this notification feature. ## What are you proposing? ## We’d like to increase visibility on monitoring long-running index operations through notifications. Admins can get notified through their email or slack channels (channels defined in Notification framework) on upcoming operations that have been completed or failed. In addition, admins can configure these notifications globally, so they will not need to manually configure notifications for every single operation. Users can also add run time notifications when submit those long-running index operations. For this feature, we will be focusing on operations that are long running and not notify users for create/read/update where it can be done quickly and currently has the toast functionality. This issue focuses on the user experience of configuring notifications for index operations in Dashboards. It's based on this [API propsal issue](https://github.com/opensearch-project/index-management/issues/700). ### What is the user experience going to be? ### #### Global notifications on index operation statuses #### Admin can also define global notification settings for long running operations. Admins can go to “Index management” section of Dashboards to configure global notifications for index operations. Admins can then choose who to get notified, so users don’t need to configure notification every time they trigger an operation. ![image](https://user-images.githubusercontent.com/3692324/236956742-65768bcd-3af2-447b-b944-dadf4511121f.png) #### View notification settings while starting shrink or other index operations #### If the notification settings is defined globally, users who trigger an operation (e.g. Shrink index flow) will see the notification channels selected for them. Users will have the option to add additional notification channels for this workflow, but users won’t be able to remove the channels defined globally by the admin. ![image](https://user-images.githubusercontent.com/3692324/228043213-143117c5-1716-4728-a5c3-52fbc1263242.png) If there are not global notification settings defined, users can opt-in to get notified on this operation’s status (Failed/ completed). Users can select who to get notified from a list of channels defined in notification framework. The notification settings will only be for this particular operation. ![image](https://user-images.githubusercontent.com/3692324/228043315-204662e9-1b3d-4f7f-be72-6ab523fc6ed4.png) #### Notified on operation statuses #### Users who triggered operations within Dashboards will be informed of the operation’s status (Failed/completed) through in-app toast messages. <img width="370" alt="image" src="https://user-images.githubusercontent.com/3692324/228043500-6eb14da0-5085-4858-8c3b-443becb82bac.png"> Users who set up notification will receive status updates through the defined channels. In this example receive via a slack channel: <img width="589" alt="image" src="https://user-images.githubusercontent.com/3692324/228043689-dfbe0c95-df54-4158-a5c3-9c2adeef14f3.png"> ## Your feedback is needed! ## Any comments about the overall direction are welcome. Some specific questions: * When managing and administrating OpenSearch, what are your use cases where notification would be useful? * What statuses do you find useful to get notified? Thank you!

Component templates UI RFC:

github.com/opensearch-project/index-management-dashboards-plugin

[RFC] UX for Component Templates in Index Management Dashboards Plugin

opened 12:57AM - 28 Mar 23 UTC

closed 02:19AM - 26 May 23 UTC

kamingleung

enhancement

This is a RFC issue for UX work related to [component template API](https://open…search.org/docs/latest/im-plugin/index-templates/#composable-index-templates) and using the components to create index templates in OpenSearch Dashboards UI. ## Context ## To help reducing the number of templates, users can create component templates as reusable building blocks of index templates. In this proposal, users will be able to use the Index Management UI to create component templates and assemble them into index templates. ## User flows ## The scope of this UX work focuses on these high level user flows in Index Management UI: * Create / Manage / Delete Component templates * Associate component templates when creating an Index template * View and configure Index template ## Your feedback is needed! ## Any comments about the overall direction are welcome. Some specific questions: - What pain points do you have when defining configurations for your indexes? - How are you using index templates and component templates? - Have a use case that is not covered in this issue? Feel free to share them! Thank you!

OpenSearch Admin Usability Study:
https://forum.opensearch.org/t/looking-for-opensearch-usability-study-candidates/

Topic		Replies	Views
OpenSearch Community Meeting - 2022-0802 Community community-meeting	6	1158	August 5, 2022
OpenSearch Community Meeting - 2023-1114 Community community-meeting	2	337	November 14, 2023
OpenSearch Community Meeting - 2023-0425 Community community-meeting	7	601	May 1, 2023
OpenSearch Community Meeting - 2023-0627 Community	10	625	July 5, 2023
OpenSearch Community Meeting - 2023-0523 Community community-meeting	10	792	May 30, 2023

OpenSearch Community Meeting - 2023-0328

Related topics