@eggjs/logrotator 4.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2016-present Alibaba Group Holding Limited and other contributors.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,123 @@
+# @eggjs/logrotator
+
+[![NPM version][npm-image]][npm-url]
+[![CI](https://github.com/eggjs/logrotator/actions/workflows/nodejs.yml/badge.svg)](https://github.com/eggjs/logrotator/actions/workflows/nodejs.yml)
+[![Test coverage](https://img.shields.io/codecov/c/github/eggjs/logrotator.svg?style=flat-square)](https://codecov.io/gh/eggjs/logrotator)
+[![npm download][download-image]][download-url]
+[![Node.js Version](https://img.shields.io/node/v/@eggjs/logrotator.svg?style=flat)](https://nodejs.org/en/download/)
+[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](https://makeapullrequest.com)
+![CodeRabbit Pull Request Reviews](https://img.shields.io/coderabbit/prs/github/eggjs/security)
+
+[npm-image]: https://img.shields.io/npm/v/@eggjs/logrotator.svg?style=flat-square
+[npm-url]: https://npmjs.org/package/@eggjs/logrotator
+[download-image]: https://img.shields.io/npm/dm/@eggjs/logrotator.svg?style=flat-square
+[download-url]: https://npmjs.org/package/@eggjs/logrotator
+
+LogRotator for egg. Rotate all file of `app.loggers` by default
+
+## Install
+
+```bash
+npm i @eggjs/logrotator
+```
+
+## Usage
+
+- `plugin.js`
+
+```js
+exports.logrotator = {
+  enable: true,
+  package: '@eggjs/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
+  gzip:false,                      // use gzip compress logger on rotate file, default is `false`. Set `true` to enable
+};
+```
+
+## 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](LICENSE)
+
+## Contributors
+
+[![Contributors](https://contrib.rocks/image?repo=eggjs/logrotator)](https://github.com/eggjs/logrotator/graphs/contributors)
+
+Made with [contributors-img](https://contrib.rocks).

package/README.zh-CN.md

@@ -0,0 +1,115 @@
+# @eggjs/logrotator
+
+[![NPM version][npm-image]][npm-url]
+[![CI](https://github.com/eggjs/logrotator/actions/workflows/nodejs.yml/badge.svg)](https://github.com/eggjs/logrotator/actions/workflows/nodejs.yml)
+[![Test coverage](https://img.shields.io/codecov/c/github/eggjs/logrotator.svg?style=flat-square)](https://codecov.io/gh/eggjs/logrotator)
+[![npm download][download-image]][download-url]
+[![Node.js Version](https://img.shields.io/node/v/@eggjs/logrotator.svg?style=flat)](https://nodejs.org/en/download/)
+[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](https://makeapullrequest.com)
+![CodeRabbit Pull Request Reviews](https://img.shields.io/coderabbit/prs/github/eggjs/security)
+
+[npm-image]: https://img.shields.io/npm/v/@eggjs/logrotator.svg?style=flat-square
+[npm-url]: https://npmjs.org/package/@eggjs/logrotator
+[download-image]: https://img.shields.io/npm/dm/@eggjs/logrotator.svg?style=flat-square
+[download-url]: https://npmjs.org/package/@eggjs/logrotator
+
+egg 的日志切割插件，默认会按照时间切割所有的 app.loggers。
+
+## 配置
+
+- `plugin.js`
+
+```js
+exports.logrotator = true;
+```
+
+- `config.default.js`
+
+```js
+// 如果有需要按照文件大小切割的日志，在这里配置
+exports.logrotator = {
+  filesRotateByHour: [],           // 需要按小时切割的文件
+  hourDelimiter: '-',              // 按照小时切割的文件, 小时部分的分隔符.
+  filesRotateBySize: [],           // 需要按大小切割的文件，其他日志文件仍按照通常方式切割
+  maxFileSize: 50 * 1024 * 1024,   // 最大文件大小，默认为50m
+  maxFiles: 10,                    // 按大小切割时，文件最大切割的份数
+  rotateDuration: 60000,           // 按大小切割时，文件扫描的间隔时间
+  maxDays: 31,                     // 日志保留最久天数
+};
+```
+
+## 功能说明
+
+logrotator 默认在每日0点按照时间切割，会将 app.loggers 下所有的 logger 都进行切割，格式为 `.log.YYYY-MM-DD`，如 `egg-web.log.2016-09-30`。
+
+### 按大小切割
+
+可以配置 `filesRotateBySize` 文件列表按大小切割，当文件大于 `maxFileSize` 时进行切割，格式为 `.log.1`。
+
+当已有切割文件时会将原文件自增 1，如 `.log.1` -> `.log.2`。当切割分数大于 `maxFiles` 时会覆盖最后一份。
+
+配置了这个功能的文件不会再按默认切割。
+
+如配置为相对路径，则默认会转换为 `path.join(this.app.config.logger.dir, file)`。
+
+### 按小时切割
+
+可以配置 `filesRotateBySize` 文件列表按小时切割，每小时0分开始切割，格式为 `.log.YYYY-MM-DD-HH`。
+
+配置了这个功能的文件不会再按默认切割。
+
+如配置为相对路径，则默认会转换为 `path.join(this.app.config.logger.dir, file)`。
+
+## 自定义
+
+你可以使用 `app.LogRotator` 来自定义切割。
+
+```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
+    },
+    * task() {
+      yield rotator.rotate();
+    }
+  };
+};
+
+function getRotator(app) {
+  class CustomRotator extends app.LogRotator {
+    // return map that contains a pair of srcPath and targetPath
+    // LogRotator will rename srcPath to targetPath
+    // 返回一个 map，其中包含 srcPath 和 targetPath，
+    // LogRotator 会将 srcPath 重命名成 targetPath
+    * 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 });
+}
+```
+
+你只需要定义一个 getRotateFiles 方法，指定重命名的 map。
+
+## Questions & Suggestions
+
+Please open an issue [here](https://github.com/eggjs/egg/issues).
+
+## License
+
+[MIT](LICENSE)
+
+## Contributors
+
+[![Contributors](https://contrib.rocks/image?repo=eggjs/logrotator)](https://github.com/eggjs/logrotator/graphs/contributors)
+
+Made with [contributors-img](https://contrib.rocks).

package/dist/commonjs/agent.d.ts

@@ -0,0 +1,2 @@
+import { Boot } from './boot.js';
+export default Boot;

package/dist/commonjs/agent.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const boot_js_1 = require("./boot.js");
+exports.default = boot_js_1.Boot;
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiYWdlbnQuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvYWdlbnQudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7QUFBQSx1Q0FBaUM7QUFFakMsa0JBQWUsY0FBSSxDQUFDIn0=

package/dist/commonjs/app/extend/agent.d.ts

@@ -0,0 +1,5 @@
+import { LogRotator } from '../../lib/rotator.js';
+declare const _default: {
+    LogRotator: typeof LogRotator;
+};
+export default _default;

package/dist/commonjs/app/extend/agent.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const rotator_js_1 = require("../../lib/rotator.js");
+// egg-schedule will load both at app and agent, so we should mount it for compatible
+exports.default = {
+    LogRotator: rotator_js_1.LogRotator,
+};
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiYWdlbnQuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi8uLi9zcmMvYXBwL2V4dGVuZC9hZ2VudC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOztBQUFBLHFEQUFrRDtBQUVsRCxxRkFBcUY7QUFDckYsa0JBQWU7SUFDYixVQUFVLEVBQVYsdUJBQVU7Q0FDWCxDQUFDIn0=

package/dist/commonjs/app/extend/application.d.ts

@@ -0,0 +1,5 @@
+import { LogRotator } from '../../lib/rotator.js';
+declare const _default: {
+    LogRotator: typeof LogRotator;
+};
+export default _default;

package/dist/commonjs/app/extend/application.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const rotator_js_1 = require("../../lib/rotator.js");
+exports.default = {
+    LogRotator: rotator_js_1.LogRotator,
+};
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiYXBwbGljYXRpb24uanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi8uLi9zcmMvYXBwL2V4dGVuZC9hcHBsaWNhdGlvbi50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOztBQUFBLHFEQUFrRDtBQUVsRCxrQkFBZTtJQUNiLFVBQVUsRUFBVix1QkFBVTtDQUNYLENBQUMifQ==

package/dist/commonjs/app/schedule/clean_log.d.ts

@@ -0,0 +1,9 @@
+import { EggCore } from '@eggjs/core';
+declare const _default: (app: EggCore) => {
+    schedule: {
+        type: string;
+        cron: string;
+    };
+    task(): Promise<void>;
+};
+export default _default;

package/dist/commonjs/app/schedule/clean_log.js

@@ -0,0 +1,74 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const node_path_1 = __importDefault(require("node:path"));
+const promises_1 = __importDefault(require("node:fs/promises"));
+const utility_1 = require("utility");
+const moment_1 = __importDefault(require("moment"));
+const utils_js_1 = require("../../lib/utils.js");
+// clean all xxx.log.YYYY-MM-DD before expired date.
+exports.default = (app) => ({
+    schedule: {
+        type: 'worker', // only one worker run this task
+        cron: '0 0 * * *', // run every day at 00:00
+    },
+    async task() {
+        const logger = app.coreLogger;
+        const logDirs = new Set();
+        const loggerFiles = (0, utils_js_1.walkLoggerFile)(app.loggers);
+        loggerFiles.forEach(file => {
+            const logDir = node_path_1.default.dirname(file);
+            logDirs.add(logDir);
+        });
+        const maxDays = app.config.logrotator.maxDays;
+        if (maxDays && maxDays > 0) {
+            try {
+                const tasks = Array.from(logDirs, logDir => removeExpiredLogFiles(logDir, maxDays, logger));
+                await Promise.all(tasks);
+            }
+            catch (err) {
+                logger.error(err);
+            }
+        }
+        logger.info('[@eggjs/logrotator] clean all log before %s days', maxDays);
+    },
+});
+// remove expired log files: xxx.log.YYYY-MM-DD
+async function removeExpiredLogFiles(logDir, maxDays, logger) {
+    // ignore not exists dir
+    const stat = await (0, utility_1.exists)(logDir);
+    if (!stat) {
+        logger.warn(`[@eggjs/logrotator] logDir ${logDir} not exists`);
+        return;
+    }
+    const files = await promises_1.default.readdir(logDir);
+    const expiredDate = (0, moment_1.default)().subtract(maxDays, 'days').startOf('date');
+    const names = files.filter(file => {
+        const name = node_path_1.default.extname(file).substring(1);
+        if (!/^\d{4}\-\d{2}\-\d{2}/.test(name)) {
+            return false;
+        }
+        const date = (0, moment_1.default)(name, 'YYYY-MM-DD').startOf('date');
+        if (!date.isValid()) {
+            return false;
+        }
+        return date.isBefore(expiredDate);
+    });
+    if (names.length === 0) {
+        return;
+    }
+    logger.info(`[@eggjs/logrotator] start remove ${logDir} files: ${names.join(', ')}`);
+    await Promise.all(names.map(async (name) => {
+        const logFile = node_path_1.default.join(logDir, name);
+        try {
+            await promises_1.default.unlink(logFile);
+        }
+        catch (err) {
+            err.message = `[@eggjs/logrotator] remove logFile ${logFile} error, ${err.message}`;
+            logger.error(err);
+        }
+    }));
+}
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY2xlYW5fbG9nLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vLi4vLi4vc3JjL2FwcC9zY2hlZHVsZS9jbGVhbl9sb2cudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7Ozs7QUFBQSwwREFBNkI7QUFDN0IsZ0VBQWtDO0FBQ2xDLHFDQUFpQztBQUNqQyxvREFBNEI7QUFFNUIsaURBQW9EO0FBRXBELG9EQUFvRDtBQUNwRCxrQkFBZSxDQUFDLEdBQVksRUFBRSxFQUFFLENBQUMsQ0FBQztJQUNoQyxRQUFRLEVBQUU7UUFDUixJQUFJLEVBQUUsUUFBUSxFQUFFLGdDQUFnQztRQUNoRCxJQUFJLEVBQUUsV0FBVyxFQUFFLHlCQUF5QjtLQUM3QztJQUVELEtBQUssQ0FBQyxJQUFJO1FBQ1IsTUFBTSxNQUFNLEdBQUcsR0FBRyxDQUFDLFVBQVUsQ0FBQztRQUM5QixNQUFNLE9BQU8sR0FBRyxJQUFJLEdBQUcsRUFBVSxDQUFDO1FBQ2xDLE1BQU0sV0FBVyxHQUFHLElBQUEseUJBQWMsRUFBQyxHQUFHLENBQUMsT0FBTyxDQUFDLENBQUM7UUFDaEQsV0FBVyxDQUFDLE9BQU8sQ0FBQyxJQUFJLENBQUMsRUFBRTtZQUN6QixNQUFNLE1BQU0sR0FBRyxtQkFBSSxDQUFDLE9BQU8sQ0FBQyxJQUFJLENBQUMsQ0FBQztZQUNsQyxPQUFPLENBQUMsR0FBRyxDQUFDLE1BQU0sQ0FBQyxDQUFDO1FBQ3RCLENBQUMsQ0FBQyxDQUFDO1FBQ0gsTUFBTSxPQUFPLEdBQUcsR0FBRyxDQUFDLE1BQU0sQ0FBQyxVQUFVLENBQUMsT0FBTyxDQUFDO1FBQzlDLElBQUksT0FBTyxJQUFJLE9BQU8sR0FBRyxDQUFDLEVBQUUsQ0FBQztZQUMzQixJQUFJLENBQUM7Z0JBQ0gsTUFBTSxLQUFLLEdBQUcsS0FBSyxDQUFDLElBQUksQ0FBQyxPQUFPLEVBQUUsTUFBTSxDQUFDLEVBQUUsQ0FBQyxxQkFBcUIsQ0FBQyxNQUFNLEVBQUUsT0FBTyxFQUFFLE1BQU0sQ0FBQyxDQUFDLENBQUM7Z0JBQzVGLE1BQU0sT0FBTyxDQUFDLEdBQUcsQ0FBQyxLQUFLLENBQUMsQ0FBQztZQUMzQixDQUFDO1lBQUMsT0FBTyxHQUFHLEVBQUUsQ0FBQztnQkFDYixNQUFNLENBQUMsS0FBSyxDQUFDLEdBQUcsQ0FBQyxDQUFDO1lBQ3BCLENBQUM7UUFDSCxDQUFDO1FBRUQsTUFBTSxDQUFDLElBQUksQ0FBQyxrREFBa0QsRUFBRSxPQUFPLENBQUMsQ0FBQztJQUMzRSxDQUFDO0NBQ0YsQ0FBQyxDQUFDO0FBRUgsK0NBQStDO0FBQy9DLEtBQUssVUFBVSxxQkFBcUIsQ0FBQyxNQUFjLEVBQUUsT0FBZSxFQUFFLE1BQTZCO0lBQ2pHLHdCQUF3QjtJQUN4QixNQUFNLElBQUksR0FBRyxNQUFNLElBQUEsZ0JBQU0sRUFBQyxNQUFNLENBQUMsQ0FBQztJQUNsQyxJQUFJLENBQUMsSUFBSSxFQUFFLENBQUM7UUFDVixNQUFNLENBQUMsSUFBSSxDQUFDLDhCQUE4QixNQUFNLGFBQWEsQ0FBQyxDQUFDO1FBQy9ELE9BQU87SUFDVCxDQUFDO0lBRUQsTUFBTSxLQUFLLEdBQUcsTUFBTSxrQkFBRSxDQUFDLE9BQU8sQ0FBQyxNQUFNLENBQUMsQ0FBQztJQUN2QyxNQUFNLFdBQVcsR0FBRyxJQUFBLGdCQUFNLEdBQUUsQ0FBQyxRQUFRLENBQUMsT0FBTyxFQUFFLE1BQU0sQ0FBQyxDQUFDLE9BQU8sQ0FBQyxNQUFNLENBQUMsQ0FBQztJQUN2RSxNQUFNLEtBQUssR0FBRyxLQUFLLENBQUMsTUFBTSxDQUFDLElBQUksQ0FBQyxFQUFFO1FBQ2hDLE1BQU0sSUFBSSxHQUFHLG1CQUFJLENBQUMsT0FBTyxDQUFDLElBQUksQ0FBQyxDQUFDLFNBQVMsQ0FBQyxDQUFDLENBQUMsQ0FBQztRQUM3QyxJQUFJLENBQUMsc0JBQXNCLENBQUMsSUFBSSxDQUFDLElBQUksQ0FBQyxFQUFFLENBQUM7WUFDdkMsT0FBTyxLQUFLLENBQUM7UUFDZixDQUFDO1FBQ0QsTUFBTSxJQUFJLEdBQUcsSUFBQSxnQkFBTSxFQUFDLElBQUksRUFBRSxZQUFZLENBQUMsQ0FBQyxPQUFPLENBQUMsTUFBTSxDQUFDLENBQUM7UUFDeEQsSUFBSSxDQUFDLElBQUksQ0FBQyxPQUFPLEVBQUUsRUFBRSxDQUFDO1lBQ3BCLE9BQU8sS0FBSyxDQUFDO1FBQ2YsQ0FBQztRQUNELE9BQU8sSUFBSSxDQUFDLFFBQVEsQ0FBQyxXQUFXLENBQUMsQ0FBQztJQUNwQyxDQUFDLENBQUMsQ0FBQztJQUNILElBQUksS0FBSyxDQUFDLE1BQU0sS0FBSyxDQUFDLEVBQUUsQ0FBQztRQUN2QixPQUFPO0lBQ1QsQ0FBQztJQUVELE1BQU0sQ0FBQyxJQUFJLENBQUMsb0NBQW9DLE1BQU0sV0FBVyxLQUFLLENBQUMsSUFBSSxDQUFDLElBQUksQ0FBQyxFQUFFLENBQUMsQ0FBQztJQUVyRixNQUFNLE9BQU8sQ0FBQyxHQUFHLENBQUMsS0FBSyxDQUFDLEdBQUcsQ0FBQyxLQUFLLEVBQUMsSUFBSSxFQUFDLEVBQUU7UUFDdkMsTUFBTSxPQUFPLEdBQUcsbUJBQUksQ0FBQyxJQUFJLENBQUMsTUFBTSxFQUFFLElBQUksQ0FBQyxDQUFDO1FBQ3hDLElBQUksQ0FBQztZQUNILE1BQU0sa0JBQUUsQ0FBQyxNQUFNLENBQUMsT0FBTyxDQUFDLENBQUM7UUFDM0IsQ0FBQztRQUFDLE9BQU8sR0FBUSxFQUFFLENBQUM7WUFDbEIsR0FBRyxDQUFDLE9BQU8sR0FBRyxzQ0FBc0MsT0FBTyxXQUFXLEdBQUcsQ0FBQyxPQUFPLEVBQUUsQ0FBQztZQUNwRixNQUFNLENBQUMsS0FBSyxDQUFDLEdBQUcsQ0FBQyxDQUFDO1FBQ3BCLENBQUM7SUFDSCxDQUFDLENBQUMsQ0FBQyxDQUFDO0FBQ04sQ0FBQyJ9

package/dist/commonjs/app/schedule/rotate_by_file.d.ts

@@ -0,0 +1,10 @@
+import { EggCore } from '@eggjs/core';
+declare const _default: (app: EggCore) => {
+    schedule: {
+        type: string;
+        cron: string;
+        disable: boolean;
+    };
+    task(): Promise<void>;
+};
+export default _default;

package/dist/commonjs/app/schedule/rotate_by_file.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const day_rotator_js_1 = require("../../lib/day_rotator.js");
+exports.default = (app) => {
+    const rotator = new day_rotator_js_1.DayRotator({ app });
+    return {
+        schedule: {
+            type: 'worker', // only one worker run this task
+            cron: '1 0 0 * * *', // run every day at 00:00
+            disable: app.config.logrotator.disableRotateByDay,
+        },
+        async task() {
+            await rotator.rotate();
+        },
+    };
+};
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoicm90YXRlX2J5X2ZpbGUuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi8uLi9zcmMvYXBwL3NjaGVkdWxlL3JvdGF0ZV9ieV9maWxlLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7O0FBQ0EsNkRBQXNEO0FBRXRELGtCQUFlLENBQUMsR0FBWSxFQUFFLEVBQUU7SUFDOUIsTUFBTSxPQUFPLEdBQUcsSUFBSSwyQkFBVSxDQUFDLEVBQUUsR0FBRyxFQUFFLENBQUMsQ0FBQztJQUV4QyxPQUFPO1FBQ0wsUUFBUSxFQUFFO1lBQ1IsSUFBSSxFQUFFLFFBQVEsRUFBRSxnQ0FBZ0M7WUFDaEQsSUFBSSxFQUFFLGFBQWEsRUFBRSx5QkFBeUI7WUFDOUMsT0FBTyxFQUFFLEdBQUcsQ0FBQyxNQUFNLENBQUMsVUFBVSxDQUFDLGtCQUFrQjtTQUNsRDtRQUVELEtBQUssQ0FBQyxJQUFJO1lBQ1IsTUFBTSxPQUFPLENBQUMsTUFBTSxFQUFFLENBQUM7UUFDekIsQ0FBQztLQUNGLENBQUM7QUFDSixDQUFDLENBQUMifQ==

package/dist/commonjs/app/schedule/rotate_by_hour.d.ts

@@ -0,0 +1,10 @@
+import { EggCore } from '@eggjs/core';
+declare const _default: (app: EggCore) => {
+    schedule: {
+        type: string;
+        cron: string;
+        disable: boolean;
+    };
+    task(): Promise<void>;
+};
+export default _default;

package/dist/commonjs/app/schedule/rotate_by_hour.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const hour_rotator_js_1 = require("../../lib/hour_rotator.js");
+exports.default = (app) => {
+    const rotator = new hour_rotator_js_1.HourRotator({ app });
+    return {
+        schedule: {
+            type: 'worker', // only one worker run this task
+            cron: '1 * * * *', // run every hour at 01
+            disable: (app.config.logrotator.filesRotateByHour || []).length === 0,
+        },
+        async task() {
+            await rotator.rotate();
+        },
+    };
+};
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoicm90YXRlX2J5X2hvdXIuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi8uLi9zcmMvYXBwL3NjaGVkdWxlL3JvdGF0ZV9ieV9ob3VyLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7O0FBQ0EsK0RBQXdEO0FBRXhELGtCQUFlLENBQUMsR0FBWSxFQUFFLEVBQUU7SUFDOUIsTUFBTSxPQUFPLEdBQUcsSUFBSSw2QkFBVyxDQUFDLEVBQUUsR0FBRyxFQUFFLENBQUMsQ0FBQztJQUV6QyxPQUFPO1FBQ0wsUUFBUSxFQUFFO1lBQ1IsSUFBSSxFQUFFLFFBQVEsRUFBRSxnQ0FBZ0M7WUFDaEQsSUFBSSxFQUFFLFdBQVcsRUFBRSx1QkFBdUI7WUFDMUMsT0FBTyxFQUFFLENBQUMsR0FBRyxDQUFDLE1BQU0sQ0FBQyxVQUFVLENBQUMsaUJBQWlCLElBQUksRUFBRSxDQUFDLENBQUMsTUFBTSxLQUFLLENBQUM7U0FDdEU7UUFFRCxLQUFLLENBQUMsSUFBSTtZQUNSLE1BQU0sT0FBTyxDQUFDLE1BQU0sRUFBRSxDQUFDO1FBQ3pCLENBQUM7S0FFRixDQUFDO0FBQ0osQ0FBQyxDQUFDIn0=

package/dist/commonjs/app/schedule/rotate_by_size.d.ts

@@ -0,0 +1,10 @@
+import { EggCore } from '@eggjs/core';
+declare const _default: (app: EggCore) => {
+    schedule: {
+        type: string;
+        interval: number;
+        disable: boolean;
+    };
+    task(): Promise<void>;
+};
+export default _default;

package/dist/commonjs/app/schedule/rotate_by_size.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const size_rotator_js_1 = require("../../lib/size_rotator.js");
+exports.default = (app) => {
+    const rotator = new size_rotator_js_1.SizeRotator({ app });
+    return {
+        schedule: {
+            type: 'worker',
+            interval: app.config.logrotator.rotateDuration,
+            disable: (app.config.logrotator.filesRotateBySize || []).length === 0,
+        },
+        async task() {
+            await rotator.rotate();
+        },
+    };
+};
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoicm90YXRlX2J5X3NpemUuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi8uLi9zcmMvYXBwL3NjaGVkdWxlL3JvdGF0ZV9ieV9zaXplLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7O0FBQ0EsK0RBQXdEO0FBRXhELGtCQUFlLENBQUMsR0FBWSxFQUFFLEVBQUU7SUFDOUIsTUFBTSxPQUFPLEdBQUcsSUFBSSw2QkFBVyxDQUFDLEVBQUUsR0FBRyxFQUFFLENBQUMsQ0FBQztJQUV6QyxPQUFPO1FBQ0wsUUFBUSxFQUFFO1lBQ1IsSUFBSSxFQUFFLFFBQVE7WUFDZCxRQUFRLEVBQUUsR0FBRyxDQUFDLE1BQU0sQ0FBQyxVQUFVLENBQUMsY0FBYztZQUM5QyxPQUFPLEVBQUUsQ0FBQyxHQUFHLENBQUMsTUFBTSxDQUFDLFVBQVUsQ0FBQyxpQkFBaUIsSUFBSSxFQUFFLENBQUMsQ0FBQyxNQUFNLEtBQUssQ0FBQztTQUN0RTtRQUVELEtBQUssQ0FBQyxJQUFJO1lBQ1IsTUFBTSxPQUFPLENBQUMsTUFBTSxFQUFFLENBQUM7UUFDekIsQ0FBQztLQUNGLENBQUM7QUFDSixDQUFDLENBQUMifQ==

package/dist/commonjs/app.d.ts

@@ -0,0 +1,2 @@
+import { Boot } from './boot.js';
+export default Boot;

package/dist/commonjs/app.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const boot_js_1 = require("./boot.js");
+exports.default = boot_js_1.Boot;
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiYXBwLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vc3JjL2FwcC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOztBQUFBLHVDQUFpQztBQUVqQyxrQkFBZSxjQUFJLENBQUMifQ==

package/dist/commonjs/boot.d.ts

@@ -0,0 +1,6 @@
+import type { EggCore, ILifecycleBoot } from '@eggjs/core';
+export declare class Boot implements ILifecycleBoot {
+    private readonly app;
+    constructor(app: EggCore);
+    didLoad(): Promise<void>;
+}

package/dist/commonjs/boot.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Boot = void 0;
+class Boot {
+    app;
+    constructor(app) {
+        this.app = app;
+    }
+    async didLoad() {
+        // reload logger to new fd after rotating
+        this.app.messenger.on('log-reload', () => {
+            this.app.loggers.reload();
+            this.app.coreLogger.info('[@eggjs/logrotator] %s logger reload: got log-reload message', this.app.type);
+        });
+    }
+}
+exports.Boot = Boot;
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiYm9vdC5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uL3NyYy9ib290LnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7OztBQUVBLE1BQWEsSUFBSTtJQUNjO0lBQTdCLFlBQTZCLEdBQVk7UUFBWixRQUFHLEdBQUgsR0FBRyxDQUFTO0lBQUcsQ0FBQztJQUU3QyxLQUFLLENBQUMsT0FBTztRQUNYLHlDQUF5QztRQUN6QyxJQUFJLENBQUMsR0FBRyxDQUFDLFNBQVMsQ0FBQyxFQUFFLENBQUMsWUFBWSxFQUFFLEdBQUcsRUFBRTtZQUN2QyxJQUFJLENBQUMsR0FBRyxDQUFDLE9BQU8sQ0FBQyxNQUFNLEVBQUUsQ0FBQztZQUMxQixJQUFJLENBQUMsR0FBRyxDQUFDLFVBQVUsQ0FBQyxJQUFJLENBQUMsOERBQThELEVBQUUsSUFBSSxDQUFDLEdBQUcsQ0FBQyxJQUFJLENBQUMsQ0FBQztRQUMxRyxDQUFDLENBQUMsQ0FBQztJQUNMLENBQUM7Q0FDRjtBQVZELG9CQVVDIn0=

package/dist/commonjs/config/config.default.d.ts

@@ -0,0 +1,64 @@
+/**
+ * logrotator options
+ * @member Config#logrotator
+ */
+export interface LogrotatorConfig {
+    /**
+     * Disable rotate by day
+     *
+     * Default: `false`
+     */
+    disableRotateByDay: boolean;
+    /**
+     * List of files that will be rotated by hour
+     *
+     * Default: `null`
+     */
+    filesRotateByHour: string[] | null;
+    /**
+     * Hour delimiter
+     *
+     * Default: `-`
+     */
+    hourDelimiter: string;
+    /**
+     * List of files that will be rotated by size
+     *
+     * Default: `null`
+     */
+    filesRotateBySize: string[] | null;
+    /**
+     * Max file size to judge if any file need rotate
+     *
+     * Default: `50 * 1024 * 1024`
+     */
+    maxFileSize: number;
+    /**
+     * Max files to keep
+     *
+     * Default: `10`
+     */
+    maxFiles: number;
+    /**
+     * Time interval to judge if any file need rotate
+     *
+     * Default: `60000`
+     */
+    rotateDuration: number;
+    /**
+     * Max days to keep log files, set `0` to keep all logs.
+     *
+     * Default: `31`
+     */
+    maxDays: number;
+    /**
+     * Enable gzip compression for rotated files
+     *
+     * Default: `false`
+     */
+    gzip: boolean;
+}
+declare const _default: {
+    logrotator: LogrotatorConfig;
+};
+export default _default;

package/dist/commonjs/config/config.default.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = {
+    logrotator: {
+        disableRotateByDay: false,
+        filesRotateByHour: null,
+        hourDelimiter: '-',
+        filesRotateBySize: null,
+        maxFileSize: 50 * 1024 * 1024,
+        maxFiles: 10,
+        rotateDuration: 60000,
+        maxDays: 31,
+        gzip: false,
+    },
+};
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY29uZmlnLmRlZmF1bHQuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi9zcmMvY29uZmlnL2NvbmZpZy5kZWZhdWx0LnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7O0FBNkRBLGtCQUFlO0lBQ2IsVUFBVSxFQUFFO1FBQ1Ysa0JBQWtCLEVBQUUsS0FBSztRQUN6QixpQkFBaUIsRUFBRSxJQUFJO1FBQ3ZCLGFBQWEsRUFBRSxHQUFHO1FBQ2xCLGlCQUFpQixFQUFFLElBQUk7UUFDdkIsV0FBVyxFQUFFLEVBQUUsR0FBRyxJQUFJLEdBQUcsSUFBSTtRQUM3QixRQUFRLEVBQUUsRUFBRTtRQUNaLGNBQWMsRUFBRSxLQUFLO1FBQ3JCLE9BQU8sRUFBRSxFQUFFO1FBQ1gsSUFBSSxFQUFFLEtBQUs7S0FDUTtDQUN0QixDQUFDIn0=

package/dist/commonjs/index.d.ts

@@ -0,0 +1,2 @@
+import './types.js';
+export * from './lib/rotator.js';

package/dist/commonjs/index.js

@@ -0,0 +1,19 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+require("./types.js");
+__exportStar(require("./lib/rotator.js"), exports);
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvaW5kZXgudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7Ozs7Ozs7Ozs7Ozs7OztBQUFBLHNCQUFvQjtBQUVwQixtREFBaUMifQ==

package/dist/commonjs/lib/day_rotator.d.ts

@@ -0,0 +1,8 @@
+import { LogRotator, RotateFile, RotatorOptions } from './rotator.js';
+export declare class DayRotator extends LogRotator {
+    private filesRotateBySize;
+    private filesRotateByHour;
+    constructor(options: RotatorOptions);
+    getRotateFiles(): Promise<Map<string, RotateFile>>;
+    _setFile(srcPath: string, files: Map<string, RotateFile>): void;
+}