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.

Sign up for GitHub

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

Jump to bottom

Add documentation for Observability PPL/event analytics visualizations using Dashboard #3752

Merged
merged 26 commits into from
Apr 24, 2023
Merged

Add documentation for Observability PPL/event analytics visualizations using Dashboard #3752

merged 26 commits into from
Apr 24, 2023

Conversation

vagimeli
Copy link
Collaborator

Description

Add Event Analytics visualizations to existing documentation.

Issues Resolved

#3549

Checklist

  • By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license and subject to the Developers Certificate of Origin.
    For more information on following Developer Certificate of Origin and signing off your commits, please check here.

@vagimeli
Add Event Analytics visualizations in Dashboards feature
b51fac5 
Signed-off-by: vagimeli <vagimeli@amazon.com>
@vagimeli vagimeli self-assigned this Apr 11, 2023
@vagimeli vagimeli added v2.7.0 2 - In progress Issue/PR: The issue or PR is in progress. labels Apr 11, 2023
@vagimeli
Content planning
d8f28e3 
Signed-off-by: vagimeli <vagimeli@amazon.com>
@vagimeli
Content planning
f1f5e30 
Signed-off-by: vagimeli <vagimeli@amazon.com>
@vagimeli
Content planning
64aca37 
Signed-off-by: vagimeli <vagimeli@amazon.com>
@vagimeli
writing
65c66a7 
Signed-off-by: vagimeli <vagimeli@amazon.com>
@vagimeli
writing
d107dbe 
Signed-off-by: vagimeli <vagimeli@amazon.com>
@vagimeli
Copy link
Collaborator Author

@joshuali925 Will you review this first-pass draft on the event analytics dashboards view feature? If possible, I'd appreaciate your feedback by Tuesday, 4/ 18. Please check for technical accuracy of the information and let me know if there are any information gaps. If we need to sync again, please let me know. Thanks for your support!

joshuali925
joshuali925 reviewed Apr 14, 2023
View reviewed changes
Copy link
Member

@joshuali925 joshuali925 left a comment

Choose a reason for hiding this comment

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

thanks for the changes.

One thing I forgot to mention in detail is the limitation on filtering. PPL visualizations currently do not support DQL/DSL and they do not use index patterns. This means

  1. PPL visualizations will only use filters created using the dropdown UI. If user has DQL query or DSL filters in a dashboard, PPL visualizations will not use them
  2. OSD dashboard filter dropdown will only show fields from the index patterns used by other visualizations in the same dashboard (or from default index pattern if PPL visualization are the only visualizations in the dashboard).

Should we mention this to user in docs or should I create a tracking issue and put it in observability readme?

Some related information here opensearch-project/OpenSearch-Dashboards#3849

_observing-your-data/event-analytics.md Outdated Show resolved Hide resolved
@vagimeli vagimeli linked an issue Apr 17, 2023 that may be closed by this pull request
[DOC] Make Event Analytics Visualizations Available in Core Dashboards #3549
Closed
4 tasks
@vagimeli @joshuali925
Update _observing-your-data/event-analytics.md
a01134f 
Co-authored-by: Joshua Li <joshuali925@gmail.com>
@vagimeli vagimeli added 3 - Tech review PR: Tech review in progress and removed 2 - In progress Issue/PR: The issue or PR is in progress. labels Apr 17, 2023
@vagimeli
Copy link
Collaborator Author

thanks for the changes.

One thing I forgot to mention in detail is the limitation on filtering. PPL visualizations currently do not support DQL/DSL and they do not use index patterns. This means

  1. PPL visualizations will only use filters created using the dropdown UI. If user has DQL query or DSL filters in a dashboard, PPL visualizations will not use them
  2. OSD dashboard filter dropdown will only show fields from the index patterns used by other visualizations in the same dashboard (or from default index pattern if PPL visualization are the only visualizations in the dashboard).

Should we mention this to user in docs or should I create a tracking issue and put it in observability readme?

Some related information here opensearch-project/OpenSearch-Dashboards#3849

@joshuali925 I've added the limitations sections. Please verify it for accuracy.

@vagimeli
Address tech review feedback
09bc0c2 
Signed-off-by: vagimeli <vagimeli@amazon.com>
@vagimeli
Address tech review feedback
04d74cf 
Signed-off-by: vagimeli <vagimeli@amazon.com>
@vagimeli
Copyediting
8b910c9 
Signed-off-by: vagimeli <vagimeli@amazon.com>
@vagimeli vagimeli added 4 - Doc review PR: Doc review in progress and removed 3 - Tech review PR: Tech review in progress labels Apr 17, 2023
kolchfa-aws
kolchfa-aws approved these changes Apr 18, 2023
View reviewed changes
Copy link
Collaborator

@kolchfa-aws kolchfa-aws left a comment

Choose a reason for hiding this comment

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

LGTM. Left a couple of open questions.

