Skip to content

Commit fccd4e8

Browse files
committed
Merge branch 'main' into copilot-ga-final
2 parents a308bcd + 3fc6f73 commit fccd4e8

File tree

3 files changed

+55
-28
lines changed

3 files changed

+55
-28
lines changed

docs/api/search-job.md

Lines changed: 6 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -66,21 +66,19 @@ So, a 404 status is generated in these two situations:
6666

6767
You can start requesting results asynchronously while the job is running and page through partial results while the job is in progress.
6868

69-
70-
7169
## Search Job Result Limits
7270

7371
| Data Tier | Non-aggregate Search |
7472
| :- | :- |
75-
| Continuous | Can return up to 10M records and 100K messages per search. |
76-
| Frequent | Can return up to 10M records and 100K messages per search. |
77-
| Infrequent | Can return up to 10M records and 100K messages per search. |
73+
| Continuous | Can return up to 100K messages per search. |
74+
| Frequent | Can return up to 100K messages per search. |
75+
| Infrequent | Can return up to 100K messages per search. |
7876

7977
:::info
80-
Flex Licensing model can return up to 10M records and 100K messages per search.
78+
Flex Licensing model can return up to 100K messages per search.
8179
:::
8280

83-
If you need more results, you'll need to break up your search into several searches that span smaller blocks of the time range needed. For example, if your search runs for a week and returns 70 million records, consider breaking it into at least seven searches, each spanning a day.
81+
If you need more results, you'll need to break up your search into several searches that span smaller blocks of the time range needed.
8482

8583
## Rate limit throttling
8684

@@ -110,10 +108,9 @@ The following figure shows the process flow for search jobs.
110108
2. **Response.** Sumo Logic responds with a job ID. If there’s a problem with the request, an error code is provided (see the list of error codes following the figure).
111109
3. **Request.** Use the job ID to request search status. This needs to be done at least every 20-30 seconds so the search session is not canceled due to inactivity.
112110
4. **Response.** Sumo Logic responds with job status. An error code (404) is returned if the request could not be completed. The status includes the current state of the search job (gathering results, done executing, etc.). It also includes the message and record counts based on how many results have already been found while executing the search. For non-aggregation queries, only the number of messages is reported. For aggregation queries, the number of records produced is also reported. The search job status provides access to an implicitly generated histogram of the distribution of found messages over the time range specified for the search job. During and after execution, the API can be used to request available messages and records in a paging fashion.
113-
5. **Request.** You request results. It’s not necessary for the search to be complete for the user to request results; the process works asynchronously. You can repeat the request as often as needed to keep seeing updated results, keeping in mind the rate limits. The Search Job API can return up to 10M records and 100K messages per search.
111+
5. **Request.** You request results. It’s not necessary for the search to be complete for the user to request results; the process works asynchronously. You can repeat the request as often as needed to keep seeing updated results, keeping in mind the rate limits. The Search Job API can return 100K messages per search.
114112
6. **Response.** Sumo Logic delivers JSON-formatted search results as requested. The API can deliver partial results that the user can start paging through, even as new results continue to come in. If there’s a problem with the results, an error code is provided (see the list of error codes following the figure).
115113

116-
117114
## Errors
118115

119116
**Generic errors that apply to all APIs**

docs/search/copilot.md

Lines changed: 49 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -23,15 +23,15 @@ Sumo Logic Copilot is our AI-powered assistant that accelerates investigations a
2323
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.
2424

2525
<Iframe url="https://www.youtube.com/embed/yaeepHSaNKk?rel=0"
26-
width="854px"
27-
height="480px"
28-
id="myId"
29-
className="video-container"
30-
display="initial"
31-
position="relative"
32-
allow="accelerometer; clipboard-write; encrypted-media; gyroscope; picture-in-picture"
33-
allowfullscreen
34-
/>
26+
width="854px"
27+
height="480px"
28+
id="myId"
29+
className="video-container"
30+
display="initial"
31+
position="relative"
32+
allow="accelerometer; clipboard-write; encrypted-media; gyroscope; picture-in-picture"
33+
allowfullscreen
34+
/>
3535

