A logger compoment for Baiji

• baiji-logger
  • 1. Menu
  • 2. Installation
  • 3. Usage
  • 4. Description
    • 4.1. classify & rotate
  • 5. Options
    • 5.1. Detail Case
  • 6. TODO list
    • 6.1. Features
  • 7. Contribution Step
  • 8. Run Tests
    • 8.1. Unit Test
    • 8.2. Benchmark Test

NodeJS version >= 10.14.2

yarn add baiji-logger
# OR
npm install baiji-logger -S

See details from ./test/app/index.js

// require
const baiji = require('baiji');
const path = require('path');
const baijiLogger = require('baiji-logger');
// define
const { accessLogger, error, info, debug } = baijiLogger({
  traceKey: 'serviceName',
  baseDir: path.join(__dirname, './logs'),
});
const infoLogger = info();
const errorLogger = error();
const debugLogger = debug();
// use case
const app = baiji('serviceName');
app.use(accessLogger()); // Add accessLogger for routes
// app.use(UsersCtrl); // Use controller
// Start app and listen on port 3000
app.listen(3000, () => infoLogger.info('Port : 3000'));

Based on winstonjs/winston

• warning/verbose/silly , not yet developed

Description

• | option |
• | .filter | means option.filter
• | -filterKeys | means options.filter.filterKeys

• option.filter.recursion not yet developed. Is recursion. In case {"body":{"password":{"a":1}}} , if true will be {"body":{"password":{"a":"*"}}} ; else , will be {"body":{"password":"*"}} .
• option.filter.replaceChat not yet developed. only support String type.

• Ensure number of log file handles < 5
• Developing warning/silly/verbose classify
• Concurrency test
• Improve the efficiency and concurrency of the filter function
• Add stringify option field to use JSON.stringify(message) ; before this , judge params typeof
• Update Options description
• Add Kafka transport config
• Add error email config
• Update trace-id of req , add the key of this app
• Add pretty message & stack show in errorLogger
• Add method for get the trace-id and the trace-key
• Add params to context
• Add config for logger response data

fork https://github.com/baijijs/logger.git
git clone <your own repository>
git branches <your own branch>
git checkout <your own branch>
yarn install -D
... something change
git cz
... step by step add commit with message
git push
pull request

Install development environment module .

yarn install -D

All of the logger test cases are written with Jest. They can be run with npm or yarn.

npm test
# OR
yarn test

Benchmark report log out to ./docs/benchmark.report.log .

Based on bestiejs/benchmark.js

npm run dev-filter
npm run dev-filter-false
npm run benchmark