Documentation: 3.3

About this manual
- What's in this guide?
About Splunk
- About Splunk
- About Splunk licenses
Use Splunk Web
Tutorial
Add inputs
Index
Search
Tag
- Use tagging
Report
Save, Schedule, and Alert
- Save, schedule, and alert options
- Find and manage saved searches
  - Delete or modify saved searches
  - Display saved searches on dashboard
Use the Splunk Command Line Interface (CLI)
Search reference
- Search syntax
- Search pipeline syntax
  - Search pipeline syntax
  - Subsearch syntax
Field reference
- Fields
- Field list
  - _index
  - _raw
  - _time
  - date_hour
  - date_mday
  - date_minute
  - date_month
  - date_second
  - date_wday
  - date_year
  - date_zone
  - eventtype
  - host
  - linecount
  - punct
  - source
  - sourcetype
  - timestamp
Modifier reference
Search command reference
- Search commands
- Data-generating commands
  - crawl
  - file
  - savedsearch
  - search
- Filtering and re-ordering commands
  - dedup
  - head
  - localize
  - regex
  - reverse
  - set
  - sort
  - tail
  - where
- Transforming and reporting commands
  - associate
  - chart
  - cluster
  - contingency
  - collect
  - correlate
  - diff
  - eventstats
  - format
  - highlight
  - makemv
  - mvcombine
  - mvexpand
  - nomv
  - overlap
  - rare
  - stats
  - strcat
  - timechart
  - top
  - transaction
  - typelearner
  - xmlunescape
- Evaluating commands
  - abstract
  - addtotals
  - anomalousvalue
  - bucket
  - convert
  - eval
  - fields
  - fillnull
  - kmeans
  - outlier
  - rename
  - replace
- Extracting commands
  - addinfo
  - extract
  - iplocation
  - multikv
  - rex
  - typer
  - xmlkv
- Administrative commands
  - admin
  - audit
  - run
- Unsupported search commands
  - createrss
  - dispatch
  - folderize
  - gentimes
  - idxprobe
  - load
  - map
  - outputatom
  - outputcsv
  - outputraw
  - outputtext
  - outputxml
  - page
  - rawstats
  - save
  - sendemail
  - translate
- Deprecated search commands
  - nopartial
  - remote
  - searchps
  - select
  - streamedcsv
  - summary
  - timeline
  - uniq
CLI command reference
- Command Line Interface (CLI) commands
  - Syntax
  - Command list

This page last updated: 06/04/08 01:06pm

Search results

Splunk allows you to navigate search results by following links and using interactive field filters. Filtering is an efficient method to organize the results of a search.

Events and fields

Your search results appear below the timeline as a list of events ordered by timestamp. A field is a name/value pair distinguished from the free-form indexed segments that you see in an event.

You can add and remove field filters, extract new fields from the results, and tag fields to group results.

Filter on fields

Search for all the sampledata index events:

index=sampledata

Splunk includes three default filters in your search results: host, source, and sourcetype. These interactive field filters are drop-down menus located below the timeline.

Each field's filter menu lists (up to) 10 values, ordered by the frequency at which they occur in the search results.

Host

The host field, which lists the originating hosts of events, lets you target one specific host in the filter. The host field is stored and indexed with each raw event.

Click on the host menu.

From the list, select the first host value, http2. The search results filter to show only results for the selected host.

Let's look at another host value and add it to our search:

To remove the first host filter, click Clear filter. The search results revert to your previous search.
Select the next host value from the menu.
To add this filter to your search string, click Add filter to search.

The search bar and search results update to include the host value restriction you applied, http1:

index=sampledata host=http1

Source

The source field lists the location where an event is accessed; a file, network port, script, etc.

Sourcetype

The sourcetype field characterizes all sources that have similar formats. For example, all Apache access logs in W3C common format have the sourcetype value access_common. The sample data contains four distinct sourcetypes - syslog, access_common, db2 and websphere_activity.

Show more fields

You can include many more field filters in addition to host, source, and sourcetype, in your searches. The fields are listed in the Fields... drop-down menu.

Search for all the sampledata index events:

index=sampledata

Let's add a couple more field filters to our search:

To display the list of field filters, click the Fields... menu.
Scroll through the list.
Check eventtype and punct.
Click Apply.

The interactive field filters list updates to include eventtype and punct menus. You can use these field filters exactly the same way you used host.

To remove a field filter menu:

Click the Fields.. menu.
Uncheck the fields you want to remove.
Click Apply.

The eventtype and punct fields are discussed further in Event types.

Define custom fields

Splunk lets you interactively define and extract fields from your search results. Let's define a field to extract the IP addresses from our search for all events in sampledata.

index=sampledata

You may need to scroll through the results or use the timeline to find events that contain an IP address.

Below the timestamp of every event is a drop-down menu. Click the down-arrow and select Extract field.

The Extract fields window opens.

Notice the panel at the top of this window:

Sample Event lists the event that you selected from the search results.
Example Value(s) provides a textarea for you to define the field value.

To define the IP address field for extraction:

Highlight the IP address from your sample event. Copy and paste (or type) it into the Example Value(s) textarea.
Click Preview.

In the Rules panel:

Select a field to restrict your search (either host, source, or sourcetype),
Splunk generates the regex rules to define your field.
Splunk provides a preview of values it has extracted from your results.

Splunk also provides a preview of other events that contain your custom field. Use this Preview panel to validate the results of your field definition.

To save your custom field definition, click Save. The Save FIeld Definition dialog box opens.

Name the field "ipaddress".
Click Save.

Now, your custom field (ipaddress) is listed in the Fields menu. You can activate and apply your field filter in exactly the same way you used host.

Tag fields

You can tag fields to group together results that share field values. Use tagging to attach a name, or tag, to a group of results that share the same value of a field, event type, host, or source. You can apply as many tags as you want to a single field, event type, host, or source. A tag cannot contain spaces.

To access the tagging dialog, click Tag field name in the drop-down menu of any field in your search results.
To apply a tag to the field you selected, type a tag name into the Tags field.
To apply multiple tags, enter a space-delimited list of tag names in the Tags field.

Note: Tags that you create for a field are displayed in italics next to that field name in your search results.

Collect snapshots

Splunk allows you to save your results in a "Snapshot Container" that houses your collection. Each snapshot includes an image of the time graph and your search string.

You can add and remove snapshots from your collection. However, after adding a snapshot, you cannot modify the time graph within the container.

If you want to modify a snapshot in your collection:

In the Snapshot Container, click Restore search.
Modify your graph.
Click Snapshot.

Your modified graph has been added to your snapshot collection.

Previous: Simple searches | Next: Event types

Comments

No comments have been submitted.