# @dojot/dojot-module-logger

> A simple configurable logger for dojot modules

Latest version **0.1.2** (published 2022-09-14) · Apache-2.0 license · 0 weekly downloads

## Install

```sh
npm install @dojot/dojot-module-logger
pnpm add @dojot/dojot-module-logger
yarn add @dojot/dojot-module-logger
bun add @dojot/dojot-module-logger
```

## Health

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

Positive: has types; no vulnerabilities; high quality score.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.2 |
| Published | 2022-09-14 |
| First published | 2018-09-25 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 39.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Felipe Muhamed Avila, Giovanni Curiel dos Santos |
| Maintainers | manuel.gavidia, giovannicuriel, mprevide, scaraficci, timedojot, thiagodpf |
| Keywords | logger, dojot, modules |

## Links

- npm: https://www.npmjs.com/package/@dojot/dojot-module-logger
- Repository: https://github.com/dojot/dojot-module-logger-nodejs
- Homepage: https://github.com/dojot/dojot-module-logger-nodejs#readme
- Issues: https://github.com/dojot/dojot-module-logger-nodejs/issues
- npm.io page: https://npm.io/package/@dojot/dojot-module-logger

## Dependencies (2)

- [express](https://npm.io/package/express.md) ^4.16.3
- [winston](https://npm.io/package/winston.md) ^3.1.0

## 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.2 (latest) — 2022-09-14
- 0.1.1 — 2022-09-08
- 0.1.0 — 2020-12-04
- 0.0.1-alpha.5 — 2019-05-30
- 0.0.1-alpha.4 — 2018-10-24
- 0.0.1-alpha.3 — 2018-10-24
- 0.0.1-alpha.2 — 2018-10-09
- 0.0.1-alpha.1 — 2018-09-25

## README

dojot-module-logger
===================

This component is a simple logger, based on [winston](https://github.com/winstonjs/winston), that
offers an endpoint to be added to an Express application.

# How to use

It's simple. Just import it and use it: 

```javascript
   const DojotLogger = require("@dojot/dojot-module-logger-nodejs");
   DojotLogger.logger.debug("This is an example", {filename: "my_module"});
```

You can change its current log level by calling:

```javascript
   DojotLogger.logger.setLevel("info");
```

You should definitely check out [winston
documentation](https://github.com/winstonjs/winston) for more information about
how to use it.

You can add an endpoint to your component as well:

```javascript

   var bodyParser = require("body-parser");
   var express = require("express");
   var app = express();

   app.use(bodyParser.json());
   app.use(DojotLogger.getHTTPRouter());
   app.listen(10001, () => {
       DojotLogger.logger.info(`Listening on port 10001.`);
   });

```

Thus you can call:

```bash

   curl -X PUT http://localhost:10001/log -H "Content-Type:application/json" -d '{"level" : "debug"}'

```
to change current log level. Currently supported levels are:

- debug
- info
- warn
- error

In order to get current log level, just send a GET request to the same endpoint:

```bash

   curl -X GET http://localhost:10001/log 

```

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