Splunk Cloud Platform

Search Reference



Replaces a field value with higher-level grouping, such as replacing filenames with directories.

Returns the maxcount events, by taking the incoming events and rolling up multiple sources into directories, by preferring directories that have many files but few events. The field with the path is PATHFIELD (e.g., source), and strings are broken up by a separator character. The default pathfield=source; sizefield=totalCount; maxcount=20; countfield=totalCount; sep="/" or "\\", depending on the operation system.


bucketdir pathfield=<field> sizefield=<field> [maxcount=<int>] [countfield=<field>] [sep=<char>]

Required arguments

Syntax: pathfield=<field>
Description: Specify a field name that has a path value.
Syntax: sizefield=<field>
Description: Specify a numeric field that defines the size of bucket.

Optional arguments

Syntax: countfield=<field>
Description: Specify a numeric field that describes the count of events.
Syntax: maxcount=<int>
Description: Specify the total number of events to bucket.
Syntax: <char>
Description: The separating character. Specify either a forward slash "/" or double back slashes "\\", depending on the operating system.


The bucketdir command is a streaming command. It is distributable streaming by default, but centralized streaming if the local setting specified for the command in the commands.conf file is set to true. See Command types.


Example 1:

Return 10 best sources and directories.

... | top source | bucketdir pathfield=source sizefield=count maxcount=10

See also

cluster, dedup

Last modified on 12 January, 2023
bucket   chart

This documentation applies to the following versions of Splunk Cloud Platform: 8.2.2112, 8.2.2201, 8.2.2202, 9.0.2205, 8.2.2203, 9.0.2208, 9.0.2209, 9.0.2303, 9.0.2305, 9.1.2308 (latest FedRAMP release), 9.1.2312, 9.2.2403

Was this topic useful?

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.

0 out of 1000 Characters