Skip to content

Commit ae00234

Browse files
committed
Edits per BA
1 parent 768b3d0 commit ae00234

File tree

1 file changed

+45
-25
lines changed

1 file changed

+45
-25
lines changed

docs/search/copilot.md

Lines changed: 45 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ keywords:
1313
import Iframe from 'react-iframe';
1414
import useBaseUrl from '@docusaurus/useBaseUrl';
1515

16-
Sumo Logic <!-- Copilot? Mo Pilot? https://www.sumologic.com/blog/copilot-amazon-bedrock/ --> is an AI-powered assistant that accelerates investigations and troubleshooting in logs by allowing you to ask questions in plain English and get contextual suggestions, helping first responders get to answers faster.
16+
Sumo Logic Copilot is our AI-powered assistant that accelerates investigations and troubleshooting in logs by allowing you to ask questions in plain English and get contextual suggestions, helping first responders get to answers faster.
1717

1818
With its intuitive interface, Copilot automatically generates log searches from natural language queries, helping you quickly investigate performance issues, anomalies, and security threats. It also guides you through investigations step-by-step with AI-driven suggestions to refine your results for faster, more accurate resolutions. Overall, Copilot enhances incident resolution with expert level insights.
1919

@@ -31,12 +31,23 @@ With its intuitive interface, Copilot automatically generates log searches from
3131

3232
### Key features
3333

34-
Copilot reduces manual effort by combining prebuilt insights with natural language query analysis.
34+
Copilot reduces manual effort in log searches by combining prebuilt insights with natural language query analysis, eliminating the need for complex query syntax. Designed to address common challenges such as syntax errors and steep learning curves, Copilot enhances usability and accelerates time to insights across your organization. With sub-2-second response times with over 90% translation accuracy, Copilot ensures fast and dependable results for all supported log types.
3535

3636
* **Natural language queries**. Ask questions in plain English—no need to enter query syntax.
37-
* **Contextual suggestions**. Automated suggestions to accelerate your workflow.
38-
* **Conversation history**. Save and resume any troubleshooting session without losing context.
39-
* **Auto-visualize**. Copilot renders charts based on search results automatically. These charts can be added to dashboards from within Copilot.
37+
* **Contextual suggestions**. Get automated suggestions tailored to your search, accelerating your workflow.
38+
* **Conversation history**. Save and resume troubleshooting sessions without losing valuable context.
39+
* **Auto-visualize**. Copilot automatically generates charts from search results, which you can add directly to dashboards.
40+
* **Log compatibility**. Copilot supports structured logs, semi-structured logs (e.g., Cohesity logs), and unstructured logs (e.g., Palo Alto Firewall) when Field Extraction Rules (FERs) are applied. This ensures valuable insights across a variety of log formats.
41+
* **Enhanced query experience**. Provides auto-completion to streamline natural language queries.
42+
43+
## Use cases
44+
45+
Copilot supports users at all expertise levels:
46+
47+
* **Novices**. Simplifies log analysis for new users or teams unfamiliar with Sumo Logic.
48+
* **Practitioners**. Provides query suggestions and assists with query refinement.
49+
* **Experts**. Offers IDE-style completion assistance for faster complex query building.
50+
4051

4152
## Security compliance and legal
4253

@@ -80,10 +91,7 @@ In this example, we'll click `Count the number of log entries by the collector I
8091

8192
<img src={useBaseUrl('img/search/copilot/suggestions.png')} alt="Copilot time period" style={{border: '1px solid gray'}} width="600" />
8293

83-
<br/><br/>
84-
85-
<details>
86-
<summary>Manual entry (not recommended)</summary>
94+
#### Ask a question
8795

8896
In the **Ask Something...** field, you can manually enter a natural language prompt similar to the prebuilt ones under **Suggestions**.
8997

@@ -92,8 +100,11 @@ In the **Ask Something...** field, you can manually enter a natural language pro
92100
Broad questions may not yield accurate results. For best outcomes, frame your queries around a small, well-defined problem. If Copilot is unable to translate your prompt into a query, it will display "Failed translation".
93101

94102
Break your questions into smaller, specific prompts to help Copilot provide more accurate answers.<br/><img src={useBaseUrl('img/search/copilot/copilot-periods.gif')} alt="Copilot time period" style={{border: '1px solid gray'}} width="700" />
95-
</details>
96103

104+
<!-- TO DO
105+
##### Autocompletion for natural language
106+
see https://drive.google.com/file/d/10XUn4DQD3K91V3Qf5heCizkHJneTaBJ7/view?usp=sharing
107+
--->
97108