_observing-your-data/event-analytics.md Outdated Show resolved Hide resolved
_observing-your-data/event-analytics.md Outdated Show resolved Hide resolved
_observing-your-data/event-analytics.md Outdated Show resolved Hide resolved
_observing-your-data/event-analytics.md Outdated Show resolved Hide resolved
_observing-your-data/event-analytics.md Outdated Show resolved Hide resolved
joshuali925
joshuali925 reviewed Apr 18, 2023
View reviewed changes
_observing-your-data/event-analytics.md Outdated Show resolved Hide resolved
_observing-your-data/event-analytics.md Outdated Show resolved Hide resolved
@vagimeli vagimeli added 5 - Editorial review PR: Editorial review in progress and removed 4 - Doc review PR: Doc review in progress labels Apr 20, 2023
@vagimeli
Copy edits
47b3aa5 
Signed-off-by: vagimeli <vagimeli@amazon.com>
natebower
natebower reviewed Apr 24, 2023
View reviewed changes
Copy link
Collaborator

@natebower natebower left a comment

Choose a reason for hiding this comment

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

@vagimeli Please see my comments and changes and let me know if you have any questions. Thanks!

_observing-your-data/event-analytics.md Outdated Show resolved Hide resolved
_observing-your-data/event-analytics.md Outdated Show resolved Hide resolved
_observing-your-data/event-analytics.md Outdated Show resolved Hide resolved
_observing-your-data/event-analytics.md Outdated Show resolved Hide resolved
_observing-your-data/event-analytics.md Outdated Show resolved Hide resolved
_observing-your-data/event-analytics.md Outdated Show resolved Hide resolved
_observing-your-data/event-analytics.md Outdated Show resolved Hide resolved
_observing-your-data/event-analytics.md Outdated Show resolved Hide resolved
_observing-your-data/event-analytics.md Outdated Show resolved Hide resolved
_observing-your-data/event-analytics.md Outdated Show resolved Hide resolved
@vagimeli @natebower
Update _observing-your-data/event-analytics.md
2c4e23e 
Co-authored-by: Nathan Bower <nbower@amazon.com>
Signed-off-by: Melissa Vagi <vagimeli@amazon.com>
@vagimeli vagimeli requested a review from JeffHuss as a code owner April 24, 2023 19:19
vagimeli and others added 10 commits April 24, 2023 13:19
@vagimeli @natebower
Update _observing-your-data/event-analytics.md
8fedd87 
Co-authored-by: Nathan Bower <nbower@amazon.com>
Signed-off-by: Melissa Vagi <vagimeli@amazon.com>
@vagimeli @natebower
Update _observing-your-data/event-analytics.md
fd28ac3 
Co-authored-by: Nathan Bower <nbower@amazon.com>
Signed-off-by: Melissa Vagi <vagimeli@amazon.com>
@vagimeli @natebower
Update _observing-your-data/event-analytics.md
0398d8d 
Co-authored-by: Nathan Bower <nbower@amazon.com>
Signed-off-by: Melissa Vagi <vagimeli@amazon.com>
@vagimeli @natebower
Update _observing-your-data/event-analytics.md
31dba83 
Co-authored-by: Nathan Bower <nbower@amazon.com>
Signed-off-by: Melissa Vagi <vagimeli@amazon.com>
@vagimeli @natebower
Update _observing-your-data/event-analytics.md
94fca73 
Co-authored-by: Nathan Bower <nbower@amazon.com>
Signed-off-by: Melissa Vagi <vagimeli@amazon.com>
@vagimeli @natebower
Update _observing-your-data/event-analytics.md
6fcb3d5 
Co-authored-by: Nathan Bower <nbower@amazon.com>
Signed-off-by: Melissa Vagi <vagimeli@amazon.com>
@vagimeli @natebower
Update _observing-your-data/event-analytics.md
d807f7f 
Co-authored-by: Nathan Bower <nbower@amazon.com>
Signed-off-by: Melissa Vagi <vagimeli@amazon.com>
@vagimeli @natebower
Update _observing-your-data/event-analytics.md
4e49317 
Co-authored-by: Nathan Bower <nbower@amazon.com>
Signed-off-by: Melissa Vagi <vagimeli@amazon.com>
@vagimeli @natebower
Update _observing-your-data/event-analytics.md
cda4b0c 
Co-authored-by: Nathan Bower <nbower@amazon.com>
Signed-off-by: Melissa Vagi <vagimeli@amazon.com>
@vagimeli @natebower
Update _observing-your-data/event-analytics.md
22e7f88 
Co-authored-by: Nathan Bower <nbower@amazon.com>
Signed-off-by: Melissa Vagi <vagimeli@amazon.com>
@vagimeli
Copy link
Collaborator Author

@vagimeli Please see my comments and changes and let me know if you have any questions. Thanks!

Accepted editorial review changes and addressed comments.

