Skip to content

Commit 7161f46

Browse files
committed
more edits based on meeting
1 parent 85516db commit 7161f46

File tree

5 files changed

+41
-30
lines changed

5 files changed

+41
-30
lines changed

blog-service/2024-10-25-search.md renamed to blog-service/2024-10-31-search.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: Simplified Query Writing Enhancements (Beta) (Search)
2+
title: Simplified Query Writing Enhancements - Beta (Search)
33
image: https://help.sumologic.com/img/sumo-square.png
44
keywords:
55
- query

docs/search/simplified-query-writing.md

Lines changed: 40 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -12,53 +12,64 @@ import useBaseUrl from '@docusaurus/useBaseUrl';
1212

1313
<p> <a href="/docs/beta"><span className="beta">Beta</span></a> </p>
1414

15-
This feature is in Beta. To participate, contact your Sumo Logic account executive.
15+
This feature is in beta, with select features available for early access. Full general availability is expected by the end of the year. To participate, contact your Sumo Logic account executive.
1616

17-
Our new **Simplified Query Writing** enhancements focus on delivering a frictionless query experience with real-time syntax suggestions, schema suggestions, and partial/full query predictions. These features make it easier for both novice and advanced users to build accurate and efficient queries.
17+
Our new simplified query writing enhancements provide a frictionless experience with real-time syntax suggestions, schema suggestions, and partial/full query predictions. These features simplify the query-building process, helping both novice and advanced users write accurate, efficient queries.
1818

19-
## Key features
19+
By incorporating user feedback, we’ve implemented improvements to reduce the complexity of Sumo Logic’s query language, making it easier to discover relevant fields, minimize errors, and benefit from intelligent query-building assistance.
2020

21-
* **Syntax suggestions**. Get real-time syntax suggestions as you type, reducing errors and speeding up query creation.
22-
* **Schema suggestions**. Automatically receive schema-related suggestions, helping you navigate complex data structures like JSON logs with ease.
23-
* **Partial/Full query suggestions**. Based on your input, the system predicts and suggests the next operator or even a full query, streamlining the process.
24-
* **Frictionless query experience**. An intuitive interface highlights errors and provides immediate fixes, allowing for smooth and seamless query building.
25-
* **Key-Value pair support**. Offers enhanced suggestions for structured logs like JSON, recognizing keys and values for more precise filtering.
26-
* **Facet identification for JSON Logs**. Identifies key facets (e.g., timestamp, status) to help refine your queries.
21+
## Key enhancements made to the query-building experience
2722

28-
## How to use
23+
* **Improved learning curve**. We’ve simplified learning and using Sumo Logic queries. The new syntax suggestions and schema-based prompts allow you to write queries faster with less need for deep familiarity with the syntax.
24+
* **Enhanced auto-complete**. The auto-complete function has been optimized to provide more relevant, context-based suggestions that align with your queries and organizational patterns, improving accuracy and efficiency.
25+
* **Streamlined field discovery**. No need to manually search for fields within your logs. The system automatically suggests key fields, especially for structured data like JSON, making it easier to navigate complex data and build accurate queries.
2926

30-
### 1. Start a Log Search
3127

32-
From the [**Classic UI**](/docs/get-started/sumo-logic-ui-classic) or the [**New UI**](/docs/get-started/sumo-logic-ui), go to **Log Search** to start crafting your query.
28+
## Token-by-token prediction and auto-complete
3329

34-
### 2. Syntax suggestions
30+
Get real-time suggestions for query completion as you type, with token-by-token predictions helping to quickly finish your queries.
3531

36-
1. Begin typing in the query field to see syntax and operator suggestions.
37-
2. Use arrow keys or your mouse to navigate and select the desired option.
32+
As you start typing a query, such as `_sourceCategory=`, the system provides **token-by-token predictions** and auto-completes your query with relevant metadata options. Simply use the `Tab` key to accept the suggestion. For example, after typing `status=`, you will be prompted with likely values such as `success`, `error`, or other status codes based on your previous queries or log data.
3833

