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 Visualization integration RFC docs #477

Merged
merged 2 commits into from
Mar 31, 2022

Conversation

ohltyler
Copy link
Member

Signed-off-by: Tyler Ohlsen [email protected]

Description

Adds docs for the AD-Visualization integration project RFC. Will link this doc in the RFC issue that will be shared around (#476)

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 <[email protected]>
@ohltyler ohltyler requested a review from a team March 30, 2022 16:46
@ohltyler ohltyler added the documentation Improvements or additions to documentation label Mar 30, 2022
@ohltyler
Copy link
Member Author

ohltyler commented Mar 30, 2022

@brijos @sean-zheng-amazon let me know if you have any other suggestions for the doc, thanks!

@codecov-commenter
Copy link

codecov-commenter commented Mar 30, 2022

Codecov Report

Merging #477 (9051ff5) into main (9dcf010) will decrease coverage by 0.07%.
The diff coverage is n/a.

Impacted file tree graph

@@             Coverage Diff              @@
##               main     #477      +/-   ##
============================================
- Coverage     78.15%   78.07%   -0.08%     
  Complexity     4158     4158              
============================================
  Files           296      296              
  Lines         17659    17659              
  Branches       1879     1879              
============================================
- Hits          13801    13787      -14     
- Misses         2961     2977      +16     
+ Partials        897      895       -2     
Flag Coverage Δ
plugin 78.07% <ø> (-0.08%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files Coverage Δ
...rch/ad/transport/ForwardADTaskTransportAction.java 94.06% <0.00%> (-3.39%) ⬇️
...ain/java/org/opensearch/ad/task/ADTaskManager.java 75.69% <0.00%> (-1.21%) ⬇️
...opensearch/ad/indices/AnomalyDetectionIndices.java 72.36% <0.00%> (+0.18%) ⬆️
...java/org/opensearch/ad/task/ADBatchTaskRunner.java 82.06% <0.00%> (+0.30%) ⬆️
...ava/org/opensearch/ad/task/ADHCBatchTaskCache.java 90.12% <0.00%> (+1.23%) ⬆️
...ain/java/org/opensearch/ad/model/ModelProfile.java 72.72% <0.00%> (+3.63%) ⬆️

| `category_field` | Default to empty. If user has x-axis terms subaggregation set, could auto-fill with that field |
| `result_index` | Use some default value (none) |
| `shingle_size` | Use some default value (8) |
| real-time / historical jobs? | Default to real-time enabled, historical disabled |
Copy link
Collaborator

Choose a reason for hiding this comment

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

Is it possible to run historical analysis on the visualization data as well? It's hard to tell whether the user's data stream is realtime or not. Detect the data shown on the visualization can give user quick overview about how the auto created detector performs.

Copy link
Member Author

Choose a reason for hiding this comment

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

Right, lots of options there. From workflow chart, I currently have the 'detect existing anomalies based on viz' use case covered by historical analysis.

Btw, we can use the RFC issue #476 for further discussion - this PR is just to persist the doc into docs/ dir like we've done for previous projects.

Copy link
Collaborator

@ylwu-amzn ylwu-amzn left a comment

Choose a reason for hiding this comment

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

LGTM. We can discuss more questions on the Github issue.

@ohltyler ohltyler merged commit 3a437d1 into opensearch-project:main Mar 31, 2022
@ohltyler ohltyler deleted the ad-viz-doc branch March 31, 2022 00:05
@ohltyler
Copy link
Member Author

@ylwu-amzn @amitgalitz updated issue: #476

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants