Exports

Default

The default export is getLogger.

Within transpiled dist/ version, the default export is available as oddlog.default.

Constants

stdTransformer

See transformers.

levels

The exported attribute levels has a key-value mapping from lowercase level name to the number value. In addition an uppercase attribute for each level is exported directly as well:

SILENT = 0
TRACE = 1
DEBUG = 2
VERBOSE = 3
INFO = 4
WARN = 5
ERROR = 6
FATAL = 7

Functions

createLogger

Creates a new logger based on passed options.

ParameterTypeDescription
nameStringThe name of the logger (also used as store key for getLogger).
optionsObjectoptional. Any options for the logger (see below).
payload?Objectoptional. Payload for all logs of this logger and its children.

The options parameter may provide the following attributes:

OptionTypeDescription
transports(?Object)[]default: [{type:"stream"}] - A list of options to derive transports of. Each entry creates one Transport.
transformer!Objectdefault: stdTransformer - Transformer mapping to apply to log payloads.
ownPayloadBooleandefault: false - Whether the given payload may be modified by the Logger.
ownChildPayloadsBooleandefault: false - Set the default for ownPayload of child and logging methods.
singleTransformBooleandefault: true - Whether transformations shall only be executed at log level. If set to false the inherited payloads will be transformed before caching. This can speed up the logging (especially for computational complex transformers), but will freeze the value of inherited payload for all its logs.
meta?Objectdefault: [platform,host,pid] - Static meta information to add to logs. The default values are os.release(), os.hostname() and process.pid. Set to null to disable meta information.
typeKey?Stringdefault: "_type" - The key to use for a payloads (nested) type identifications. Supported types by the log reader can be specified within any payload data at this key.
logSourceBooleandefault: false - Whether to add the source code location of the logging method caller to log records.
messageFormatter?{String}Function<String,?Object|String...>default: util.format - The formatting function to use for log messages.
levelNumber,Stringdefault: INFO - The initial level for the stateful logging methods.
shyBooleandefault: false - If true, transport fallback level will be WARN instead of DEBUG and stream transport fallback format will be "simple" instead of "raw".

Returns: A new Logger instance.

defineLogger

Creates a new logger based on passed options and stores it within the logger store.

The arguments can be either of the two signatures below:

ParameterTypeDescription
nameStringThe name of the logger (also used as store key for getLogger).
optionsObjectoptional. Any options for the logger (see createLogger above).
payload?Objectoptional. Payload for all logs of this logger and its children.
ParameterTypeDescription
keyStringdefault: logger.loggerScope.name - The store key for getLogger.
loggerLoggerThe logger to store; to be retrieved by getLogger(key).

Returns: The Logger that is being defined.

getLogger

Retrieves a logger previously defined via defineLogger.

ParameterTypeDescription
nameStringThe name of the logger to retrieve from store.
...If additional arguments are provided, a child logger will be created and returned; additional arguments are passed to Logger#child.

Returns: The Logger stored at the provided name.

createTransport

ParameterTypeDescription
optionsObjectThe options for the Transport. If a type attribute is set, it will be used to determine the Transport type.

Returns: The new Transport instance.

defineType

ParameterTypeDescription
keyStringThe identifier of the type (as to be used within transport definition type attribute).
createFn{Transport} Function(options, createTransport)The creation function for new transports of this type. Is called without new keyword and gets passed the options as well as a function that creates transports from options.
overwriteBooleandefault: false - Whether to overwrite already existing transport type with the same key.

Returns:undefined

eachScopeOnce

ParameterTypeDescription
loggersLogger[]The loggers whose logger-scopes to listen on. Note: Their logger-scopes are assumed to be disjoint.
eventStringThe event to listen for.
cbFunction<>The event callback. Called once by each logger-scope.

Returns:undefined

closeAll

ParameterTypeDescription
failSilentBooleandefault: true - Whether to silently ignore future incoming logs; throw Error otherwise.
loggersLogger[]The loggers to close.
cbFunction<>Gets called when all logs have been flushed.

Returns:undefined

mixin

ParameterTypeDescription
oddlogexports of this packageThe oddlog package for which the plugin(s) should be initialized.
pluginsFunction|{init:Function}|ArrayThe plugin(s) to mix into this package.

Returns:undefined

Utilities

assign

ParameterTypeDescription
targetObjectThe target.
sourcesObject...The sources.

Returns:target

clone

ParameterTypeDescription
obj?Object|*The source.

Returns:?Object|* - The clone.

cloneDeep,

ParameterTypeDescription
obj?Object|*The source.

Returns:?Object|* - The clone.

Classes

Transports

The following transport classes are exported:

Last Updated: 7/28/2018, 1:40:09 PM