Class LogItem

LogItem is a class that holds the attributes of a log item.

It is used by LogFormatter to store the attributes of a log item and to add additional attributes to it.

Index

Constructors

Methods

addAttributes getAttributes prepareForPrint removeEmptyKeys setAttributes

Constructors

constructor

new LogItem(params: { attributes: LogAttributes }): LogItem
Constructor for LogItem.

Attributes are added in the following order:
- Standard keys provided by the logger (e.g. message, level, timestamp)
- Persistent attributes provided by developer, not formatted (done later)
- Ephemeral attributes provided as parameters for a single log item (done later)
Parameters
- params: { attributes: LogAttributes }
  The parameters for the LogItem.
Returns LogItem
- Defined in packages/logger/src/formatter/LogItem.ts:25

Methods

addAttributes

addAttributes(attributes: LogAttributes): this
Add attributes to the log item.
Parameters
- attributes: LogAttributes
  The attributes to add to the log item.
Returns this
- Defined in packages/logger/src/formatter/LogItem.ts:34

getAttributes

getAttributes(): LogAttributes
Get the attributes of the log item.

Returns LogAttributes
- Defined in packages/logger/src/formatter/LogItem.ts:43

prepareForPrint

prepareForPrint(): void
Prepare the log item for printing.

This operation removes empty keys from the log item, see removeEmptyKeys() for more information.

Returns void
- Defined in packages/logger/src/formatter/LogItem.ts:52

removeEmptyKeys

removeEmptyKeys(attributes: LogAttributes): LogAttributes
Remove empty keys from the log item, where empty keys are defined as keys with values of undefined, empty strings (''), or null.
Parameters
- attributes: LogAttributes
  The attributes to remove empty keys from.
Returns LogAttributes
- Defined in packages/logger/src/formatter/LogItem.ts:62

setAttributes

setAttributes(attributes: LogAttributes): void
Replace the attributes of the log item.
Parameters
- attributes: LogAttributes
  The attributes to set for the log item.
Returns void
- Defined in packages/logger/src/formatter/LogItem.ts:82