Syntax

Required arguments

Optional arguments

Description: A name of the index report on, or a wildcard matching many indexes to report on. You can specify this argument multiple times, for example index=* index=_*.

Default: If no index is specified, the command returns information about the default index.

list_vix

Syntax: list_vix=<bool>

Description: Specify whether or not to list virtual indexes. If list_vix=false, the command does not list virtual indexes.

Default: true

report_size

Syntax: report_size=<bool>

Description: Specify whether or not to report the index size. If report_size=true, the command returns the index size in bytes.

Default: false

summarize

Syntax: summarize=<bool>

Description: Specifies whether or not to summarize events across all peers and indexes. If summarize=false, the command splits the event counts by index and search peer.

Default: true

Usage

The eventcount command is a generating command and should be the first command in the search. Generating commands use a leading pipe character.

Specifying a time range has no effect on the results returned by the eventcount command. All of the events on the indexes you specify are counted.

You cannot specify indexes to exclude from the results. For example, index!=foo is not valid syntax.

You can specify the index argument multiple times. For example:

|eventcount summarize=false index=_audit index=main

Examples

Example 1:

Display a count of the events in the default indexes from all of the search peers. A single count is returned.

| eventcount

Example 2:

Return the number of events in only the internal default indexes. Include the index size, in bytes, in the results.

| eventcount summarize=false index=_* report_size=true

When you specify summarize=false, the command returns three fields: count, index, and server. When you specify report_size=true, the command returns the size_bytes field. The values in the size_bytes field are not the same as the index size on disk.

Example 3:

Return the event count for each index and server pair. Only the external indexes are returned.

| eventcount summarize=false index=*

To return the count all of the indexes including the internal indexes, you must specify the internal indexes separately from the external indexes:

Comments

Woodcock
Thank you for pointing out the missing See also section. I have added that section and improved the information in the Usage section as well.

Lstewart splunk, Splunker

December 5, 2017

The "See Also" section is missing and it should include (at least) "metadata" and "fieldsummary".

Woodcock

December 4, 2017

Shaker ali: You cannot specify a timerange with eventcount.

Ckurtz: You can only specify indexes to include in your output, not indexes to exclude. "index!=foo" is not valid syntax. Also, you do not use boolean operators to specify multiple indexes with eventcount.

Sophy

March 16, 2015

Can we specify the time? Because I only get the all time stats, but when i specify the time it gives me the same number. | eventcount index=* is the search i'm using.

Enter your email address, and someone from the documentation team will respond to you:

Please provide your comments here. Ask a question or make a suggestion.

Feedback submitted, thanks!

You must be logged into splunk.com in order to post comments.
Log in now.

Please try to keep this discussion focused on the content covered in this documentation topic.
If you have a more general question about Splunk functionality or are experiencing a difficulty with Splunk,
consider posting a question to Splunkbase Answers.