Script Execution Processor

Script

The JavaScript code to transform your data

message

This is a reference to the actual message that flows through this processor

metadata (optional)

The metadata associated with the event

timestamp (optional)

The timestamp associated with this event. In some automated parsing sources we will try and extract the timestamp from the incoming event, but for the most part this timestamp will be set to the time we received the event.

annotations (optional)

The annotations object for the event. In scenarios where you have created a Data Profile, classification information such as event type, message type, and total bytes will be present.

Date.now()

Returns the number of milliseconds elapsed since the epoch, which is defined as the midnight at the beginning of January 1, 1970, UTC.

Date.parse(date_string, unit)

Parses a string representation of a date, and returns and returns the number of milliseconds elapsed since the epoch. It defaults to null when parsing fails.

Unit indicates the scale of units to return (seconds, milliseconds or nanoseconds) and defaults to milliseconds.

new Date()

Returns a timestamp representing the time of processing of this script.

new Date(date_string)

Parses date_string to produce a timestamp. The following formats are supported - ISO8601, W3C, Apache, nginx:

%+

%Y-%m-%d %T%.f%#z

%Y-%m-%d %T%.f

%d/%b/%Y:%T%.f %z

%Y/%m/%d %T%.f

%Y/%m/%d %T%.f#z

JSON.parse(json_string)

Parses a JSON string into a JS type. It defaults to null when parsing fails.

JSON.stringify(value)

Converts a JavaScript value to a JSON string. You should use this for converting any JSON object, instead of the toString() method.

Object.entries(value)

Returns an array of property key-value pairs of the spedified object. It returns an empty array when the provided value is not an object, or null.

Object.keys(value)

Returns an array of property keys of the provided object. It returns an empty array when the provided value is not an object or null.

parseInt(value)

Attempts to parse the data as an integer and returns the integer. It defaults to 0when it fails.

parseFloat(value)

Attempts to parse the data as a float and returns the float. It defaults to 0.0when it fails.

parseGrok(value, pattern)

Parses the value using a grok pattern. Note that only these literals are supported between expression:\s,;:-

toString()

Casts an object to a string. Returns an empty string for null values.

>

Greater Than

>=

Greater Than or Equal To

<

Less Than

<=

Less Than or Equal To

== or ===

Equal. Note: This has strict type checking whether it's defined as == or ===

!= or !==

Not Equal. Note: This has strict type checking whether it's defined as == or ===

Addition

Subtraction

Multiplication

/

Division

Concatenates two strings together

.endsWith(substring)

Checks whether a string ends with substring.

.startsWith(substring)

Checks whether a string starts with substring.

.at()

Retrieve an character at the specific index from a string (more readable)

.charAt()

Retrieve an character at the specific index from a string

.indexOf()

Return the first index of a value in a string

.lastIndexOf()

Return the last index of a value in a string

.length

Returns the number of characters in a string

Note that to avoid collisions with a field name of .lengththe function checks to ensure that field does not exist first. If it does, it will return the value of the field, not the computed length.

.padEnd()

Adds additional specified characters to the end of a string

.padStart()

Adds additional specified characters to the beginning of a string

.repeat()

Returns a new string with a number of copies of the original string

.slice()

Extracts the specified portion of the string by index, defaulting to the end of the string if only one index is specified

.substring()

Extracts a specified portion of the string between the indexes given

.toLowerCase()

Changes all string characters to lower case letters

.toUpperCase()

Changes all string characters to upper case letters

.trim()

Removes whitespaces from both sides of the string

.trimEnd()

Removes whitespaces from the end of the string

.trimStart()

Removes whitespaces from the beginning of the string