39-
### 3. Schema suggestions
34+
## Schema discovery and field suggestions
4035

41-
1. For structured logs (like JSON), Intellisense will offer schema-based suggestions, helping you choose relevant keys (e.g., `status`, `timestamp`) for more accurate queries.
36+
Automatically receive suggestions for relevant fields in structured data like JSON logs, making field discovery much easier.
4237

43-
### 4. Partial/Full query predictions
38+
For structured logs like JSON, the system automatically suggests relevant fields such as `userID`, `eventType`, or `timestamp` as you type. This eliminates the need for manual inspection of logs, making it easier to filter and aggregate data.
4439

45-
1. After entering a filtering condition (e.g., `where status="error"`), the system will predict and suggest the next logical operator or a complete query, saving you time.
40+
## Next operator and full query predictions
4641

47-
### 5. UI enhancements
42+
The system intelligently predicts the next operator or offers full query suggestions based on your input, reducing manual effort.
4843

49-
1. As you write, syntax issues are automatically highlighted, with real-time suggestions for corrections.
44+
When you type a query such as `source=logs | where status="error"`, the system predicts the **next operator** and offers suggestions like `count by employeeID` or other common fields. This minimizes manual input and ensures your queries are accurate and aligned with standard query patterns.
5045

51-
### 6. JSON facet identification
46+
## Real-time error highlighting and feedback
5247

53-
1. When working with JSON logs, relevant facets like `status` and `timestamp` will be suggested to refine your query further.
48+
Errors are flagged as you type, with immediate suggestions for corrections, ensuring a seamless query-writing experience.
5449

55-
These enhancements ensure a smoother, more efficient query-building experience, making it easier to analyze your data.
50+
As you write queries, the system highlights any syntax errors in real-time. For example, if you forget to close parentheses or misspell an operator, the system will flag it and provide suggestions to fix the issue immediately, preventing unnecessary troubleshooting.
5651

57-
<!--
58-
## Example
59-
Use meeting query
60-
-->
52+
## Contextual auto-complete and field discovery
53+
54+
Suggestions are ranked based on your organization’s common queries, making query completion smarter and more relevant.
55+
56+
The system ranks suggestions based on common queries from your organization or your own previous queries. This ensures that your auto-complete options are not only relevant but also contextually accurate, speeding up the query-writing process.
57+
58+
## How to get started
6159

62-
## Need more help?
60+
1. **Start a log search**. From the [**Classic UI**](/docs/get-started/sumo-logic-ui-classic) or the [**New UI**](/docs/get-started/sumo-logic-ui), go to **Log Search** to start crafting your query.
61+
2. **Leverage syntax and schema suggestions**. As you type, the system will offer real-time suggestions for fields and operators. Select options using your arrow keys and press `Tab` to auto-complete.
62+
3. **Use partial and full query predictions**. Take advantage of the system’s predictions to build queries faster and more accurately.
63+
4. **Review and correct errors**. As you write your query, watch for real-time error highlighting and corrections before running the query.
64+
65+
### Need more help?
6366

6467
Try [Sumo Logic Copilot](/docs/search/copilot), our AI-powered assistant that helps you write queries in plain English and auto-generates them for you.
68+
69+
<!--
70+
These features will be available in phases:
71+
72+
* **Phase 1**. Token-by-token prediction, metadata auto-complete, and basic schema suggestions.
73+
* **Phase 2**. Enhanced operator predictions, full query suggestions, and advanced schema discovery.
74+
* **Phase 3**. Real-time error feedback, more contextual suggestions, and query pattern-based improvements.
75+
-->
-66 KB
Binary file not shown.
-77.4 KB
Binary file not shown.
3.24 MB
Loading

0 commit comments

Comments
 (0)