ac-logger 2.2.3 → 2.3.1

package/.ncurc.js

@@ -0,0 +1,8 @@
+// List packages for minor updates
+const minorUpdatePackages = ['chai']
+
+module.exports = {
+  target: packageName => {
+    return minorUpdatePackages.includes(packageName) ? 'minor' : 'latest'
+  }
+}

package/CHANGELOG.md

@@ -1,3 +1,28 @@
+<a name="2.3.1"></a>
+
+## [2.3.1](https://github.com/admiralcloud/ac-logger/compare/v2.3.0..v2.3.1) (2024-03-10 12:31:44)
+
+
+### Bug Fix
+
+* **App:** Minor improvement for backwards compatibily | MP | [462a6c38269dafccde1f18ffd8a079ac19022269](https://github.com/admiralcloud/ac-logger/commit/462a6c38269dafccde1f18ffd8a079ac19022269)    
+Minor improvement for backwards compatibility  
+Related issues: [undefined/undefined#master](undefined/browse/master)
+<a name="2.3.0"></a>
+ 
+# [2.3.0](https://github.com/admiralcloud/ac-logger/compare/v2.2.3..v2.3.0) (2024-03-10 11:09:52)
+
+
+### Feature
+
+* **App:** Improved application logs | MP | [5d505c148e44045daf40909092542d7e96949f74](https://github.com/admiralcloud/ac-logger/commit/5d505c148e44045daf40909092542d7e96949f74)    
+ac-logger now supports machine readable application logs (if enabled). This way analyzing logs in Cloudwatch (or other apps) will be much easier.  
+Related issues: [undefined/undefined#master](undefined/browse/master)
+### Chores
+
+* **App:** Updated packages | MP | [d2fe6c8ade4f1058e0315c30a8f4c85686f03181](https://github.com/admiralcloud/ac-logger/commit/d2fe6c8ade4f1058e0315c30a8f4c85686f03181)    
+Updated packages  
+Related issues: [undefined/undefined#master](undefined/browse/master)
 <a name="2.2.3"></a>
 
 ## [2.2.3](https://github.com/admiralcloud/ac-logger/compare/v2.2.2..v2.2.3) (2024-01-01 13:10:51)

package/README.md

@@ -14,12 +14,16 @@ const aclog = require('ac-logger')
 const logConfig = {
   prefixFields: [
     { field: 'jobId', short: 'J' },
-  ]
+  ],
+  applicationLogs: {
+    enabled: true // if true, JSON formatted, machine readable application logs will be created into logs directory
+  }
 }
 
 app = {} // 
 app.log = aclog({ prefixFields: logConfig.prefixFields }).acLogger
 
+// DEPRECATED
 let logMeta = {
   fileName: 'UploadS3',
   functionName: 'upload',
@@ -28,6 +32,9 @@ let logMeta = {
 app.log.info('Message for %s', 'some string', { meta: logMeta })
 // -> INFO UploadS3 | upload | J 193 | Message for some string
 
+// MODERN APPROACH (that is best suited for machine and human readability)
+app.log.info('Message for some string', { functionName: 'upload', ... }) // all meta data like "functionName" will be available in application logs
+
 ```
 
 ## Error logging

package/index.js

@@ -1,43 +1,125 @@
 const _ = require('lodash')
 const moment = require('moment')
 const path = require('path')
+const util = require('util')
 
 const { createLogger, format, transports, addColors } = require('winston')
 require('winston-daily-rotate-file')
 
-module.exports = ({ prefixFields = [], timestampFormat = 'YYYY-MM-DD HH:mm:ss', level = (process.env.NODE_ENV === 'production' ? 'info' : 'verbose'), headLength = 80, padLength = 12, customLevels, transporters = [] } = {}) => {
+module.exports = ({ prefixFields = [], timestampFormat = 'YYYY-MM-DD HH:mm:ss', level = (process.env.NODE_ENV === 'production' ? 'info' : 'verbose'), headLength = 80, padLength = 12, customLevels, transporters = [], applicationLogs = { enabled: false } } = {}) => {
   const precisionMap = [
     { precision: 1e6, name: 'ms' },
     { precision: 1e3, name: 'µs' },
     { precision: 1, name: 'ns' },
   ]
 
-  const myFormat = format.printf(({ timestamp, level, message, meta, e }) => {
-    const fileName = _.get(meta, 'fileName') ? _.get(meta, 'fileName') + ' | ' : ''
-    const functionName = _.get(meta, 'functionName') ? _.get(meta, 'functionName') + ' | ' : ''
-    const subName = _.get(meta, 'sub') ? _.get(meta, 'sub') + ' | ' : ''
-
-    let prefix = []
-    let data = []
-    _.forEach(prefixFields, item => {
-      if (_.get(meta, _.get(item, 'field'))) {
-        prefix.push(_.get(item, 'short'))
-        data.push(_.get(meta, _.get(item, 'field')))
-      }  
-    })
-    const prefixData = _.size(prefix) ? (_.join(prefix, '/') + ' ' + _.join(data, '/') + ' | ') : ''
-    if (e instanceof Error) {
-      // log the stack
-      console.error(e)
-      if (_.get(e, 'message')) message += ' | ' + _.get(e, 'message', '')
+  const splatFormatter = format((data) => {
+    // Check if splat is available and the message contains placeholder(s)
+    if (data[Symbol.for('splat')] && /%[sjdifoO%]/.test(data.message)) {
+      data.message = util.format(data.message, ...data[Symbol.for('splat')])
+    }
+    return data
+  })
+
+  const myFormat = format.printf((data) => {
+    const level = data[Symbol.for('level')]
+    // http log format
+    if (level === 'http' && data?.controller) {
+      // display accessKey, link (if applicable)
+      let message = data?.message ? ` ${data.message}` : ''
+      let cuid = data?.customerId ? data?.customerId : ''
+      if (data?.userId) cuid += `/${data.userId} `
+      return `${data?.timestamp} ${data?.level} ${data?.ip} ${data?.iso2 || ''} ${data?.accessKey || ''} ${cuid}${data?.controller} ${data?.action}${message} | ${data?.statusCode} | ${data?.performance?.executionTime}ms`
+    }
+    else {
+      const meta = data?.meta
+      // 
+      let fileName = _.get(meta, 'fileName') ? _.get(meta, 'fileName') + ' | ' : ''
+      let functionName = _.get(meta, 'functionName') ? _.get(meta, 'functionName') + ' | ' : _.get(data, 'functionName') ? _.get(data, 'functionName') + ' | ' : ''
+      let subName = _.get(meta, 'sub') ? _.get(meta, 'sub') + ' | ' : _.get(data, 'sub') ? _.get(data, 'sub') + ' | ' : ''
+      
+      // modern approach (fileName, functionName, sub) // TBD with team
+      let functionIdentifier =  _.get(data, 'functionIdentifier') ? _.get(data, 'functionIdentifier') + ' | ' : ''
+      if (!fileName && _.get(data, 'fileName')) fileName =  _.get(data, 'fileName')
+      if (!functionName && _.get(data, 'functionName')) functionName =  _.get(data, 'functionName')
+      if (!subName && _.get(data, 'sub')) subName =  _.get(data, 'sub')
+
+      
+      let message = data?.message
+
+  
+      let prefix = []
+      let dataFromPrefix = []
+      _.forEach(prefixFields, item => {
+        if (_.get(meta, _.get(item, 'field'))) {
+          prefix.push(_.get(item, 'short'))
+          dataFromPrefix.push(_.get(meta, _.get(item, 'field')))
+        }  
+      })
+      const prefixData = _.size(prefix) ? (_.join(prefix, '/') + ' ' + _.join(dataFromPrefix, '/') + ' | ') : ''
+      if (data?.e instanceof Error) {
+        // log the stack
+        console.error(data?.e)
+        if (data?.e?.message) message += ' | ' + ( data?.e?.message  || '')
+      }
+      // TODO: for better readability, we shold use padding for fileName, functionname, etc
+      return `${data?.timestamp} ${data?.level} ${fileName}${functionName}${functionIdentifier}${subName}${prefixData}${message}`
     }
-    return `${timestamp} ${level} ${fileName}${functionName}${subName}${prefixData}${message}`
   })
 
+
   const logTransports = []
   if (!_.size(transporters)) {
     // default behaviour
-    logTransports.push(new transports.Console())
+    // human-readable console output
+    logTransports.push(new transports.Console({
+      format: format.combine(
+        format.timestamp({
+          format: timestampFormat
+        }),
+        format.errors({ stack: true }),
+        format(info => {
+          info.level = _.padEnd(info.level.toUpperCase(), 8)
+          return info
+        })(),
+        format.colorize(),
+        splatFormatter(),
+        myFormat
+      ),
+    }))
+
+    // structured logging for analysis and querying within the CloudWatch service.
+    if (applicationLogs?.enabled) {
+      let filename = applicationLogs?.filename || 'application.log'
+      if (filename.endsWith('.log')) {
+        // If the filename ends with .log, insert -%DATE% before the extension
+        filename = filename.replace(/\.log$/, '-%DATE%.log');
+      } 
+      else {
+        // If the filename doesn't end with .log, append -%DATE%.log
+        filename = `${filename}-%DATE%.log`;
+      }
+
+      const transport = new transports.DailyRotateFile({
+        filename,
+        datePattern: 'YYYY-MM-DD',
+        zippedArchive: true, // Enable gzip compression for rotated files
+        maxSize: applicationLogs?.maxSize || '100m', // Rotate the file when it reaches 20MB
+        maxFiles: applicationLogs?.maxFiles || '7d', // Keep rotated files for 7 days
+        dirname: applicationLogs?.firname || './logs', // Specify the directory for log files
+        format: format.combine(
+          format.timestamp(),
+          splatFormatter(),
+          format.json()
+        )
+      })
+
+      transport.on('error', error => {
+        acLogger.error('ac-logger | ApplicationLogs | TransportError | %j', error?.message)
+      })
+      logTransports.push(transport)
+    }
+
     if (process.env.NODE_ENV === 'test') {
       logTransports.push(new transports.File({
         filename: 'test.log',
@@ -55,19 +137,6 @@ module.exports = ({ prefixFields = [], timestampFormat = 'YYYY-MM-DD HH:mm:ss',
 
   const logConfig = {
     level,
-    format: format.combine(
-      format.timestamp({
-        format: timestampFormat
-      }),
-      format.errors({ stack: true }),
-      format(info => {
-        info.level = _.padEnd(info.level.toUpperCase(), 8)
-        return info
-      })(),
-      format.colorize(),
-      format.splat(),
-      myFormat
-    ),
     transports: logTransports
   }
   if (_.get(customLevels, 'levels')) _.set(logConfig, 'levels', _.get(customLevels, 'levels'))
@@ -76,6 +145,7 @@ module.exports = ({ prefixFields = [], timestampFormat = 'YYYY-MM-DD HH:mm:ss',
   if (_.get(customLevels, 'colors')) addColors(_.get(customLevels, 'colors'))
   
 
+
   const headline = (params) => {
     acLogger.info('')
     const fill = _.get(params, 'headFill', '*')

package/package.json

@@ -3,19 +3,19 @@
   "author": "Mark Poepping (https://www.admiralcloud.com)",
   "license": "MIT",
   "repository": "admiralcloud/ac-logger",
-  "version": "2.2.3",
+  "version": "2.3.1",
   "dependencies": {
     "lodash": "^4.17.21",
     "moment": "^2.30.1",
-    "winston": "^3.11.0",
-    "winston-daily-rotate-file": "^4.7.1"
+    "winston": "^3.12.0",
+    "winston-daily-rotate-file": "^5.0.0"
   },
   "devDependencies": {
     "ac-semantic-release": "^0.4.2",
-    "chai": "^4.3.10",
-    "eslint": "^8.56.0",
+    "chai": "^4.4.1",
+    "eslint": "^8.57.0",
     "intercept-stdout": "^0.1.2",
-    "mocha": "^10.2.0",
+    "mocha": "^10.3.0",
     "mocha-jenkins-reporter": "^0.4.8"
   },
   "scripts": {