Related Answers
Download topic as PDF
sistats
Description
The sistats command is one of several commands that you can use to create summary indexes. Summary indexing is one of the methods that you can use to speed up searches that take a long time to run.
The sistats command is the summary indexing version of the stats command, which calculates aggregate statistics over the dataset.
The sistats command populates a summary index. You must then create a report to generate the summary statistics. See the Usage section.
Syntax
sistats [allnum=<bool>] [delim=<string>] ( <stats-agg-term> | <sparkline-agg-term> ) [<by clause>]
- For descriptions of each of the arguments in this syntax, refer to the stats command.
- For information about functions that you can use with the
sistatscommand, see Statistical and charting functions.
Usage
The summary indexes exist separately from your main indexes.
After you create the summary index, create a report by running a search against the summary index. You use the exact same search string that you used to populate the summary index, substituting the stats command for the sistats command, to create your reports.
For more information, see About report acceleration and summary indexing and Use summary indexing for increased reporting efficiency in the Knowledge Manager Manual.
Memory and maximum results
In the limits.conf file, the maxresultrows setting in the [searchresults] stanza specifies the maximum number of results to return. The default value is 50,000. Increasing this limit can result in more memory usage.
The max_mem_usage_mb setting in the [default] stanza is used to limit how much memory the sistats command uses to keep track of information. If the sistats command reaches this limit, the command stops adding the requested fields to the search results. You can increase the limit, contingent on the available system memory.
Prerequisites
- Only users with file system access, such as system administrators, can increase the
maxresultrowsandmax_mem_usage_mbsettings using configuration files. - Review the steps in How to edit a configuration file in the Splunk Enterprise Admin Manual.
- You can have configuration files with the same name in your default, local, and app directories. Read Where you can place (or find) your modified configuration files in the Splunk Enterprise Admin Manual.
Never change or copy the configuration files in the default directory. The files in the default directory must remain intact and in their original location. Make changes to the files in the local directory.
If you are using Splunk Cloud and want to change either of these limits, file a Support ticket.
Examples
Example 1:
Create a summary index with the statistics about the average, for each hour, of any unique field that ends with the string "lay". For example, delay, xdelay, relay, etc.
... | sistats avg(*lay) BY date_hour
To create a report, run a search against the summary index using this search
index=summary | stats avg(*lay) BY date_hour
See also
collect, overlap, sichart, sirare, sitop, sitimechart
For a detailed explanation and examples of summary indexing, see Use summary indexing for increased reporting efficiency in the Knowledge Manager Manual.
|
PREVIOUS sirare |
NEXT sitimechart |
This documentation applies to the following versions of Splunk® Enterprise: 6.3.0, 6.3.1, 6.3.2, 6.3.3, 6.3.4, 6.3.5, 6.3.6, 6.3.7, 6.3.8, 6.3.9, 6.3.10, 6.3.11, 6.3.12, 6.3.13, 6.3.14, 6.4.0, 6.4.1, 6.4.2, 6.4.3, 6.4.4, 6.4.5, 6.4.6, 6.4.7, 6.4.8, 6.4.9, 6.4.10, 6.4.11, 6.5.0, 6.5.1, 6.5.2, 6.5.3, 6.5.4, 6.5.5, 6.5.6, 6.5.7, 6.5.8, 6.5.9, 6.5.10, 6.6.0, 6.6.1, 6.6.2, 6.6.3, 6.6.4, 6.6.5, 6.6.6, 6.6.7, 6.6.8, 6.6.10, 6.6.9, 6.6.11, 6.6.12, 7.0.1, 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.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, 8.0.0, 8.0.1, 8.0.2, 8.0.3, 8.0.4, 8.0.5, 7.0.0, 7.0.11, 7.0.13, 7.0.2
Feedback submitted, thanks!