anylogger-log4js

anylogger-log4js _{^1.1.0-beta.3}

Anylogger adapter for log4js

^_.

What is this?

This is an anylogger adapter for log4js.

This package is meant for application projects that are using libraries using anylogger. By including this adapter in your project, all libraries using anylogger will automatically start to use log4js as their logging framework.

Install

Install this adapter, as well as both anylogger and log4js:

npm install --save anylogger-log4js anylogger log4js

Include in your application project

This package is meant for application projects. If you are writing a library to be NPM installed into some other project, most likely you should not include any adapter, but instead just use anylogger directly.

The anylogger-log4js adapter will modify the anylogger factory in such a way that the loggers it creates will be logging to log4js.

When using log4js, all logging except for warnings and errors is supressed by default. As such, you should make sure to set the log level to INFO or DEBUG as usual before expecting to see any output.

To activate the adapter, include it in your application entry point.

Import

main.js

import adapter from 'anylogger-log4js'
import anylogger from 'anylogger'
import log4js from 'log4js'
adapter(anylogger, log4js)

Require

main.js

const adapter = require('anylogger-log4js')
const anylogger = require('anylogger')
const log4js = require('log4js')
adapter(anylogger, log4js)

Logging in the application project

In your application module code, only use anylogger to stay framework independent:

my-module.js

import anylogger from 'anylogger'
const log = anylogger('my:module')
log('Logging is simple!')

This is helpful if you ever decide to factor out the application module into a separate library.

log configuration in the application project

Because anylogger is simply using log4js below the surface, you can use all the normal configuration mechanisms available for log4js.

If you need to control log settings programmatically, just import log4js and use it directly:

main.js

// ...
import log4js from 'log4js'
log4js.getLogger('my:module').level = 'info'
// ...

Issues

Add an issue in this project's issue tracker to let me know of any problems you find, or questions you may have.

Copyright

© 2024 by Stijn de Witt. Some rights reserved.

License

Licensed under the MIT Open Source license.