localize command generates results that represent a list of time contiguous event regions. An event region is a period of time in which consecutive events are separated, at most, by the
maxpause time value. The regions found can be expanded using the
The regions discovered by the
localize command are meant to be fed into the
map command. The
map command uses a different region for each iteration.
localize [<maxpause>] [<timeafter>] [<timebefore>]
- Syntax: maxpause=<int>(s|m|h|d)
- Description: Specify the maximum (inclusive) time between two consecutive events in a contiguous time region.
- Default: 1m
- Syntax: timeafter=<int>(s|m|h|d)
- Description: Specify the amount of time to add to the output endtime field (expand the time region forward in time).
- Default: 30s
- Syntax: timebefore=<int>(s|m|h|d)
- Description: Specify the amount of time to subtract from the output starttime field (expand the time region backwards in time).
- Default: 30s
Expanding event ranges
You can expand the event range after the last event or before the first event in the region. These expansions are done arbitrarily, possibly causing overlaps in the regions if the values are larger than
Event region order
The regions are returned in search order, or descending time for historical searches and data-arrival order for realtime search. The time of each region is the initial pre-expanded start-time.
Other information returned by the localize command
localize command also reports:
- The number of events in the range
- The range duration in seconds
- The region density defined as the
number of events in rangedivided by <range duration -
events per second.
1. Search the time range of each previous result for the term "failure"
... | localize maxpause=5m | map search="search failure starttimeu=$starttime$ endtimeu=$endtime$"
2: Finds suitable regions around where "error" occurs
Searching for "error" and calling the
localize command finds suitable regions around where error occurs and passes each on to the search inside of the
map command. Each iteration works with a specific time range to find potential transactions.
error | localize | map search="search starttimeu::$starttime$ endtimeu::$endtime$ | transaction uid,qid maxspan=1h"
This documentation applies to the following versions of Splunk Cloud Platform™: 8.2.2112, 8.2.2201, 8.2.2202, 8.2.2203, 9.0.2205, 9.0.2208, 9.0.2209 (latest FedRAMP release), 9.0.2303
Feedback submitted, thanks!