Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/eggjs/egg-logrotator
Log rotate plugin for egg
https://github.com/eggjs/egg-logrotator
egg-logrotator egg-plugin
Last synced: 4 days ago
JSON representation
Log rotate plugin for egg
- Host: GitHub
- URL: https://github.com/eggjs/egg-logrotator
- Owner: eggjs
- License: mit
- Created: 2016-07-13T01:55:30.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2024-09-28T08:05:55.000Z (about 1 month ago)
- Last Synced: 2024-10-29T21:05:53.553Z (5 days ago)
- Topics: egg-logrotator, egg-plugin
- Language: JavaScript
- Homepage:
- Size: 104 KB
- Stars: 55
- Watchers: 9
- Forks: 14
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: History.md
- License: LICENSE
Awesome Lists containing this project
- awesome-egg - egg-logrotator - 日志切分。   (仓库 / [内置插件](https://eggjs.org/zh-cn/basics/plugin.html#%E6%8F%92%E4%BB%B6%E5%88%97%E8%A1%A8))
README
# egg-logrotator
[![NPM version][npm-image]][npm-url]
[](https://github.com/eggjs/egg-logrotator/actions/workflows/nodejs.yml)
[](https://codecov.io/gh/eggjs/egg-logrotator)
[![npm download][download-image]][download-url]
[npm-image]: https://img.shields.io/npm/v/egg-logrotator.svg?style=flat-square
[npm-url]: https://npmjs.org/package/egg-logrotator
[download-image]: https://img.shields.io/npm/dm/egg-logrotator.svg?style=flat-square
[download-url]: https://npmjs.org/package/egg-logrotator
LogRotator for egg. Rotate all file of `app.loggers` by default
## Install
```bash
npm i egg-logrotator
```
## Usage
- `plugin.js`
```js
exports.logrotator = {
enable: true,
package: 'egg-logrotator',
};
```
- `config.default.js`
```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.
```js
// 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](https://github.com/eggjs/egg/issues).
## License
[MIT](https://github.com/eggjs/egg-logrotator/blob/master/LICENSE)
## Contributors
[](https://github.com/eggjs/egg-logrotator/graphs/contributors)
Made with [contributors-img](https://contrib.rocks).