1.1.5 • Published 3 months ago
@nooks-ai/nooks-logger v1.1.5
Classes
Logger
new Logger(serviceName, options)
Creates a JSON Logger for Node Applications
| Param | Type | Description |
|---|---|---|
| serviceName | String | Name of the service or application. |
| options | Object | Configuration options. |
| options.level | String | Minimum level logged. Static fields are provided for convenience: Logger.DEBUG, Logger.INFO, Logger.WARN, Logger.ERROR, and Logger.FATAL. Defaults to Logger.INFO. |
| options.metadata | Object | Initial fields to include with every log from logger instance |
logger.debug(message, data)
Writes a debug JSON log to the console.
| Param | Type | Description |
|---|---|---|
| message | string | log message. |
| metadata | Object | extra metadata associated with the log. |
logger.info(message, data)
Writes an info JSON log to the console.
| Param | Type | Description |
|---|---|---|
| message | string | log message. |
| metadata | Object | extra metadata associated with the log. |
logger.warn(message, data)
Writes a warning JSON log to the console.
| Param | Type | Description |
|---|---|---|
| message | string | log message. |
| metadata | Object | extra metadata associated with the log. |
logger.error(message, data)
Writes an error JSON log to the console.
| Param | Type | Description |
|---|---|---|
| message | string | log message. |
| metadata | Object | extra metadata associated with the log. |
logger.fatal(message, data)
Writes a fatal JSON log to the console.
| Param | Type | Description |
|---|---|---|
| message | string | log message. |
| metadata | Object | extra metadata associated with the log. |
logger.err(error) ⇒ Logger
Creates a new logger with the error field set at root to be serialized
nicely.
Returns: Logger - returns child logger to log a unit of work.
| Param | Type | Description |
|---|---|---|
| error | Error | a javascript Error. |
logger.data(data) ⇒ Logger
Chainable command to define extra metadata to be included in all subsequent logs.
Returns: Logger - returns child logger that will include extra metadata in all subsequent logs.
| Param | Type | Description |
|---|---|---|
| data | Object | top-level data to add to logs. |