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

DOCS-409 - Intellisense (Beta) #4563

Draft
wants to merge 22 commits into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from 11 commits
Commits
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
31 changes: 31 additions & 0 deletions blog-service/2024-10-15-search.md
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).
2 changes: 2 additions & 0 deletions docs/search/copilot.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,8 @@ This is a Preview release. To learn more, contact your Sumo Logic account execut

Sumo Logic Copilot is an AI-based assistant designed to simplify log analysis by allowing you to ask questions in plain English and providing search suggestions without the need to write log queries.

<!-- Mention Intellisense -->

kimsauce marked this conversation as resolved.
Show resolved Hide resolved
### Key features

* **AI-curated insights**. Get customized insights tailored to your data.
Expand Down
78 changes: 78 additions & 0 deletions docs/search/intellisense.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,78 @@
---
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.
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.
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.
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

In a hurry to complete your investigation? 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.
kimsauce marked this conversation as resolved.
Show resolved Hide resolved
kimsauce marked this conversation as resolved.
Show resolved Hide resolved
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.
Loading