Add query assist documentation to Observability #6419

lezzago · 2024-02-16T00:15:06Z

Description

Documentation for query assist in the Observability Log Explorer page.

Issues Resolved

#6292

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.

Signed-off-by: Ashish Agrawal <ashisagr@amazon.com>

_observing-your-data/event-analytics.md

Signed-off-by: Ashish Agrawal <ashisagr@amazon.com>

joshuali925

lgtm, thanks

Signed-off-by: Melissa Vagi <vagimeli@amazon.com>

_observing-your-data/event-analytics.md

Signed-off-by: Melissa Vagi <vagimeli@amazon.com>

vagimeli · 2024-02-16T02:33:42Z

_observing-your-data/event-analytics.md


-You can also choose intervals and switch between them to dictate how often live tail should stream live logs. This feature is similar to the CLI's `tail -f` command in that it only retrieves the most recent live logs by possibly eliminating a large portion of live logs. Live tail also provides you with the total count of live logs received by OpenSearch during the live stream, which you can use to better understand the incoming traffic.
+You can select intervals and seamlessly switch between them to control the frequency of live log streaming with Live Tail. This functionality is similar to the CLI command `tail -f` command, as it retrieves only the most recent live logs, potentially eliminating a significant portion of live logs. Live Tail displays the total count of live logs received by OpenSearch during the live stream, offering insights into incoming traffic patterns. The following demo shows this feture in action. 


Is Live Tail a proper name of a feature?

Signed-off-by: Melissa Vagi <vagimeli@amazon.com>

vagimeli · 2024-02-16T02:49:58Z

_observing-your-data/event-analytics.md


 ## Getting started with event analytics

-To get started, choose **Observability** in OpenSearch Dashboards and then choose **Event analytics**. If you want to start exploring without adding any of your own data, choose **Add samples**, and Dashboards adds sample visualizations you can interact with.
+To get started, choose **Observability** in OpenSearch Dashboards and then choose **Event analytics**. If you want to start exploring without adding your own data, choose **Add samples**. Dashboards adds sample visualizations you can interact with.


Is "Event analytics" now "Logs?"

It is in this page where we talk about the log explorer for the event analytics. This is a feature to help with event analytics as it helps explore the logs.

kolchfa-aws · 2024-02-16T13:49:56Z

_observing-your-data/event-analytics.md


 For more information about building PPL queries, see [Piped Processing Language]({{site.url}}{{site.baseurl}}/search-plugins/sql/ppl/index).

-## Saving a visualization
+### OpenSearch Query Assist


Should this be "OpenSearch Query Assistant"?

Revised throughout

Signed-off-by: Melissa Vagi <vagimeli@amazon.com>

lezzago · 2024-02-19T16:19:31Z

_observing-your-data/event-analytics.md


