You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
* Copilot GA
* add article ref
* Edits per BA
* edits per BA
* expand on glossary
* add more best practices
* minor fix
* Update docs/search/copilot.md
* Delete blog-service/2024-12-02-search-copilot.md
* Update docs/search/copilot.md
* sidebar
* add back preview
* Copilot GA 12/2
* Update copilot.md
* release note
* video
* Update docs/search/copilot.md
* Update docs/search/copilot.md
* rm todo
We're excited to introduce Copilot, an AI-powered assistant that accelerates log investigations and troubleshooting. With natural language query capabilities and contextual suggestions, Copilot helps security first responders and on-call engineers resolve incidents quickly and efficiently. [Learn more](/docs/search/copilot).
18
+
19
+
* Ask questions in plain English to generate actionable log insights.
20
+
* Get tailored suggestions relevant to your troubleshooting and investigation context.
21
+
* Leverage conversation history to save and resume sessions without losing context.
22
+
* Auto-visualize charts from search results and add them directly to dashboards.
23
+
* Use auto-complete for natural language queries to access insights faster.
24
+
25
+
<img src={useBaseUrl('img/search/copilot/ga-releasenote.png')} alt="Copilot UI with the query Analyze the geographic distribution of requests by source IP" style={{border: '1px solid gray'}} width="800" />
Copy file name to clipboardExpand all lines: docs/search/copilot.md
+34-15Lines changed: 34 additions & 15 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,7 +1,7 @@
1
1
---
2
2
id: copilot
3
-
title: Sumo Logic Copilot - Feature Preview
4
-
sidebar_label: Copilot - Preview
3
+
title: Sumo Logic Copilot
4
+
sidebar_label: Copilot
5
5
description: Streamline your log analysis with Sumo Logic Copilot, our 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.
6
6
keywords:
7
7
- copilot
@@ -14,8 +14,8 @@ keywords:
14
14
import Iframe from 'react-iframe';
15
15
import useBaseUrl from '@docusaurus/useBaseUrl';
16
16
17
-
:::sumo Preview release
18
-
This is a Preview release. To learn more, contact your Sumo Logic account executive. To opt out, please open a [support ticket](https://support.sumologic.com/support/s/).
17
+
:::note
18
+
If you need to opt out, please open a [support ticket](https://support.sumologic.com/support/s/).
19
19
:::
20
20
21
21
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.
***Natural language queries**. Ask questions in plain English.
42
42
***Contextual suggestions**. Get suggestions relevant to your troubleshooting and investigations context.
43
43
***Conversation history**. Save and resume troubleshooting or investigation sessions without losing context.
44
-
***Auto-visualize**. Copilot automatically generates charts from search results, which you can add directly to dashboards.
44
+
***Auto-visualize**. Copilot automatically generates charts from search results, which you can add directly to dashboards, reducing time and effort in data interpretation.
45
45
***Log compatibility**. Copilot supports structured logs, semi-structured logs (partial JSON), 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.
46
46
***Enhanced query experience**. Auto-complete to streamline natural language queries.
47
47
@@ -60,6 +60,9 @@ Copilot is ideal for users of all skill levels:
60
60
61
61
***On-call engineers**. Accelerate time to resolution by surfacing key troubleshooting insights.
***Early career professionals**. Simplifies troubleshooting with natural language queries, making incident resolution accessible to those unfamiliar with query syntax.
64
+
***Practitioners**. Speeds up workflows with auto-complete and context-aware suggestions for frequent tasks.
65
+
***Experts**. Provides IDE-style assistance for crafting complex queries efficiently.
63
66
64
67
## How to use Copilot
65
68
@@ -112,17 +115,14 @@ Broad questions may not yield accurate results. For best outcomes, frame your qu
112
115
113
116
Break your questions into smaller, specific requirements 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" />
114
117
115
-
<!-- TO DO
116
-
##### Autocompletion for natural language
117
-
see https://drive.google.com/file/d/10XUn4DQD3K91V3Qf5heCizkHJneTaBJ7/view?usp=sharing
118
-
--->
119
-
120
118
#### Tips and tricks
121
119
122
120
***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.
123
121
***Disambiguate field names**. If fields have similar names and cause confusion, explicitly specify the field (e.g., `<field_name>`) to improve accuracy.
124
122
***Experiment with phrasing**. Try multiple variations of a query to provide context and receive more relevant suggestions.
125
123
***Include time or variations to add `timeslice` as a dimension**. When timeslicing data, include the term `time` in your query. For example: `Count requests, every 1m, different code challenges and user used during login attempts by time`.
124
+
***Explore context-aware suggestions**. Use prompts like `Calculate 95th percentile latency` or `Visualize request volumes over time` to quickly surface key metrics.
125
+
***Detect malicious activity**. Try queries like `Count register requests by 503 status code, IP, and threat confidence` to uncover potential DDoS attacks.
126
126
127
127
Below are examples of how you can phrase queries if the autocompletions and contextual suggestions are not relevant to you:
128
128
@@ -136,6 +136,23 @@ Below are examples of how you can phrase queries if the autocompletions and cont
136
136
:::
137
137
*`Apply logreduce to logs`
138
138
139
+
More examples:
140
+
141
+
* Detecting malicious activity:
142
+
```
143
+
Count logs by action. Sort the results.
144
+
Filter results by action contains Malicious.
145
+
```
146
+
* Advanced analysis with users and URLs:
147
+
```
148
+
Count logs by action, url, user.
149
+
Sort the results. Filter results by action contains Malicious.
150
+
```
151
+
* Root cause analysis for latency:
152
+
```
153
+
Calculate 95th percentile latency by service and API.
154
+
```
155
+
139
156
Additional prompts can trigger more advanced activities (e.g., mapping network activity against CrowdStrike):
140
157
141
158
*`Analyze risk and severity of network activity`
@@ -171,7 +188,7 @@ If required, select your preferred chart type, such as **Table**, **Bar**, **Col
171
188
172
189
You can manually edit your log search query code if needed.
173
190
174
-
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" />
191
+
1. Click in the code editor field and edit your search. New to Sumo Logic query language? Learn more in the [Search Query Language](/docs/search/search-query-language)guide.<br/><img src={useBaseUrl('img/search/copilot/code-editor.png')} alt="Copilot time period" style={{border: '1px solid gray'}} width="500" />
175
192
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" />
176
193
177
194
:::tip
@@ -196,13 +213,15 @@ If your log query contains a mix of JSON and non-JSON formatting (i.e., a log fi
196
213
197
214
#### History
198
215
199
-
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" />
216
+
Conversation History saves all previous queries and suggestions, allowing you to backtrack and refine your investigation. For example, if a status code analysis yields inconclusive results, revisit earlier queries to explore other hypotheses.
200
217
201
-
You can resume a conversation in two ways:
218
+
This functionality comes in handy when you're working on multiple incidents at the same time. To view Copilot interactions related to an incident, click **History**.
First, the Resume conversation icon picks up from the last query in a conversation.<br/><img src={useBaseUrl('img/search/copilot/resume-convo-history1.png')} alt="Copilot History" style={{border: '1px solid gray'}} width="700" />
221
+
You can resume a conversation in two ways:
204
222
205
-
Second, you can resume from a specific query in a conversation by clicking on the row in the conversation history and then clicking on the gray area on the right side, as shown below.<br/><img src={useBaseUrl('img/search/copilot/resume-convo-history2.png')} alt="Copilot History" style={{border: '1px solid gray'}} width="700" />
223
+
* Click the **Resume conversation** icon to pick up from the last query in a conversation.<br/><img src={useBaseUrl('img/search/copilot/resume-convo-history1.png')} alt="Copilot History" style={{border: '1px solid gray'}} width="600" />
224
+
* Click on the row in the conversation history, and then click the gray area on the right side to resume from a specific query in a conversation.<br/><img src={useBaseUrl('img/search/copilot/resume-convo-history2.png')} alt="Copilot History" style={{border: '1px solid gray'}} width="600" />
0 commit comments