Class: LogEvent

LogEvent

A LogEvent represents a single event from the raw log and contains the text of the log, a reference to the VectorTimestamp, and other contextual information. LogEvents are immutable.

Constructor

new LogEvent(text, vectorTimestamp, lineNum, fieldsopt, nullable)

Constructs a LogEvents given the log text, a VectorTimestamp and the line number associated with this log event <>
Parameters:
Name Type Attributes Default Description
text String the text of the log (description)
vectorTimestamp VectorTimestamp the vector timestamp of the log
lineNum Number the line number of the event in the log
fields Object.<String, String> <optional>
<nullable>
{} a mapping of field names to field values extracted using regex.
Source:

Methods

getFields() → {Object.<String, String>}

Returns the custom captured fields for the log event.
Source:
Returns:
The fields
Type
Object.<String, String>

getHost() → {String}

Returns the host that the LogEvent was generated by
Source:
Returns:
the name of the host
Type
String

getId() → {Number}

Returns the LogEvent's unique ID
Source:
Returns:
the ID
Type
Number

getLineNumber() → {Number}

Returns line number in the raw input string that this log event was parsed from.
Source:
Returns:
Type
Number

getText() → {String}

Returns the log text associated with this LogEvent
Source:
Returns:
the log text
Type
String

getVectorTimestamp() → {VectorTimestamp}

Returns the VectorTimestamp associated with this LogEvent
Source:
Returns:
Type
VectorTimestamp