Splunk® Enterprise

Search Manual

Download manual as PDF

Download topic as PDF

Extract fields with search commands

You can use search commands to extract fields in different ways.

  • The rex command performs field extractions using named groups in Perl regular expressions.
  • The extract (or kv, for key/value) command explicitly extracts field and value pairs using default patterns.
  • The multikv command extracts field and value pairs on multiline, tabular-formatted events.
  • The spath command extracts field and value pairs on structured event data, such as XML and JSON.
  • The xmlkv and xpath commands extract field and value pairs on XML-formatted event data.
  • The kvform command extracts field and value pairs based on predefined form templates.

In Splunk Web, you can define field extractions on the Settings > Fields > Field Extractions page.

The following sections describe how to extract fields using regular expressions and commands. See About fields in the Knowledge Manager Manual.

Extract fields using regular expressions

The rex command performs field extractions using named groups in Perl regular expressions that you include in the search criteria. The rex command matches segments of your raw events with the regular expression and saves these matched values into a field.

In this example, values that occur after the strings From: and To: are saved into the from and to fields.

... | rex field=_raw "From: (?<from>.*) To: (?<to>.*)"

If a raw event contains From: Susan To: Bob, the search extracts the field name and value pairs: from=Susan and to=Bob.

For a primer on regular expression syntax and usage, see www.regular-expressions.info. The following are useful third-party tools for writing and testing regular expressions:

Extract fields from .conf files

The extract command forces field and value extractions on the search result set. If you use the extract command without specifying any arguments, the fields are extracted using field extraction stanzas in the props.conf file. You can use the extract command to test field extractions that you add manually to .conf files.

Extract fields from events formatted as tables

Use the multikv command to force field and value extractions on multiline, tabular-formatted events. The multikv command creates a new event for each table row and derives field names from the table title.

Extract fields from events formatted in XML

The xmlkv command enables you to force field and value extractions on XML-formatted tags in event data, such as transactions from web pages.

Extract fields from XML and JSON documents

The spath command extracts information from structured data formats, such as XML and JSON, and store the extracted values in fields.

Extract fields from events based on form templates

The kvform command extracts field and value pairs from events based on form templates that are predefined and stored in $SPLUNK_HOME/etc/system/local/, or your own custom application directory in $SPLUNK_HOME/etc/apps/. For example, if form=sales_order, the search looks for a sales_order.form, and matches all processed events against that form to extract values.

If you have Splunk Cloud and want to use form templates for field extraction, file a Support ticket.

PREVIOUS
Use lookup to add fields from lookup tables
  NEXT
Manipulate and evaluate fields with multiple values

This documentation applies to the following versions of Splunk® Enterprise: 6.2.0, 6.2.1, 6.2.2, 6.2.3, 6.2.4, 6.2.5, 6.2.6, 6.2.7, 6.2.8, 6.2.9, 6.2.10, 6.2.11, 6.2.12, 6.2.13, 6.3.0, 6.3.1, 6.3.2, 6.3.3, 6.3.4, 6.3.5, 6.3.6, 6.3.7, 6.3.8, 6.3.9, 6.3.10, 6.3.11, 6.4.0, 6.4.1, 6.4.2, 6.4.3, 6.4.4, 6.4.5, 6.4.6, 6.4.7, 6.4.8, 6.5.0, 6.5.1, 6.5.1612 (Splunk Cloud only), 6.5.2, 6.5.3, 6.5.4, 6.5.5, 6.6.0, 6.6.1, 6.6.2, 6.6.3


Was this documentation topic helpful?

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.

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