Splunk® Add-on Builder

Splunk Add-on Builder User Guide

Acrobat logo Download manual as PDF

This documentation does not apply to the most recent version of AddonBuilder. Click here for the latest version.
Acrobat logo Download topic as PDF

Extract Fields

In the Extract Fields section, parse the data in your sourcetypes to create field extractions. The sourcetypes you created in the previous section appear in the Sourcetype dropdown list.

AddonBuilder 4ExtractFields v2.png

Parse data

To extract fields from your data, you must parse the data for each of the sourcetypes in your add-on according to the data format. The Field Extractor supports the following data formats:

  • Unstructured Data. Typically used for log files.
  • Table. Data in tabular formats, such as comma-separated values (CSV) and tab-separated values (TSV).
  • Key Value. Data that contains key-value pairs.
  • JSON. Data in the JavaScript Object Notation (JSON) format.
  • XML. Data in the Extensible Markup Language (XML) format.

To parse the data for a sourcetype and extract fields:

  1. On the Step 4: Extract Fields page, from Sourcetype, select a sourcetype to parse.
  2. From Format, select the format of the data.
  3. A format type is automatically selected if it has been detected. You can change it as needed. If you aren't sure and a format type has not been automatically selected, try "Unstructured Data".

  4. Click Parse.

Extract fields

After parsing the data, the results are displayed on a summary page. Depending on the data format, you can adjust the way fields are extracted.

  • If you are satisfied with the results, click Save.
  • If you want to try parsing again using a different format, click Cancel to return to the previous page.

Once data for a sourcetype has been parsed, the sourcetype is added to the table on the Step 4: Extract Fields page.

  • To retrieve the field extractions you have already parsed, click Load Results for the sourcetype.

Unstructured Data

The Add-on Builder's Field Extractor displays a selection of events in groups, along with the fields that were extracted.

AddonBuilder 4ExtractFieldsUnstructured v2.png

Here are some of the actions you can perform:

  • Select one or more groups that best represent the data.
  • If you are familiar with creating regular expressions, you can display the regular expression that the Field Extractor used, and modify it to improve the field extraction.
  • Click on individual field names to include or exclude the field for extraction.
  • Click the edit icon next to a field name to edit its name.
  • Click the trash icon next to a field name to remove its capture group from the regular expression.


The Table format is used with tabular data.

AddonBuilder 4ExtractFieldsTable v2.png

Here are some of the actions you can perform:

  • Change how data is parsed by selecting the delimiter character that is used to separate fields. To specify a different character, click Other and enter the character.
  • Change the field names, but only after you have selected the correct delimiter. Each time you change delimiters, the number of columns could change and you might lose any changes to field names.

Key Value

The Key Value format is used with data containing key-value pairs.

AddonBuilder 4ExtractFieldsKV v2.png

Here are some of the actions you can perform:

  • Change how data is parsed. For Extraction Methods, select :
  • Auto to let the Add-on Builder parse data automatically.
  • Delimiters to use delimiters.
  • Regex to use regular expressions.
  • For Delimiters, select the delimiters for the key-value pairs:
  • Specify the pair delimiter character, which is used to separate key-value pairs.
    Using the example key_a=value_a, key_b=value_b, the correct character is a comma.
  • Specify the key-value delimiter character, which is used to separate keys and values.
    Using the example key_a=value_a, key_b=value_b, the correct character is an equals sign.
  • For Regex: select the regular expression to use, or create your own.


The JSON format is used with JSON data. There are no additional parsing options.

AddonBuilder 4ExtractFieldsJSON v2.png


The XML format is used with XML data. There are no additional parsing options.

AddonBuilder 4ExtractFieldsXML v2.png


What if I need to upload different sample data?

If you decide that you need to upload a different sample data file for a sourcetype, for example you want to clean the data first, you can return to Step 3: Upload Sample Data, delete the sample data, then upload additional data files.

A regular expression had too many capture groups, what do I do?

This error is displayed after attempting to parse a file, and the regular expression created by the Field Extractor contains more than 100 capture groups (fields).

This error might indicate a problem with the Event Break setting for the sourcetype:

  1. Go back to Step 3: Upload Sample Data.
  2. Edit the sourcetype and select a different option for Event Break.
  3. Upload the sample events again. Because the Event Break option is applied when indexing the data, changing this value does not affect events that have already been indexed.
  4. Parse the data again.

The sample data might contain an event that is too long:

  1. Edit the sample data file by splitting the long lines to clean up the data.
  2. Go back to Step 3: Upload Sample Data.
  3. Upload the sample events again.
  4. Parse the data again.

Why are the field names not detected in my tabular data?

The Add-on Builder uses the first 1000 events for field extraction. If your data contains more than 1000 events, the parser cannot automatically detect the field names.

The parser assumes that all entries except the table header contain a timestamp. If entries in your tabular data do not contain a timestamp, the parser will not correctly detect which entry is the table header.

Learn more

For more information, see the following Splunk Enterprise documentation:

Last modified on 11 July, 2016
Add Sample Data
Map to CIM

This documentation applies to the following versions of Splunk® Add-on Builder: 1.1.0

Was this documentation topic helpful?

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