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

Add callouts and make category fields readonly after creation #79

Merged

Conversation

ohltyler
Copy link
Member

@ohltyler ohltyler commented Aug 30, 2021

Signed-off-by: Tyler Ohlsen ohltyler@amazon.com

Description

This PR blocks users from editing the selected category fields after initial detector creation. The reason for this change is because the anomaly results and charts can get in weird states if the detector cardinality type is changed, and lead to showing confusing and/or misleading data to the users (e.g., making a single-category high-cardinality detector into a non-high-cardinality detector will show multiple results with the same timestamp for each entity).

Changes include:

  • Adding callouts to the model config page describing the changes. In the creation flow, show a warning callout once the user initially enables the category field checkbox. In the edit flow, show an info callout describing why the category field selections (enabled or disabled, selected fields) are readonly.
  • Making the checkbox and combo box readonly when editing the model config

Testing:

  • Sanity tested the functionality for the create & edit flows
  • Updated and added unit tests

Screenshots:

Warning callout in creation flow:

Screen Shot 2021-08-31 at 9 56 03 AM

Info callout in edit flow:

Screen Shot 2021-08-31 at 9 55 33 AM

Check List

  • 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.

Signed-off-by: Tyler Ohlsen <ohltyler@amazon.com>
@ohltyler ohltyler marked this pull request as draft August 30, 2021 20:58
@ohltyler ohltyler added the v1.1.0 Version 1.1.0 label Aug 30, 2021
@ohltyler ohltyler marked this pull request as ready for review August 31, 2021 17:01
@ohltyler
Copy link
Member Author

Everything is approved by UX, only waiting on wording confirmation. In the meantime everything else is ready for review.

@ohltyler ohltyler requested review from kaituo and ylwu-amzn August 31, 2021 17:05
ylwu-amzn
ylwu-amzn previously approved these changes Aug 31, 2021
@ohltyler ohltyler merged commit 2ef9098 into opensearch-project:main Aug 31, 2021
@ohltyler ohltyler deleted the block-category-field-change branch August 31, 2021 23:30
ohltyler added a commit to ohltyler/anomaly-detection-dashboards-plugin-1 that referenced this pull request Sep 1, 2021
ohltyler added a commit that referenced this pull request Sep 1, 2021
Signed-off-by: Tyler Ohlsen <ohltyler@amazon.com>
@ohltyler ohltyler added the enhancement New feature or request label Sep 2, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request v1.1.0 Version 1.1.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants