# CHANGELOG ## [v3.9.0](https://github.com/winstonjs/winston/compare/v3.8.2...v3.9.0) ### Functionality changes * Handle undefined errors in getAllInfo in exception-handler in https://github.com/winstonjs/winston/pull/2208; thanks to new contributor @eivindrs * fix: properly allow passing non-array transport in https://github.com/winstonjs/winston/pull/2256; thanks to new contributor @Tanuel * fix #1732 (Http Transport uses JSON format options as request options) in https://github.com/winstonjs/winston/pull/2272; thanks to new contributor @MoritzLoewenstein (minor version bump per comment on the issue) * fix: add guard clause to prevent FD leak in https://github.com/winstonjs/winston/pull/2301; thanks to new contributor @td-tomasz-joniec ### Dependency updates by @dependabot + CI autotesting * Bump eslint from 8.23.0 to 8.32.0 by @dependabot in https://github.com/winstonjs/winston/pull/2209, https://github.com/winstonjs/winston/pull/2236, https://github.com/winstonjs/winston/pull/2258, & https://github.com/winstonjs/winston/pull/2271 * Bump @babel/core from 7.19.0 to 7.20.12 by @dependabot in https://github.com/winstonjs/winston/pull/2206, https://github.com/winstonjs/winston/pull/2234, https://github.com/winstonjs/winston/pull/2259, & https://github.com/winstonjs/winston/pull/2275 * Bump @types/node from 18.0.0 to 18.11.18 by @dependabot in https://github.com/winstonjs/winston/pull/2215, https://github.com/winstonjs/winston/pull/2235, & https://github.com/winstonjs/winston/pull/2264 * Bump @babel/preset-env from 7.19.0 to 7.20.2 by @dependabot in https://github.com/winstonjs/winston/pull/2218 & https://github.com/winstonjs/winston/pull/2244 * Bump safe-stable-stringify from 2.3.1 to 2.4.3 by @dependabot in https://github.com/winstonjs/winston/pull/2217 & https://github.com/winstonjs/winston/pull/2292 * Bump @babel/cli from 7.18.10 to 7.19.3 by @dependabot in https://github.com/winstonjs/winston/pull/2216 * Bump json5 from 2.2.1 to 2.2.3 by @dependabot in https://github.com/winstonjs/winston/pull/2260 ### Documentation changes * Fix readme typo in https://github.com/winstonjs/winston/pull/2230; thanks to new contributor @aretecode * create new example for ready to use in https://github.com/winstonjs/winston/pull/2240; thanks to new contributor @myagizmaktav * minor fixes to publishing.md ### Build Infrastructure changes * GitHub Workflows security hardening in https://github.com/winstonjs/winston/pull/2252; thanks to new contributor @sashashura ## [v3.8.2](https://github.com/winstonjs/winston/compare/v3.8.1...v3.8.2) ### Patch-level changes * Add `.js` to main entry point in package.json in https://github.com/winstonjs/winston/pull/2177; thanks to new contributor @rumanbsl * Small grammatical fixes in README.md in https://github.com/winstonjs/winston/pull/2183; thanks to new contributor @mikebarr24 * Move colors to non-dev dependencies by @wbt in https://github.com/winstonjs/winston/pull/2190 ### Dependency updates by @dependabot + CI autotesting * Bump @babel/preset-env from 7.18.2 to 7.19.0 in https://github.com/winstonjs/winston/pull/2189 * Bump @babel/cli from 7.17.10 to 7.18.10 in https://github.com/winstonjs/winston/pull/2173 * Bump eslint from 8.18.0 to 8.23.0 in https://github.com/winstonjs/winston/pull/2184 * Bump @babel/core from 7.18.5 to 7.19.0 in https://github.com/winstonjs/winston/pull/2192 * Bump logform from 2.4.1 to 2.4.2 in https://github.com/winstonjs/winston/pull/2191 ## [v3.8.1](https://github.com/winstonjs/winston/compare/v3.8.0...v3.8.1) ### Patch-level changes * Update types to match in-code definitions in https://github.com/winstonjs/winston/pull/2157; thanks to new contributor @flappyBug ### Dependency updates by @dependabot + CI autotesting * Bump logform from 2.4.0 to 2.4.1 in https://github.com/winstonjs/winston/pull/2156 * Bump async from 3.2.3 to 3.2.4 in https://github.com/winstonjs/winston/pull/2147 ## [v3.8.0](https://github.com/winstonjs/winston/compare/v3.7.2...v3.8.0) / 2022-06-23 ### Added functionality * Add the stringify replacer option to the HTTP transport by @domiins in https://github.com/winstonjs/winston/pull/2155 ### Dependency updates by @dependabot + CI autotesting * Bump @babel/core from 7.17.8 to 7.18.5 * Bump eslint from 8.12.0 to 8.18.0 * Bump @types/node from 17.0.23 to 18.0.0 * Bump @babel/preset-env from 7.16.11 to 7.18.2 * Bump @babel/cli from 7.17.6 to 7.17.10 ### Updates facilitating repo maintenance & enhancing documentation * Explicitly note that the Contributing.md file is out of date * Add instructions for publishing updated version by @wbt (docs/publishing.md) * Prettier Config File by @jeanpierrecarvalho in https://github.com/winstonjs/winston/pull/2092 * Readme update to explain origin of errors for handling (#2120) * update documentation for #2114 by @zizifn in https://github.com/winstonjs/winston/pull/2138 * enhance message for logs with no transports #2114 by @zizifn in https://github.com/winstonjs/winston/pull/2139 * Added a new Community Transport option to the list: Worker Thread based async Console Transport by @arpad1337 in https://github.com/winstonjs/winston/pull/2140 Thanks especially to new contributors @zizifn, @arpad1337, @domiins, & @jeanpierrecarvalho! ## v3.7.2 / 2022-04-04 This change reverts what should have been the feature-level update in 3.7.0 due to issue #2103 showing this to be breaking, unintentionally. ## v3.7.1 / 2022-04-04 This change includes some minor updates to package-lock.json resolving npm audit failures: one in [ansi-regex](https://github.com/advisories/GHSA-93q8-gq69-wqmw) and another in [minimist](https://github.com/advisories/GHSA-xvch-5gv4-984h). ## v3.7.0 / 2022-03-30 Feature-level updates: - [#1989] Fix: resolve issues with metadata and the associated overriding behavior (thanks @maverick1872, @wbt, @DABH, @fearphage and issue reporters) Patch-level updates: - [#2075] Fix: add missing types for batching options for HTTP Transport (thanks @KylinDC) - Various dependencies updated, quality of life & maintainability changes, etc ## v3.6.0 / 2022-02-12 - [#2057] Fix potential memory leak by not waiting for `process.nextTick` before clearing pending callbacks (thanks @smashah!) - [#2071] Update to `logform` 2.4.0, which includes changes such as new options for `JsonOptions` and some typo fixes regarding levels - Various other dependencies are updated, tests are reorganized and cleaned up, etc. (thanks @wbt, @Maverick1872, @fearphage!) ## v3.5.1 / 2022-01-31 This release reverts the changes made in PR #1896 which added stricter typing to the available log levels, and inadvertently broke use of custom levels with TypeScript (Issue #2047). Apologies for that! ## v3.5.0 / 2022-01-27 This release includes the following, in sequence by first merge in group: Feature updates: - Support batch mode in HTTP Transport (Issue #1970, PR #1998, thanks @BBE78!) Patch-level updates: - Bump dependency versions (thanks @dependabot & @DABH!) - Bump @types/node from 16.11.12 to 17.0.8 (PR #2009) - Bump @babel/preset-env from 7.16.7 to 7.16.8 (#2036) - Bump @types/node from 17.0.8 to 17.0.9 (#2035) - Bump @babel/cli from 7.16.7 to 7.16.8 (#2034) - Bump @types/node from 17.0.9 to 17.0.10 (#2042) - Bump @babel/core from 7.16.7 to 7.16.12 (#2041) - Bump @babel/preset-env from 7.16.8 to 7.16.11 (#2040) - Fixing documentation syntax errors in transports code examples (#1916; thanks @romanzaycev!) - Fix missing type declarations, especially for `.rejections` (#1842, #1929, #2021; thanks @vanflux, @svaj, @glensc, & others!) - More narrowly typing the “level” string (#1896, thanks @yonas-g!) - Using a safer `stringify`, e.g. to avoid issues from circular structures, in the http transport (#2043, thanks @karlwir!) Updates to the repo & project which don’t actually affect the running code: - Add a channel for reporting security vulnerabilities (#2024, thanks @JamieSlome!) - Add coverage tracking in CI & documentation (#2025 and #2028, thanks @fearphage!) - Update issue templates (#2030 and #2031, thanks @Maverick1872!) - Remove gitter link from README.md (#2027, thanks @DABH!) Thanks also to maintainers @DABH, @fearphage, @Maverick1872, and @wbt for issue/PR shepherding and help across multiple parts of the release! If somebody got missed in the list of thanks, please forgive the accidental oversight and/or feel free to open a PR on this changelog. ## v3.4.0 / 2022-01-10 Yesterday's release was done with a higher sense of urgency than usual due to vandalism in the `colors` package. This release: - ties up a loose end by including [#1973] to go with [#1824] - adds a missing http property in NpmConfigSetColors [#2004] (thanks @SimDaSong) - fixes a minor issue in the build/release process [#2014] - pins the version of the testing framework to avoid an issue with a test incorrectly failing [#2017] The biggest change in this release, motivating the feature-level update, is [#2006] Make winston more ESM friendly, thanks to @miguelcobain. Thanks also to @DABH, @wbt, and @fearphage for contributions and reviews! ## v3.3.4 / 2022-01-09 Compared to v3.3.3, this version fixes some issues and includes some updates to project infrastructure, such as replacing Travis with Github CI and dependabot configuration. There have also been several relatively minor improvements to documentation, and incorporation of some updated dependencies. Dependency updates include a critical bug fix [#2008] in response to self-vandalism by the author of a dependency. - [#1964] Added documentation for how to use a new externally maintained [Seq](https://datalust.co/seq) transport. - [#1712] Add default metadata when calling log with string level and message. - [#1824] Unbind event listeners on close - [#1961] Handle undefined rejections - [#1878] Correct boolean evaluation of empty-string value for eol option - [#1977] Improved consistency of object parameters for better test reliability ## v3.3.3 / 2020-06-23 - [#1820] Revert [#1807] to resolve breaking changes for Typescript users. ## v3.3.2 / 2020-06-22 - [#1814] Use a fork of `diagnostics` published to NPM to avoid git dependency. ## v3.3.1 / 2020-06-21 - [#1803], [#1807] Fix TypeScript bugs. - [#1740] Add space between `info.message` and `meta.message`. - [#1813] Avoid indirect storage-engine dependency. - [#1810] README updates. ## v3.3.0 / 2020-06-21 - [#1779] Fix property name in rejection handler. - [#1768] Exclude extraneous files from NPM package. - [#1364], [#1714] Don't remove transport from logger when transport error occurs. - [#1603] Expose `child` property on default logger. - [#1777] Allow HTTP transport to pass options to request. - [#1662] Add bearer auth capabilities to HTTP transport. - [#1612] Remove no-op in file transport. - [#1622], [#1623], [#1625] Typescript fixes. - (Minor) [#1647], [#1793] Update CI settings. - (Minor) [#1600], [#1605], [#1593], [#1610], [#1654], [#1656], [#1661], [#1651], [#1652], [#1677], [#1683], [#1684], [#1700], [#1697], [#1650], [#1705], [#1723], [#1737], [#1733], [#1743], [#1750], [#1754], [#1780], [#1778] README, Transports.md, other docs changes. - [#1672], [#1686], [#1772] Update dependencies. ## v3.2.1 / 2019-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 / 2019-01-26 ### SORRY IT TOO SO LONG EDITION > **NOTE:** this was our first release using Github Projects. See the > [3.2.0 Release Project](https://github.com/orgs/winstonjs/projects/3). ### 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 `error`s. - [#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 `logform@2.0.0`,** `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. ``` js 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 && logform@1.x 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 && logform@2.x 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 `winston@3.0.0`** - [#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 `winston-transport@4.0.0` 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 `winston@3.0.0` 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 `winston@3.0.0`** - **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 ``` js 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 - `logform@1.4.1` - 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](https://github.com/winstonjs/winston/pull/1104) ## v3.0.0-rc0 / 2017-10-02 ### IT'S-DONE.GIF EDITION **See [UPGRADE-3.0.md](UPGRADE-3.0.md) for a complete & living upgrade guide.** **See [3.0.0.md](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. ``` js 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 WINSTON@3.0.0-RC0 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](https://github.com/winstonjs/winston/pull/868), Fix 'Maximum call stack size exceeded' error with custom formatter. ## v2.3.0 / 2016-11-02 ### ZOMG WHY WOULD YOU ASK EDITION - Full `CHANGELOG.md` entry forthcoming. See [the `git` diff for `2.3.0`](https://github.com/winstonjs/winston/compare/2.2.0...2.3.0) for now. ## v2.2.0 / 2016-02-25 ### LEAVING CALIFORNIA EDITION - Full `CHANGELOG.md` entry forthcoming. See [the `git` diff for `2.2.0`](https://github.com/winstonjs/winston/compare/2.1.1...2.2.0) for now. ## v2.1.1 / 2015-11-18 ### COLOR ME IMPRESSED EDITION - [#751](https://github.com/winstonjs/winston/pull/751), Fix colors not appearing in non-tty environments. Fixes [#609](https://github.com/winstonjs/winston/issues/609), [#616](https://github.com/winstonjs/winston/issues/616), [#669](https://github.com/winstonjs/winston/issues/669), [#648](https://github.com/winstonjs/winston/issues/648) (`fiznool`). - [#752](https://github.com/winstonjs/winston/pull/752) Correct syslog RFC number. 5424 instead of 524. (`jbenoit2011`) ## v2.1.0 / 2015-11-03 ### TEST ALL THE ECOSYSTEM EDITION - [#742](https://github.com/winstonjs/winston/pull/742), [32d52b7](https://github.com/winstonjs/winston/commit/32d52b7) Distribute common test files used by transports in the `winston` ecosystem. ## v2.0.1 / 2015-11-02 ### BUGS ALWAYS HAPPEN OK EDITION - [#739](https://github.com/winstonjs/winston/issues/739), [1f16861](https://github.com/winstonjs/winston/commit/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](https://github.com/winstonjs/winston/commit/0f82204) Move `winston.transports.DailyRotateFile` [into a separate module](https://github.com/winstonjs/winston-daily-rotate-file)**: `require('winston-daily-rotate-file');` - **[fb9eec0](https://github.com/winstonjs/winston/commit/fb9eec0) Reverse log levels in `npm` and `cli` configs to conform to [RFC524](https://tools.ietf.org/html/rfc5424). Fixes [#424](https://github.com/winstonjs/winston/pull/424) [#406](https://github.com/winstonjs/winston/pull/406) [#290](https://github.com/winstonjs/winston/pull/290)** - **[8cd8368](https://github.com/winstonjs/winston/commit/8cd8368) Change the method signature to a `filter` function to be consistent with `rewriter` and log functions:** ``` js function filter (level, msg, meta, inst) { // Filter logic goes here... } ``` **Other breaking changes** - [e0c9dde](https://github.com/winstonjs/winston/commit/e0c9dde) Remove `winston.transports.Webhook`. Use `winston.transports.Http` instead. - [f71e638](https://github.com/winstonjs/winston/commit/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](https://github.com/winstonjs/winston/commit/a470ab5) No longer respect the `handleExceptions` option to `new winston.Logger`. Instead just pass in the `exceptionHandlers` option itself. - [8cb7048](https://github.com/winstonjs/winston/commit/8cb7048) Removed `Logger.prototype.extend` functionality #### New features - [3aa990c](https://github.com/winstonjs/winston/commit/3aa990c) Added `Logger.prototype.configure` which now contains all logic previously in the `winston.Logger` constructor function. (`indexzero`) - [#726](https://github.com/winstonjs/winston/pull/726) Update .npmignore (`coreybutler`) - [#700](https://github.com/winstonjs/winston/pull/700) Add an `eol` option to the `Console` transport. (`aquavitae`) - [#731](https://github.com/winstonjs/winston/pull/731) Update `lib/transports.js` for better static analysis. (`indexzero`) #### Fixes, refactoring, and optimizations. OH MY! - [#632](https://github.com/winstonjs/winston/pull/632) Allow `File` transport to be an `objectMode` writable stream. (`stambata`) - [#527](https://github.com/winstonjs/winston/issues/527), [163f4f9](https://github.com/winstonjs/winston/commit/163f4f9), [3747ccf](https://github.com/winstonjs/winston/commit/3747ccf) Performance optimizations and string interpolation edge cases (`indexzero`) - [f0edafd](https://github.com/winstonjs/winston/commit/f0edafd) Code cleanup for reability, ad-hoc styleguide enforcement (`indexzero`) ## v1.1.1 - v1.1.2 / 2015-10 ### MINOR FIXES EDITION #### Notable changes * [727](https://github.com/winstonjs/winston/pull/727) Fix "raw" mode (`jcrugzz`) * [703](https://github.com/winstonjs/winston/pull/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](https://github.com/winstonjs/winston/pull/721) Fixed octal literal to work with node 4 strict mode (`wesleyeff`) * [#630](https://github.com/winstonjs/winston/pull/630) Add stderrLevels option to Console Transport and update docs (`paulhroth`) * [#626](https://github.com/winstonjs/winston/pull/626) Add the logger (this) in the fourth argument in the rewriters and filters functions (`christophehurpeau `) * [#623](https://github.com/winstonjs/winston/pull/623) Fix Console Transport's align option tests (`paulhroth`, `kikobeats`) * [#692](https://github.com/winstonjs/winston/pull/692) Adding winston-aws-cloudwatch to transport docs (`timdp`) ## v1.0.2 2015-09-25 ### LET'S TALK ON GITTER EDITION #### Notable Changes * [de80160](https://github.com/winstonjs/winston/commit/de80160) Add Gitter badge (`The Gitter Badger`) * [44564de](https://github.com/winstonjs/winston/commit/44564de) [fix] Correct listeners in `logException`. Fixes [#218](https://github.com/winstonjs/winston/issues/218) [#213](https://github.com/winstonjs/winston/issues/213) [#327](https://github.com/winstonjs/winston/issues/327). (`indexzero`) * [45b1eeb](https://github.com/winstonjs/winston/commit/45b1eeb) [fix] Get `tailFile` function working on latest/all node versions (`Christopher Jeffrey`) * [c6d45f9](https://github.com/winstonjs/winston/commit/c6d45f9) Fixed event subscription on close (`Roman Stetsyshin`) #### Other changes * TravisCI updates & best practices [87b97cc](https://github.com/winstonjs/winston/commit/87b97cc) [91a5bc4](https://github.com/winstonjs/winston/commit/91a5bc4), [cf24e6a](https://github.com/winstonjs/winston/commit/cf24e6a) (`indexzero`) * [d5397e7](https://github.com/winstonjs/winston/commit/d5397e7) Bump async version (`Roderick Hsiao`) * Documentation updates & fixes [86d7527](https://github.com/winstonjs/winston/commit/86d7527), [38254c1](https://github.com/winstonjs/winston/commit/38254c1), [04e2928](https://github.com/winstonjs/winston/commit/04e2928), [61c8a89](https://github.com/winstonjs/winston/commit/61c8a89), [c42a783](https://github.com/winstonjs/winston/commit/c42a783), [0688a22](https://github.com/winstonjs/winston/commit/0688a22), [eabc113](https://github.com/winstonjs/winston/commit/eabc113) [c9506b7](https://github.com/winstonjs/winston/commit/c9506b7), [17534d2](https://github.com/winstonjs/winston/commit/17534d2), [b575e7b](https://github.com/winstonjs/winston/commit/b575e7b) (`Stefan Thies`, `charukiewicz`, `unLucio`, `Adam Cohen`, `Denis Gorbachev`, `Frederik Ring`, `Luigi Pinca`, `jeffreypriebe`) * Documentation refactor & cleanup [a19607e](https://github.com/winstonjs/winston/commit/a19607e), [d1932b4](https://github.com/winstonjs/winston/commit/d1932b4), [7a13132](https://github.com/winstonjs/winston/commit/7a13132) (`indexzero`) ## v1.0.1 / 2015-06-26 ### YAY DOCS EDITION * [#639](https://github.com/winstonjs/winston/pull/639) Fix for [#213](https://github.com/winstonjs/winston/issues/213): More than 10 containers triggers EventEmitter memory leak warning (`marcus`) * Documentation and `package.json` updates [cec892c](https://github.com/winstonjs/winston/commit/cec892c), [2f13b4f](https://github.com/winstonjs/winston/commit/2f13b4f), [b246efd](https://github.com/winstonjs/winston/commit/b246efd), [22a5f5a](https://github.com/winstonjs/winston/commit/22a5f5a), [5868b78](https://github.com/winstonjs/winston/commit/5868b78), [99b6b44](https://github.com/winstonjs/winston/commit/99b6b44), [447a813](https://github.com/winstonjs/winston/commit/447a813), [7f75b48](https://github.com/winstonjs/winston/commit/7f75b48) (`peteward44`, `Gilad Peleg`, `Anton Ian Sipos`, `nimrod-becker`, `LarsTi`, `indexzero`) ## v1.0.0 / 2015-04-07 ### OMG 1.0.0 FINALLY EDITION #### Breaking Changes * [#587](https://github.com/winstonjs/winston/pull/587) Do not extend `String` prototypes as a side effect of using `colors`. (`kenperkins`) * [#581](https://github.com/winstonjs/winston/pull/581) File transports now emit `error` on error of the underlying streams after `maxRetries` attempts. (`ambbell`). * [#583](https://github.com/winstonjs/winston/pull/583), [92729a](https://github.com/winstonjs/winston/commit/92729a68d71d07715501c35d94d2ac06ac03ca08) Use `os.EOL` for all file writing by default. (`Mik13`, `indexzero`) * [#532](https://github.com/winstonjs/winston/pull/532) Delete logger instance from `Container` when `close` event is emitted. (`snater`) * [#380](https://github.com/winstonjs/winston/pull/380) Rename `duration` to `durationMs`, which is now a number a not a string ending in `ms`. (`neoziro`) * [#253](https://github.com/winstonjs/winston/pull/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](https://github.com/winstonjs/winston/commit/b83de62) Fix rendering of stack traces. * [c899cc](https://github.com/winstonjs/winston/commit/c899cc1f0719e49b26ec933e0fa263578168ea3b) Update documentation (Fixes [#549](https://github.com/winstonjs/winston/issues/549)) * [#551](https://github.com/winstonjs/winston/pull/551) Filter metadata along with messages * [#578](https://github.com/winstonjs/winston/pull/578) Fixes minor issue with `maxFiles` in `File` transport (Fixes [#556](https://github.com/winstonjs/winston/issues/556)). * [#560](https://github.com/winstonjs/winston/pull/560) Added `showLevel` support to `File` transport. * [#558](https://github.com/winstonjs/winston/pull/558) Added `showLevel` support to `Console` transport. ## v0.9.0 / 2015-02-03 * [#496](https://github.com/flatiron/winston/pull/496) Updated default option handling for CLI (`oojacoboo`). * [f37634b](https://github.com/flatiron/winston/commit/f37634b) [dist] Only support `node >= 0.8.0`. (`indexzero`) * [91a1e90](https://github.com/flatiron/winston/commit/91a1e90), [50163a0](https://github.com/flatiron/winston/commit/50163a0) Fix #84 [Enable a better unhandled exception experience](https://github.com/flatiron/winston/issues/84) (`samz`) * [8b5fbcd](https://github.com/flatiron/winston/commit/8b5fbcd) #448 Added tailable option to file transport which rolls files backwards instead of creating incrementing appends. Implements #268 (`neouser99`) * [a34f7d2](https://github.com/flatiron/winston/commit/a34f7d2) Custom log formatter functionality were added. (`Melnyk Andii`) * [4c08191](https://github.com/flatiron/winston/commit/4c08191) Added showLevel flag to common.js, file*, memory and console transports. (`Tony Germaneri`) * [64ed8e0](https://github.com/flatiron/winston/commit/64ed8e0) Adding custom pretty print function test. (`Alberto Pose`) * [3872dfb](https://github.com/flatiron/winston/commit/3872dfb) Adding prettyPrint parameter as function example. (`Alberto Pose`) * [2b96eee](https://github.com/flatiron/winston/commit/2b96eee) implemented filters #526 (`Chris Oloff`) * [72273b1](https://github.com/flatiron/winston/commit/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](https://github.com/flatiron/winston/commit/178e8a6) Prevent message from meta input being overwritten (`Leonard Martin`) * [270be86](https://github.com/flatiron/winston/commit/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](https://github.com/flatiron/winston/commit/0a848fa) Add depth options for meta pretty print (`Loïc Mahieu`) * [106b670](https://github.com/flatiron/winston/commit/106b670) Allow debug messages to be sent to stdout (`John Frizelle`) * [ad2d5e1](https://github.com/flatiron/winston/commit/ad2d5e1) [fix] Handle Error instances in a sane way since their properties are non-enumerable __by default.__ Fixes #280. (`indexzero`) * [5109dd0](https://github.com/flatiron/winston/commit/5109dd0) [fix] Have a default `until` before a default `from`. Fixes #478. (`indexzero`) * [d761960](https://github.com/flatiron/winston/commit/d761960) Fix logging regular expression objects (`Chasen Le Hara`) * [2632eb8](https://github.com/flatiron/winston/commit/2632eb8) Add option for EOL chars on FileTransport (`José F. Romaniello`) * [bdecce7](https://github.com/flatiron/winston/commit/bdecce7) Remove duplicate logstash option (`José F. Romaniello`) * [7a01f9a](https://github.com/flatiron/winston/commit/7a01f9a) Update declaration block according to project's style guide (`Ricardo Torres`) * [ae27a19](https://github.com/flatiron/winston/commit/ae27a19) Fixes #306: Can't set customlevels to my loggers (RangeError: Maximum call stack size exceeded) (`Alberto Pose`) * [1ba4f51](https://github.com/flatiron/winston/commit/1ba4f51) [fix] Call `res.resume()` in HttpTransport to get around known issues in streams2. (`indexzero`) * [39e0258](https://github.com/flatiron/winston/commit/39e0258) Updated default option handling for CLI (`Jacob Thomason`) * [8252801](https://github.com/flatiron/winston/commit/8252801) Added logstash support to console transport (`Ramon Snir`) * [18aa301](https://github.com/flatiron/winston/commit/18aa301) Module isStream should be isstream (`Michael Neil`) * [2f5f296](https://github.com/flatiron/winston/commit/2f5f296) options.prettyPrint can now be a function (`Matt Zukowski`) * [a87a876](https://github.com/flatiron/winston/commit/a87a876) Adding rotationFormat prop to file.js (`orcaman`) * [ff187f4](https://github.com/flatiron/winston/commit/ff187f4) Allow custom exception level (`jupiter`) ## 0.8.3 / 2014-11-04 * [fix lowercase issue (`jcrugzz`)](https://github.com/flatiron/winston/commit/b3ffaa10b5fe9d2a510af5348cf4fb3870534123) ## 0.8.2 / 2014-11-04 * [Full fix for #296 with proper streams2 detection with `isstream` for file transport (`jcrugzz`)](https://github.com/flatiron/winston/commit/5c4bd4191468570e46805ed399cad63cfb1856cc) * [Add isstream module (`jcrugzz`)](https://github.com/flatiron/winston/commit/498b216d0199aebaef72ee4d8659a00fb737b9ae) * [Partially fix #296 with streams2 detection for file transport (`indexzero`)](https://github.com/flatiron/winston/commit/b0227b6c27cf651ffa8b8192ef79ab24296362e3) * [add stress test for issue #288 (`indexzero`)](https://github.com/flatiron/winston/commit/e08e504b5b3a00f0acaade75c5ba69e6439c84a6) * [lessen timeouts to check test sanity (`indexzero`)](https://github.com/flatiron/winston/commit/e925f5bc398a88464f3e796545ff88912aff7568) * [update winston-graylog2 documentation (`unlucio`)](https://github.com/flatiron/winston/commit/49fa86c31baf12c8ac3adced3bdba6deeea2e363) * [fix test formatting (`indexzero`)](https://github.com/flatiron/winston/commit/8e2225799520a4598044cdf93006d216812a27f9) * [fix so options are not redefined (`indexzero`)](https://github.com/flatiron/winston/commit/d1d146e8a5bb73dcb01579ad433f6d4f70b668ea) * [fix self/this issue that broke `http` transport (`indexzero`)](https://github.com/flatiron/winston/commit/d10cbc07755c853b60729ab0cd14aa665da2a63b) ## 0.8.1 / 2014-10-06 * [Add label option for DailyRotateFile transport (`francoisTemasys`)](https://github.com/flatiron/winston/pull/459) * [fix Logger#transports length check upon Logger#log (`adriano-di-giovanni`, `indexzero`)](https://github.com/flatiron/winston/pull/404) * [err can be a string. (`gdw2`, `indexzero`)](https://github.com/flatiron/winston/pull/396) * [Added color for pre-defined cli set. (`danilo1105`, `indexzero`)](https://github.com/flatiron/winston/pull/365) * [Fix dates on transport test (`revington`)](https://github.com/flatiron/winston/pull/346) * [Included the label from options to the output in JSON mode. (`arxony`)](https://github.com/flatiron/winston/pull/326) * [Allow using logstash option with the File transport (`gmajoulet`)](https://github.com/flatiron/winston/pull/299) * [Be more defensive when working with `query` methods from Transports. Fixes #356. (indexzero)](https://github.com/flatiron/winston/commit/b80638974057f74b521dbe6f43fef2105110afa2) * [Catch exceptions for file transport unlinkSync (`calvinfo`)](https://github.com/flatiron/winston/pull/266) * [Adding the 'addRewriter' to winston (`machadogj`)](https://github.com/flatiron/winston/pull/258) * [Updates to transport documentation (`pose`)](https://github.com/flatiron/winston/pull/262) * [fix typo in "Extending another object with Logging" section.](https://github.com/flatiron/winston/pull/281) * [Updated README.md - Replaced properties with those listed in winston-mongodb module](https://github.com/flatiron/winston/pull/264) ## 0.8.0 / 2014-09-15 * [Fixes for HTTP Transport](https://github.com/flatiron/winston/commit/a876a012641f8eba1a976eada15b6687d4a03f82) * Removing [jsonquest](https://github.com/flatiron/winston/commit/4f088382aeda28012b7a0498829ceb243ed74ac1) and [request](https://github.com/flatiron/winston/commit/a5676313b4e9744802cc3b8e1468e4af48830876) dependencies. * Configuration is now [shalow cloned](https://github.com/flatiron/winston/commit/08fccc81d18536d33050496102d98bde648853f2). * [Added logstash support](https://github.com/flatiron/winston/pull/445/files) * Fix for ["flush" event should always fire after "flush" call bug](https://github.com/flatiron/winston/pull/446/files) * Added tests for file: [open and stress](https://github.com/flatiron/winston/commit/47d885797a2dd0d3cd879305ca813a0bd951c378). * [Test fixes](https://github.com/flatiron/winston/commit/9e39150e0018f43d198ca4c160acef2af9860bf4) * [Fix ")" on string interpolation](https://github.com/flatiron/winston/pull/394/files) ## 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