LumberjackService
Defined in: packages/ngworker/lumberjack/src/lib/logging/lumberjack.service.ts:28
Service with programmatic API to pass logs to Lumberjack. Optionally supports a log payload.
Lumberjack passes the logs to the registered log drivers based on their configurations.
NOTE! Consider extending the LumberjackLogger or ScopedLumberjackLogger
base classes to set up predefined loggers unless you need a programmatic
API.
Type Parameters
Section titled “Type Parameters”TPayload
Section titled “TPayload”TPayload extends LumberjackLogPayload | void = void
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new LumberjackService<
TPayload>():LumberjackService<TPayload>
Defined in: packages/ngworker/lumberjack/src/lib/logging/lumberjack.service.ts:37
Returns
Section titled “Returns”LumberjackService<TPayload>
Methods
Section titled “Methods”log(
lumberjackLog):void
Defined in: packages/ngworker/lumberjack/src/lib/logging/lumberjack.service.ts:49
Pass a log to Lumberjack which will be forwarded to the registered log drivers based on their configurations.
NOTE! It’s recommended to use LumberjackLogBuilder to create the log.
Parameters
Section titled “Parameters”lumberjackLog
Section titled “lumberjackLog”LumberjackLog<TPayload>
The Lumberjack log. Optionally supports a log payload.
Returns
Section titled “Returns”void
logCritical()
Section titled “logCritical()”logCritical(
message,payload?,scope?):void
Defined in: packages/ngworker/lumberjack/src/lib/logging/lumberjack.service.ts:63
Pass a critical log to Lumberjack which will be forwarded to the registered log drivers based on their configurations.
Parameters
Section titled “Parameters”message
Section titled “message”string
Log message, for example describing an event that happened.
payload?
Section titled “payload?”TPayload
An optional payload to add to the log.
scope?
Section titled “scope?”string
An optional scope to add to the LumberjackLog.
Returns
Section titled “Returns”void
logDebug()
Section titled “logDebug()”logDebug(
message,payload?,scope?):void
Defined in: packages/ngworker/lumberjack/src/lib/logging/lumberjack.service.ts:135
Pass a debug log to Lumberjack which will be forwarded to the registered log drivers based on their configurations.
Parameters
Section titled “Parameters”message
Section titled “message”string
Log message, for example describing an event that happened.
payload?
Section titled “payload?”TPayload
An optional payload to add to the log.
scope?
Section titled “scope?”string
An optional scope to add to the LumberjackLog.
Returns
Section titled “Returns”void
logError()
Section titled “logError()”logError(
message,payload?,scope?):void
Defined in: packages/ngworker/lumberjack/src/lib/logging/lumberjack.service.ts:81
Pass an error log to Lumberjack which will be forwarded to the registered log drivers based on their configurations.
Parameters
Section titled “Parameters”message
Section titled “message”string
Log message, for example describing an event that happened.
payload?
Section titled “payload?”TPayload
An optional payload to add to the log.
scope?
Section titled “scope?”string
An optional scope to add to the LumberjackLog.
Returns
Section titled “Returns”void
logInfo()
Section titled “logInfo()”logInfo(
message,payload?,scope?):void
Defined in: packages/ngworker/lumberjack/src/lib/logging/lumberjack.service.ts:117
Pass an info log to Lumberjack which will be forwarded to the registered log drivers based on their configurations.
Parameters
Section titled “Parameters”message
Section titled “message”string
Log message, for example describing an event that happened.
payload?
Section titled “payload?”TPayload
An optional payload to add to the log.
scope?
Section titled “scope?”string
An optional scope to add to the LumberjackLog.
Returns
Section titled “Returns”void
logTrace()
Section titled “logTrace()”logTrace(
message,payload?,scope?):void
Defined in: packages/ngworker/lumberjack/src/lib/logging/lumberjack.service.ts:153
Pass a trace log to Lumberjack which will be forwarded to the registered log drivers based on their configurations.
Parameters
Section titled “Parameters”message
Section titled “message”string
Log message, for example describing an event that happened.
payload?
Section titled “payload?”TPayload
An optional payload to add to the log.
scope?
Section titled “scope?”string
An optional scope to add to the LumberjackLog.
Returns
Section titled “Returns”void
logWarning()
Section titled “logWarning()”logWarning(
message,payload?,scope?):void
Defined in: packages/ngworker/lumberjack/src/lib/logging/lumberjack.service.ts:99
Pass a warning log to Lumberjack which will be forwarded to the registered log drivers based on their configurations.
Parameters
Section titled “Parameters”message
Section titled “message”string
Log message, for example describing an event that happened.
payload?
Section titled “payload?”TPayload
An optional payload to add to the log.
scope?
Section titled “scope?”string
An optional scope to add to the LumberjackLog.
Returns
Section titled “Returns”void