98109
#### Time range
99110

@@ -125,27 +136,36 @@ If required, select your preferred chart type, such as **Table**, **Bar**, **Col
125136

126137
You can manually edit your log search query code if needed.
127138

128-
<details>
129-
<summary>JSON Syntax Rules</summary>
130-
131-
* Copilot supports querying JSON logs only. It cannot be used to query unstructured data, metrics, or traces. To retrieve a list of `_sourceCategories` with JSON data, use the following query:
132-
```sql
133-
_sourceCategory=* "{" "}"
134-
| limit 10000 | logreduce keys noaggregate
135-
| count by _sourceCategory, _schema
136-
| where _schema != "unknown"
137-
| sum(_count) by _sourceCategory
138-
```
139-
* If your log query contains a mix of JSON and non-JSON formatting (i.e., a log file is partially JSON), you can isolate the JSON portion by adding `{` to the source expression to trigger **Suggestions**.<br/><img src={useBaseUrl('img/search/copilot/copilot-json.png')} alt="Copilot JSON formatting" style={{border: '1px solid gray'}} width="350" />
140-
</details>
141-
142139
1. Click in the code editor field and edit your search. Not familiar with Sumo Logic query language? See [Search Query Language](/docs/search/search-query-language) to learn more.<br/><img src={useBaseUrl('img/search/copilot/code-editor.png')} alt="Copilot time period" style={{border: '1px solid gray'}} width="500" />
143140
1. When you're done, press Enter or click the search button.<br/><img src={useBaseUrl('img/search/copilot/play.png')} alt="Copilot time period" style={{border: '1px solid gray'}} width="500" />
144141

145142
:::tip
146143
To save space, you can use the **Hide Log Query** icon to collapse the log query code.<br/><img src={useBaseUrl('img/search/copilot/show-hide-query.png')} alt="Copilot time period" style={{border: '1px solid gray'}} width="500" />
147144
:::
148145

146+
#### JSON Syntax Rules
147+
148+
Copilot querying is compatible with JSON logs, partial JSON logs, and unstructured logs with Field Extraction Rules. It cannot be used to query unstructured data, metrics, or traces.
149+
150+
To retrieve a list of `_sourceCategories` with JSON data, use the following query:
151+
152+
```sql
153+
_sourceCategory=* "{" "}"
154+
| limit 10000 | logreduce keys noaggregate
155+
| count by _sourceCategory, _schema
156+
| where _schema != "unknown"
157+
| sum(_count) by _sourceCategory
158+
```
159+
160+
If your log query contains a mix of JSON and non-JSON formatting (i.e., a log file is partially JSON), you can isolate the JSON portion by adding `{` to the source expression to trigger **Suggestions**.<br/><img src={useBaseUrl('img/search/copilot/copilot-json.png')} alt="Copilot JSON formatting" style={{border: '1px solid gray'}} width="350" />
161+
162+
#### Tips and tricks
163+
164+
* **Start with a broad query**. Begin with a query like `Show me the most recent logs` to understand the structure and available fields in your logs.
165+
* **Clarify field names**. If fields have similar names and cause confusion, explicitly specify the field (e.g., `<field_name>`) to improve accuracy.
166+
* **Experiment with phrasing**. Try multiple variations of a query to provide context and receive more relevant suggestions.
167+
* **Include time for timeslicing**. When timeslicing data, ensure you mention `time` in your query. For example: `Count requests, every 1m, different code challenges and user used during login attempts by time`.
168+
149169
#### History
150170

151171
Often, users work on multiple incidents at the same time. To view Copilot interactions related to these incidents, click **History**.<br/><img src={useBaseUrl('img/search/copilot/history.png')} alt="Copilot History" style={{border: '1px solid gray'}} width="700" />
@@ -209,7 +229,7 @@ You are a SecOps engineer who uses [Cloud SIEM](/docs/cse/). You are worried abo
209229
Count logs by action. Sort the results. versus the previous 1h
210230
```
211231
Notice the system translated the suggestion to a log query and rendered results as a bar graph with no user input. <br/><img src={useBaseUrl('img/search/copilot/copilot-cloud-siem-2.png')} alt="Copilot tab" style={{border: '1px solid gray'}} width="800" />
212-
1. Switching to table view, you notice Malicious” in the search results. So, you add in `Filter results by action contains Malicious` to the query:
232+
1. Switching to table view, you notice "Malicious” in the search results. So, you add in `Filter results by action contains Malicious` to the query:
213233
```
214234
Count logs by action. Sort the results. Filter results by action contains Malicious.
215235
```

0 commit comments

Comments
 (0)