Expected Behaviour

Have an equivalent to console.time() and console.timeEnd() logging, to provide rough timing of internal functions.

Actual Behaviour

logger.time() is not a function.

Reproduce Scenario (including but not limited to)

Inside an App Builder action, add a timing function.

Steps to Reproduce

Platform and Version

Sample Code that illustrates the problem

Logs taken while reproducing problem

The devDependency codecov was updated from 3.6.4 to 3.6.5.

🚨 View failing branch.

This version is covered by your current version range and after updating it in your project the build failed.

codecov is a devDependency of this project. It might not break your production code or affect downstream projects, but probably breaks your build or test tools, which may prevent deploying or publishing.

Your Greenkeeper Bot 🌴

It would seem obvious that a logger should have a log method, but our logger does not. We should alias log to the info log level.

(caused issues like this adobe/aio-cli-plugin-app#341)

currently logging an Error with the debug doesn't log the stack trace while console does.
Should we support this?

https://jamesthom.as/2017/11/openwhisk-logstash-forwarder/

Expected Behaviour

To help with debugging and building actions, a console.table() equivalent for logger would be preferential. This would allow for Arrays and Objects to be passed and output as a table in the various log locations.

Actual Behaviour

Currently not available (or not documented?), have to us logger.info/debug/etc and output a string.

Reproduce Scenario (including but not limited to)

N/A

Steps to Reproduce

N/A

Platform and Version

v2.0.0

Sample Code that illustrates the problem

N/A

Logs taken while reproducing problem

N/A

Description

Right now you have to set the log level via the constructor like so:

const aioLogger = require('@adobe/aio-lib-core-logging')('App', { level: 'info' })

function main (params) {
     // you can't set the log level here, it is already fixed to `info` above
    // thus .debug won't output anything
     aioLogger.debug('this will not output anything')
}

Proposed setLogLevel feature

const aioLogger = require('@adobe/aio-lib-core-logging')('App')

function main (params) {
    // the log level is by default `info` and you can't change it after construction,
    // unless you add this feature like so
    aioLogger.setLogLevel(params.LOG_LEVEL)
   // if params.LOG_LEVEL was 'debug', now debug logs will show in the output
   aioLogger.debug('this will output if params.LOG_LEVEL is debug')
}

Workaround

The workaround is to create the logger with the log level, in your function scope.

const coreLogger = require('@adobe/aio-lib-core-logging')

function main (params) {
    const  aioLogger = coreLogger('App', { level: params.LOG_LEVEL })
   // if params.LOG_LEVEL was 'debug', debug logs will show in the output
    aioLogger.debug('this will output if params.LOG_LEVEL is debug')
}

The devDependency eslint-plugin-jest was updated from 23.6.0 to 23.7.0.

🚨 View failing branch.

This version is covered by your current version range and after updating it in your project the build failed.

eslint-plugin-jest is a devDependency of this project. It might not break your production code or affect downstream projects, but probably breaks your build or test tools, which may prevent deploying or publishing.

Your Greenkeeper Bot 🌴

Pino

Pino is a lightweight logging library which is ideal for serverless logging.
It is a good candidate to replace winston-logger and debug providers

• Pino streams logs in NDJSON (Line delimited JSON) to standard output
• Pino core does not include transports, does not support in process transport
• Pino core does not include custom formating, only logs in JSON
• Pino API is similar/compatible with winston

Additional features

• Child loggers
• Redact
• Async logging

Pino plugins

• Pino Pretty
• Pino Debug

Aio Core Logger Features

• multiple logger types
• write to file
• custom formats

In my runtime action code, I am doing this:

const aioLogger = require('@adobe/aio-lib-core-logging')('@adobe/aio-app-myapps/resolver', { provider: 'debug', level: 'debug' })
...
// and later
aioLogger.debug('resolver got a request')

When I look at the logs, I see this:

2020-03-10T22:35:04.802Z       stdout: 2020-03-10T22:35:04.802Z @adobe/aio-app-myapps/resolver:debug  resolver got a request

With the double time stamp, plus the stream name, plus a verbose debug namespace, there are 100 char before the message.

Expected Behaviour

test.js:

const logger = require('@adobe/aio-lib-core-logging')('myapp', { provider: './DebugLogger' })
logger.debug('yo!')

DEBUG=myapp node test.js => should print yo!

Actual Behaviour

Need to add a * to the DEBUG env var
DEBUG=myapp* node test.js => prints yo!

This is because the debug label is extended with action name and log level

suggestion: preserve the user given debug key but add a string prefix to each log message

Proposal to remove debug logger as the default log provider and use winston logger.

Core logger

• Custom Formatter support
  • Logging in JSON
  • Eternal Log viewers
• Customise transports
• Log levels
• Switch log levels with env variables

debug logger

• Debug logger uses a global DEBUG env variable to define log level and it cannot be over ridden by the aio library.
• The environment variable takes precedence over AIO_LOG_LEVEL
• Logs from 3rd party dependencies will also be logged when using this env variable

Winston

• Use winston as the only log provider
• Expose more winston configs via the aio core logger
• Dependency size

Other Loggers

Bunyan

• API Similar to winston
• Serializers can be complicated
• Supports multiple streams
• Child loggers

Pino

• Light weight and fast
• asynchronous logging
• separate thread for transports
• No support for transports, file and stdout supported
• Logs only in JSON
• additional modules for compatibility
• custom log levels
• good documentation (https://getpino.io)
• pino debug (https://github.com/pinojs/pino-debug)
• no log rotation (use plugin)
• pino-http
• http benchmark

If you choose the winston log provider, it adds a timestamp by default. Add an option in the config to not show the timestamp, and also the ability to turn on/off timestamp after initialization.

Proposed

// init winston logger (timestamp is true by default for backwards compat)
const aioLogger = require('@adobe/aio-lib-core-logging')('App', {provider:'winston', timestamp: false })
// turn on the timestamp later 
aioLogger.config.timestamp = true // use a setter

See example adobe/aio-lib-core-config@2b41d81

1. package.json scripts
2. jsconfig.json
3. files key in package.json (if used)

(Fix JSDoc issues)

console.log(obj1 [, obj2, ..., objN])

console.log outputs a hson representation of each object passed to it.

console.log('resolver got request: ', request)
aioLogger.debug('resolver got request: ', request)

// console.log output:
2020-03-10T23:00:56.312Z       stdout: resolver got request:  { org: 'asdsomeorg@AdobeOrg',
  path: '/',
  clientId: 'aio-app-myapple',
  tenant: '3124',
  imsProfile: ...
  ...
}
// aioLogger.debug output:
2020-03-10T23:00:56.313Z       stdout: 2020-03-10T23:00:56.312Z @adobe/aio-app-myapps/resolver:debug resolver got request:

Wdyt?