Skip to main content

@rbxts/rlog > RLogConfig

RLogConfig interface

Configuration settings for RLog.

Signature:

export interface RLogConfig 

Properties

Property

Modifiers

Type

Description

contextBypass

readonly

boolean

Allows logs that have context to bypass minLogLevel under certain circumstances.

correlationGenerator?

readonly

() => string

(Optional) Function to generate correlation IDs.

enrichers?

readonly

LogEnricherCallback[]

(Optional) An array of LogEnricherCallback to call whenever sending a message.

minLogLevel

readonly

LogLevel

Sets the minimum LogLevel for data to be logged.

Messages below the minimum level will be ignored.

serialization

readonly

SerializationConfig

Settings to use when encoding data in logs.

sinks?

readonly

LogSinkCallback[]

(Optional) An array of LogSinkCallback to call whenever sending a message.

suspendContext

readonly

boolean

Prevents logs from propogating until the context is killed.

tag?

readonly

string

(Optional) String to prefix to all logs.

Will be followed by a -> between the log message and the log level.