# restify-bunyan-logger

> Bunyan Logger for Restify =========================

Latest version **2.0.7** (published 2015-03-17) · 0 weekly downloads

## Install

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

Provides the command `restify-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 | 2.0.7 |
| Published | 2015-03-17 |
| First published | 2014-11-20 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=0.10 |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 2 |
| Maintainers | matthieu.bacconnier |

## Links

- npm: https://www.npmjs.com/package/restify-bunyan-logger
- Repository: https://github.com/AnyFetch/restify-bunyan-logger
- Issues: https://github.com/AnyFetch/restify-bunyan-logger/issues
- npm.io page: https://npm.io/package/restify-bunyan-logger

## Dependencies (1)

- [underscore](https://npm.io/package/underscore.md) ^1.7.0

## Recent versions

- 2.0.7 (latest) — 2015-03-17
- 2.0.6 — 2014-11-27
- 2.0.5 — 2014-11-26
- 2.0.4 — 2014-11-25
- 2.0.3 — 2014-11-25
- 2.0.2 — 2014-11-25
- 2.0.1 — 2014-11-25
- 2.0.0 — 2014-11-25
- 1.0.1 — 2014-11-20
- 1.0.0 — 2014-11-20

## README

Bunyan Logger for Restify
=========================

Add bunyan logging to your restify app.

## Installation
```
npm install restify-bunyan-logger
```

Use `--save` to add the package to your current package.json.

## Usage
Basic usage is one line (if you're already using bunyan):

```js
var restifyBunyanLogger = require('restify-bunyan-logger');
server.on('after', restifyBunyanLogger());
```

If you're not using bunyan, you'll need to update your server creation too:

```js
var Logger = require('bunyan');
var server = restify.createServer({
  log: new Logger.createLogger({
    name: "your app name",
  })
});
```


### Parameters
`restifyBunyanLogger` takes an option parameter. Valid keys are:

* `skip`: function to skip some logs. Take as parameters req and res, must return true to skip the logging of this request.
* `custom`: function to add custom values to the bunyan log. Take as parameters req, res, route, err, log (a pre defined log object). Must return a Javascript object.
* `logger`: a custom bunyan logger. Will default to req.log if unspecified

```js
server.on('after', restifyBunyanLogger({
  skip: function(req, res) {
    return req.method === "OPTIONS";
  },
  custom: function(req, res, route, err, log) {
    // This will not work when using gzip.
    log.res.length = res.get('Content-Length');

    // Don't forget to return!
    return log;
  },
  logger: bunyanLogger
}));
```

## CLI usage
You can pipe your json logs into `bin/restify-bunyan-logger` (or `restify-bunyan-logger` when installed with `npm -g`) to get a nicely formatted one-line view.

This is a dirty hack around the standard bunyan logger, until https://github.com/trentm/node-bunyan/pull/191 is merged.

## More...
This package fits nicely with the default restify bunyan implementation, and will use any custom logger you want.
You may want to add `server.use(restify.requestLogger());` to get a unique request identifier on each log.

## I'm using express
I'm quite sad for you. If you want, you can use this simple wrapper to get lbunyan logging on express:

```js
'use strict';
var onFinished = require('on-finished');
var BunyanLogger = require('restify-bunyan-logger');
var Logger = require('bunyan');


var bunyanLogger = new BunyanLogger({
  custom: function(req, res, route, err, log) {
    log.req.route = req.route ? req.route.path : null;
    return log;
  },
  logger: new Logger.createLogger(),
});



module.exports = function(req, res, next) {
  req._startAt = new Date();
  onFinished(res, function(err) {
    req.time = function() {
      return req._startAt;
    };
    bunyanLogger(req, res, null, err);
  });

  next();
};
```

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