Splunk® Enterprise

Knowledge Manager Manual

Download manual as PDF

Download topic as PDF

Field Extractor: Rename Fields step

The Rename Fields step of the field extractor is for delimiter-based field extractions only. If you are extracting fields using a regular expression, see the topics for the Select Fields and Validate steps.

In the Rename Fields step you:

  • Identify the delimiter that separates the fields in your sample event, such as a space, comma, tab, pipe, or another character or character combination. The field extractor breaks the event out into fields based on your delimiter choice
  • Rename one or more the fields that you want to extract from these events.
  • Optionally preview the results of the delimiter-based field extraction. This can help you validate the extraction and determine which fields to rename.

Identify a delimiter and rename one or more fields

Identify a delimiter. Rename at least one field.

1. Under Rename Fields, select one of the available Delimiter options or provide one of your own.

The field extractor replaces the sample event with a display of the fields it finds in the event, using the delimiter that you select. It gives each field a color and a temporary name (field1, field2, field3 and so on).
If you select Space, Comma, Tab, or Pipe, the field extractor breaks the event up into fields based on that delimiter. For example, a string like 2015-06-01T14:07:50:170Z|Jones|Alex|555-922-1212|324 Bowie Street|Alexandria, Va would get broken up into six separate fields if you choose Pipe as its delimiter.
If the delimiter is not one of those four options, select Other, and enter the delimiter character or characters in the provided field. Then click the Return key to have the field extractor break up your event into fields based on that delimiter.
The field extractor also creates a Preview area below the field display that previews how the delimiter-based field extraction works for other events in the dataset represented by your source or source type selection. See "Preview the results of the field extraction."

Em FX rename fields step.png

2. (Optional) Review the contents of the Preview section to determine the accuracy of the delimiter-based extraction and identify fields that should be renamed.

This can help you make decisions about which fields to rename.

3. Click on a field that you want to rename.

A Field Name field appears. Enter the correct field name.
You must select and rename at least one field to move on to the Save step.

4. Click Rename Field to rename the field.

The field extractor replaces the field temporary name with the name you have provided throughout the page.

Em FX rename fields step detail.png

5. (Optional) Repeat steps 3 and 4 for all additional fields you choose to rename from the event.

Note: You do not have to rename every field discovered by the field extractor.

6. Click Next to go to the Save step.

Preview the results of the field extraction

These actions are optional for the Rename Fields step.

After the field extractor applies delimiter-based field extraction to your sample event, the lower part of the page becomes a Preview section. You can go to the Preview section to preview the results of this extraction against the dataset represented by your chosen source or source type.

The Preview section has features that you can use to inspect the accuracy of the field extraction and identify fields that you may want to rename. It consists of a table that shows the events broken out into fields according to your delimiter choice. It also provides informational tabs for each field that the field extractor discovers.

1. (Optional) Change the sample size of the preview dataset to see statistics for a wider range of events.

The preview section displays results for the First 1,000 events in the dataset by default. You can change the preview set to be the first 10,000 events or the events from the last five minutes, 24 hours, or 30 days.

2. (Optional) Review the first column to see if any events failed to match the pattern of the selected event.

The first column of the Preview event listing table displays a green check mark for events that match the pattern and a red "X" for events that do not match.
If you have events that do not match, it means that those events may have more or fewer fields than your sample event, and you may want to try using a different delimiter or investigate why your chosen delimiter is only working for some events in your event set.
You can quickly find rare matching or non-matching events by using the Matches and Non-Matches filters.

3. (Optional) Click a field tab to see information about it.

Each field information tab provides a value distribution for the field, organized from most to least common. It is based on the selected event sample. If the default sample of 1,000 isn't providing values that you expected to see, try changing it to a larger sample.
Field Extractor: Select Fields step
Field Extractor: Validate step

This documentation applies to the following versions of Splunk® Enterprise: 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.4.0, 6.4.1, 6.4.2, 6.4.3, 6.4.4, 6.4.5, 6.4.6, 6.5.0, 6.5.1, 6.5.1612 (Splunk Cloud only), 6.5.2

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