logEvent

logEvent

Contains constants and functions for a Log Event.

The structure for a Log Event is as follows:

{
  payload: {
    logline: <string>,
  },
  type: 'log'
  annotations: <array>,
  clientId: <string>,
  timestamp: <number>,
  uuid: <string>,
}
Source:

Members

(static, constant) group

A grouping for this object

Source:

(static, constant) label

A label that can be used when describing this object

Source:

(static, constant) matcher

Matcher can be used to find matching Log Event objects.

Source:
See:
  • kit.match

(static, constant) parentDepth

Describes the number of parents this object has based off schema references. When checking for matches for example, we want to use a schema that is more specific over a more generic schema

Source:

(static, constant) path :string

Paths for the keys on a Log Event

Properties:
Name Type Description
payload string

An object with custom data describing the event.
Path is payload.
logLine string

Represents a line logged by the application.
Path is payload.logline.
rootType string

The type of event.
Path is type.
annotations string

Array of Annotation objects.
Path is annotations.
clientId string

A unique id that differentiates clients from one another.
Path is clientId.
timestamp string

When the event occurred.
Path is timestamp.
rootId string

Uniquely identifies each event.
Path is uuid.
Source:

(static, constant) ROOT_TYPE

The value for rootType for a Log Event.

Path is type.

Source:

Methods

(static) get(alias, data) → {*}

Retrieves a value from the object. You can provide either a path or an alias.

Parameters:
Name Type Description
alias string

Path or alias
data *

Data to search
Source:

(static) getLogLine(source) → {string}

Returns the logLine from the Log Event. This is the represents a line logged by the application.

Path is payload,logline.

Parameters:
Name Type Description
source object

The Log Event instance
Source:

(static) isMatch(source) → {boolean}

Tests the provided source against the matcher to see if it's Log Event event.

Parameters:
Name Type Description
source object

The Log Event instance
Source:
See:
  • kit.isMatch

(static) make(…input) → {object}

Generates a Log Event with the const values set. Can be useful in testing. Can provide additional data by providing a flat object of paths and values.

Parameters:
Name Type Attributes Description
input function <repeatable>

Overrides
Source:

(static) mock(…input) → {object}

Generates a Log Event with some default values set. Can be useful in testing. Can override defaults and provide additional data by providing a flat object of paths and values.

Parameters:
Name Type Attributes Description
input function <repeatable>

Overrides
Source: