ProtectedconstructorProtectedclearTo ensure when invoking clearInstance in a sub-class it also clear (null) the last log event.
ProtectedclearThe last log event sent by the appender.
-Log a message or log event.
+The last log event sent by the appender.
+Log a message or log event.
LogEvent or message string.
Optionalarg2: LOG_EVENTLOG_EVENT, only required if arg1 is a string.
Optionalarg3: LogEventExtraFieldsextraFields, only used if arg1 is a string.
// Example: Log an error message with a custom event type and extra fields.
const appender = new ConsoleAppender() // Assuming ConsoleAppender extends AbstractAppender
appender.log("An error occurred", LOG_EVENT.ERROR, { user: "dlealv", id: 42 })
// Example: Log a warning event directly.
const warningEvent = new LogEventImpl("This is a warning", LOG_EVENT.WARNING)
appender.log(warningEvent) // Directly log a LogEvent instance
Protected AbstractsendSend the log event to the appropriate destination. +
Protected AbstractsendSend the log event to the appropriate destination. This method must be implemented by subclasses to define how the log event is sent. It is responsible for sending the log event to the appropriate destination (e.g., console, file, etc.).
The log event to be sent.
Optionalcontext: string(Optional) A string to provide additional context in case of an error.
ProtectedsetSend the log event to the appropriate destination.
+ProtectedsetSend the log event to the appropriate destination.
The log event to be sent.
Returns a string representation of the appender. +
Returns a string representation of the appender. It includes the information from the base class plus the information of the current class, so far this class doesn't have additional properties to show.
A string representation of the appender.
-StaticclearStaticclearStaticgetThe layout associated to all events. Used to format the log event before sending it to the appenders. +
StaticgetThe layout associated to all events. Used to format the log event before sending it to the appenders. If the layout was not set, it returns a default layout (lazy initialization). The layout is shared by all events and all appenders, so it is static.
StaticgetGets the log event factory function used to create LogEvent instances. If it was not set before, it returns the default factory function.
+
StaticgetGets the log event factory function used to create LogEvent instances. If it was not set before, it returns the default factory function.
The logEventFactory is shared by all events and all appenders, so it is static.
The log event factory function.
-StaticsetSets the layout associated to all events, the layout is assigned only if it was not set before.
+StaticsetSets the layout associated to all events, the layout is assigned only if it was not set before.
The layout to set.
StaticsetSets the log event factory function used to create LogEvent instances if it was not set before.
StaticsetSets the log event factory function used to create LogEvent instances if it was not set before.
A factory function to create LogEvent instances.
Must have the signature (message: string, eventType: LOG_EVENT) => LogEvent, i.e. LogEventFactory type.
If not provided, a default factory function is used.
// Example: Custom LogEvent to be used to specify the environment where the log event was created.
let prodLogEventFactory: LogEventFactory
= function prodLogEventFactoryFun(message: string, eventType: LOG_EVENT) {
return new LogEventImpl("PROD-" + message, eventType) // add environment prefix
}
AbstractAppender.setLogEventFactory(prodLogEventFactory) // Now all appenders will use ProdLogEvent
Constructs a new
-AbstractAppenderinstance. Nothing is initialized, because the class only has static properties that are lazy initialized or set by the user.