# mini-logger

**Repository Path**: mirrors_node-modules/mini-logger

## Basic Information

- **Project Name**: mini-logger
- **Description**: a really simple logger for web server or others
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-08-19
- **Last Updated**: 2025-11-29

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

mini-logger
------------

[![NPM version][npm-image]][npm-url]
[![build status][travis-image]][travis-url]
[![Coveralls][coveralls-image]][coveralls-url]
[![David deps][david-image]][david-url]
[![Known Vulnerabilities][snyk-image]][snyk-url]
[![npm download][download-image]][download-url]

[npm-image]: https://img.shields.io/npm/v/mini-logger.svg?style=flat-square
[npm-url]: https://npmjs.org/package/mini-logger
[travis-image]: https://img.shields.io/travis/node-modules/mini-logger.svg?style=flat-square
[travis-url]: https://travis-ci.org/node-modules/mini-logger
[coveralls-image]: https://img.shields.io/coveralls/node-modules/mini-logger.svg?style=flat-square
[coveralls-url]: https://coveralls.io/r/node-modules/mini-logger?branch=master
[david-image]: https://img.shields.io/david/node-modules/mini-logger.svg?style=flat-square
[david-url]: https://david-dm.org/node-modules/mini-logger
[snyk-image]: https://snyk.io/test/npm/mini-logger/badge.svg?style=flat-square
[snyk-url]: https://snyk.io/test/npm/mini-logger
[download-image]: https://img.shields.io/npm/dm/mini-logger.svg?style=flat-square
[download-url]: https://npmjs.org/package/mini-logger

A really simple logger for web server or others.

## Install

```bash
npm install mini-logger
```

## Goal

Log levels for logger is useless. Just let [debug](https://github.com/visionmedia/debug) module handle the debug log. All you need is error log and some custom categories. `mini-logger` just write logs into different files or stdout, do not care formats(only format Errors and Objects).

## Features

* rolling log files based on datetime
* easy to extended
* custom categories
* encoding support
* support Error / Object format

## Usage

### Example

```js
var path = require('path');
var Logger = require('mini-logger');
var logger = Logger({
  dir: path.join(__dirname, 'logs'),
  categories: [ 'http' ],
  format: '[{category}.]YYYY-MM-DD[.log]'
});

logger.error(new Error('error'));
logger.http('http request url: %s', 'https://github.com');
```

### Options

* **dir**: log directory path, required.
* **categories**: custom categories, all categories will add a method to Logger's instance
* **format**: log file name's format, will pase to momentjs to format. `{category}` will replace with logger category, default is `[{category.}]YYYY-MM-DD[.log]`
* **stdout**: write logs into stdout, default is `false`
* **file**: write logs into file, default is `true`
* **errorFormater**: formater for errors, default is [error-formater](https://github.com/node-modules/error-formater)
* **seperator**: the seperator of each line of logs, default is `os.EOL + os.EOL`
* **encoding**: output logs' encoding, default is `utf-8`
* **flushInterval**: all logs will cache in memory first, every `flushInterval` ms flush into files. default is `1s`
* **duration**: cut the logs every `duration` ms. default is `1h`
* **mkdir**: everytime before create a writeStream, will try to `mkdirp` first. useful when format is like `YYYY/MM/DD/[{category}.log]`, default to false
* **timestamp**: write timestamp with format YYYYMMDDHHmmssSSS before every line of logs, default is false

### Events

Logger will emit an error event when any write streams emit an error. If you don't listen this `error` event, it will default hanlde by:

```js
function onerror(err) {
  console.error(err.stack);
}
```

## License

[MIT](LICENSE)