-
Notifications
You must be signed in to change notification settings - Fork 225
DOCS-409 - Query Assist (preview 1) #4563
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
Merged
Changes from 12 commits
Commits
Show all changes
35 commits
Select commit
Hold shift + click to select a range
7633db4
Intellisense docs/release note
kimsauce 97f5456
Merge branch 'main' into DOCS-409
kimsauce e46524f
typo
kimsauce 625cb99
Merge branch 'main' into DOCS-409
kimsauce 6c456a4
fixes
kimsauce fa4fbbc
Merge branch 'main' into DOCS-409
kimsauce 067c9fb
more edits
kimsauce ec2c49d
more edits
kimsauce a58fcac
Merge branch 'main' into DOCS-409
kimsauce 3ffea9a
link fix
kimsauce 71c0bca
Merge branch 'main' into DOCS-409
kimsauce ec99bfe
Update docs/search/intellisense.md
kimsauce 654f144
Merge branch 'main' into DOCS-409
kimsauce 72e622b
Merge branch 'DOCS-409' of github.com:SumoLogic/sumologic-documentati…
kimsauce d22ea99
Merge branch 'main' into DOCS-409
kimsauce 5222cb1
more edits
kimsauce ea922e8
add noindex code
kimsauce aaed992
Update docs/search/copilot.md
kimsauce 48599f1
Merge branch 'main' into DOCS-409
kimsauce dc6b63a
Merge branch 'main' into DOCS-409
kimsauce 85516db
Merge branch 'DOCS-409' of github.com:SumoLogic/sumologic-documentati…
kimsauce 7161f46
more edits based on meeting
kimsauce 1e14b76
Merge branch 'main' into DOCS-409
kimsauce 52c5acb
Merge branch 'main' into DOCS-409
kimsauce c86ebe3
Merge branch 'main' into DOCS-409
kimsauce ab48afd
updates
kimsauce 387e197
Merge branch 'DOCS-409' of github.com:SumoLogic/sumologic-documentati…
kimsauce e840187
fixes
kimsauce 67ae91a
fixes
kimsauce 8d3fc54
Merge branch 'main' into DOCS-409
kimsauce eec19c7
add vid
kimsauce 1d978c5
Update docs/search/query-assist.md
kimsauce 30a3501
Merge branch 'DOCS-409' of github.com:SumoLogic/sumologic-documentati…
kimsauce 480f648
edits per MS
kimsauce ced1ba3
edits per MS
kimsauce File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,31 @@ | ||
--- | ||
title: Intellisense for Logs Search (Search) | ||
image: https://help.sumologic.com/img/sumo-square.png | ||
keywords: | ||
- intellisense | ||
- ai | ||
- copilot | ||
- search | ||
- log-search | ||
hide_table_of_contents: true | ||
--- | ||
|
||
import useBaseUrl from '@docusaurus/useBaseUrl'; | ||
|
||
<a href="https://help.sumologic.com/release-notes-service/rss.xml"><img src={useBaseUrl('img/release-notes/rss-orange2.png')} alt="icon" width="50"/></a> | ||
|
||
We're excited to announce the beta release of Intellisense for Logs Search. This feature enhances the querying experience with syntax-driven autocompletion, operator prediction, and improved key-value pair support. | ||
|
||
Intellisense streamlines query creation, speeds up navigation through large datasets like JSON logs, and reduces errors. The revamped UI provides real-time syntax error detection and intelligent suggestions for a smoother, more intuitive log search experience. | ||
|
||
Key features: | ||
|
||
* **Syntax-driven autocompletion**. Real-time suggestions reduce errors and accelerate query creation. | ||
* **Enhanced key-value pair support**. Improved parsing and suggestions for structured log data like JSON. | ||
* **Next-operator prediction**. Anticipates the next logical operator, simplifying query writing. | ||
* **Revamped log assist UI**. Updated interface for better usability and query-building efficiency. | ||
* **Facet determination for JSON logs**. Automatically suggests facets for improved filtering and data discovery. | ||
|
||
These features are now live in the new code editor, designed to enhance log search efficiency. | ||
|
||
[Learn more](/docs/search/intellisense). |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,76 @@ | ||
--- | ||
id: intellisense | ||
title: Intellisense for Logs Search (Beta) | ||
kimsauce marked this conversation as resolved.
Show resolved
Hide resolved
|
||
description: Intellisense enhancements for log search improves the querying experience for both novice and advanced users with query autocompletion, operator prediction, and improved key-value pair support. | ||
--- | ||
|
||
<head> | ||
<meta name="robots" content="noindex" /> | ||
</head> | ||
|
||
import useBaseUrl from '@docusaurus/useBaseUrl'; | ||
|
||
<p> <a href="/docs/beta"><span className="beta">Beta</span></a> </p> | ||
|
||
This feature is in Beta. To participate, contact your Sumo Logic account executive. | ||
|
||
Intellisense enhances log search functionality with syntax-driven autocompletion, in-line context-based recommendations, operator prediction, and improved key-value pair support. These features streamline query creation and enable you to quickly navigate through large datasets, particularly JSON logs. A revamped log assist UI makes the query-writing process more intuitive and user-friendly. | ||
|
||
## Key features | ||
|
||
* **Syntax autocompletion**. Automatically suggests query syntax, operators, and functions to reduce errors and speed up query creation. | ||
* **Key-value pair support**. Offers suggestions for structured logs, such as JSON, recognizing keys and values to create more precise queries. | ||
* **Next-operator prediction**. Anticipates and suggests the next logical operator based on the current query context, reducing steps. | ||
* **Revamped log assist UI**. Highlights syntax errors and suggests fixes in real-time for a smoother user experience. | ||
* **Facet determination for JSON logs**. Automatically identifies facets (e.g., timestamp, status) from JSON logs to help refine searches. | ||
* **Context-aware querying**. The **Context Store** tracks past queries and operator usage, powering the **Next Clause Predictor** for smarter suggestions. | ||
* **Operator usage cache**. Stores operator usage history, providing more accurate predictions for the next clause or operator. | ||
|
||
|
||
## How to use Intellisense | ||
|
||
### 1. Open a Log Search | ||
|
||
To start a new log search: | ||
|
||
From the [**Classic UI**](/docs/get-started/sumo-logic-ui-classic), go to the Sumo Logic home dashboard and select **Log Search**. | ||
|
||
From the [**New UI**](/docs/get-started/sumo-logic-ui), go to the left nav and click **Logs** > **Log Search**. | ||
|
||
### 2. Use Syntax autocompletion | ||
|
||
1. Clicking in the empty query field to generate a list of suggested metadata field entries to start your search.<br/><img src={useBaseUrl('img/search/intellisense/more-information.png')} alt="more-information.png" style={{border: '1px solid gray'}} /> | ||
1. Type a search operator like `parse` to begin a query clause, and Intellisense will suggest options. Refer to the [Search Operator](/docs/search/search-query-language/search-operators) guide for syntax and examples. | ||
kimsauce marked this conversation as resolved.
Show resolved
Hide resolved
|
||
1. Use your keyboard's **arrow keys** or cursor to scroll through the suggestions. Press **Enter** or click to select an entry. | ||
1. Depending on the search operators you're including, you may need to use pipes (`|`) to separate query segments. For example, the `where` operator must be separated from other operators by the pipe symbol (`|`). | ||
|
||
:::tip | ||
To learn more about a suggestion before adding it to your query, click the "i" icon. This shows you more information, such as the field type (e.g., metadata, keyword), definition, examples, and/or link to doc.<br/><img src={useBaseUrl('img/search/intellisense/initial-prompts.png')} alt="initial-prompts.png" style={{border: '1px solid gray'}} /> | ||
::: | ||
|
||
### 3. Key-value pair support | ||
|
||
1. For JSON or structured logs, type a key (e.g., `status`). Select the suggested facet (e.g., `timestamp`) for more precise filtering. | ||
kimsauce marked this conversation as resolved.
Show resolved
Hide resolved
|
||
1. Intellisense will suggest keys and values. Select the appropriate one using **Enter**. | ||
|
||
### 4. Next-operator prediction | ||
|
||
1. Add a filtering clause like `where status="error"` and group results using `group by`. | ||
1. Intellisense will predict and suggest the next operator (e.g., `group by`, `where`). Use **arrow keys** or click to select. | ||
|
||
### 5. Revamped log assist UI | ||
|
||
1. As you write, the UI will highlight syntax issues. Hover over the underlined errors for suggested fixes. | ||
kimsauce marked this conversation as resolved.
Show resolved
Hide resolved
|
||
1. The side panel provides query-building tutorials and examples for additional support. | ||
|
||
### 6. Facet determination for JSON logs | ||
|
||
1. When querying for JSON-formatted logs, Intellisense will suggest facets like `status` or `timestamp`. | ||
1. Click the facet to refine your query. | ||
|
||
By following these steps, you can take full advantage of Intellisense to accelerate query writing and improve search efficiency. | ||
|
||
|
||
## Leverage Copilot AI | ||
|
||
Still need help writing queries? Try [Sumo Logic Copilot](/docs/search/copilot), our AI-powered assistant that lets you enter natural questions in plain English and auto-generate queries - no need to write them manually. It guides you through query building step-by-step with AI-driven suggestions to refine your results. Because all your observability and security source records are in Sumo Logic, Copilot helps discover related datasets. |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.