abstract
Description
Produces an abstract, a summary or brief representation, of the text of the search results. The original text is replaced by the summary.
The abstract is produced by a scoring mechanism. Events that are larger than the selected maxlines, those with more textual terms and more terms on adjacent lines, are preferred over events with fewer terms. If a line has a search term, its neighboring lines also partially match, and might be returned to provide context. When there are gaps between the selected lines, lines are prefixed with an ellipsis (...).
If the text of an event has fewer lines or an equal number of lines as maxlines, no change occurs.
Syntax
The required syntax is in bold.
- abstract
- [maxterms=<int>]
- [maxlines=<int>]
Optional arguments
- maxterms
- Syntax: maxterms=<int>
- Description: The maximum number of terms to match. Accepted values are 1 to 1000.
- Default: 1000
- maxlines
- Syntax: maxlines=<int>
- Description: The maximum number of lines to match. Accepted values are 1 to 500.
- Default: 10
Examples
Specify the number of lines to return
Show a summary of up to 5 lines for each search result.
... | abstract maxlines=5
Specify the number of terms to return
Consider the following events:
| Time | Event |
|---|---|
| 1/4/23 6:22:16.000 PM |
91.205.189.15 - - [04/Jan/2023:18:22:16] "GET /oldlink?itemId=EST-14&JSESSIONID=SD6SL7FF7ADFF53113 HTTP 1.1" 200 1665 "http://www.buttercupgames.com/oldlink?itemId=EST-14" "Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/536.5 (KHTML, like Gecko) Chrome/19.0.1084.46 Safari/536.5" 159 |
| 1/3/23 11:08:57.000 PM |
194.146.236.22 - - [03/Jan/2023:23:08:57] "POST /cart.do?action=addtocart&itemId=EST-15&productId=WC-SH-T02&JSESSIONID=SD4SL1FF2ADFF47548 HTTP 1.1" 200 1493 "http://www.buttercupgames.com/product.screen?productId=WC-SH-T02" "Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/536.5 (KHTML, like Gecko) Chrome/19.0.1084.52 Safari/536.5" 848 |
If you specify maxterms=20 the results look like this:
| Time | Event |
|---|---|
| 1/4/23 6:22:16.000 PM |
91.205.189.15 - - [04/Jan/2023:18 |
| 1/3/23 11:08:57.000 PM |
194.146.236.22 - - [03/Jan/2023:23 |
The "terms" are identified as shown in the following table:
| Number | Event 1 term | Event 2 term |
|---|---|---|
| 1 | 91 | 194 |
| 2 | . | . |
| 3 | 205 | 146 |
| 4 | . | . |
| 5 | 189 | 236 |
| 6 | . | . |
| 7 | 15 | 22 |
| 8 | ||
| 9 | - | - |
| 10 | ||
| 11 | - | - |
| 12 | ||
| 13 | [ | [ |
| 14 | 04 | 03 |
| 15 | / | / |
| 16 | Jan | Jan |
| 17 | / | / |
| 18 | 2023 | 2023 |
| 19 | : | : |
| 20 | 18 | 23 |
See also
| Time modifiers | accum |
This documentation applies to the following versions of Splunk® Enterprise: 7.0.0, 7.0.1, 7.0.2, 7.0.3, 7.0.4, 7.0.5, 7.0.6, 7.0.7, 7.0.8, 7.0.9, 7.0.10, 7.0.11, 7.0.13, 7.1.0, 7.1.1, 7.1.2, 7.1.3, 7.1.4, 7.1.5, 7.1.6, 7.1.7, 7.1.8, 7.1.9, 7.1.10, 7.2.0, 7.2.1, 7.2.2, 7.2.3, 7.2.4, 7.2.5, 7.2.6, 7.2.7, 7.2.8, 7.2.9, 7.2.10, 7.3.0, 7.3.1, 7.3.2, 7.3.3, 7.3.4, 7.3.5, 7.3.6, 7.3.7, 7.3.8, 7.3.9, 8.0.0, 8.0.1, 8.0.2, 8.0.3, 8.0.4, 8.0.5, 8.0.6, 8.0.7, 8.0.8, 8.0.9, 8.0.10, 8.1.0, 8.1.1, 8.1.2, 8.1.3, 8.1.4, 8.1.5, 8.1.6, 8.1.7, 8.1.8, 8.1.9, 8.1.11, 8.2.0, 8.2.1, 8.2.2, 8.2.3, 8.2.4, 8.2.5, 8.2.6, 8.2.7, 8.2.8, 8.2.9, 8.2.10, 8.2.11, 8.2.12, 9.0.0, 9.0.1, 9.0.2, 9.0.3, 9.0.4, 9.0.5, 9.0.6, 9.0.7, 9.0.8, 9.0.9, 9.0.10, 9.1.0, 9.1.1, 9.1.2, 9.1.3, 9.1.4, 9.1.5, 9.1.6, 9.1.7, 9.2.0, 9.2.1, 9.2.2, 9.2.3, 9.2.4, 9.3.0, 9.3.1, 9.3.2, 8.1.10, 8.1.12, 8.1.13, 8.1.14
Download manual
Feedback submitted, thanks!