From e99276d141caffd7cf41d05a130ade2aed8f4a95 Mon Sep 17 00:00:00 2001 From: Gareth Jones Date: Fri, 20 Jul 2018 08:17:55 +1000 Subject: [PATCH] docs: v3 changes --- README.md | 2 ++ docs/index.md | 2 ++ docs/v3-changes.md | 25 +++++++++++++++++++++++++ 3 files changed, 29 insertions(+) create mode 100644 docs/v3-changes.md diff --git a/README.md b/README.md index 3e7f712..927d971 100644 --- a/README.md +++ b/README.md @@ -8,6 +8,8 @@ framework to work with [node](http://nodejs.org). I started out just stripping o The full documentation is available [here](https://log4js-node.github.io/log4js-node/). +[Changes in version 3.x](https://log4js-node.github.io/log4js-node/v3-changes.md) + There have been a few changes between log4js 1.x and 2.x (and 0.x too). You should probably read this [migration guide](https://log4js-node.github.io/log4js-node/migration-guide.html) if things aren't working. Out of the box it supports the following features: diff --git a/docs/index.md b/docs/index.md index 99e6f58..26556a5 100644 --- a/docs/index.md +++ b/docs/index.md @@ -3,6 +3,8 @@ This is a conversion of the [log4js](https://github.com/stritti/log4js) framework to work with [node](http://nodejs.org). I started out just stripping out the browser-specific code and tidying up some of the javascript to work better in node. It grew from there. Although it's got a similar name to the Java library [log4j](https://logging.apache.org/log4j/2.x/), thinking that it will behave the same way will only bring you sorrow and confusion. +[Changes in version 3.x](v3-changes.md) + ## Migrating from log4js < v2.x? There have been a few changes between log4js 1.x and 2.x (and 0.x too). You should probably read this [migration guide](migration-guide.md) if things aren't working. diff --git a/docs/v3-changes.md b/docs/v3-changes.md new file mode 100644 index 0000000..a8494a5 --- /dev/null +++ b/docs/v3-changes.md @@ -0,0 +1,25 @@ +# Changes in version 3.x of log4js + +log4js no longer supports node versions less than 6. + +The following appenders have been removed from the core, and moved to their own projects: +* [gelf](https://github.com/log4js-node/gelf) +* [hipchat](https://github.com/log4js-node/hipchat) +* [logFaces-HTTP](https://github.com/log4js-node/logFaces-HTTP) +* [logFaces-UDP](https://github.com/log4js-node/logFaces-UDP) +* [loggly](https://github.com/log4js-node/loggly) +* [logstashHTTP](https://github.com/log4js-node/logstashHTTP) +* [logstashUDP](https://github.com/log4js-node/logstashUDP) +* [mailgun](https://github.com/log4js-node/mailgun) +* [rabbitmq](https://github.com/log4js-node/rabbitmq) +* [redis](https://github.com/log4js-node/redis) +* [slack](https://github.com/log4js-node/slack) +* [smtp](https://github.com/log4js-node/smtp) +If you were using them, you'll need to `npm i @log4js-node/`. + +Removing the optional appenders removed all the security vulnerabilities. + +The TCP [client](tcp.md)/[server](tcp-server.md) was introduced to replace the multiprocess appender. + +[Issues resolved in 3.0.0](https://github.com/log4js-node/log4js-node/milestone/31?closed=1) +[PR for the code changes](https://github.com/log4js-node/log4js-node/pull/754)