+0
日增长
5,824
stars
749
forks
106
watchers
602
prs
852
issues
0
releases
README
log4js-node
This is a conversion of the log4js
framework to work with node. 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, thinking that it will behave the same way will only bring you sorrow and confusion.
The full documentation is available here.
Changes in version 3.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 if things aren't working.
Out of the box it supports the following features:
- coloured console logging to stdout or stderr
- file appender, with configurable log rolling based on file size or date
- a logger for connect/express servers
- configurable log message layout/patterns
- different log levels for different log categories (make some parts of your app log as DEBUG, others only ERRORS, etc.)
Optional appenders are available:
- SMTP
- GELF
- Loggly
- Logstash (UDP and HTTP)
- logFaces (UDP and HTTP)
- RabbitMQ
- Redis
- Hipchat
- Slack
- mailgun
- InfluxDB
installation
bash
npm install log4js
usage
Minimalist version:
javascript
var log4js = require("log4js");
var logger = log4js.getLogger();
logger.level = "debug";
logger.debug("Some debug messages");
By default, log4js will not output any logs (so that it can safely be used in libraries). The level for the default category is set to OFF. To enable logs, set the level (as in the example). This will then output to stdout with the coloured layout (thanks to masylum), so for the above you would see:
bash
[2010-01-17 11:43:37.987] [DEBUG] [default] - Some debug messages
See example.js for a full example, but here's a snippet (also in examples/fromreadme.js):
javascript
const log4js = require("log4js");
log4js.configure({
appenders: { cheese: { type: "file", filename: "cheese.log" } },
categories: { default: { appenders: ["cheese"], level: "error" } },
});
const logger = log4js.getLogger("cheese");
logger.trace("Entering cheese testing");
logger.debug("Got cheese.");
logger.info("Cheese is Comté.");
logger.warn("Cheese is quite smelly.");
logger.error("Cheese is too ripe!");
logger.fatal("Cheese was breeding ground for listeria.");
Output (in cheese.log):
bash
[2010-01-17 11:43:37.987] [ERROR] cheese - Cheese is too ripe!
[2010-01-17 11:43:37.990] [FATAL] cheese - Cheese was breeding ground for listeria.
Note for library makers
If you're writing a library and would like to include support for log4js, without introducing a dependency headache for your users, take a look at log4js-api.
Documentation
Available here.
There's also an example application.
TypeScript
ts
import as log4js from "log4js";
log4js.configure({
appenders: { cheese: { type: "file", filename: "cheese.log" } },
categories: { default: { appenders: ["cheese"], level: "error" } },
});
const logger = log4js.getLogger();
logger.level = "debug";
loggerTop issues
#711Log file is deleted at run time and get operation not permitted error of new generated log file21 comments · 2018-05-14#547pm2 logging problem with multiple applications12 comments · 2017-09-21#1122Custom appender support for ESM project9 comments · 2022-01-11#1175layout is not a function error when trying to write JSON file8 comments · 2022-01-27#901Please add support for source maps8 comments · 2019-06-20#936How are files compressed on zOS?7 comments · 2019-08-28#1410TypeError: log4js.getLogger is not a function6 comments · 2024-01-04#1395multiFile type is not able to use with the error: type "multiFile" could not be found6 comments · 2023-09-22