Skip to content

Commit ab73109

Browse files
authored
DOCS-551 Copilot GA (Dec 2) (#4788)
* 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
1 parent 289163e commit ab73109

File tree

4 files changed

+59
-15
lines changed

4 files changed

+59
-15
lines changed

blog-service/2024-12-02-copilot.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
---
2+
title: Sumo Logic Copilot (Search)
3+
image: https://help.sumologic.com/img/sumo-square.png
4+
keywords:
5+
- copilot
6+
- artificial intelligence
7+
- ai
8+
- machine learning
9+
- ml
10+
hide_table_of_contents: true
11+
---
12+
13+
import useBaseUrl from '@docusaurus/useBaseUrl';
14+
15+
<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>
16+
17+
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" />

docs/search/copilot.md

Lines changed: 34 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
id: copilot
3-
title: Sumo Logic Copilot - Feature Preview
4-
sidebar_label: Copilot - Preview
3+
title: Sumo Logic Copilot
4+
sidebar_label: Copilot
55
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.
66
keywords:
77
- copilot
@@ -14,8 +14,8 @@ keywords:
1414
import Iframe from 'react-iframe';
1515
import useBaseUrl from '@docusaurus/useBaseUrl';
1616

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/).
1919
:::
2020

2121
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.
@@ -41,7 +41,7 @@ Copilot accelerates incident response by combining prebuilt contextual insights
4141
* **Natural language queries**. Ask questions in plain English.
4242
* **Contextual suggestions**. Get suggestions relevant to your troubleshooting and investigations context.
4343
* **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.
4545
* **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.
4646
* **Enhanced query experience**. Auto-complete to streamline natural language queries.
4747

@@ -60,6 +60,9 @@ Copilot is ideal for users of all skill levels:
6060

6161
* **On-call engineers**. Accelerate time to resolution by surfacing key troubleshooting insights.
6262
* **Security engineers**. Obtain security insights rapidly for faster security incident resolution.
63+
* **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.
6366

6467
## How to use Copilot
6568

@@ -112,17 +115,14 @@ Broad questions may not yield accurate results. For best outcomes, frame your qu
112115

113116
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" />
114117

115-
<!-- TO DO
116-
##### Autocompletion for natural language
117-
see https://drive.google.com/file/d/10XUn4DQD3K91V3Qf5heCizkHJneTaBJ7/view?usp=sharing
118-
--->
119-
120118
#### Tips and tricks
121119

122120
* **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.
123121
* **Disambiguate field names**. If fields have similar names and cause confusion, explicitly specify the field (e.g., `<field_name>`) to improve accuracy.
124122
* **Experiment with phrasing**. Try multiple variations of a query to provide context and receive more relevant suggestions.
125123
* **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.
126126

127127
Below are examples of how you can phrase queries if the autocompletions and contextual suggestions are not relevant to you:
128128

@@ -136,6 +136,23 @@ Below are examples of how you can phrase queries if the autocompletions and cont
136136
:::
137137
* `Apply logreduce to logs`
138138

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+
139156
Additional prompts can trigger more advanced activities (e.g., mapping network activity against CrowdStrike):
140157

141158
* `Analyze risk and severity of network activity`
@@ -171,7 +188,7 @@ If required, select your preferred chart type, such as **Table**, **Bar**, **Col
171188

172189
You can manually edit your log search query code if needed.
173190

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" />
175192
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" />
176193

177194
:::tip
@@ -196,13 +213,15 @@ If your log query contains a mix of JSON and non-JSON formatting (i.e., a log fi
196213

197214
#### History
198215

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.
200217

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**.
219+
<br/><img src={useBaseUrl('img/search/copilot/history.png')} alt="Copilot History" style={{border: '1px solid gray'}} width="700" />
202220

203-
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:
204222

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" />
206225

207226
#### New Conversation
208227

514 KB
Loading
-5.06 KB
Loading

0 commit comments

Comments
 (0)