Configure automatic key-value field extraction
Automatic key-value field extraction is a search-time field extraction configuration that uses the
KV_MODE attribute to automatically extract fields for events associated with a specific host, source, or source type. Configure automatic key-value field extractions by finding or creating the appropriate stanza in
props.conf. You can find
$SPLUNK_HOME/etc/system/local/ or your own custom app directory in
Automatic key-value field extraction is not explicit. You cannot configure it to find a specific field or set of fields. It looks for key-value patterns in events and extracts them as field/value pairs. You can configure it to extract fields from structured data formats like JSON, CSV, and from table-formatted events. Automatic key-value field extraction cannot be configured in Splunk Web, and cannot be used for index-time field extractions.
Automatic key-value field extraction and the sequence of search operations
Search-time operation order
Automatic key-value field extraction is fourth in the sequence of search operations, before field aliases and after transform extractions.
Splunk software processes automatic key-value field extractions in the order that it finds them in events.
For more information
Automatic key-value field extraction format
The following is the format for autoKV field extraction.
KV_MODE = [none|auto|auto_escaped|multi|json|xml]
||Disables field extraction for the source, source type, or host identified by the stanza name. Use this setting to ensure that other regular expressions that you create are not overridden by automatic field/value extraction for a particular source, source type, or host. Use this setting to increase search performance by disabling extraction for common but nonessential fields. We have some field extraction examples at the end of this topic that demonstrate the disabling of field extraction in different circumstances.|
||This is the default field extraction behavior if you do not include this attribute in your field extraction stanza. Extracts field/value pairs and separates them with equal signs.|
||Extracts field/value pairs and separates them with equal signs, and ensures that Splunk Enterprise recognizes \" and \\ as escaped sequences within quoted values. For example: |
||Invokes the |
||Use this setting to use the field extraction stanza to extract fields from XML data. This mode does not extract non-XML data.|
||Use this setting to use the field extraction stanza to extract fields from JSON data. This mode does not extract non-JSON data.
KV_MODE is set to
auto_escaped, automatic JSON field extraction can take place alongside other automatic key/value field extractions. To disable JSON field extraction when
KV_MODE is set to
AUTO_KV_JSON=false to the stanza. When not set,
AUTO_KV_JSON defaults to
AUTO_KV_JSON = false applies only when
KV_MODE = auto or
AUTO_KV_JSON = false when
KV_MODE is set to
xml has no effect.
Disabling automatic extractions for specific sources, source types, or hosts
You can disable automatic search-time field extraction for specific sources, source types, or hosts in
KV_MODE = none for the appropriate
props.conf. When automatic key-value field extraction is disabled, explicit field extraction still takes place.
Custom field extractions set up manually via the configuration files or Splunk Web will still be processed for the affected source, source type, or host when
KV_MODE = none.
[<spec>] KV_MODE = none
<spec> can be:
<sourcetype>is the event source type.
<host>is the host for an event.
<source>is the source for an event.
Configure advanced extractions with field transforms
Example inline field extraction configurations
This documentation applies to the following versions of Splunk Cloud Platform™: 9.0.2209 (latest FedRAMP release), 8.2.2106, 8.2.2109, 8.2.2107, 8.2.2111, 8.2.2112, 8.2.2201, 8.2.2202, 8.2.2203, 9.0.2205, 9.0.2208