# loopback-bunyan-logger

> Logging component for loopback UPDATED

Latest version **1.1.3** (published 2017-05-09) · GNU license · 0 weekly downloads

## Install

```sh
npm install loopback-bunyan-logger
pnpm add loopback-bunyan-logger
yarn add loopback-bunyan-logger
bun add loopback-bunyan-logger
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.1.3 |
| Published | 2017-05-09 |
| First published | 2017-04-24 |
| Weekly downloads | 0 |
| License | GNU |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Maintainers | saikatharryc |

## Links

- npm: https://www.npmjs.com/package/loopback-bunyan-logger
- Repository: https://github.com/saikatharryc/loopback-bunyan-logger
- Homepage: https://github.com/saikatharryc/loopback-bunyan-logger#readme
- Issues: https://github.com/saikatharryc/loopback-bunyan-logger/issues
- npm.io page: https://npm.io/package/loopback-bunyan-logger

## Dependencies (2)

- [debug](https://npm.io/package/debug.md) ^2.6.4
- [bunyan](https://npm.io/package/bunyan.md) ^1.8.10

## Recent versions

- 1.1.3 (latest) — 2017-05-09
- 1.1.2 — 2017-05-09
- 1.1.1 — 2017-05-09
- 1.0.0 — 2017-04-24

## README

# loopback-bunyan-logger
updated   {loopback-component-logger}
 
 **incase if you dont want the child node logs. please use the version ^1.1.2 of `loopback-bunyan-looger`.
 
Logging component for [loopback] using [bunyan] logger with additional loopback specific hooks and log management API

[![NPM](https://nodei.co/npm/loopback-bunyan-logger.png?downloads=true)](https://nodei.co/npm/loopback-bunyan-logger/) [![NPM](https://nodei.co/npm-dl/loopback-bunyan-logger.png?months=1&height=2)](https://nodei.co/npm/loopback-bunyan-logger/)


[![Build Status](https://travis-ci.org/saikatharryc/loopback-bunyan-logger.svg?branch=master)](https://travis-ci.org/saikatharryc/loopback-bunyan-logger)


# Features

- Default logger using [bunyan]
- Can use of custom bunyan [streams] to create root logger
- Hook: Basic performance instrumentation for remote execution
- Hook: Log management API (configurable)

# Usage

Example _server.js_:

```js
var loopback = require('loopback');
var boot = require('loopback-boot');
var rootlogger = bunyan.createlogger({name: 'myloopbackAPI'});
var logger = require('loopback-bunyan-logger')(rootlogger);
var app = module.exports = loopback();

```

If rootlogger is not provide, the component creates a logger with default
 [bunyan] settings:

```js
var loopback = require('loopback');
var boot = require('loopback-boot');
var logger = require('loopback-bunyan-logger')();
var app = module.exports = loopback();

```

Child loggers can be created for model as shown below. By default child loggers
inherit the log level from root.

```js

var logger = require('loopback-bunyan-logger')('TestModel');
module.exports = function(TestModel) {
    logger.debug('Initializing TestModel');
};

```

To add hooks and log management API to [loopback], add configuration to component-config.json:

```js
{
  "loopback-component-explorer": {
    "mountPath": "/explorer"
  },
  "loopback-bunyan-logger": {
      "enableAPI" : true
  }
}

```
Make sure enableHttpContext is set as true in config.json for to allow collection
 of datasources performance within req/res
If you dont want expand the child nodes please use version @1.1.2
# License

[GNU](https://github.com/saikatharryc/loopback-bunyan-logger/blob/master/LICENSE)
 
# Create Issue
  Create issue here [here](https://github.com/saikatharryc/loopback-bunyan-logger/issues)

# Roadmap
- Additional Unit Test and Coverage
- Integrate with Strongloop Devops tools

# Known Issue
- datasources performance will not recorded at times when loopback context is null. Noticed this issue when a composite called MongoDB followed by REST. Only MongoDB response time was recorded and REST was missing.

# See Also

- [Loopback][loopback]
- [bunyan][bunyan]

[bunyan]: https://github.com/trentm/node-bunyan
[loopback]: http://loopback.io
[streams]: https://github.com/trentm/node-bunyan#streams

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