Generates a list of terms or indexed fields from each bucket of event indexes. Only applies to buckets that have a
merged_lexicon.lex file or a single tsidx file.
Due to the variable nature of
walklex does not always return consistent results.
The required syntax is in bold.
- | walklex
- [ type=<walklex-type> ]
- [ prefix=<string> | pattern=<wc-string> ]
- [ splunk_server=<wc-string> ]
- [ splunk_server_group=<wc-string> ]...
- Syntax: index=<index-name> index=<index-name> ...
- Description: Limits the search to one or more indexes. For example,
- prefix | pattern
- Syntax: prefix=<string> | pattern=<wc-string>
- Description: Limits results to terms that match a specific pattern or prefix. Either prefix or pattern can be specified but not both. Includes only buckets with a
merged_lexicon.lexfile or a single tsidx file. This means that hot buckets are generally not included.
- Default: pattern=*
- Syntax: splunk_server=<wc-string>
- Description: Specifies the distributed search peers from which to return results.
- If you are using Splunk Cloud, omit this parameter.
- If you are using Splunk Enterprise, you can specify only one
splunk_serverargument. However, you can use a wildcard when you specify the server name to indicate multiple servers. For example, you can specify
localto refer to the search head.
- Default: All configured search peers return information
- Syntax: splunk_server_group=<wc-string>
- Description: Limits the results to one or more server groups. You can specify a wildcard character in the string to indicate multiple server groups with similar names. If you are using Splunk Cloud, omit this parameter.
- Default: None
- Syntax: type = ( all | field | fieldvalue | term )
- Description: Specifies which type of terms to return in the lexicon. See Usage for more information about using the
fieldto return only the unique field names in each index bucket.
fieldvalueto include only indexed field terms.
termto exclude all indexed field terms of the form "<field>::<value>".
- Default: all
walklex command applies only to event indexes. It cannot be used with metrics indexes.
When the Splunk software indexes event data, it segments each event into raw tokens using rules specified in
segmenters.conf file. You might end up with raw tokens that are actually key-value pairs separated by an arbitrary delimiter such as an equal ( = ) symbol.
The following search uses the
where commands to find the raw tokens in your index. The
stats command is used to count the raw tokens:
| walklex index=<target-index> | where NOT like(term, "%::%") | stats sum(count) by term
type=field argument is specified, the results returned will include only the field names from indexed fields. With the default settings, the Splunk software indexes the values for host, source, and sourcetype. In addition, the settings in the
props.conf file can permit the creation of the
date_* fields, the
punct field, etc. Any additional fields, whether created by INDEXED_EXTRACTIONS or other "WRITE_META" methods, would also be returned. It is the discovery of this list of additional fields which is most likely to benefit you in accelerating your searches.
type=fieldvalue argument returns the list of terms from the index which are part of indexed fields and have indexed values. Unlike the
type=field argument, where the values returned are only the field names themselves, the
type=fieldvalue argumentt returns terms that have any field value for an indexed term.
For example, if the indexed field term is
runtime::0.04, the value returned with the
runtime::0.04. The value returned by the
type=field argument would be
type-term is specified, the keywords from the TSIDX files which are not part of any indexed field structure are returned.
When no type is specified, the default
type=all is used. The terms in the index of all three types
term are returned.
type=all is used, the indexed fields are not called out explicitly as the fields are with the
type=field argument. You will need to split the term field on
:: to obtain the field values from the indexed term.
Walklex and tsidx bucket reduction
walklex searches over indexes that have undergone tsidx bucket reduction will return incorrect results.
For more information see Reduce tsidx disk usage in Managing indexers and clusters of indexers.
1: Return the total count for each term in a specific bucket
The following example returns all of the terms in each bucket of the
_internal index and finds the total count for each term.
| walklex index=_internal | stats sum(count) BY term
2: Specifying multiple indexes
The following example returns all of the terms that start with
foo in each bucket of the
| walklex prefix=foo index=_internal index=_audit
3. Use a pattern to locate indexed field terms
The following example returns all of the indexed field terms for each bucket that end with
bar in the
| walklex pattern=*bar type=fieldvalue index=_internal
4. Return all field names of indexed fields
The following example returns all of the field names of indexed fields in each bucket of the
| walklex type=field index=_audit
This documentation applies to the following versions of Splunk® Enterprise: 7.3.0, 7.3.1, 7.3.2, 7.3.3, 7.3.4, 7.3.5, 7.3.6, 7.3.7, 8.0.0, 8.0.1, 8.0.2, 8.0.3, 8.0.4