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
Copy file name to clipboardExpand all lines: docs/api/search-job.md
+6-9Lines changed: 6 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -66,21 +66,19 @@ So, a 404 status is generated in these two situations:
66
66
67
67
You can start requesting results asynchronously while the job is running and page through partial results while the job is in progress.
68
68
69
-
70
-
71
69
## Search Job Result Limits
72
70
73
71
| Data Tier | Non-aggregate Search |
74
72
| :- | :- |
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. |
78
76
79
77
:::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.
81
79
:::
82
80
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.
84
82
85
83
## Rate limit throttling
86
84
@@ -110,10 +108,9 @@ The following figure shows the process flow for search jobs.
110
108
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).
111
109
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.
112
110
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.
114
112
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).
Copy file name to clipboardExpand all lines: docs/search/copilot.md
+49-19Lines changed: 49 additions & 19 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -23,15 +23,15 @@ Sumo Logic Copilot is our AI-powered assistant that accelerates investigations a
23
23
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.
***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
@@ -93,6 +96,10 @@ In this example, we'll click `Count the number of log entries by the collector I
93
96
94
97
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.
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".
111
115
112
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" />
113
117
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
115
124
116
125
***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.
117
126
***Disambiguate field names**. If fields have similar names and cause confusion, explicitly specify the field (e.g., `<field_name>`) to improve accuracy.
118
127
***Experiment with phrasing**. Try multiple variations of a query to provide context and receive more relevant suggestions.
119
128
***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.
120
131
121
132
Below are examples of how you can phrase queries if the autocompletions and contextual suggestions are not relevant to you:
122
133
@@ -130,6 +141,23 @@ Below are examples of how you can phrase queries if the autocompletions and cont
130
141
:::
131
142
*`Apply logreduce to logs`
132
143
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
+
133
161
Additional prompts can trigger more advanced activities (e.g., mapping network activity against CrowdStrike):
134
162
135
163
*`Analyze risk and severity of network activity`
@@ -165,7 +193,7 @@ If required, select your preferred chart type, such as **Table**, **Bar**, **Col
165
193
166
194
You can manually edit your log search query code if needed.
167
195
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" />
169
197
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" />
170
198
171
199
:::tip
@@ -190,13 +218,15 @@ If your log query contains a mix of JSON and non-JSON formatting (i.e., a log fi
190
218
191
219
#### History
192
220
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.
194
222
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**.
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:
198
227
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" />
0 commit comments