Extracts key/value pairs from events based on a form template that describes how to extract the values.
kvform [form=<string>] [field=<field>]
- Syntax: form=<string>
- Description: Specify a .form file located in a
- Syntax: field=<field_name>
- Description: Uses the field name to look for
.formfiles that correspond to the field values for that field name. For example, your Splunk deployment uses the
mongodsourcetypes. If you specify
kvformcommand looks for the
- Default: sourcetype
Before you can use the
kvform command, you must:
- Create the
formsdirectory in the appropriate application path. For example
- Create the
.formfiles and add the files to the
If you have Splunk Cloud and want to install form files, file a Support ticket.
Format for the .form files
.form file is essentially a text file of all static parts of a form. It might be interspersed with named references to regular expressions of the type found in the transforms.conf file.
.form file might look like this:
Students Name: [[string:student_name]] Age: [[int:age]] Zip: [[int:zip]]
Specifying a form
form argument is specified, the
kvform command uses the
<form_name>.form file found in the Splunk configuration
forms directory. For example, if
kvform command looks for a
sales_order.form file in the
$SPLUNK_HOME/etc/apps/<app_name>/forms directory for all apps. All the events processed are matched against the form, trying to extract values.
Specifying a field
If you specify the
field argument, the the
kvform command looks for forms in the
forms directory that correspond to the values for that field. For example, if you specify
field=error_code, and an event has the field value
error_code=404, the command looks for a form called
404.form in the
field argument is specified, the
kvform command uses the default value for the
field argument, which is
kvform command looks for
<sourcetype_value>.form files to extract values.
1. Extract values using a specific form
Use a specific form to extract values from.
... | kvform form=sales_order
2. Extract values using a field name
field=sourcetype to extract values from forms such as
mongod.form. If there is a form for a source type, values are extracted from that form. If one of the source types is
access_combined but there is no
access_combined.form file, that source type is ignored.
... | kvform field=sourcetype
3. Extract values using the eventtype field
... | kvform field=eventtype
This documentation applies to the following versions of Splunk Cloud™: 7.0.11, 7.0.13, 7.2.4, 7.2.6, 7.2.7, 7.2.8, 7.2.9, 7.2.10, 8.0.2001, 8.0.2003, 8.0.2004, 8.0.2006, 8.0.2007, 8.1.2008