# @eggjs/logrotator

> logrotator for egg

Latest version **5.1.0** (published 2026-10-07) · MIT license · 0 weekly downloads

## Install

```sh
npm install @eggjs/logrotator
pnpm add @eggjs/logrotator
yarn add @eggjs/logrotator
bun add @eggjs/logrotator
```

## Health

**Score 70/100 (B)** — status: active.

Positive: has types; esm support; no vulnerabilities; has provenance; recently updated; high maintenance score.

Warnings: low downloads.

## Facts

| | |
|---|---|
| Version | 5.1.0 |
| Published | 2026-10-07 |
| First published | 2025-02-03 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM |
| Node | >= 22.18.0 |
| Dependencies | 2 |
| Unpacked size | 29.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Provenance | attested (GitHub Actions) |
| Author | tianyi.jiangty |
| Maintainers | gxkl, eggjs-admin, fengmk2, atian25, hyj1991, killagu, coolme200, akitasummer, elrrrrrrr, niania |
| Keywords | egg, egg-plugin, eggPlugin, logger, logrotator |

## Links

- npm: https://www.npmjs.com/package/@eggjs/logrotator
- Repository: https://github.com/eggjs/egg
- Homepage: https://github.com/eggjs/egg/tree/next/plugins/logrotator#readme
- Issues: https://github.com/eggjs/egg/issues
- npm.io page: https://npm.io/package/@eggjs/logrotator

## Dependencies (2)

- [moment](https://npm.io/package/moment.md) ^2.30.1
- [utility](https://npm.io/package/utility.md) ^2.5.0

## Alternatives

- [cli-color](https://npm.io/package/cli-color.md) — 3.4M weekly downloads
- [log](https://npm.io/package/log.md) — 1.3M weekly downloads
- [logstash-client](https://npm.io/package/logstash-client.md) — 4.5K weekly downloads
- [@nocobase/plugin-logger](https://npm.io/package/@nocobase/plugin-logger.md) — 2.0K weekly downloads
- [child-process-debug](https://npm.io/package/child-process-debug.md) — 695 weekly downloads

## Recent versions

- 5.1.0 (latest) — 2026-10-07
- 5.0.2-rc.1 (rc) — 2026-10-06
- 5.0.2-beta.27 (beta) — 2026-09-20
- 5.0.2 — 2026-10-06
- 5.0.2-rc.0 — 2026-09-23
- 5.0.2-beta.26 — 2026-08-07
- 5.0.2-beta.25 — 2026-07-13
- 5.0.2-beta.24 — 2026-07-12
- 5.0.2-beta.23 — 2026-07-11
- 5.0.2-beta.22 — 2026-07-11
- 5.0.2-beta.20 — 2026-07-09
- 5.0.2-beta.19 — 2026-06-29
- 5.0.2-beta.17 — 2026-06-28
- 5.0.2-beta.16 — 2026-06-26
- 5.0.2-beta.15 — 2026-06-26
- … 39 more at https://npm.io/package/@eggjs/logrotator/versions

## README

# @eggjs/logrotator

[![NPM version][npm-image]][npm-url]
[![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

egg built-in plugin `logrotator` is enabled by default.

## Usage

- `config/config.default.ts`

```ts
// if any files need rotate by file size, config here
export default {
  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.

```ts
// app/schedule/custom.ts
export default (app: Application) => {
  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: Application) {
  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/egg)](https://github.com/eggjs/egg/graphs/contributors)

Made with [contributors-img](https://contrib.rocks).

---
_Source: https://npm.io/package/@eggjs/logrotator · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._