# node-red-contrib-logger

> Node-RED implements logger and debug/logging for control for any insert.

Latest version **0.1.1** (published 2024-11-15) · GPL-3.0 license · 0 weekly downloads

## Install

```sh
npm install node-red-contrib-logger
pnpm add node-red-contrib-logger
yarn add node-red-contrib-logger
bun add node-red-contrib-logger
```

## Health

**Score 40/100 (D)** — status: stable.

Positive: no vulnerabilities; high maintenance score.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: stale.

## Facts

| | |
|---|---|
| Version | 0.1.1 |
| Published | 2024-11-15 |
| First published | 2020-01-14 |
| Weekly downloads | 0 |
| License | GPL-3.0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 798.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Peter Prib |
| Maintainers | peter.prib |
| Keywords | node-red, debug, logging |

## Links

- npm: https://www.npmjs.com/package/node-red-contrib-logger
- Repository: https://github.com/peterprib/node-red-contrib-logger
- Homepage: https://github.com/peterprib/node-red-contrib-logger#readme
- Issues: https://github.com/peterprib/node-red-contrib-logger/issues
- npm.io page: https://npm.io/package/node-red-contrib-logger

## Dependencies (1)

- [node-red-contrib-logger](https://npm.io/package/node-red-contrib-logger.md) file:

## Alternatives

- [cli-color](https://npm.io/package/cli-color.md) — 3.4M weekly downloads
- [log](https://npm.io/package/log.md) — 1.3M weekly downloads
- [logstash-client](https://npm.io/package/logstash-client.md) — 4.5K weekly downloads
- [@nocobase/plugin-logger](https://npm.io/package/@nocobase/plugin-logger.md) — 2.0K weekly downloads
- [child-process-debug](https://npm.io/package/child-process-debug.md) — 695 weekly downloads

## Recent versions

- 0.1.1 (latest) — 2024-11-15
- 0.1.0 — 2024-06-29
- 0.0.8 — 2023-09-24
- 0.0.6 — 2021-03-19
- 0.0.5 — 2021-03-06
- 0.0.4 — 2020-06-27
- 0.0.3 — 2020-06-03
- 0.0.2 — 2020-05-27
- 0.0.1 — 2020-01-14

## README

# [node-red-contrib-logger][2]

[Node Red][1] node for logging and debugging that dynamically turns off after reporting a set number of points.

* logger

The code can be used in developed nodes for loggings. Benefit it can be used to sample important detail in case of issues.  Tracing could be dynamically turned on by special topic messages. 


	const Logger = require("logger");
	const logger = new Logger("identifier");


The following inserted where required to log

	if(logger.active) logger.send({label:"a label" ,data:data});
	if(logger.active) logger.send("a message");
	logger.sendInfo("Copyright 2020 Jaroslav Peter Prib");

Use of active is to avoid overhead of function call and parameter preparation when logging is not in effect. It changes state by default after 100 "send" are issued

Alternatively can create by
	
	const logger = new Logger({name:"identifier",count:10,active:true,label:"debug"});

Property "node" can be used to place status on node.
"count" is number of sends processed before active set off. Default is 100
"active" is initial state, default being true.
"label" is set according to standard being info,warn,error,debug,trace.  Default is debug,

Follow calls available: 

	logger.setOff();	//turn off logging
	logger.setOn();		//turn on logging for next x points
	logger.setOn(22);		//turn on logging for next 22 points
	logger.sendInfo("a message"); 		//always send info message 
	logger.sendWarn("a message"); 		//always send warn message 
	logger.sendError("a message"); 		//always send error message 
	logger.sendDebug("a message",{a:a}); 		//always send error message 
	logger.objectDump(anObject); // dump an object
	logger.stackDump(); // dump stack trace
	logger.sendErrorAndDump("a message",anObject); //always sendError+objectDump+stackDump
	logger.sendErrorAndStackDump("a message"); //sendError+stackDump

------------------------------------------------------------

## logger

Defines a node that will log messages, send to a second port and/or send to debug console for a set number of messages. 

![logger](documentation/logger.JPG "logger")

------------------------------------------------------------

# Install

Run the following command in the root directory of your Node-RED install or via GUI install

    npm install node-red-contrib-logger


------------------------------------------------------------

# Version

0.0.6 Add parameter value to send json data to debug console and handle circular references

0.0.5 Add parameter value to send json data to display

0.0.4 Fixes bug and add warn/error alias

0.0.3 Fixes on dump and stack

0.0.2 add more functions

0.0.1 base

# Author

[Peter Prib][3]

[1]: http://nodered.org "node-red home page"

[2]: https://www.npmjs.com/package/node-red-contrib-logger "source code"

[3]: https://github.com/peterprib "base github"

![.github/workflows/nodejs.yml](https://github.com/peterprib/node-red-contrib-logger/workflows/.github/workflows/nodejs.yml/badge.svg?event=release)

---
_Source: https://npm.io/package/node-red-contrib-logger · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._