Skip to content

Latest commit

 

History

History
527 lines (438 loc) · 33.1 KB

CHANGELOG.md

File metadata and controls

527 lines (438 loc) · 33.1 KB
Raw

CHANGELOG

v3.2.1 / 2018-01-29

UNBOUND PROTOTYPE AD INFINITUM EDITION

  • #[1579], (@indexzero) Fallback to the "root" instance always created by createLogger for level convenience methods (e.g. .info(), .silly()). (Fixes [#1577]).
  • [#1539], (@indexzero) Assume message is the empty string when level-helper methods are invoked with no arguments (Fixed [#1501]).
  • [#1583], (@kibertoad) Add typings for defaultMeta (Fixes [#1582])
  • [#1586], (@kibertoad) Update dependencies.

v3.2.0 / 2018-01-26

SORRY IT TOO SO LONG EDITION

NOTE: this was our first release using Github Projects. See the 3.2.0 Release Project.

New Features!

  • [#1471], (@kibertoad) Implement child loggers.
  • [#1462], (@drazisil) Add handleRejection support.
    • [#1555], (@DABH) Add fixes from [#1355] to unhandled rejection handler.
  • [#1418], (@mfrisbey) Precompile ES6 syntax before publishing to npm.
    • [#1533], (@kibertoad) Update to Babel 7.
  • [#1562], (@indexzero) [fix] Better handling of new Error(string) throughout the pipeline(s). (Fixes [#1338], [#1486]).

Bug Fixes

  • [#1355], (@DABH) Fix issues with ExceptionHandler (Fixes [#1289]).
  • [#1463], (@SerayaEryn) Bubble transport warn events up to logger in addition to errors.
  • [#1480], [#1503], (@SerayaEryn) File tailrolling fix.
  • [#1483], (@soldair) Assign log levels to un-bound functions.
  • [#1513], (@TilaTheHun0) Set maxListeners for Console transport.
  • [#1521], (@jamesbechet) Fix Transform from readable-stream using CRA.
  • [#1434], (@Kouzukii) Fixes logger.query function (regression from 3.0.0)
  • [#1526], (@pixtron) Log file without .gz for tailable (Fixes [#1525]).
  • [#1559], (@eubnara) Fix typo related to exitOnError.
  • [#1556], (@adoyle-h) Support to create log directory if it doesn't exist for FileTransport.

New splat behavior

  • [#1552], (@indexzero) Consistent handling of meta with (and without) interpolation in winston and logform.
  • [#1499], (@DABH) Provide all of SPLAT to formats (Fixes [#1485]).
  • [#1485], (@mpabst) Fixing off-by-one when using both meta and splat.

Previously splat would have added a meta property for any additional info[SPLAT] beyond the expected number of tokens.

As of [email protected], format.splat assumes additional splat paramters (aka "metas") are objects and merges enumerable properties into the info. e.g. BE ADVISED previous "metas" that were not objects will very likely lead to odd behavior. e.g.

const { createLogger, format, transports } = require('winston');
const { splat } = format;
const { MESSAGE, LEVEL, SPLAT } = require('triple-beam');

const logger = createLogger({
  format: format.combine(
    format.splat(),
    format.json()
  ),
  transports: [new transports.Console()]
});

// Expects two tokens, but four splat parameters provided.
logger.info(
  'Let us %s for %j',   // message
  'objects',           // used for %s
  { label: 'sure' },   // used for %j
  'lol', ['ok', 'why'] // Multiple additional meta values 
);

// winston < 3.2.0 && [email protected] behavior:
// Added "meta" property.
//
// { level: 'info',
//   message: 'Let us objects for {"label":"sure"}',
//   meta: ['lol', ['ok', 'why']],
//   [Symbol(level)]: 'info',
//   [Symbol(message)]: 'Let us %s for %j',
//   [Symbol(splat)]: [ 'objects', { label: 'sure' } ] }

// winston >= 3.2.0 && [email protected] behavior: Enumerable properties
// assigned into `info`. Since **strings and Arrays only have NUMERIC
// enumerable properties we get this behavior!**
//
// { '0': 'ok',
//   '1': 'why',
//   '2': 'l',
//   level: 'info',
//   message: 'Let us objects for {"label":"sure"}',
//   [Symbol(level)]: 'info',
//   [Symbol(message)]: 'Let us %s for %j',
//   [Symbol(splat)]: [ 'objects', { label: 'sure' } ] }

Maintenance & Documentation

  • Documentation Updates
    • [#1410], (@hakanostrom) Add docs reference to transport for Cloudant.
    • [#1467], (@SeryaEryn) Add fast-file-rotate transport to transport.md.
    • [#1488], (@adamcohen) Fix multi logger documentation.
    • [#1531], (@mapleeit) Add links to transports.
    • [#1548], (@ejmartin504) Fix README.md for awaiting logs.
    • [#1554], (@indexzero) Document the solution to [#1486] as by design.
    • Other small improvements: [#1509].
  • Improved TypeScript support
    • [#1470], (@jd-carroll) Export all transport options (Fixes [#1469]).
    • [#1474], (@jd-carroll) Correct import to avoid conflict (Fixed [#1472]).
    • [#1546], (@alewiahmed) Add consoleWarnLevels field to the ConsoleTransportOptions interface type definition.
    • [#1557], (@negezor) Add missing child() method.
  • Dependency management
    • [#1560], (@kibertoad) Update dependencies.
    • [#1512], (@SerayaEryn) Add node@11 and disallow failures on node@10.
    • [#1516], (@SerayaEryn) Update readable-stream to v3.0.6.
    • [#1534], (@kibertoad) Update @types/node, nyc, and through2.

v3.1.0 / 2018-08-22

RELEASES ON A PLANE EDITION

  • Minor TypeScript fixes [#1362], [#1395], [#1440]
  • Fix minor typos [#1359], [#1363], [#1372], [#1378], [#1390]
  • [#1373], (@revik): Add consoleWarnLevels property to console transport options for console.warn browser support.
  • [#1394], (@bzoz): Fix tests on Windows.
  • [#1447], (@dboshardy): Support transport name option to override default names for built-in transports.
  • [#1420], (@ledbit): Fix file rotation with tailing: true (Fixes [#1450], [#1194]).
  • [#1352], (@lutovich): Add isLevelEnabled(string) & isXXXEnabled() to Logger class.
  • Dependency management
    • Regenerate package-lock.json.
    • Upgrade to colors@^1.3.2 (Fixes [#1439]).
    • Upgrade to logform@^1.9.1.
    • Upgrade to diagnostics@^1.1.1.
    • Upgrade to @types/node@^10.9.3.
    • Upgrade to assume@^2.1.0.
    • Upgrade to hock@^1.3.3.
    • Upgrade to mocha@^5.2.0.
    • Upgrade to nyc@^13.0.1.
    • Upgrade to split2@^3.0.0.

v3.0.0 / 2018-06-12

GET IN THE CHOPPA EDITION

  • [#1332], (@DABH): logger.debug is sent to stderr (Fixed [#1024])
  • [#1328], (@ChrisAlderson): Logger level doesn't update transports level (Fixes [#1191]).
  • [#1356], (@indexzero) Move splat functionality into logform. (Fixes [#1298]).
  • [#1340], (@indexzero): Check log.length when evaluating "legacyness" of transports (Fixes [#1280]).
  • [#1346], (@indexzero): Implement _final from Node.js streams. (Related to winston-transport#24, Fixes [#1250]).
  • [#1347], (@indexzero): Wrap calls to format.transform with try / catch (Fixes [#1261]).
  • [#1357], (@indexzero): Remove paddings as we have no use for it in the current API.
  • [TODO]: REMAINS OPEN, NO PR (Fixes [#1289])
  • Documentation
    • [#1301], (@westonpace) Cleaned up some of the documentation on colorize to address concerns in [#1095].
    • First pass at a heavy refactor of docs/transports.md.
  • Dependency management
    • Regenerate package-lock.json.
    • Upgrade to logform@^1.9.0.

v3.0.0-rc6 / 2018-05-30

T-MINUS 6-DAY TO WINSTON@3 EDITION

  • Document that we are pushing for a June 5th, 2018 release of [email protected]
  • [#1287], (@DABH) Added types for Typescript.
    • [#1335] Typescript: silent is boolean.
    • [#1323] Add level method to default logger.
  • [#1286], (@ChrisAlderson) Migrate codebase to ES6
    • [#1324], (@ChrisAlderson) Fix regression introduced by ES6 migration for exception handling.
    • [#1333], (@ChrisAlderson) Fix removing all loggers from a container.
  • [#1291], [#1294], [#1318], (@indexzero, @ChrisAlderson, @mempf) Improvements to File transport core functionality. Fixes [#1194].
  • [#1311], (@ChrisAlderson) Add eol option to Stream transport.
  • [#1297], (@ChrisAlderson) Move winston.config to triple-beam. Expose for backwards compatibility.
  • [#1320], (@ChrisAlderson) Enhance tests to run on Windows.
  • Internal project maintenance
    • Bump to [email protected] which may cause incompatibilities if your custom transport does not explicitly require winston-transport itself.
    • [#1292], (@ChrisAlderson) Add node v10 to TravisCI build matrix.
    • [#1296], (@indexzero) Improve UPGRADE-3.0.md. Add Github Issue Template.
    • Remove "npm run report" in favor of reports being automatically generate.
    • Update logform, triple-beam, and winston-transport to latest.

Special thanks to our newest winston core team member – @ChrisAlderson for helping make [email protected] a reality next week!

v3.0.0-rc5 / 2018-04-20

UNOFFICIAL NATIONAL HOLIDAY EDITION

  • [#1281] Use Buffer.alloc and Buffer.from instead of new Buffer.
  • Better browser support
    • [#1142] Move common tailFile to a separate file
    • [#1279] Use feature detection to be safer for browser usage.
  • MOAR Docs!
    • Document that we are pushing for a May 29th, 2018 release of [email protected]
    • Add David Hyde as official contributor.
    • [#1278] Final Draft of Upgrade Guide in UPGRADE-3.0.md
    • Merge Roadmap from 3.0.0.md into CONTRIBUTING.md and other improvements to CONTRIBUTING.md
  • Improve & expand examples
    • [#1175] Add more copy about printf formats based on issue feedback.
    • [#1134] Add sampleto document timestamps more clearly as an example.
    • [#1273] Add example using multiple formats.
    • [#1250] Add an example illustrating the "finish" event for AWS Lambda scenarios.
    • Use simple format to better show that humanReadableUnhandledException is now the default message format.
    • Add example to illustrate that example code from winston-transport README.md is correct.
  • Update devDependencies
    • Bump assume to ^2.0.1.
    • Bump winston-compat to ^0.1.1.

v3.0.0-rc4 / 2018-04-06

IF A TREE FALLS IN THE FORREST DOES IT MAKE A LOG EDITION

  • (@indexzero, @dabh) Add support for { silent } option to
require('winston').Logger;
require('winston-transport').TransportStream;
  • Better browser support
    • [#1145], (@Jasu) Replace isstream with is-stream to make stream detection work in browser.
    • [#1146], (@Jasu) Rename query to different than function name, to support Babel 6.26.
  • Better Typescript support in all supporting libraries
  • Update documentation
    • (@indexzero) Correct link to upgrade guide. Fixes #1255.
    • [#1258], (@morenoh149) Document how to colorize levels. Fixes #1135.
    • [#1246], (@KlemenPlazar) Update colors argument when adding custom colors
    • Update CONTRIBUTING.md
    • [#1239], (@dabh) Add changelog entries for v3.0.0-rc3
    • Add example showing that { level } can be deleted from info objects because Symbol.for('level') is what winston uses internally. Fixes #1184.

v3.0.0-rc3 / 2018-03-16

I GOT NOTHING EDITION

  • [#1195], (@Nilegfx) Fix type error when creating new stream.Stream()
  • [#1109], (@vsetka) Fix file transprot bug where self.filename was not being updated on ENOENT
  • [#1153], (@wizardnet972) Make prototype methods return like the original method
  • [#1234], (@guiguan, @indexzero) Add tests for properly handling logging of undefined, null and Error values
  • [#1235], (@indexzero) Add example demonstrating how meta objects BECOME the info object
  • Minor fixes to docs & examples: [#1232], [#1185]

v3.0.0-rc2 / 2018-03-09

MAINTENANCE RESUMES EDITION

  • [#1209], (@dabh) Use new version of colors, solving a number of issues.
  • [#1197], (@indexzero) Roadmap & guidelines for contributors.
  • [#1100] Require the package.json by its full name.
  • [#1149] Updates async to latest (2.6.0)
  • [#1228], (@mcollina) Always pass a function to fs.close.
  • Minor fixes to docs & examples: [#1177], [#1182], [#1208], [#1198], [#1165], [#1110], [#1117], [#1097], [#1155], [#1084], [#1141], [#1210], [#1223].

v3.0.0-rc1 / 2017-10-19

OMG THEY FORGOT TO NAME IT EDITION

  • Fix file transport improper binding of _onDrain and _onError #1104

v3.0.0-rc0 / 2017-10-02

IT'S-DONE.GIF EDITION

See UPGRADE-3.0.md for a complete & living upgrade guide.

See 3.0.0.md for a list of remaining RC tasks.

  • Rewrite of core logging internals: Logger & Transport are now implemented using Node.js objectMode streams.
  • Your transports should not break: Special attention has been given to ensure backwards compatibility with existing transports. You will likely see this:
YourTransport is a legacy winston transport. Consider upgrading to winston@3:
- Upgrade docs: https://github.com/winstonjs/winston/tree/master/UPGRADE.md
  • filters, rewriters, and common.log are now formats: winston.format offers a simple mechanism for user-land formatting & style features. The organic & frankly messy growth of common.log is of the past; these feature requests can be implemented entirely outside of winston itself.
const { createLogger, format, transports } = require('winston');
const { combine, timestamp, label, printf } = format;

const myFormat = printf(info => {
  return `${info.timestamp} [${info.label}] ${info.level}: ${info.message}`;
});

const logger = createLogger({
  combine(
    label({ label: 'right meow!' }),
    timestamp(),
    myFormat
  ),
  transports: [new transports.Console()]
});
  • Increased modularity: several subsystems are now stand-alone packages:
    • [logform] exposed as winston.format
    • [winston-transport] exposed as winston.Transport
    • [abstract-winston-transport] used for reusable unit test suites for transport authors.
  • 2.x branch will get little to no maintenance: no feature requests will be accepted – only a limited number of open PRs will be merged. Hoping the [significant performance benefits][perf-bench] incentivizes folks to upgrade quickly. Don't agree? Say something!
  • No guaranteed support for node@4 or below: all code will be migrated to ES6 over time. This release was started when ES5 was still a hard requirement due to the current LTS needs.

v2.4.0 / 2017-10-01

ZOMFG [email protected] EDITION

  • [#1036] Container.add() 'filters' and 'rewriters' option passing to logger.
  • [#1066] Fixed working of "humanReadableUnhandledException" parameter when additional data is added in meta.
  • [#1040] Added filtering by log level
  • [#1042] Fix regressions brought by 2.3.1.
    • Fix regression on array printing.
    • Fix regression on falsy value.
  • [#977] Always decycle objects before cloning.
    • Fixes [#862]
    • Fixes [#474]
    • Fixes [#914]
  • [57af38a] Missing context in .lazyDrain of File transport.
  • [178935f] Suppress excessive Node warning from fs.unlink.
  • [fcf04e1] Add label option to File transport docs.
  • [7e736b4], [24300e2] Added more info about undocumented winston.startTimer() method.
  • [#1076], [#1082], [#1029], [#989], [e1e7188] Minor grammatical & style updates to README.md.

v2.3.1 / 2017-01-20

WELCOME TO THE APOCALYPSE EDITION

  • #868, Fix 'Maximum call stack size exceeded' error with custom formatter.

v2.3.0 / 2016-11-02

ZOMG WHY WOULD YOU ASK EDITION

v2.2.0 / 2016-02-25

LEAVING CALIFORNIA EDITION

v2.1.1 / 2015-11-18

COLOR ME IMPRESSED EDITION

  • #751, Fix colors not appearing in non-tty environments. Fixes #609, #616, #669, #648 (fiznool).
  • #752 Correct syslog RFC number. 5424 instead of 524. (jbenoit2011)

v2.1.0 / 2015-11-03

TEST ALL THE ECOSYSTEM EDITION

  • #742, 32d52b7 Distribute common test files used by transports in the winston ecosystem.

v2.0.1 / 2015-11-02

BUGS ALWAYS HAPPEN OK EDITION

  • #739, 1f16861 Ensure that logger.log("info", undefined) does not throw.

v2.0.0 / 2015-10-29

OMG IT'S MY SISTER'S BIRTHDAY EDITION

Breaking changes

Most important

  • 0f82204 Move winston.transports.DailyRotateFile into a separate module: require('winston-daily-rotate-file');
  • fb9eec0 Reverse log levels in npm and cli configs to conform to RFC524. Fixes #424 #406 #290
  • 8cd8368 Change the method signature to a filter function to be consistent with rewriter and log functions:
function filter (level, msg, meta, inst) {
  // Filter logic goes here...
}

Other breaking changes

  • e0c9dde Remove winston.transports.Webhook. Use winston.transports.Http instead.
  • f71e638 Remove Logger.prototype.addRewriter and Logger.prototype.addFilter since they just push to an Array of functions. Use logger.filters.push or logger.rewriters.push explicitly instead.
  • a470ab5 No longer respect the handleExceptions option to new winston.Logger. Instead just pass in the exceptionHandlers option itself.
  • 8cb7048 Removed Logger.prototype.extend functionality

New features

  • 3aa990c Added Logger.prototype.configure which now contains all logic previously in the winston.Logger constructor function. (indexzero)
  • #726 Update .npmignore (coreybutler)
  • #700 Add an eol option to the Console transport. (aquavitae)
  • #731 Update lib/transports.js for better static analysis. (indexzero)

Fixes, refactoring, and optimizations. OH MY!

  • #632 Allow File transport to be an objectMode writable stream. (stambata)
  • #527, 163f4f9, 3747ccf Performance optimizations and string interpolation edge cases (indexzero)
  • f0edafd Code cleanup for reability, ad-hoc styleguide enforcement (indexzero)

v1.1.1 - v1.1.2 / 2015-10

MINOR FIXES EDITION

Notable changes

  • 727 Fix "raw" mode (jcrugzz)
  • 703 Do not modify Error or Date objects when logging. Fixes #610 (harriha).

v1.1.0 / 2015-10-09

GREETINGS FROM CARTAGENA EDITION

Notable Changes

  • #721 Fixed octal literal to work with node 4 strict mode (wesleyeff)
  • #630 Add stderrLevels option to Console Transport and update docs (paulhroth)
  • #626 Add the logger (this) in the fourth argument in the rewriters and filters functions (christophehurpeau )
  • #623 Fix Console Transport's align option tests (paulhroth, kikobeats)
  • #692 Adding winston-aws-cloudwatch to transport docs (timdp)

v1.0.2 2015-09-25

LET'S TALK ON GITTER EDITION

Notable Changes

  • de80160 Add Gitter badge (The Gitter Badger)
  • 44564de [fix] Correct listeners in logException. Fixes #218 #213 #327. (indexzero)
  • 45b1eeb [fix] Get tailFile function working on latest/all node versions (Christopher Jeffrey)
  • c6d45f9 Fixed event subscription on close (Roman Stetsyshin)

Other changes

v1.0.1 / 2015-06-26

YAY DOCS EDITION

v1.0.0 / 2015-04-07

OMG 1.0.0 FINALLY EDITION

Breaking Changes

  • #587 Do not extend String prototypes as a side effect of using colors. (kenperkins)
  • #581 File transports now emit error on error of the underlying streams after maxRetries attempts. (ambbell).
  • #583, 92729a Use os.EOL for all file writing by default. (Mik13, indexzero)
  • #532 Delete logger instance from Container when close event is emitted. (snater)
  • #380 Rename duration to durationMs, which is now a number a not a string ending in ms. (neoziro)
  • #253 Do not set a default level. When level is falsey on any Transport instance, any Logger instance uses the configured level (instead of the Transport level) (jstamerj).

Other changes

  • b83de62 Fix rendering of stack traces.
  • c899cc Update documentation (Fixes #549)
  • #551 Filter metadata along with messages
  • #578 Fixes minor issue with maxFiles in File transport (Fixes #556).
  • #560 Added showLevel support to File transport.
  • #558 Added showLevel support to Console transport.

v0.9.0 / 2015-02-03

  • #496 Updated default option handling for CLI (oojacoboo).
  • f37634b [dist] Only support node >= 0.8.0. (indexzero)
  • 91a1e90, 50163a0 Fix #84 Enable a better unhandled exception experience (samz)
  • 8b5fbcd #448 Added tailable option to file transport which rolls files backwards instead of creating incrementing appends. Implements #268 (neouser99)
  • a34f7d2 Custom log formatter functionality were added. (Melnyk Andii)
  • 4c08191 Added showLevel flag to common.js, file*, memory and console transports. (Tony Germaneri)
  • 64ed8e0 Adding custom pretty print function test. (Alberto Pose)
  • 3872dfb Adding prettyPrint parameter as function example. (Alberto Pose)
  • 2b96eee implemented filters #526 (Chris Oloff)
  • 72273b1 Added the options to colorize only the level, only the message or all. Default behavior is kept. Using true will only colorize the level and false will not colorize anything. (Michiel De Mey)
  • 178e8a6 Prevent message from meta input being overwritten (Leonard Martin)
  • 270be86 [api] Allow for transports to be removed by their string name [test fix] Add test coverage for multiple transports of the same type added in #187. [doc] Document using multiple transports of the same type (indexzero)
  • 0a848fa Add depth options for meta pretty print (Loïc Mahieu)
  • 106b670 Allow debug messages to be sent to stdout (John Frizelle)
  • ad2d5e1 [fix] Handle Error instances in a sane way since their properties are non-enumerable by default. Fixes #280. (indexzero)
  • 5109dd0 [fix] Have a default until before a default from. Fixes #478. (indexzero)
  • d761960 Fix logging regular expression objects (Chasen Le Hara)
  • 2632eb8 Add option for EOL chars on FileTransport (José F. Romaniello)
  • bdecce7 Remove duplicate logstash option (José F. Romaniello)
  • 7a01f9a Update declaration block according to project's style guide (Ricardo Torres)
  • ae27a19 Fixes #306: Can't set customlevels to my loggers (RangeError: Maximum call stack size exceeded) (Alberto Pose)
  • 1ba4f51 [fix] Call res.resume() in HttpTransport to get around known issues in streams2. (indexzero)
  • 39e0258 Updated default option handling for CLI (Jacob Thomason)
  • 8252801 Added logstash support to console transport (Ramon Snir)
  • 18aa301 Module isStream should be isstream (Michael Neil)
  • 2f5f296 options.prettyPrint can now be a function (Matt Zukowski)
  • a87a876 Adding rotationFormat prop to file.js (orcaman)
  • ff187f4 Allow custom exception level (jupiter)

0.8.3 / 2014-11-04

0.8.2 / 2014-11-04

0.8.1 / 2014-10-06

0.8.0 / 2014-09-15

## 0.6.2 / 2012-07-08

  • Added prettyPrint option for console logging
  • Multi-line values for conditional returns are not allowed
  • Added acceptance of stringify option
  • Fixed padding for log levels