egg-logrotator

egg-logrotator

LogRotator for egg. Rotate all file of app.loggers by default

Install

$ npm i egg-logrotator

Usage

• plugin.js

exports.logrotator = {
  enable: true,
  package: 'egg-logrotator',
};

• config.default.js

// if any files need rotate by file size, config here
exports.logrotator = {
  filesRotateByHour: [],           // list of files that will be rotated by hour
  hourDelimiter: '-',              // rotate the file by hour use specified delimiter
  filesRotateBySize: [],           // list of files that will be rotated by size
  maxFileSize: 50 * 1024 * 1024,   // Max file size to judge if any file need rotate
  maxFiles: 10,                    // pieces rotate by size
  rotateDuration: 60000,           // time interval to judge if any file need rotate
  maxDays: 31,                     // keep max days log files, default is `31`. Set `0` to keep all logs
};

Feature

By default, LogRotator will rotate all files of app.loggers at 00:00 everyday, the format is .log.YYYY-MM-DD (egg-web.log.2016-09-30).

By Size

Rotate by size with config filesRotateBySize. when the file size is greater than maxFileSize, it will rename to .log.1.

If the file you renamed to is exists, it will increment by 1 (.log.1 -> .log.2), until maxFiles. if it reaches the maxFiles, then overwrite .log.${maxFiles}.

Files in filesRotateBySize won't be rotated by day.

If file is relative path, then will normalize to path.join(this.app.config.logger.dir, file).

By Hour

Rotate by hour with config filesRotateByHour. rotate the file at 00 every hour, the format is .log.YYYY-MM-DD-HH.

Files in filesRotateByHour won't be rotated by day.

If file is relative path, then will normalize to path.join(this.app.config.logger.dir, file).

Customize

You can use app.LogRotator to customize.

// app/schedule/custom.js
module.exports = app => {
  const rotator = getRotator(app);
  return {
    // https://github.com/eggjs/egg-schedule
    schedule: {
      type: 'worker', // only one worker run this task
      cron: '10 * * * *', // custom cron, or use interval
    },
    async task() {
      await rotator.rotate();
    }
  };
};

function getRotator(app) {
  class CustomRotator extends app.LogRotator {
    // return map that contains a pair of srcPath and targetPath
    // LogRotator will rename ksrcPath to targetPath
    async getRotateFiles() {
      const files = new Map();
      const srcPath = '/home/admin/foo.log';
      const targetPath = '/home/admin/foo.log.2016.09.30';
      files.set(srcPath, { srcPath, targetPath });
      return files;
    }
  }
  return new CustomRotator({ app });
}

Define a method called getRotateFiles, return a map contains a pair of srcPath and targetPath.

Questions & Suggestions

Please open an issue here.

License

MIT

Changelog

3.2.0 (2024-09-28)

Features

• remove debug deps (#32) (e897d48)

Bug Fixes

• hour crontab (#31) (75e4787)

---

3.1.0 / 2019-04-25

features

• [cd39697] - feat: support relative path (#26) (TZ | 天猪 <[e-mail]>)

3.0.7 / 2019-03-14

fixes

• [4c1632b] - fix: all rotator should use transport file (#25) (Hongcai Deng <[e-mail]>)

3.0.6 / 2019-03-06

fixes

• [4f52df7] - fix: clean log should use transport options file (#24) (Hongcai Deng <[e-mail]>)

3.0.5 / 2018-12-04

fixes

• [3371e60] - fix: allow 2 minutes deviation on schedule cron (#22) (fengmk2 <[e-mail]>)

3.0.4 / 2018-10-24

fixes

• [9c0f71f] - fix: ignore not exists logdir (#21) (fengmk2 <[e-mail]>)
• [3c8786d] - fix: in for in loop add hasOwnProperty filter (#20) (AllenZeng <[e-mail]>)

3.0.3 / 2018-03-29

• fix: custom LogRotator error (#18)

3.0.2 / 2018-02-23

fixes

• [7211181] - fix: support json files (#17) (Haoliang Gao <[e-mail]>)

3.0.1 / 2017-12-11

fixes

• [922824b] - fix: split file at 00:00:01 && update deps (#15) (TZ | 天猪 <[e-mail]>)

3.0.0 / 2017-11-10

others

• [6b4e6e5] - refactor: use async function and support egg@2 (#13) (Yiyu He <[e-mail]>)

2.3.0 / 2017-11-02

features

• [bd3c95f] - feat: support custom hour delimiter (#12) (hui <[e-mail]>)

others

• [5e6c563] - test: upgrade dependencies (#11) (Haoliang Gao <[e-mail]>)

2.2.3 / 2017-06-04

• docs: fix License url (#10)
• chore: upgrade deps and fix test (#9)

2.2.2 / 2016-10-27

• fix: should rotate agent log (#8)

2.2.1 / 2016-10-27

• fix: check directory exist before readdir (#7)

2.2.0 / 2016-09-29

• refactor: use OO refactor schedule (#6)

2.1.0 / 2016-08-29

• feat: reload loggers after rotating (#5)

2.0.0 / 2016-08-17

• feat: rename logrotater => logrotator (#4)

1.0.1 / 2016-08-10

• fix: auto find log file dirs to do rotate (#2)

1.0.0 / 2016-07-26

• feat: auto remove expired files (#1)
• init commit by egg-init