# mqttlogger

> MQTT integrated Winston logger

Latest version **1.0.6** (published 2023-01-19) · MIT license · 0 weekly downloads

## Install

```sh
npm install mqttlogger
pnpm add mqttlogger
yarn add mqttlogger
bun add mqttlogger
```

## Health

**Score 20/100 (F)** — status: abandoned.

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.6 |
| Published | 2023-01-19 |
| First published | 2023-01-19 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Dependencies | 0 |
| Unpacked size | 7.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | RamS |
| Maintainers | ramsuj |
| Keywords | Winston, Logger |

## Links

- npm: https://www.npmjs.com/package/mqttlogger
- npm.io page: https://npm.io/package/mqttlogger

## 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

- 1.0.6 (latest) — 2023-01-19
- 1.0.5 — 2023-01-19
- 1.0.4 — 2023-01-19
- 1.0.2 — 2023-01-19
- 1.0.1 — 2023-01-19
- 1.0.0 — 2023-01-19

## README

# mqttlogger
A Winston logger package integrated with MQTT publish support

# Installation
```bash
npm install mqttlogger --save
```

# Usage
```javascript
/**
 * Requiring `mqttlogger` will expose
 * `winston.transports.MqttTransport`
 */
import logger from 'mqttlogger';

logger.log('hardwareDown', "COMPONENT-NAME", {baseTopic : 'TOPIC/TO/PUBLISH', data: { status: 'hardwareDown'}} )

```
The logger supports custom levels such as hardwareDown and hardwareUp. Whatever levels need to be published need to be declared on .env file. Also MQTT credentials need to be declared in the .env
* __MQTT_LOG_LEVELS__='hardwareDown|hardwareUp'
* __MQTT_USERNAME__='hardwareDown|hardwareUp'
* __MQTT_PASSWORD__='mqtt-password'

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