log4js

A port of log4js to node.js

Showing:

Popularity

Downloads/wk

2.6M

GitHub Stars

5.1K

Maintenance

Last Commit

1yr ago

Contributors

161

Package

Dependencies

5

Size (min+gzip)

24.7KB

License

Apache-2.0

Type Definitions

Built-In

Tree-Shakeable

No?

Categories

Node.js Logging

Reviews

Average Rating

4.0/56
Read All Reviews
jatin269

Top Feedback

3Great Documentation
2Performant
2Highly Customizable

Readme

log4js-node Build Status codecov

NPM

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:

Getting help

Having problems? Jump on the slack channel, or create an issue. If you want to help out with the development, the slack channel is a good place to go as well.

installation

npm install log4js

usage

Minimalist version:

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:

[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):

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

[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

import { configure, getLogger } from "log4js";
configure("./filename");
const logger = getLogger();
logger.level = "debug";
logger.debug("Some debug messages");

configure({
  appenders: { cheese: { type: "file", filename: "cheese.log" } },
  categories: { default: { appenders: ["cheese"], level: "error" } }
});

Contributing

We're always looking for people to help out. Jump on slack and discuss what you want to do. Also, take a look at the rules before submitting a pull request.

License

The original log4js was distributed under the Apache 2.0 License, and so is this. I've tried to keep the original copyright and author credits in place, except in sections that I have rewritten extensively.

Rate & Review

Great Documentation3
Easy to Use0
Performant2
Highly Customizable2
Bleeding Edge0
Responsive Maintainers0
Poor Documentation0
Hard to Use0
Slow0
Buggy0
Abandoned0
Unwelcoming Community0
100
jatin26975 Ratings84 Reviews
9 months ago
Great Documentation
Highly Customizable
Performant

When I use a queue for logging it integrates perfectly with it. However, it is very different from log4j in java, coming from java used it like I did in as same and got so many unwanted errors, and was just painful. Otherwise, it is a great logger, go well with Winston as well. One of the must-have loggers in your codebase these.


0
JITENDER144171 Ratings50 Reviews
9 months ago
prachyaprapawat6 Ratings0 Reviews
1 year ago
Great Documentation
Tarith JayasooriyaSri lanka5 Ratings0 Reviews
A 15 year old dev whos trying to learn everything from programing to robotics
October 8, 2020
Romain LenzottiIle-de-france, France54 Ratings1 Review
Tech Lead Front-End | Fullstack | Formateur à @Zenika | #nodejs #vuejs #angular #react #typescript #javascript
October 1, 2020

Alternatives

winstonA logger for just about everything.
User Rating
4.6/ 5
35
Top Feedback
20Great Documentation
18Highly Customizable
12Performant
GitHub Stars
18K
Weekly Downloads
6M
@awesomeeng/awesome-logLogging for enterprise ready nodejs applications.
User Rating
5.0/ 5
2
Top Feedback
1Great Documentation
1Easy to Use
GitHub Stars
25
Weekly Downloads
4K
tra
tracerA powerful and customizable logging library for node.js
User Rating
5.0/ 5
2
Top Feedback
1Great Documentation
1Easy to Use
1Performant
GitHub Stars
1K
Weekly Downloads
1M
sig
signaleHighly configurable logging utility
User Rating
4.3/ 5
3
Top Feedback
1Great Documentation
1Easy to Use
1Highly Customizable
GitHub Stars
9K
Weekly Downloads
829K
olo
olologA better console.log for the log-driven debugging junkies
User Rating
5.0/ 5
1
Top Feedback
N/A
GitHub Stars
159
Weekly Downloads
3K
See 16 Alternatives

Tutorials

No tutorials found
Add a tutorial