-You can also choose intervals and switch between them to dictate how often live tail should stream live logs. This feature is similar to the CLI's `tail -f` command in that it only retrieves the most recent live logs by possibly eliminating a large portion of live logs. Live tail also provides you with the total count of live logs received by OpenSearch during the live stream, which you can use to better understand the incoming traffic.
+- [Demonstrating OpenSearch Assistant toolkit for Analysis](https://www.youtube.com/watch?v=VTiJtGI2Sr4&t=152s)
+You can select intervals and seamlessly switch between them to control the frequency of live log streaming with Live Tail. This functionality is similar to the CLI command `tail -f` command, as it retrieves only the most recent live logs, potentially eliminating a significant portion of live logs. Live Tail displays the total count of live logs received by OpenSearch during the live stream, offering insights into incoming traffic patterns. The following demo shows this feature in action. 


Should there be another - to mark the next bullet point?

Good catch. Formatting done.

Signed-off-by: Melissa Vagi <vagimeli@amazon.com> Signed-off-by: Melissa Vagi <vagimeli@amazon.com>

natebower

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

_observing-your-data/event-analytics.md

natebower · 2024-02-19T19:12:03Z

_observing-your-data/event-analytics.md

+observability.query_assist.ppl_agent_name: "PPL agent"
+```
+
+To enable the option to summarize the responses, locate your copy of the `opensearch_dashboards.yml` file and set the following option:


"To enable summarization of responses"?

_observing-your-data/event-analytics.md

natebower · 2024-02-19T19:27:53Z

_observing-your-data/event-analytics.md


 ![Surrounding Events]({{site.url}}{{site.baseurl}}/images/surrounding_events.gif)

 ### Livestreaming logs

-If you prefer watching events happen live, you can configure an interval so event analytics automatically refreshes the content. Live tail lets you stream logs live to OpenSearch observability event analytics based on the provided PPL query, as well as provide rich functionality such as filters. Doing so improves your debugging experience and lets you monitor your logs in real-time without having to manually refresh.
+If you prefer real-time monitoring, you can set up an interval for automatic content refresh in event analytics. Live Tail enables you to stream logs directly to OpenSearch Observability event analytics using the specified PPL query, while offering robust features like filters. This enhances your debugging process and enables seamless real-time monitoring of logs without the need for manual refreshing.


First sentence: "an interval at which event analytics content will be automatically refreshed"? Last sentence: "without the need to manually refresh content"?

_observing-your-data/event-analytics.md

natebower · 2024-02-19T19:33:24Z

_observing-your-data/event-analytics.md

+
+## Related articles
+
+- [Demonstrating OpenSearch Assistant toolkit for Analysis](https://www.youtube.com/watch?v=VTiJtGI2Sr4&t=152s)


I changed to this to reflect the exact title on YouTube.

Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Melissa Vagi <vagimeli@amazon.com>

Signed-off-by: Melissa Vagi <vagimeli@amazon.com> Signed-off-by: Melissa Vagi <vagimeli@amazon.com>

vagimeli

Doc and editorial reviews completed. Editorial feedback addressed.

Signed-off-by: Melissa Vagi <vagimeli@amazon.com> Signed-off-by: Melissa Vagi <vagimeli@amazon.com>

) Add Query Assistant documentation --------- Signed-off-by: Ashish Agrawal <ashisagr@amazon.com> Signed-off-by: Melissa Vagi <vagimeli@amazon.com> Co-authored-by: Melissa Vagi <vagimeli@amazon.com> Co-authored-by: Nathan Bower <nbower@amazon.com>

Add query assist documentation to Observability

8344898

Signed-off-by: Ashish Agrawal <ashisagr@amazon.com>

lezzago requested review from hdhalter, kolchfa-aws, Naarcha-AWS, vagimeli, AMoo-Miki, natebower and dlvenable as code owners February 16, 2024 00:15

joshuali925 reviewed Feb 16, 2024

View reviewed changes

_observing-your-data/event-analytics.md Show resolved Hide resolved

hdhalter added release-notes PR: Include this PR in the automated release notes experimental v2.12.0 labels Feb 16, 2024

hdhalter assigned vagimeli and kolchfa-aws Feb 16, 2024

hdhalter added the 4 - Doc Review PR: Doc review in progress label Feb 16, 2024

Add summary detail

aba121a

Signed-off-by: Ashish Agrawal <ashisagr@amazon.com>

joshuali925 reviewed Feb 16, 2024

View reviewed changes

Doc review with comments and edits

989028a

Signed-off-by: Melissa Vagi <vagimeli@amazon.com>

vagimeli reviewed Feb 16, 2024

View reviewed changes

_observing-your-data/event-analytics.md Outdated Show resolved Hide resolved

vagimeli added 3 commits February 15, 2024 19:30

Update _observing-your-data/event-analytics.md

dc09f31

Signed-off-by: Melissa Vagi <vagimeli@amazon.com>

Update event-analytics.md

4b9f314

Signed-off-by: Melissa Vagi <vagimeli@amazon.com>

Update event-analytics.md

c73538d

Signed-off-by: Melissa Vagi <vagimeli@amazon.com>

vagimeli reviewed Feb 16, 2024

View reviewed changes

vagimeli added 2 commits February 15, 2024 19:39

Update event-analytics.md

b05775e

Signed-off-by: Melissa Vagi <vagimeli@amazon.com>

Update event-analytics.md

b337adc

Signed-off-by: Melissa Vagi <vagimeli@amazon.com>

vagimeli reviewed Feb 16, 2024

View reviewed changes

kolchfa-aws reviewed Feb 16, 2024

View reviewed changes

vagimeli added 2 commits February 16, 2024 10:23

Copy edits

d999a9e

Signed-off-by: Melissa Vagi <vagimeli@amazon.com>

Update event-analytics.md

c423514

Signed-off-by: Melissa Vagi <vagimeli@amazon.com>

lezzago commented Feb 19, 2024

View reviewed changes

vagimeli added 4 commits February 19, 2024 11:29

Update event-analytics.md

8bc17e5

Signed-off-by: Melissa Vagi <vagimeli@amazon.com> Signed-off-by: Melissa Vagi <vagimeli@amazon.com>

Update event-analytics.md

c6e2dcf

Signed-off-by: Melissa Vagi <vagimeli@amazon.com> Signed-off-by: Melissa Vagi <vagimeli@amazon.com>

Update event-analytics.md

856adb6

Signed-off-by: Melissa Vagi <vagimeli@amazon.com> Signed-off-by: Melissa Vagi <vagimeli@amazon.com>

Update event-analytics.md

acf7b1f

Signed-off-by: Melissa Vagi <vagimeli@amazon.com> Signed-off-by: Melissa Vagi <vagimeli@amazon.com>

vagimeli added 5 - Final Editorial Review PR: Editorial Review in progress and removed 4 - Doc Review PR: Doc review in progress labels Feb 19, 2024

natebower reviewed Feb 19, 2024

View reviewed changes

vagimeli and others added 14 commits February 19, 2024 12:46

Update _observing-your-data/event-analytics.md

d456738

Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Melissa Vagi <vagimeli@amazon.com>

Update _observing-your-data/event-analytics.md

c91b284

Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Melissa Vagi <vagimeli@amazon.com>

Update _observing-your-data/event-analytics.md

3ebbb70

Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Melissa Vagi <vagimeli@amazon.com>

Update _observing-your-data/event-analytics.md

6339ed4

Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Melissa Vagi <vagimeli@amazon.com>

Update _observing-your-data/event-analytics.md

5eb833e

Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Melissa Vagi <vagimeli@amazon.com>

Update _observing-your-data/event-analytics.md

a2bd1b4

Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Melissa Vagi <vagimeli@amazon.com>

Update _observing-your-data/event-analytics.md

32a60f4

Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Melissa Vagi <vagimeli@amazon.com>

Update _observing-your-data/event-analytics.md

c678781

Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Melissa Vagi <vagimeli@amazon.com>

Update _observing-your-data/event-analytics.md

ba8b45e

Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Melissa Vagi <vagimeli@amazon.com>

Update _observing-your-data/event-analytics.md

ad5735e

Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Melissa Vagi <vagimeli@amazon.com>

Update _observing-your-data/event-analytics.md

c738d05

Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Melissa Vagi <vagimeli@amazon.com>

Update _observing-your-data/event-analytics.md

5e58566

Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Melissa Vagi <vagimeli@amazon.com>

Update event-analytics.md

2e6ea7a

Signed-off-by: Melissa Vagi <vagimeli@amazon.com> Signed-off-by: Melissa Vagi <vagimeli@amazon.com>

Merge branch 'main' into main

bc02e48

vagimeli self-requested a review February 19, 2024 20:05

vagimeli approved these changes Feb 19, 2024

View reviewed changes

Update event-analytics.md

b27995c

Signed-off-by: Melissa Vagi <vagimeli@amazon.com> Signed-off-by: Melissa Vagi <vagimeli@amazon.com>

vagimeli merged commit 8d2a7f2 into opensearch-project:main Feb 19, 2024
2 of 3 checks passed

vagimeli added 3 - Done Issue is done/complete and removed 5 - Final Editorial Review PR: Editorial Review in progress labels Feb 19, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add query assist documentation to Observability #6419

Add query assist documentation to Observability #6419

lezzago commented Feb 16, 2024

joshuali925 left a comment

vagimeli Feb 16, 2024

vagimeli Feb 16, 2024

lezzago Feb 19, 2024

kolchfa-aws Feb 16, 2024

vagimeli Feb 16, 2024

lezzago Feb 19, 2024

vagimeli Feb 19, 2024

natebower left a comment

natebower Feb 19, 2024

natebower Feb 19, 2024

natebower Feb 19, 2024

vagimeli left a comment


		You can also choose intervals and switch between them to dictate how often live tail should stream live logs. This feature is similar to the CLI's `tail -f` command in that it only retrieves the most recent live logs by possibly eliminating a large portion of live logs. Live tail also provides you with the total count of live logs received by OpenSearch during the live stream, which you can use to better understand the incoming traffic.
		You can select intervals and seamlessly switch between them to control the frequency of live log streaming with Live Tail. This functionality is similar to the CLI command `tail -f` command, as it retrieves only the most recent live logs, potentially eliminating a significant portion of live logs. Live Tail displays the total count of live logs received by OpenSearch during the live stream, offering insights into incoming traffic patterns. The following demo shows this feture in action.


		## Related articles

		- [Demonstrating OpenSearch Assistant toolkit for Analysis](https://www.youtube.com/watch?v=VTiJtGI2Sr4&t=152s)

Add query assist documentation to Observability #6419

Add query assist documentation to Observability #6419

Conversation

lezzago commented Feb 16, 2024

Description

Issues Resolved

Checklist

joshuali925 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

natebower left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

vagimeli left a comment

Choose a reason for hiding this comment