Skip to content

Commit de4e356

Browse files
JV0812kimsauce
andauthored
Updated the search query with correct syntax (#5113)
* Updated the search query with right syntax * Update docs/search/optimize-search-partitions.md Co-authored-by: Kim (Sumo Logic) <[email protected]> * Update docs/send-data/collect-from-other-data-sources/docker-collection-methods.md Co-authored-by: Kim (Sumo Logic) <[email protected]> * Update docs/send-data/collection/search-collector-or-source.md Co-authored-by: Kim (Sumo Logic) <[email protected]> * Update docs/send-data/collect-from-other-data-sources/docker-collection-methods.md Co-authored-by: Kim (Sumo Logic) <[email protected]> --------- Co-authored-by: Kim (Sumo Logic) <[email protected]>
1 parent e77bea0 commit de4e356

File tree

13 files changed

+23
-23
lines changed

13 files changed

+23
-23
lines changed

docs/cse/troubleshoot/troubleshoot-parsers.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ The recommended method is to set `_siemForward = true` and `_parser = <path/to/p
3232
* At the [source](/docs/cse/ingestion/ingestion-sources-for-cloud-siem/). Logs from an entire source will be forwarded to Cloud SIEM and the specified parser.
3333
* At the [collector](/docs/send-data/installed-collectors/). Logs from the collector and its child sources will be forwarded to Cloud SIEM and the specified parser
3434
* Using a [Field Extraction Rule (FER)](/docs/manage/field-extractions/create-field-extraction-rule/).
35-
* Often used to specify SIEM forwarding and the parser path by `sourceCategory`, but can also be used to filter specific subsets of logs for forwarding to Cloud SIEM (or not forwarded).
35+
* Often used to specify SIEM forwarding and the parser path by `_sourceCategory`, but can also be used to filter specific subsets of logs for forwarding to Cloud SIEM (or not forwarded).
3636
* Sending subsets of logs to Cloud SIEM is useful as not all log data is useful from a security context.
3737

3838
Many [Cloud-To-Cloud (C2C)](/docs/send-data/hosted-collectors/cloud-to-cloud-integration-framework/) sources set the `_parser` and `_siemForward` metadata within the parser, bypassing the need to manually specify for these sources.

docs/integrations/saas-cloud/citrix-cloud.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ This Citrix Cloud App uses [SystemLog](https://developer.cloud.com/citrix-cloud/
5555
### Sample queries
5656

5757
```sql="Active Team Members"
58-
sourceCategory="citrixCloudSource"
58+
_sourceCategory="citrixCloudSource"
5959
| json "eventType","targetDisplayName","targetEmail","beforeChanges.AccessType","afterChanges.AccessType","actorType","message.en-US" as event_type,name, email, access_type_before, access_type_after, actor, message nodrop
6060
| where event_type matches("*platform/administrator/create*")
6161
| where actor matches"{{actor}}"

docs/manage/field-extractions/fer-templates/cisco-fwsm-fer.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ The first rule is generic and matches all messages:
2121
**Scope:**
2222

2323
```sql
24-
sourceCategory=networking/cisco/fwsm
24+
_sourceCategory=networking/cisco/fwsm
2525
```
2626

2727
**Extraction Rule:**

docs/manage/ingestion-volume/monitor-ingestion-receive-alerts.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -155,12 +155,12 @@ This hourly alert is generated when both of the following occur:
155155

156156
```
157157
_index=sumologic_volume sizeInBytes _sourceCategory="sourcecategory_volume"
158-
| parse regex "\"(?<sourcecategory>[^\"]*)\"\:(?<data>\{[^\}]*\})" multi
158+
| parse regex "\"(?<_sourcecategory>[^\"]*)\"\:(?<data>\{[^\}]*\})" multi
159159
| json field=data "sizeInBytes", "count" as bytes, count
160160
| timeslice 1h
161161
| bytes/1024/1024/1024 as gbytes
162-
| sum(gbytes) as gbytes by sourcecategory, _timeslice
163-
| where !(sourceCategory matches "*_volume")
162+
| sum(gbytes) as gbytes by _sourcecategory, _timeslice
163+
| where !(_sourceCategory matches "*_volume")
164164
| compare timeshift -1w 4 max
165165
| if(isNull(gbytes_4w_max), 0, gbytes_4w_max) as gbytes_4w_max
166166
| ((gbytes - gbytes_4w_max) / gbytes) * 100 as pct_increase

docs/manage/partitions/data-tiers/create-edit-partition.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ If you have a Sumo Logic Enterprise Suite account, you can take advantage of th
4848
When designing partitions, keep the following in mind:
4949
* **Avoid using queries that are subject to change**. In order to benefit from using Partitions, they should be used for long-term message organization.
5050
* **Make the query as specific as possible**. Making the query specific will reduce the amount of data in the Partition, which increases search performance.
51-
* **Keep the query flexible**. Use a flexible query, such as `sourceCategory=*Apache*`, so that metadata can be adjusted without breaking the query.
51+
* **Keep the query flexible**. Use a flexible query, such as `_sourceCategory=*Apache*`, so that metadata can be adjusted without breaking the query.
5252
* **Group data together that is most often used together**. For example, create Partitions for categories such as web data, security data, or errors.
5353
* **Group data together that is used by teams**. Partitions are an excellent way to organize messages by role and teams within your organization.
5454
* **Avoid including too much data in your partition**. Send between 2% and 20% of your data to a Partition. Including 90% of the data in your index in a Partition won’t improve search performance.

docs/manage/partitions/flex/create-edit-partition-flex.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ To create or edit a Partition, you must be an account Administrator or have th
4444
When designing partitions, keep the following in mind:
4545
* **Avoid using queries that are subject to change**. In order to benefit from using Partitions, they should be used for long-term message organization.
4646
* **Make the query as specific as possible**. Making the query specific will reduce the amount of data in the Partition, which increases search performance.
47-
* **Keep the query flexible**. Use a flexible query, such as `sourceCategory=*Apache*`, so that metadata can be adjusted without breaking the query.
47+
* **Keep the query flexible**. Use a flexible query, such as `_sourceCategory=*Apache*`, so that metadata can be adjusted without breaking the query.
4848
* **Group data together that is most often used together**. For example, create Partitions for categories such as web data, security data, or errors.
4949
* **Group data together that is used by teams**. Partitions are an excellent way to organize messages by role and teams within your organization.
5050
* **Avoid including too much data in your partition**. Send between 2% and 20% of your data to a Partition. Including 90% of the data in your index in a Partition won’t improve search performance.

docs/search/get-started-with-search/build-search/keyword-search-expressions.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -143,7 +143,7 @@ It is '\u001F', U+001F UNIT SEPARATOR
143143

144144
For example, in the following query, there are multiple space characters present in `"VM Periodic" and "Task Thread"`, but normalization returns the same result as a single space whitespace character.
145145
```sql
146-
sourceCategory=stream_thread_dumps "VM Periodic_____Task Thread"
146+
_sourceCategory=stream_thread_dumps "VM Periodic_____Task Thread"
147147
```
148148

149149
:::note
@@ -154,7 +154,7 @@ It is '\u001F', U+001F UNIT SEPARATOR
154154

155155
For example, in the the following query there is a tab character present in `"VM Periodic" and "Task Thread"`, but normalization returns the same result as a single space whitespace character.
156156
```sql
157-
sourceCategory=stream_thread_dumps "VM Periodic_Task Thread"
157+
_sourceCategory=stream_thread_dumps "VM Periodic_Task Thread"
158158
```
159159

160160
:::note
@@ -165,7 +165,7 @@ It is '\u001F', U+001F UNIT SEPARATOR
165165

166166
For example, in the following query, there is a new line after the string `Task`, but normalization returns the same result as a single space whitespace character. This shows that a query string with a single space can match a log line that has a new line character.
167167
```sql
168-
sourceCategory=stream_thread_dumps "VM Periodic Task\nThread"
168+
_sourceCategory=stream_thread_dumps "VM Periodic Task\nThread"
169169
```
170170

171171
:::note
@@ -176,13 +176,13 @@ It is '\u001F', U+001F UNIT SEPARATOR
176176

177177
For example, in the the following query, there is a new line and tab character after the string `Task`, but normalization returns the same result as a single space whitespace character. This shows that a query string with a single space can match a log line that has a new line and a tab whitespace character.
178178
```sql
179-
sourceCategory=stream_thread_dumps "VM Periodic Task\n\tThread"
179+
_sourceCategory=stream_thread_dumps "VM Periodic Task\n\tThread"
180180
```
181181
:::note
182182
The character `\n\t` is used to describe the new line + tab whitespace characters.
183183
:::
184184

185185
All of the above queries containing various whitespace characters will accept a single space whitespace character by default and return the desired results. See the query below.
186186
```sql
187-
sourceCategory=stream_thread_dumps "VM Periodic Task Thread"
187+
_sourceCategory=stream_thread_dumps "VM Periodic Task Thread"
188188
```

docs/search/optimize-search-partitions.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -123,9 +123,9 @@ It may prevent you from searching horizontally without OR’ing partitions toget
123123

124124
This helps users easily identify the correct partition to use.
125125

126-
### Keep your partition broadly scoped with sourceCategory and avoid keywords
126+
### Keep your partition broadly scoped with _sourceCategory and avoid keywords
127127

128-
Use sourceCategory in your partitions definitions and avoid keywords to keep your partition broadly scoped. You can always narrow down the scope of your search when you query your partition.
128+
Use `_sourceCategory` in your partitions definitions and avoid keywords to keep your partition broadly scoped. You can always narrow down the scope of your search when you query your partition.
129129

130130
### Group similar data together
131131

docs/search/optimize-search-performance.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -60,10 +60,10 @@ Here's a quick look at how to choose the right indexed search optimization tool.
6060
| :-- | :-- | :-- |
6161
| Run queries against a certain set of data | Choose if the quantity of data to be indexed is more than 2% of the total data. | Choose if the quantity of data to be indexed is less than 2% of the total data. |
6262
| Use data to identify long-term trends |   | Yes |
63-
| Segregate data by sourceCategory | Yes |   |
63+
| Segregate data by _sourceCategory | Yes |   |
6464
| Have aggregate data ready to query |   | Yes |
6565
| Use RBAC to deny or grant access to the data set | Yes | Yes |
66-
| Reuse the fields that I'm parsing for other searches against this same sourceCategory |   |   |
66+
| Reuse the fields that I'm parsing for other searches against this same _sourceCategory |   |   |
6767

6868
## How is data added to Partitions and Scheduled Views?
6969

docs/search/search-cheat-sheets/log-operators.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -182,7 +182,7 @@ This section provides detailed syntax, rules, and examples for Sumo Logic Opera
182182
<td>The backshift operator compares values as they change over time. Backshift can be used with rollingstd, smooth, or any other operators whose results could be affected by spikes of data (where a spike could possibly throw off future results).</td>
183183
<td>_backshift</td>
184184
<td>Can be used in Dashboard Panels, but in the search they must be included after the first <code>group-by</code> phrase.</td>
185-
<td><code>_sourcecategory=katta <br/>| timeslice by 1m <br/>| count by _timeslice,_sourcehost <br/>| sort + _timeslice <br/>| backshift _count,1 by _sourcehost</code></td>
185+
<td><code>_sourceCategory=katta <br/>| timeslice by 1m <br/>| count by _timeslice,_sourcehost <br/>| sort + _timeslice <br/>| backshift _count,1 by _sourcehost</code></td>
186186
</tr>
187187
<tr>
188188
<td><a href="/docs/search/search-query-language/search-operators/base64decode">base64Decode</a></td>

0 commit comments

Comments
 (0)