Search Reference

fieldformat

Description

With the fieldformat command you can use eval expressions to change the format of a field value when the results render. You can change the format without changing the underlying value of the field. Commands later in the search pipeline cannot modify the formatted value.

The fieldformat command does not apply to commands that export data, such as the outputcsv and output lookup commands. The export retains the original data format and not the rendered format. If you want the format to apply to exported data, use the eval command instead of the fieldformat command.

Syntax

fieldformat <field>=<eval-expression>

Required arguments

<field>

Description: The name of a new or existing field, non-wildcarded, for the output of the eval expression.

<eval-expression>

Syntax: <string>

Description: A combination of values, variables, operators, and functions that represent the value of your destination field. See Usage.

For more information, see the eval command.

Usage

Time format variables are frequently used with the fieldformat command. See Date and time format variables.

Functions

You can use a wide range of functions with the fieldformat command. For general information about using functions, see Evaluation functions.

The following table lists the supported functions by type of function. Use the links in the table to learn more about each function examples, and to see examples.

Type of function	Supported functions and syntax
Comparison and Conditional functions	case(X,"Y",...) cidrmatch("X",Y) coalesce(X,...) false()	if(X,Y,Z) like(TEXT, PATTERN) match(SUBJECT, "REGEX") null()	nullif(X,Y) searchmatch(X) true() validate(X,Y,...)
Conversion functions	tonumber(NUMSTR,BASE)	tostring(X,Y)
Cryptographic functions	md5(X) sha1(X)	sha256(X)	sha512(X)
Date and Time functions	now() relative_time(X,Y)	strftime(X,Y) strptime(X,Y)	time()
Informational functions	isbool(X) isint(X) isnotnull(X)	isnull(X) isnum(X)	isstr(X) typeof(X)
Mathematical functions	abs(X) ceiling(X) exact(X) exp(X)	floor(X) ln(X) log(X,Y) pi()	pow(X,Y) round(X,Y) sigfig(X) sqrt(X)
Multivalue eval functions	commands(X) mvappend(X,...) mvcount(MVFIELD) mvdedup(X)	mvfilter(X) mvfind(MVFIELD,"REGEX") mvindex(MVFIELD,STARTINDEX,ENDINDEX) mvjoin(MVFIELD,STR)	mvrange(X,Y,Z) mvsort(X) mvzip(X,Y,"Z")
Statistical eval functions	max(X,...)	min(X,...)	random()
Text functions	len(X) lower(X) ltrim(X,Y) replace(X,Y,Z)	rtrim(X,Y) spath(X,Y) split(X,"Y") substr(X,Y,Z)	trim(X,Y) upper(X) urldecode(X)
Trigonometry and Hyperbolic functions	acos(X) acosh(X) asin(X) asinh(X) atan(X)	atan2(X,Y) atanh(X) cos(X) cosh(X) hypot(X,Y)	sin(X) sinh(X) tan(X) tanh(X)

Examples

Example 1:

Return metadata results for the sourcetypes in the main index.

| metadata type=sourcetypes | rename totalCount as Count firstTime as "First Event" lastTime as "Last Event" recentTime as "Last Update" | table sourcetype Count "First Event" "Last Event" "Last Update"

The fields are also renamed, but without the fieldformat command the time fields display in Unix time:

Now use the fieldformat command to reformat the time fields firstTime, lastTime, and recentTime:

| metadata type=sourcetypes | rename totalCount as Count firstTime as "First Event" lastTime as "Last Event" recentTime as "Last Update" | table sourcetype Count "First Event" "Last Event" "Last Update" | fieldformat Count=tostring(Count, "commas") | fieldformat "First Event"=strftime('First Event', "%c") | fieldformat "Last Event"=strftime('Last Event', "%c") | fieldformat "Last Update"=strftime('Last Update', "%c")

Note that the fieldformat command is also used to reformat the Count field to display the values with commas. The results are more readable:

Example 2:

Assume that the start_time field contains epoch numbers, format the start_time field to display only the hours, minutes, and seconds corresponding to the epoch time.

... | fieldformat start_time = strftime(start_time, "%H:%M:%S")

Example 3:

To format numerical values in a field with a currency symbol, you must specify the symbol as a literal and enclose it in quotation marks. Use a period character as a binary concatenation operator, followed by the tostring function, which enables you to display commas in the currency values.

...| fieldformat totalSales="$".tostring(totalSales,"commas")

See also

eval, where

Date and time format variables

Answers

Have questions? Visit Splunk Answers and see what questions and answers the Splunk community has using the fieldformat command.