archive-gh-me/log4js-node
1
0
Fork 0
mirror of https://github.com/log4js-node/log4js-node.git synced 2025-12-08 19:26:01 +00:00
Code Issues Projects Releases Wiki Activity

docs: v3 changes

Browse Source
This commit is contained in:
Gareth Jones 2018-07-20 08:17:55 +10:00
parent c7e9b06edf
commit e99276d141
3 changed files with 29 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
README.md
View File

@ -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:

2
docs/index.md
View File

@ -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.

25
docs/v3-changes.md Normal file
View File

@ -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/<appender>`.
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)