3636

3737
## Key features
@@ -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

@@ -93,6 +96,10 @@ In this example, we'll click `Count the number of log entries by the collector I
9396

9497
In the **Ask Something...** field, you can manually enter a natural language prompt similar to the prebuilt ones under **Suggestions**. In addition, use autocompletions if appropriate. Type a word in the search bar to trigger completions based on the keyword.
9598

99+
<img src={useBaseUrl('img/search/copilot/manual-entry.png')} alt="Copilot time period" style={{border: '1px solid gray'}} width="600" />
100+
101+
#### Video: Autocomplete in action
102+
96103
<Iframe url="https://player.vimeo.com/video/1034043268?badge=0&amp;autopause=0&amp;player_id=0&amp;app_id=58479"
97104
width="854px"
98105
height="480px"
@@ -104,19 +111,23 @@ In the **Ask Something...** field, you can manually enter a natural language pro
104111
allowfullscreen
105112
/>
106113

107-
108-
<img src={useBaseUrl('img/search/copilot/manual-entry.png')} alt="Copilot time period" style={{border: '1px solid gray'}} width="600" />
109-
110114
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".
111115

112116
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" />
113117

114-
##### Tips and tricks
118+
<!-- TO DO
119+
##### Autocompletion for natural language
120+
see https://drive.google.com/file/d/10XUn4DQD3K91V3Qf5heCizkHJneTaBJ7/view?usp=sharing
121+
--->
122+
123+
#### Tips and tricks
115124

116125
* **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.
117126
* **Disambiguate field names**. If fields have similar names and cause confusion, explicitly specify the field (e.g., `<field_name>`) to improve accuracy.
118127
* **Experiment with phrasing**. Try multiple variations of a query to provide context and receive more relevant suggestions.
119128
* **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`.
129+
* **Explore context-aware suggestions**. Use prompts like `Calculate 95th percentile latency` or `Visualize request volumes over time` to quickly surface key metrics.
130+
* **Detect malicious activity**. Try queries like `Count register requests by 503 status code, IP, and threat confidence` to uncover potential DDoS attacks.
120131

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

@@ -130,6 +141,23 @@ Below are examples of how you can phrase queries if the autocompletions and cont
130141
:::
131142
* `Apply logreduce to logs`
132143

144+
More examples:
145+
146+
* Detecting malicious activity:
147+
```
148+
Count logs by action. Sort the results.
149+
Filter results by action contains Malicious.
150+
```
151+
* Advanced analysis with users and URLs:
152+
```
153+
Count logs by action, url, user.
154+
Sort the results. Filter results by action contains Malicious.
155+
```
156+
* Root cause analysis for latency:
157+
```
158+
Calculate 95th percentile latency by service and API.
159+
```
160+
133161
Additional prompts can trigger more advanced activities (e.g., mapping network activity against CrowdStrike):
134162

135163
* `Analyze risk and severity of network activity`
@@ -165,7 +193,7 @@ If required, select your preferred chart type, such as **Table**, **Bar**, **Col
165193

166194
You can manually edit your log search query code if needed.
167195

168-
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" />
196+
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" />
169197
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" />
170198

171199
:::tip
@@ -190,13 +218,15 @@ If your log query contains a mix of JSON and non-JSON formatting (i.e., a log fi
190218

191219
#### History
192220

193-
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" />
221+
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.
194222

195-
You can resume a conversation in two ways:
223+
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**.
224+
<br/><img src={useBaseUrl('img/search/copilot/history.png')} alt="Copilot History" style={{border: '1px solid gray'}} width="700" />
196225

197-
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" />
226+
You can resume a conversation in two ways:
198227

199-
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" />
228+
* 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" />
229+
* 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" />
200230

201231
#### New Conversation
202232

-5.06 KB
Loading

0 commit comments

Comments
 (0)