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 query assist documentation to Observability #6419

Merged
merged 29 commits into from
Feb 19, 2024
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
29 commits
Select commit Hold shift + click to select a range
8344898
Add query assist documentation to Observability
lezzago Feb 16, 2024
aba121a
Add summary detail
lezzago Feb 16, 2024
989028a
Doc review with comments and edits
vagimeli Feb 16, 2024
dc09f31
Update _observing-your-data/event-analytics.md
vagimeli Feb 16, 2024
4b9f314
Update event-analytics.md
vagimeli Feb 16, 2024
c73538d
Update event-analytics.md
vagimeli Feb 16, 2024
b05775e
Update event-analytics.md
vagimeli Feb 16, 2024
b337adc
Update event-analytics.md
vagimeli Feb 16, 2024
d999a9e
Copy edits
vagimeli Feb 16, 2024
c423514
Update event-analytics.md
vagimeli Feb 16, 2024
8bc17e5
Update event-analytics.md
vagimeli Feb 19, 2024
c6e2dcf
Update event-analytics.md
vagimeli Feb 19, 2024
856adb6
Update event-analytics.md
vagimeli Feb 19, 2024
acf7b1f
Update event-analytics.md
vagimeli Feb 19, 2024
d456738
Update _observing-your-data/event-analytics.md
vagimeli Feb 19, 2024
c91b284
Update _observing-your-data/event-analytics.md
vagimeli Feb 19, 2024
3ebbb70
Update _observing-your-data/event-analytics.md
vagimeli Feb 19, 2024
6339ed4
Update _observing-your-data/event-analytics.md
vagimeli Feb 19, 2024
5eb833e
Update _observing-your-data/event-analytics.md
vagimeli Feb 19, 2024
a2bd1b4
Update _observing-your-data/event-analytics.md
vagimeli Feb 19, 2024
32a60f4
Update _observing-your-data/event-analytics.md
vagimeli Feb 19, 2024
c678781
Update _observing-your-data/event-analytics.md
vagimeli Feb 19, 2024
ba8b45e
Update _observing-your-data/event-analytics.md
vagimeli Feb 19, 2024
ad5735e
Update _observing-your-data/event-analytics.md
vagimeli Feb 19, 2024
c738d05
Update _observing-your-data/event-analytics.md
vagimeli Feb 19, 2024
5e58566
Update _observing-your-data/event-analytics.md
vagimeli Feb 19, 2024
2e6ea7a
Update event-analytics.md
vagimeli Feb 19, 2024
bc02e48
Merge branch 'main' into main
vagimeli Feb 19, 2024
b27995c
Update event-analytics.md
vagimeli Feb 19, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 25 additions & 0 deletions _observing-your-data/event-analytics.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,31 @@

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

### OpenSearch Query Assist

Check failure on line 31 in _observing-your-data/event-analytics.md

View workflow job for this annotation

GitHub Actions / style-job

[vale] reported by reviewdog 🐶 [OpenSearch.HeadingCapitalization] 'OpenSearch Query Assist' is a heading and should be in sentence case. Raw Output: {"message": "[OpenSearch.HeadingCapitalization] 'OpenSearch Query Assist' is a heading and should be in sentence case.", "location": {"path": "_observing-your-data/event-analytics.md", "range": {"start": {"line": 31, "column": 5}}}, "severity": "ERROR"}
Copy link
Collaborator

Choose a reason for hiding this comment

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

Should this be "OpenSearch Query Assistant"?

Copy link
Contributor

Choose a reason for hiding this comment

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

Revised throughout


This is an experimental feature and is not recommended for use in a production environment. For updates on the progress of the feature or if you want to leave feedback, see the associated [OpenSearch forum thread](https://forum.opensearch.org/t/feedback-opensearch-assistant/16741).
{: .warning}

To make building queries easier, the OpenSearch Assistant Toolkit provides an assistant to help convert natural language queries to PPL.

![Sample OpenSearch Query Assist View]({{site.url}}{{site.baseurl}}/images/log-explorer-query-assist.png)
vagimeli marked this conversation as resolved.
Show resolved Hide resolved

#### Enabling OpenSearch Query Assist

Check failure on line 40 in _observing-your-data/event-analytics.md

View workflow job for this annotation

GitHub Actions / style-job

[vale] reported by reviewdog 🐶 [OpenSearch.HeadingCapitalization] 'Enabling OpenSearch Query Assist' is a heading and should be in sentence case. Raw Output: {"message": "[OpenSearch.HeadingCapitalization] 'Enabling OpenSearch Query Assist' is a heading and should be in sentence case.", "location": {"path": "_observing-your-data/event-analytics.md", "range": {"start": {"line": 40, "column": 6}}}, "severity": "ERROR"}
To enable **OpenSearch Query Assist** in OpenSearch Dashboards, locate your copy of the `opensearch_dashboards.yml` file and set the following option:
```
observability.query_assist.enabled: true
observability.query_assist.ppl_agent_name: "PPL agent"
lezzago marked this conversation as resolved.
Show resolved Hide resolved
```
To enable the option to summarize the responses, locate your copy of the `opensearch_dashboards.yml` file and set the following option:
Copy link
Collaborator

Choose a reason for hiding this comment

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

"To enable summarization of responses"?

```
observability.summarize.enabled: true
observability.summarize.response_summary_agent_name: "Response summary agent"
observability.summarize.error_summary_agent_name: "Error summary agent"
```

#### How to setup OpenSearch Query Assist

Check failure on line 53 in _observing-your-data/event-analytics.md

View workflow job for this annotation

GitHub Actions / style-job

[vale] reported by reviewdog 🐶 [OpenSearch.HeadingCapitalization] 'How to setup OpenSearch Query Assist' is a heading and should be in sentence case. Raw Output: {"message": "[OpenSearch.HeadingCapitalization] 'How to setup OpenSearch Query Assist' is a heading and should be in sentence case.", "location": {"path": "_observing-your-data/event-analytics.md", "range": {"start": {"line": 53, "column": 6}}}, "severity": "ERROR"}
For a guide to setup the query assist, follow the getting started guide [here](https://github.com/opensearch-project/dashboards-assistant/blob/main/GETTING_STARTED_GUIDE.md). This guide shows how to setup OpenSearch Assistant and Query Assist. To only setup Query Assist, use only the `query-assist-agent` template called out in the guide.

Check failure on line 54 in _observing-your-data/event-analytics.md

View workflow job for this annotation

GitHub Actions / style-job

[vale] reported by reviewdog 🐶 [OpenSearch.SetupVerb] Use 'set up' as a verb instead of 'setup'. Raw Output: {"message": "[OpenSearch.SetupVerb] Use 'set up' as a verb instead of 'setup'.", "location": {"path": "_observing-your-data/event-analytics.md", "range": {"start": {"line": 54, "column": 16}}}, "severity": "ERROR"}

Check failure on line 54 in _observing-your-data/event-analytics.md

View workflow job for this annotation

GitHub Actions / style-job

[vale] reported by reviewdog 🐶 [OpenSearch.SetupVerb] Use 'set up' as a verb instead of 'setup'. Raw Output: {"message": "[OpenSearch.SetupVerb] Use 'set up' as a verb instead of 'setup'.", "location": {"path": "_observing-your-data/event-analytics.md", "range": {"start": {"line": 54, "column": 200}}}, "severity": "ERROR"}

## Saving a visualization

After Dashboards generates a visualization, you must save it if you want to return to it at a later time or if you want to add it to an [operational panel]({{site.url}}{{site.baseurl}}/observing-your-data/operational-panels).
Expand Down
Binary file added images/log-explorer-query-assist.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading