Related Answers
Download topic as PDF
Mathematical functions
The following list contains the functions that you can use to perform mathematical calculations.
- For information about using string and numeric fields in functions, and nesting functions, see Evaluation functions.
- For the list of mathematical operators you can use with these functions, see "Operators" in the Usage section of the eval command.
abs(X)
Description
This function takes a number X and returns its absolute value.
Usage
You can use this function with the eval, fieldformat, and where commands, and as part of eval expressions.
Basic example
The following example creates a field called absnum, whose values are the absolute values of the numeric field number.
... | eval absnum=abs(number)
ceiling(X) or ceil(X)
Description
This function rounds a number X up to the next highest integer.
Usage
You can use this function with the eval, fieldformat, and where commands, and as part of eval expressions.
You can use the abbreviation ceil(X) instead of the full name of the function.
Basic example
The following example returns n=2.
... | eval n=ceil(1.9)
exact(X)
Description
This function renders the result of a numeric eval calculation with a larger amount of precision in the formatted output.
Usage
You can use this function with the eval, fieldformat, and where commands, and as part of eval expressions.
Basic example
... | eval n=exact(3.14 * num)
exp(X)
Description
This function takes a number X and returns the exponential function eX.
Usage
You can use this function with the eval, fieldformat, and where commands, and as part of eval expressions.
Basic example
The following example returns y=e3.
... | eval y=exp(3)
floor(X)
Description
This function rounds a number X down to the nearest whole integer.
Usage
You can use this function with the eval, fieldformat, and where commands, and as part of eval expressions.
Basic example
The following example returns 1.
... | eval n=floor(1.9)
ln(X)
Description
This function takes a number X and returns its natural logarithm.
Usage
You can use this function with the eval, fieldformat, and where commands, and as part of eval expressions.
Basic example
The following example returns the natural logarithm of the values of bytes.
... | eval lnBytes=ln(bytes)
log(X,Y)
Description
This function takes either one or two numeric arguments and returns the logarithm of the first argument X using the second argument Y as the base. If the second argument Y is omitted, this function evaluates the logarithm of number X with base 10.
Usage
You can use this function with the eval, fieldformat, and where commands, and as part of eval expressions.
Basic example
... | eval num=log(number,2)
pi()
Description
This function takes no arguments and returns the constant pi to 11 digits of precision.
Usage
You can use this function with the eval, fieldformat, and where commands, and as part of eval expressions.
Basic example
The following example calculates the area of a circle, which is pi() multiplied by the radius to the power of 2.
... | eval area_circle=pi()*pow(radius,2)
pow(X,Y)
Description
This function takes two numeric arguments X and Y and returns XY, X to the power of Y.
Usage
You can use this function with the eval, fieldformat, and where commands, and as part of eval expressions.
Basic example
The following example calculates the area of a circle, which is pi() multiplied by the radius to the power of 2.
... | eval area_circle=pi()*pow(radius,2)
round(X,Y)
Description
This function takes one or two numeric arguments X and Y, returning X rounded up to the amount of decimal places specified by Y. The default is to round up to an integer.
Usage
You can use this function with the eval, fieldformat, and where commands, and as part of eval expressions.
Basic examples
The following example returns n=4.
... | eval n=round(3.5)
The following example returns n=2.56.
... | eval n=round(2.555, 2)
The following example uses -1 to specify precision that rounds to the tens.
... | eval n=round(155, -1)
This search returns n=150.
sigfig(X)
Description
This function takes one argument X, a number, and rounds that number to the appropriate number of significant figures.
Usage
You can use this function with the eval, fieldformat, and where commands, and as part of eval expressions.
The computation for sigfig is based on the type of calculation that generates the number.
- For multiplication and division, the result should have the minimum number of significant figures of all of the operands.
- For addition and subtraction, the result should have the same number of decimal places as the least precise number of all of the operands.
For example, the numbers 123.0 and 4.567 contain different precision with the decimal places. The first number is less precise because it has 1 decimal place. The second number is more precise because it has 3 decimal places.
If the calculation is 123.0 + 4.567 = 127.567, then the sigfig function returns the fewest number of decimal places. In this example only one decimal place is returned. Because the numbers to the right of the last significant figure are greater than 5, the result returned is 127.6
Basic examples
Example 1: The following example shows how the sigfig function works. The calculation 1.00*1111 returns the value n=1111, but the following search using the sigfig function returns n=1110.
... | eval n=sigfig(1.00*1111)
In this example, 1.00 has 3 significant figures and 1111 has 4 significant figures. In this example, the minimum number of significant figures for all operands is 3. Using the sigfig function, the final result is rounded to 3 digits, returning n=1110 and not 1111.
Example 2: There are situations where the results of a calculation can return a different accuracy to the very far right of the decimal point. For example, the following search calculates the average of 100 values:
| makeresults count=100 | eval test=3.99 | stats avg(test)
The result of this calculation is:
| avg(test) |
|---|
| 3.9900000000000055 |
When the count is changed to 10000, the results are different:
| makeresults count=10000 | eval test=3.99 | stats avg(test)
The result of this calculation is:
| avg(test) |
|---|
| 3.990000000000215 |
This occurs because numbers are treated as double-precision floating-point numbers.
To mitigate this issue, you can use the sigfig function to specify the number of significant figures you want returned.
However, first you need to make a change to the stats command portion of the search. You need to change the name of the field avg(test) to remove the parenthesis. For example stats avg(test) AS test. The sigfig function expects either a number or a field name for X. The sigfig function cannot accept a field name that looks like another function, in this case avg.
To specify the number of decimal places you want returned, you multiply the field name by 1 and use zeros to specify the number of decimal places. If you want 4 decimal places returned, you would multiply the field name by 1.0000. To return 2 decimal places, multiply by 1.00, as shown in the following example:
| makeresults count=10000 | eval test=3.99 | stats avg(test) AS test | eval new_test=sigfig(test*1.00)
The result of this calculation is:
| test |
|---|
| 3.99 |
sqrt(X)
Description
This function takes one numeric argument X and returns its square root.
Usage
You can use this function with the eval, fieldformat, and where commands, and as part of eval expressions.
Basic example
The following example returns 3:
... | eval n=sqrt(9)
|
PREVIOUS Informational functions |
NEXT Multivalue eval functions |
This documentation applies to the following versions of Splunk® Enterprise: 7.0.0, 7.0.1, 7.0.2, 7.0.3, 7.0.4, 7.0.5, 7.0.6, 7.0.7, 7.0.8, 7.0.9, 7.0.10, 7.0.11, 7.0.13, 7.1.0, 7.1.1, 7.1.2, 7.1.3, 7.1.4, 7.1.5, 7.1.6, 7.1.7, 7.1.8, 7.1.9, 7.1.10, 7.2.0, 7.2.1, 7.2.2, 7.2.3, 7.2.4, 7.2.5, 7.2.6, 7.2.7, 7.2.8, 7.2.9, 7.2.10, 7.3.0, 7.3.1, 7.3.2, 7.3.3, 7.3.4, 7.3.5, 7.3.6, 7.3.7, 7.3.8, 7.3.9, 8.0.0, 8.0.1, 8.0.2, 8.0.3, 8.0.4, 8.0.5, 8.0.6, 8.0.7, 8.0.8, 8.0.9, 8.0.10
Feedback submitted, thanks!