@vagimeli
Address editorial review feedback and add example dashboard image
f437cee 
Signed-off-by: vagimeli <vagimeli@amazon.com>
@vagimeli
Address editorial review feedback
c072812 
Signed-off-by: vagimeli <vagimeli@amazon.com>
@vagimeli
Add demo
a5ed5ac 
Signed-off-by: vagimeli <vagimeli@amazon.com>
@vagimeli vagimeli merged commit 49d25db into main Apr 24, 2023
@vagimeli vagimeli deleted the issue-3549 branch April 24, 2023 23:57
@vagimeli vagimeli added Closed - Complete Issue: Work is done and associated PRs closed and removed 5 - Editorial review PR: Editorial review in progress labels Apr 25, 2023
vagimeli added a commit that referenced this pull request Apr 25, 2023
@vagimeli @joshuali925 @natebower
Add Event Analytics visualizations in Dashboards feature (#3752)
3456545 
* Add new documentation for event analytics/PPL visualizations in Dashboards feature

Signed-off-by: vagimeli <vagimeli@amazon.com>
Signed-off-by: Melissa Vagi <vagimeli@amazon.com>
Co-authored-by: Joshua Li <joshuali925@gmail.com>
Co-authored-by: Nathan Bower <nbower@amazon.com>
vagimeli added a commit that referenced this pull request Apr 25, 2023
@vagimeli
Revert "Add Event Analytics visualizations in Dashboards feature (#3752…
d6193d5 
…)"

This reverts commit 3456545.
@hdhalter hdhalter added the release-notes PR: Include this PR in the automated release notes label Apr 26, 2023
@vagimeli vagimeli changed the title Add Event Analytics visualizations in Dashboards feature Add documentation for Observability PPL/event analytics visualizations using Dashboard Apr 27, 2023
Naarcha-AWS pushed a commit that referenced this pull request Apr 27, 2023
@vagimeli @joshuali925
@natebower @Naarcha-AWS
Add Event Analytics visualizations in Dashboards feature (#3752)
6b3d48a 
* Add new documentation for event analytics/PPL visualizations in Dashboards feature

Signed-off-by: vagimeli <vagimeli@amazon.com>
Signed-off-by: Melissa Vagi <vagimeli@amazon.com>
Co-authored-by: Joshua Li <joshuali925@gmail.com>
Co-authored-by: Nathan Bower <nbower@amazon.com>
vagimeli added a commit that referenced this pull request May 4, 2023
@vagimeli @joshuali925 @natebower
Add Event Analytics visualizations in Dashboards feature (#3752)
36f4227 
* Add new documentation for event analytics/PPL visualizations in Dashboards feature

Signed-off-by: vagimeli <vagimeli@amazon.com>
Signed-off-by: Melissa Vagi <vagimeli@amazon.com>
Co-authored-by: Joshua Li <joshuali925@gmail.com>
Co-authored-by: Nathan Bower <nbower@amazon.com>
vagimeli added a commit that referenced this pull request May 4, 2023
@vagimeli
Revert "Add Event Analytics visualizations in Dashboards feature (#3752…
99cec6d 
…)"

This reverts commit 36f4227.
harshavamsi pushed a commit to harshavamsi/documentation-website that referenced this pull request Oct 31, 2023
@vagimeli @joshuali925
@natebower @harshavamsi
Add Event Analytics visualizations in Dashboards feature (opensearch-…
8d7cbce 
…project#3752)

* Add new documentation for event analytics/PPL visualizations in Dashboards feature

Signed-off-by: vagimeli <vagimeli@amazon.com>
Signed-off-by: Melissa Vagi <vagimeli@amazon.com>
Co-authored-by: Joshua Li <joshuali925@gmail.com>
Co-authored-by: Nathan Bower <nbower@amazon.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@joshuali925 joshuali925 joshuali925 left review comments

@natebower natebower natebower left review comments

@Naarcha-AWS Naarcha-AWS Naarcha-AWS approved these changes

@kolchfa-aws kolchfa-aws kolchfa-aws approved these changes

@ariamarble ariamarble Awaiting requested review from ariamarble

@carolxob carolxob Awaiting requested review from carolxob

@cwillum cwillum Awaiting requested review from cwillum

@hdhalter hdhalter Awaiting requested review from hdhalter

@JeffHuss JeffHuss Awaiting requested review from JeffHuss

@ananzh ananzh Awaiting requested review from ananzh

@seanneumann seanneumann Awaiting requested review from seanneumann

@AMoo-Miki AMoo-Miki Awaiting requested review from AMoo-Miki AMoo-Miki is a code owner

Assignees

@vagimeli vagimeli

Labels
Closed - Complete Issue: Work is done and associated PRs closed release-notes PR: Include this PR in the automated release notes v2.7.0
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

[DOC] Make Event Analytics Visualizations Available in Core Dashboards
6 participants
@vagimeli @joshuali925 @Naarcha-AWS @natebower @kolchfa-aws @hdhalter