AbstractProtected 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 the final 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.
+ProtectedsetSet the last log event sent to the appender.
The log event to be sent.
-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.
+Returns a string representation of the appender. It includes the class name, layout, log event factory, +so far this class doesn't have additional properties to show. +Intended to be used by subclasses to provide information of the base class.
A string representation of the appender.
-StaticclearStaticclearSets to null the log event factory, useful for running different scenarios.
StaticclearStaticgetThe layout associated to all events. Used to format the log event before sending it to the appenders.
+This method is available only in src folder, it is not deployed in dist folder (production).
StaticclearStaticgetThe 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
Abstract base class for all log appenders. -This class defines shared utility methods to standardize log formatting, -label generation, and event validation across concrete appender implementations.
-It relies on a
-LogEventFactoryfunction to create log events, enabling flexible -and customizable event creation strategies. TheLogEventFactoryis validated on -construction to ensure it meets the expected signature. This design allows users -to supply custom event creation logic if needed.Appenders such as
-ConsoleAppenderandExcelAppendershould extend this class -to inherit consistent logging behavior and event creation via theLogEventFactory.See
+Provides a common interface and shared functionality for concrete appender implementations. +
Features:
++- Allows specifying the formatting of log events via a shared
+- Uses a static
+- Implements the core logic for logging, delegating the actual delivery of log events to subclasses via the
+
+Layout(see Layout).LogEventFactoryfunction type to create log events, enabling flexible and customizable event creation.sendEventmethod.Usage:
++- Extend this class to implement specific appenders (e.g.,
+- Subclasses must implement the
+
+ConsoleAppender,ExcelAppender).sendEvent(event, context)method to define how log events are delivered.Remarks
+- The static layout and log event factory are shared across all appenders.
+- Designed for extensibility and consistency across different output targets.
+
+See
+- LOG_EVENT for the enumeration of log event types.
+- LogEvent for the structure of log events.
+- Layout for the layout used to format log events before sending them to appenders.
+- LayoutImpl for the default layout implementation.
- Appender for the interface definition.
- LogEventFactory for the factory function type used to create log events.
-- Layout for the layout used to format log events before sending them to appenders.
-Hierarchy (View Summary)
Implements
Index
Constructors
Hierarchy (View Summary)
Implements
Index
Constructors
Properties
Methods
Constructors
ProtectedconstructorConstructs a new
-AbstractAppenderinstance. Nothing is initialized, because the class only has static properties that are lazy initialized or set by the user.Returns AbstractAppender
Properties
StaticdefaultMethods
ProtectedclearTo ensure when invoking clearInstance in a sub-class it also clear (
-null) the last log event.Returns void
Remarks
Mainly intended for testing purposes. The state of the singleton will be lost. -This method only exist in
-srcfolder, it won't be deployed indistfolder (production).get
Returns LogEvent
The last log event sent by the appender.
-log
Log a message or log event.
+Returns AbstractAppender
Properties
StaticdefaultDefault factory function to create
+LogEventinstances. Used in case it was not set before by the user.Methods
ProtectedclearTo ensure when invoking
+clearInstancemethod in a sub-class it also clears (null) the last log event +sent to the appender.Returns void
Remarks
Mainly intended for testing purposes. The state of the singleton will be lost. +This method is available only in
+srcfolder, it is not deployed indistfolder (production).get
Returns LogEvent
The last log event sent by the appender.
+log
Log a
LogEventor build a log event using a message string with event type, and if present, with extra fields. +It implements both thelogmethods from theAppenderinterface, +since in Typescript doesn't allow you to overload methods with the same name but with different signatures.Parameters
-LogEventor message string.Optionalarg2: LOG_EVENT
+LOG_EVENT, only required ifarg1is a string.Optionalarg2: LOG_EVENTLOG_EVENTtype. Only required ifarg1is a string.Optionalarg3: LogEventExtraFields
-extraFields, only used ifarg1is a string.Returns void
Throws
ScriptError if: --
-arg1is a string butarg2is not provided or is not a validLOG_EVENT. --arg1is not a validLogEvent. -- The log event factory is not set or is not a valid function.Remarks
-- If
+
arg1is a string, it creates a newLogEventusing the provided message and event type.Returns void
Throws
ScriptError if:
++- if the
+
+arg1is a string butarg2is not provided or is not a validLOG_EVENT.arg1is not a string andarg1is not a validLogEvent.Remarks
+- If
- If
- The method uses the static layout to format the log event before sending it to the appenders.
-- The
-- It relays on abstract method
+- The
+- The Template pattern is used, i.e. it implements common logic for logging, but delegates the actual sending of the log event
+to the
arg1is a string, it creates a newLogEventusing the provided message and event type, and if presentsextraFields.arg1is already aLogEvent, it validates the event and sends it directly.arg3parameter is optional and can be used to provide additional fields for the log event.sendEventto send the log event to the appropriate destination.arg3parameter is optional and can be used to provide extra fields to create a log event, ifarg1is a string.sendEventabstract method. Therefore subclasses must implement thesendEventmethod to define how the log event is sent.Example
-ProtectedAbstractsendSend 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.).
+