Skip to content

Latest commit

 

History

History
124 lines (85 loc) · 3.7 KB

README.md

File metadata and controls

124 lines (85 loc) · 3.7 KB
Raw

aio-lib-core-logging

Version Downloads/week Node.js CI License Codecov Coverage

Node.js Logger module for use by the Adobe I/O SDK

Install

npm install @adobe/aio-lib-core-logging

Use

let aioLogger = require('@adobe/aio-lib-core-logging')('App')
aioLogger.info('Hello logs')

Output

Above code will log the following

[App /mynamespace/myaction] info: Hello logs

Where App would be the name of the application/module that is sending the logs.

Configuration

The logger can be customized by passing a config object at the time of creation.

let aioLogger = require('@adobe/aio-lib-core-logging')('App', config)

The config object can have one or more of the following keys.

  • level (max severity logging level to be logged. can be one of error, warn, info, verbose, debug, silly)
  • provider (logging provider. default is winston.)
  • logSourceAction (boolean to control whether to include the action name in the log message)
  • transports (array of custom winston transports)

The global log level can also be overridden using the env variable AIO_LOG_LEVEL or the env variable LOG_LEVEL.

Enabling Debug Level Logging on command line

Avoid setting the global env variable by passing the log configuration in front of the aio command and stax flexibel.

To see all logs, do

$ DEBUG=* aio app run

Once you have figured out what logs you are interrested in, use something more specific, like

$ DEBUG=aio-telemetry:telemetry-lib* aio config

Enabling Debug Level Logging programatically

Example of logger configuration:

const logger = require('@adobe/aio-lib-core-logging')('MyModuleName', {provider: 'debug'})
logger.info('info')
logger.debug('debug')

To see both logs:

AIO_LOG_LEVEL = debug
DEBUG = MyModuleName

It is possible to set the log level from another environment variable if needed:

const logger = require('@adobe/aio-lib-core-logging')('MyModuleName', {provider: 'debug', level: process.env.FOOBAR})
logger.info('info')
logger.debug('debug')

Using custom logger

// Winston Logger
let aioLogger = require('@adobe/aio-lib-core-logging')('App', {provider:'winston'})
aioLogger.info('Hello logs')

or

// Debug Logger
let aioLogger = require('@adobe/aio-lib-core-logging')('App', {provider:'debug'})

Send logs to a file

let aioLogger = require('@adobe/aio-lib-core-logging')('App', {transports: './logfile.txt' })

Custom winston transports

const winston = require('winston')
let aioLogger = require('@adobe/aio-lib-core-logging')('App', {transports: [new winston.transports.File({ filename: './winstoncustomfilelog.txt' })]})

Creating custom logger

This is currently as simple as creating a new logger class under src with all the log level functions defined

Explore

goto API

Contributing

Contributions are welcomed! Read the Contributing Guide for more information.

Licensing

This project is licensed under the Apache V2 License. See LICENSE for more information.