think-logger3 - npm Package Compare versions

Comparing version 0.0.7 to 1.0.0

.nyc_output/0098d178e0fb6141a886e84e814baa01.json

.nyc_output/547a5cbd282464a4758c7d0afc486f75.json

.nyc_output/bdc5ee8230ca17538e97cee88465c306.json

.nyc_output/f35d912a98e5adbec7320f30fc845f09.json

package.json

		{
		"name": "think-logger3",
		"version": "0.0.7",
		"version": "1.0.0",
		"description": "logger for ThinkJS 3.x",
		@@ -5,0 +5,0 @@ "main": "./src",

README.md

		# think-logger

		[![npm](https://img.shields.io/npm/v/think-logger3.svg?style=flat-square)]()
		[![Travis](https://img.shields.io/travis/thinkjs/think-logger3.svg?style=flat-square)]()
		[![Coveralls](https://img.shields.io/coveralls/thinkjs/think-logger3.svg?style=flat-square)]()
		[![David](https://img.shields.io/david/strongloop/think-logger3.svg?style=flat-square)]()
		[![Travis](https://img.shields.io/travis/thinkjs/think-logger.svg?style=flat-square)]()
		[![Coveralls](https://img.shields.io/coveralls/thinkjs/think-logger/master.svg?style=flat-square)]()
		[![David](https://img.shields.io/david/thinkjs/think-logger.svg?style=flat-square)]()

		@@ -17,2 +17,5 @@ ThinkJS3.x log module


		### Basic

		```js
		@@ -23,10 +26,19 @@ const Logger = require('think-logger');
		```


		## Advanced

		There has four log function you can use:

		```js
		logger.info('info log');
		logger.debug('debug log');
		logger.warn('warn log');
		logger.error('error log');
		```

		### Advanced

		If you want to log file, you can use file adapter like this:

		```js
		const Logger = require('think-logger');
		const Logger = require('think-logger3');
		let logger = new Logger({
		@@ -39,17 +51,72 @@ handle: Logger.File,

		## Adapters

		There has four log function you can use:
		### File

		```js
		logger.info('info log');
		logger.debug('debug log');
		logger.warn('warn log');
		logger.error('error log');
		```
		This adapter will log to a file, and supports split log file by a constant file size. For example:

		## Other Adapters
		```js
		const Logger = require('think-logger3');
		let logger = new Logger({
		handle: Logger.File,
		filename: __dirname + '/debug.log',
		maxLogSize: 50 * 1024, //50M
		backups: 10 //max chunk number
		})
		```

		Then initial log would create a file called `debug.log`. After this file reached `maxLogSize`, a new file named `debug.log.1` will be created. After log file number reached `backups`, old log chunk file will be removed.

		#### Configuration

		- `filename`: log filename
		- `maxLogSize`: The maximum size (in bytes) for a log file, if not provided then logs won't be rotated.
		- `backups`: The number of log files to keep after logSize has been reached (default 5)
		- `absolute`: If `filename` is a absolute path, the `absolute` value should be `true`.
		- `layouts`: Layout defines the way how a log record is rendered. More layouts can see [here](https://github.com/nomiddlename/log4js-node/wiki/Layouts).

		### DateFile

		This adapter will log to a file, moving old log messages to timestamped files according to a specified pattern. For example:

		```js
		const Logger = require('think-logger3');
		let logger = new Logger({
		handle: Logger.DateFile,
		filename: __dirname + '/debug.log',
		pattern: '-yyyy-MM-dd',
		alwaysIncludePattern: false
		});
		```

		Then initial log would create a file called `debug.log`. At midnight, the current `debug.log` file would be rename to `debug.log-2017-03-12`(for example), and a new `debug.log` file created.

		#### Configuration

		- `level`: log level
		- `filename`: log base filename
		- `pattern`: date filename would append to filename. A new file is started whenever the pattern for the current log entry differs from that of the previous log entry. The following strings are recognised in the pattern:
		- yyyy - the full year, use yy for just the last two digits
		- MM - the month
		- dd - the day of the month
		- hh - the hour of the day (24-hour clock)
		- mm - the minute of the hour
		- ss - seconds
		- SSS - milliseconds (although I'm not sure you'd want to roll your logs every millisecond)
		- O - timezone (capital letter o)
		- `alwaysIncludePattern`: If `alwaysIncludePattern` is true, then the initial file will be `filename.2017-03-12` and no renaming will occur at midnight, but a new file will be written to with the name `filename.2017-03-13`.
		- `absolute`: If `filename` is a absolute path, the `absolute` value should be `true`.
		- `layouts`: Layout defines the way how a log record is rendered. More layouts can see [here](https://github.com/nomiddlename/log4js-node/wiki/Layouts).

		### Tips:

		`think-logger3` will auto detect cluster mode, you needn't configure for cluster handly.


		## Contributing

		Contributions welcome!

		## License

		[MIT](https://github.com/thinkjs/think-logger/blob/master/LICENSE)

.nyc_output/09003df33b92fc84f0bb227ede0db32a.json

.nyc_output/0fc4eedce76668608dd0e1cc9763d046.json

.nyc_output/8e743262a7204e150b8e1543b8cc4c05.json

.nyc_output/dddbe95c7ac5000ccde86e9d9f239c8a.json

lib/adapter/base.js

lib/adapter/console.js

lib/adapter/datefile.js

lib/adapter/file.js

lib/adapter/gelf.js

lib/index.js

coverage/index.html